Bug fixes in the man page.

This commit is contained in:
Ole Tange 2012-03-15 21:23:53 +01:00
parent 202f2ec571
commit 93c5c6aaa5
2 changed files with 49 additions and 24 deletions

View file

@ -63,8 +63,9 @@ Command to execute. If I<command> or the following arguments contain
replacement strings (such as B<{}>) every instance will be substituted replacement strings (such as B<{}>) every instance will be substituted
with the input. with the input.
If I<command> is given, GNU B<parallel> will behave similar to B<xargs>. If If I<command> is given, GNU B<parallel> solve the same tasks as
I<command> is not given GNU B<parallel> will behave similar to B<cat | sh>. B<xargs>. If I<command> is not given GNU B<parallel> will behave
similar to B<cat | sh>.
The I<command> must be an executable, a script, a composed command, or The I<command> must be an executable, a script, a composed command, or
a function. If it is a function you need to B<export -f> the function a function. If it is a function you need to B<export -f> the function
@ -182,6 +183,18 @@ directory (if any) removed.
To understand positional replacement strings see B<{>I<n>B<}>. To understand positional replacement strings see B<{>I<n>B<}>.
=item B<{>I<n>//B<}>
Dirname of argument from input source I<n> or the I<n>'th argument.
It is a combination of B<{>I<n>B<}> and B<{//}>.
This positional replacement string will be replaced by the dir of the
input from input source I<n> (when used with B<-a> or B<::::>) or with
the I<n>'th argument (when used with B<-N>). See B<dirname>(1).
To understand positional replacement strings see B<{>I<n>B<}>.
=item B<{>I<n>/.B<}> =item B<{>I<n>/.B<}>
Basename of argument from input source I<n> or the I<n>'th argument Basename of argument from input source I<n> or the I<n>'th argument
@ -562,10 +575,8 @@ If B<--semaphore> is set default is 1 thus making a mutex.
=item B<-P> I<+N> =item B<-P> I<+N>
Add N to the number of CPU cores. Run this many jobs in parallel. For Add N to the number of CPU cores. Run this many jobs in parallel.
compute intensive jobs B<-j> +0 is useful as it will run See also B<--use-cpus-instead-of-cores>.
number-of-cpu-cores jobs simultaneously. See also
B<--use-cpus-instead-of-cores>.
=item B<--jobs> I<-N> =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 A complete example that others can run that shows the problem. A
combination of B<seq>, B<cat>, B<echo>, and B<sleep> can reproduce combination of B<seq>, B<cat>, B<echo>, and B<sleep> can reproduce
most errors. If your example requires large files, see if you can make most errors. If your example requires large files, see if you can make
them by something like B<seq 1000000>>B<file>. them by something like B<seq 1000000> > B<file>.
=back =back
If you suspect the error is dependent on your distribution, please see If you suspect the error is dependent on your distribution, please see
if you can reproduce the error on one of these VirtualBox images: if you can reproduce the error on one of these VirtualBox images:
http://sourceforge.net/projects/virtualboximage/files/ Specifying the http://sourceforge.net/projects/virtualboximage/files/
name of your distribution is not enough as you may have installed
software that is not the the VirtualBox images. Specifying the name of your distribution is not enough as you may have
installed software that is not in the VirtualBox images.
=head1 AUTHOR =head1 AUTHOR

View file

@ -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 replacement strings (such as @strong{@{@}}) every instance will be substituted
with the input. with the input.
If @emph{command} is given, GNU @strong{parallel} will behave similar to @strong{xargs}. If If @emph{command} is given, GNU @strong{parallel} solve the same tasks as
@emph{command} is not given GNU @strong{parallel} will behave similar to @strong{cat | sh}. @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 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 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{@}}. 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{@}} @item @strong{@{}@emph{n}/.@strong{@}}
@anchor{@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} @item @strong{-P} @emph{+N}
@anchor{@strong{-P} @emph{+N}} @anchor{@strong{-P} @emph{+N}}
Add N to the number of CPU cores. Run this many jobs in parallel. For Add N to the number of CPU cores. Run this many jobs in parallel.
compute intensive jobs @strong{-j} +0 is useful as it will run See also @strong{--use-cpus-instead-of-cores}.
number-of-cpu-cores jobs simultaneously. See also
@strong{--use-cpus-instead-of-cores}.
@item @strong{--jobs} @emph{-N} @item @strong{--jobs} @emph{-N}
@anchor{@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 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%} @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 for one per CPU is a valid setting. Only difference is 0 which is
actually means 0. interpreted as 0.01.
The load average is only sampled every 10 seconds to avoid stressing The load average is only sampled every 10 seconds using @strong{uptime} to
small computers. avoid stressing small computers. Only the first (1 minute) load is
used.
@item @strong{--controlmaster} (experimental) @item @strong{--controlmaster} (experimental)
@anchor{@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 @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 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 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 @end itemize
If you suspect the error is dependent on your distribution, please see If you suspect the error is dependent on your distribution, please see
if you can reproduce the error on one of these VirtualBox images: if you can reproduce the error on one of these VirtualBox images:
http://sourceforge.net/projects/virtualboximage/files/ Specifying the http://sourceforge.net/projects/virtualboximage/files/
name of your distribution is not enough as you may have installed
software that is not the the VirtualBox images. Specifying the name of your distribution is not enough as you may have
installed software that is not in the VirtualBox images.
@chapter AUTHOR @chapter AUTHOR
@anchor{AUTHOR} @anchor{AUTHOR}