sem: man page updates

This commit is contained in:
Ole Tange 2011-06-25 09:22:05 +02:00
parent ccaa30b4c3
commit 978456b207
2 changed files with 98 additions and 11 deletions

View file

@ -282,7 +282,7 @@ Run command in background thus GNU B<parallel> will not wait for
completion of the command before exiting. This is the default if completion of the command before exiting. This is the default if
B<--semaphore> is set. B<--semaphore> is set.
See also: B<--fg> See also: B<--fg>, B<man sem>
Implies B<--semaphore>. Implies B<--semaphore>.
@ -399,7 +399,7 @@ Implies B<--progress>.
Run command in foreground thus GNU B<parallel> will wait for Run command in foreground thus GNU B<parallel> will wait for
completion of the command before exiting. completion of the command before exiting.
See also: B<--bg> See also: B<--bg>, B<man sem>
Implies B<--semaphore>. Implies B<--semaphore>.
@ -932,16 +932,26 @@ Used with B<--fg>, B<--wait>, and B<--semaphorename>.
The command B<sem> is an alias for B<parallel --semaphore>. The command B<sem> is an alias for B<parallel --semaphore>.
See also: B<man sem>
=item B<--semaphorename> I<name> =item B<--semaphorename> I<name>
=item B<--id> I<name> =item B<--id> I<name>
The name of the semaphore to use. The semaphore can be shared between Use B<name> as the name of the semaphore. Default is the name of the
multiple processes. controlling tty (output from B<tty>).
The default normally works as expected when used interactively, but
when used in a script I<name> should be set. I<$$> or I<my_task_name>
are often a good value.
The semaphore is stored in ~/.parallel/semaphores/
Implies B<--semaphore>. Implies B<--semaphore>.
See also: B<man sem>
=item B<--semaphoretimeout> I<secs> (not implemented) =item B<--semaphoretimeout> I<secs> (not implemented)
@ -949,6 +959,8 @@ If the semaphore is not released within secs seconds, take it anyway.
Implies B<--semaphore>. Implies B<--semaphore>.
See also: B<man sem>
=item B<--seqreplace> I<replace-str> =item B<--seqreplace> I<replace-str>
@ -1203,6 +1215,8 @@ Wait for all commands to complete.
Implies B<--semaphore>. Implies B<--semaphore>.
See also: B<man sem>
=item B<-X> =item B<-X>

View file

@ -31,7 +31,13 @@ B<sem> is capable of.
Command to execute. The command may be followed by arguments for the command. Command to execute. The command may be followed by arguments for the command.
=item B<--count> I<N> =item B<--bg>
Run command in background thus GNU B<parallel> will not wait for
completion of the command before exiting. This is the default.
See also: B<--fg>
=item B<-j> I<N> =item B<-j> I<N>
@ -39,15 +45,82 @@ Run up to N commands in parallel. Default is 1 thus acting like a
mutex. mutex.
=item B<--id> I<id> =item B<--jobs> I<N>
=item B<-i> I<id> =item B<-j> I<N>
Use B<id> as the name of the semaphore. Default is the name of the =item B<--max-procs> I<N>
=item B<-P> I<N>
Run up to N commands in parallel. Default is 1 thus acting like a
mutex.
=item B<--jobs> I<+N>
=item B<-j> I<+N>
=item B<--max-procs> I<+N>
=item B<-P> I<+N>
Add N to the number of CPU cores. Run up to this many jobs in
parallel. For compute intensive jobs B<-j> +0 is useful as it will run
number-of-cpu-cores jobs simultaneously.
=item B<--jobs> I<-N>
=item B<-j> I<-N>
=item B<--max-procs> I<-N>
=item B<-P> I<-N>
Subtract N from the number of CPU cores. Run up to this many jobs in
parallel. If the evaluated number is less than 1 then 1 will be used.
See also B<--use-cpus-instead-of-cores>.
=item B<--jobs> I<N>%
=item B<-j> I<N>%
=item B<--max-procs> I<N>%
=item B<-P> I<N>%
Multiply N% with the number of CPU cores. Run up to this many jobs in
parallel. If the evaluated number is less than 1 then 1 will be used.
See also B<--use-cpus-instead-of-cores>.
=item B<--jobs> I<procfile>
=item B<-j> I<procfile>
=item B<--max-procs> I<procfile>
=item B<-P> I<procfile>
Read parameter from file. Use the content of I<procfile> as parameter
for I<-j>. E.g. I<procfile> could contain the string 100% or +2 or
10.
=item B<--semaphorename> I<name>
=item B<--id> I<name>
Use B<name> as the name of the semaphore. Default is the name of the
controlling tty (output from B<tty>). controlling tty (output from B<tty>).
The default normally works as expected when used interactively, but The default normally works as expected when used interactively, but
when used in a script I<id> should be set. $$ is often a good value. when used in a script I<name> should be set. I<$$> or I<my_task_name>
are often a good value.
The semaphore is stored in ~/.parallel/semaphores/
=item B<--fg> =item B<--fg>
@ -95,7 +168,7 @@ time. B<sem> running as a mutex will do just that:
=head1 BUGS =head1 BUGS
Quoting and composed commands are not working. None known.
=head1 REPORTING BUGS =head1 REPORTING BUGS
@ -219,7 +292,7 @@ A copy of the full license is included in the file as cc-by-sa.txt.
=head1 DEPENDENCIES =head1 DEPENDENCIES
GNU B<sem> uses Perl, and the Perl modules Getopt::Long, GNU B<sem> uses Perl, and the Perl modules Getopt::Long,
Symbol, Fcntl. Symbol, Fcntl.