From 93c5c6aaa590da85f52ef64f583234fb6b65d20d Mon Sep 17 00:00:00 2001 From: Ole Tange Date: Thu, 15 Mar 2012 21:23:53 +0100 Subject: [PATCH] Bug fixes in the man page. --- src/parallel.pod | 32 ++++++++++++++++++++++---------- src/parallel.texi | 41 +++++++++++++++++++++++++++-------------- 2 files changed, 49 insertions(+), 24 deletions(-) diff --git a/src/parallel.pod b/src/parallel.pod index 71589b85..b35d7d28 100644 --- a/src/parallel.pod +++ b/src/parallel.pod @@ -63,8 +63,9 @@ Command to execute. If I or the following arguments contain replacement strings (such as B<{}>) every instance will be substituted with the input. -If I is given, GNU B will behave similar to B. If -I is not given GNU B will behave similar to B. +If I is given, GNU B solve the same tasks as +B. If I is not given GNU B will behave +similar to B. The I must be an executable, a script, a composed command, or a function. If it is a function you need to B the function @@ -182,6 +183,18 @@ directory (if any) removed. To understand positional replacement strings see B<{>IB<}>. +=item B<{>I//B<}> + +Dirname of argument from input source I or the I'th argument. +It is a combination of B<{>IB<}> and B<{//}>. + +This positional replacement string will be replaced by the dir of the +input from input source I (when used with B<-a> or B<::::>) or with +the I'th argument (when used with B<-N>). See B(1). + +To understand positional replacement strings see B<{>IB<}>. + + =item B<{>I/.B<}> Basename of argument from input source I or the I'th argument @@ -562,10 +575,8 @@ If B<--semaphore> is set default is 1 thus making a mutex. =item B<-P> I<+N> -Add N to the number of CPU cores. Run this many jobs in parallel. For -compute intensive jobs B<-j> +0 is useful as it will run -number-of-cpu-cores jobs simultaneously. See also -B<--use-cpus-instead-of-cores>. +Add N to the number of CPU cores. Run this many jobs in parallel. +See also B<--use-cpus-instead-of-cores>. =item B<--jobs> I<-N> @@ -3230,15 +3241,16 @@ fixed in that version. A complete example that others can run that shows the problem. A combination of B, B, B, and B can reproduce most errors. If your example requires large files, see if you can make -them by something like B>B. +them by something like B > B. =back If you suspect the error is dependent on your distribution, please see if you can reproduce the error on one of these VirtualBox images: -http://sourceforge.net/projects/virtualboximage/files/ Specifying the -name of your distribution is not enough as you may have installed -software that is not the the VirtualBox images. +http://sourceforge.net/projects/virtualboximage/files/ + +Specifying the name of your distribution is not enough as you may have +installed software that is not in the VirtualBox images. =head1 AUTHOR diff --git a/src/parallel.texi b/src/parallel.texi index ae5bcf8e..e2d98392 100644 --- a/src/parallel.texi +++ b/src/parallel.texi @@ -74,8 +74,9 @@ Command to execute. If @emph{command} or the following arguments contain replacement strings (such as @strong{@{@}}) every instance will be substituted with the input. -If @emph{command} is given, GNU @strong{parallel} will behave similar to @strong{xargs}. If -@emph{command} is not given GNU @strong{parallel} will behave similar to @strong{cat | sh}. +If @emph{command} is given, GNU @strong{parallel} solve the same tasks as +@strong{xargs}. If @emph{command} is not given GNU @strong{parallel} will behave +similar to @strong{cat | sh}. The @emph{command} must be an executable, a script, a composed command, or a function. If it is a function you need to @strong{export -f} the function @@ -192,6 +193,18 @@ directory (if any) removed. To understand positional replacement strings see @strong{@{}@emph{n}@strong{@}}. +@item @strong{@{}@emph{n}//@strong{@}} +@anchor{@strong{@{}@emph{n}//@strong{@}}} + +Dirname of argument from input source @emph{n} or the @emph{n}'th argument. +It is a combination of @strong{@{}@emph{n}@strong{@}} and @strong{@{//@}}. + +This positional replacement string will be replaced by the dir of the +input from input source @emph{n} (when used with @strong{-a} or @strong{::::}) or with +the @emph{n}'th argument (when used with @strong{-N}). See @strong{dirname}(1). + +To understand positional replacement strings see @strong{@{}@emph{n}@strong{@}}. + @item @strong{@{}@emph{n}/.@strong{@}} @anchor{@strong{@{}@emph{n}/.@strong{@}}} @@ -601,10 +614,8 @@ If @strong{--semaphore} is set default is 1 thus making a mutex. @item @strong{-P} @emph{+N} @anchor{@strong{-P} @emph{+N}} -Add N to the number of CPU cores. Run this many jobs in parallel. For -compute intensive jobs @strong{-j} +0 is useful as it will run -number-of-cpu-cores jobs simultaneously. See also -@strong{--use-cpus-instead-of-cores}. +Add N to the number of CPU cores. Run this many jobs in parallel. +See also @strong{--use-cpus-instead-of-cores}. @item @strong{--jobs} @emph{-N} @anchor{@strong{--jobs} @emph{-N}} @@ -706,11 +717,12 @@ Implies @strong{-X} unless @strong{-m} is set. Do not start new jobs on a given computer unless the load is less than @emph{max-load}. @emph{max-load} uses the same syntax as @strong{--jobs}, so @emph{100%} -for one per CPU is a valid setting. Only difference is 0 which -actually means 0. +for one per CPU is a valid setting. Only difference is 0 which is +interpreted as 0.01. -The load average is only sampled every 10 seconds to avoid stressing -small computers. +The load average is only sampled every 10 seconds using @strong{uptime} to +avoid stressing small computers. Only the first (1 minute) load is +used. @item @strong{--controlmaster} (experimental) @anchor{@strong{--controlmaster} (experimental)} @@ -3439,15 +3451,16 @@ fixed in that version. @item A complete example that others can run that shows the problem. A combination of @strong{seq}, @strong{cat}, @strong{echo}, and @strong{sleep} can reproduce most errors. If your example requires large files, see if you can make -them by something like @strong{seq 1000000}>@strong{file}. +them by something like @strong{seq 1000000} > @strong{file}. @end itemize If you suspect the error is dependent on your distribution, please see if you can reproduce the error on one of these VirtualBox images: -http://sourceforge.net/projects/virtualboximage/files/ Specifying the -name of your distribution is not enough as you may have installed -software that is not the the VirtualBox images. +http://sourceforge.net/projects/virtualboximage/files/ + +Specifying the name of your distribution is not enough as you may have +installed software that is not in the VirtualBox images. @chapter AUTHOR @anchor{AUTHOR}