Changeset 30

Timestamp:

Nov 30, 2011, 11:10:56 PM (13 years ago)

Author:

g7moreau

Message:

• Update doc
• Generate man for perl script

Location:

trunk/oar

Files:

• Makefile (modified) (1 diff)
• oar-dispatch (modified) (2 diffs)

trunk/oar/Makefile

@@ -7 +7 @@
 .PHONY: all clean distclean
 
-all: mpilauncher mpilauncher.1 oar-envsh.1
+all: mpilauncher mpilauncher.1 oar-envsh.1 oar-dispatch.1 oar-parexec.1
 
 clean:

trunk/oar/oar-dispatch

@@ -106 +106 @@
 =head1 SYNOPSIS
 
- oar-dispatch [--core integer] [--overload real] --file filepath [--verbose]
+ oar-dispatch [--task integer] [--overload real] --file filepath [--verbose]
  oar-dispatch --help
 
 =head1 OPTIONS
 
- --task number of task to do in parallel.
-                        default to line number of file OAR_NODE_FILE.
+=over 12
+
+=item B<[-t|--task integer]>
+
+Number of task to do in parallel.
+Default to the line number of the file OAR_NODE_FILE.
  
- --overload     number of OAR job to create / number of task.
-                        Some job are create in advance to start whenever it's possible.
-                        1.1 by default.
+=item B<[-o|--overload real]>
 
- --file file name which content OAR job list
+Number of OAR job to create / number of task.
+Some job are create in advance to start whenever it's possible.
+1.1 by default.
 
- --verbose
+=item B<[-f|--file filepath]>
+
+File name which content OAR job list
+
+=item B<[-v|--verbose]>
  
- --help
+=item B<[-h|--help]>
+
+=back
 
 Input job file name content can have
@@ -133 +143 @@
 just after C<oarsub>.
 
-Example where F<$HOME/test/subjob.txt> is a list of OAR script job (and can be executable but not need here).
+=head1 EXAMPLE
+
+Example where the file F<$HOME/test/subjob.txt> is a list of OAR script job (and can be executable but not need here).
 
  oarsub -n test -l /core=1,walltime=00:05:00 $HOME/test/subjob1.oar