parallel.pod: explain no replacement string => {} is appended.

This commit is contained in:
Ole Tange 2011-07-10 16:33:33 +02:00
parent de6d588893
commit f69a6d52f1
2 changed files with 87 additions and 34 deletions

View file

@ -195,6 +195,13 @@ New in this release:
* GNU Parallel was presented at Nordic Perl Workshop 2011. * GNU Parallel was presented at Nordic Perl Workshop 2011.
http://conferences.yapceurope.org/npw2011/talk/3416 http://conferences.yapceurope.org/npw2011/talk/3416
* Blog post about zcat and GNU Parallel. Thanks to Dr. John.
http://drjohnstechtalk.com/blog/2011/06/gnu-parallel-really-helps-with-zcat/
* 2 blog posts in Japanese. Thanks to Negima.
http://d.hatena.ne.jp/negima1976/20110607/1307412660
http://d.hatena.ne.jp/negima1976/20110628/1309252494
* Bug fixes and man page updates. * Bug fixes and man page updates.

View file

@ -72,66 +72,84 @@ http://www.perlmonks.org/index.pl?node_id=484296).
=item B<{}> (still alpha testing) =item B<{}> (still alpha testing)
Input line. This is the default replacement string and will normally Input line. This replacement string will be replaced by a full line
be used for putting the argument in the command line. It can be read from the input source.
changed with B<-I>.
The replacement string B<{}> can be changed with B<-I>.
If the command line contains no replacement strings then B<{}> will be
appended to the command line.
=item B<{.}> (still alpha testing) =item B<{.}> (still alpha testing)
Input line without extension. This is a specialized replacement string Input line without extension. This replacement string will be replaced
with the extension removed. If the input line contains B<.> after the by the input with the extension removed. If the input line contains
last B</> the last B<.> till the end of the string will be removed and B<.> after the last B</> the last B<.> till the end of the string will
B<{.}> will be replaced with the remaining. E.g. I<foo.jpg> becomes be removed and B<{.}> will be replaced with the
I<foo>, I<subdir/foo.jpg> becomes I<subdir/foo>, I<sub.dir/foo.jpg> remaining. E.g. I<foo.jpg> becomes I<foo>, I<subdir/foo.jpg> becomes
becomes I<sub.dir/foo>, I<sub.dir/bar> remains I<sub.dir/bar>. If the I<subdir/foo>, I<sub.dir/foo.jpg> becomes I<sub.dir/foo>,
input line does not contain B<.> it will remain unchanged. I<sub.dir/bar> remains I<sub.dir/bar>. If the input line does not
contain B<.> it will remain unchanged.
B<{.}> can be used the same places as B<{}>. The replacement string The replacement string B<{.}> can be changed with B<-U>.
B<{.}> can be changed with B<-U>.
To understand replacement strings see B<{}>.
=item B<{/}> (still alpha testing) =item B<{/}> (still alpha testing)
Basename of input line. This is a specialized replacement string Basename of input line. This replacement string will be replaced by
with the directory part removed. the input with the directory part removed.
B<{/}> can be used the same places as B<{}>. The replacement string The replacement string B<{/}> can be changed with
B<{/}> can be changed with B<--basenamereplace>. B<--basenamereplace>.
To understand replacement strings see B<{}>.
=item B<{//}> (still alpha testing) =item B<{//}> (still alpha testing)
Dirname of input line. This is a specialized replacement string Dirname of input line. This replacement string will be replaced by the
containing the dir of the input. See B<dirname>(1). dir of the input line. See B<dirname>(1).
B<{//}> can be used the same places as B<{}>. The replacement string The replacement string B<{//}> can be changed with
B<{//}> can be changed with B<--dirnamereplace>. B<--dirnamereplace>.
To understand replacement strings see B<{}>.
=item B<{/.}> (still alpha testing) =item B<{/.}> (still alpha testing)
Basename of input line without extension. This is a specialized Basename of input line without extension. This replacement string will
replacement string with the directory and extension part removed. It be replaced by the input with the directory and extension part
is a combination of B<{/}> and B<{.}>. removed. It is a combination of B<{/}> and B<{.}>.
B<{/.}> can be used the same places as B<{}>. The replacement string The replacement string B<{/.}> can be changed with
B<{/.}> can be changed with B<--basenameextensionreplace>. B<--basenameextensionreplace>.
To understand replacement strings see B<{}>.
=item B<{#}> (still alpha testing) =item B<{#}> (still alpha testing)
Sequence number of the job to run. The same as $PARALLEL_SEQ. Sequence number of the job to run. This replacement string will be
replaced by the sequence number of the job being run. It contains the
same number as $PARALLEL_SEQ.
The replacement string B<{#}> can be changed with B<--seqreplace>. The replacement string B<{#}> can be changed with B<--seqreplace>.
To understand replacement strings see B<{}>.
=item B<{>I<n>B<}> (still alpha testing) =item B<{>I<n>B<}> (still alpha testing)
Argument from input source I<n> or the I<n>'th argument. See B<-a> Argument from input source I<n> or the I<n>'th argument. This
and B<-N>. positional replacement string will be replaced by 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>).
B<{>I<n>B<}> can be used the same places as B<{}>. To understand replacement strings see B<{}>.
=item B<{>I<n>.B<}> (still alpha testing) =item B<{>I<n>.B<}> (still alpha testing)
@ -139,24 +157,39 @@ B<{>I<n>B<}> can be used the same places as B<{}>.
Argument from input source I<n> or the I<n>'th argument without Argument from input source I<n> or the I<n>'th argument without
extension. It is a combination of B<{>I<n>B<}> and B<{.}>. extension. It is a combination of B<{>I<n>B<}> and B<{.}>.
B<{>I<n>.B<}> can be used the same places as B<{>I<n>B<}>. This positional replacement string will be replaced by 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>). The input will have the
extension removed.
To understand positional replacement strings see B<{>I<n>B<}>.
=item B<{>I<n>/B<}> (still alpha testing) =item B<{>I<n>/B<}> (still alpha testing)
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.
It is a combination of B<{>I<n>B<}> and B<{/}>. See B<-a> and B<-N>. It is a combination of B<{>I<n>B<}> and B<{/}>.
B<{>I<n>/B<}> can be used the same places as B<{>I<n>B<}>. This positional replacement string will be replaced by 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>). The input will have the
directory (if any) removed.
To understand positional replacement strings see B<{>I<n>B<}>.
=item B<{>I<n>/.B<}> (still alpha testing) =item B<{>I<n>/.B<}> (still alpha testing)
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
without extension. It is a combination of B<{>I<n>B<}>, B<{/}>, and without extension. It is a combination of B<{>I<n>B<}>, B<{/}>, and
B<{.}>. See B<-a> and B<-N>. B<{.}>.
B<{>I<n>/.B<}> can be used the same places as B<{>I<n>B<}>. This positional replacement string will be replaced by 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>). The input will have the
directory (if any) and extension removed.
To understand positional replacement strings see B<{>I<n>B<}>.
=item B<:::> I<arguments> (alpha testing) =item B<:::> I<arguments> (alpha testing)
@ -608,6 +641,19 @@ that specify their own ssh command.
=item B<--xargs> =item B<--xargs>
Multiple arguments. Insert as many arguments as the command line
length permits.
If B<{}> is not used the arguments will be appended to the
line. If B<{}> is used multiple times each B<{}> will be replaced
with all the arguments.
Support for B<--xargs> with B<--sshlogin> is limited and may fail.
See also B<-X> for context replace. If in doubt use B<-X> as that will
most likely do what is needed.
=item B<-m> =item B<-m>
Multiple arguments. Insert as many arguments as the command line Multiple arguments. Insert as many arguments as the command line