Changeset 21 for trunk/oar/oar-parexec

Timestamp:

Nov 29, 2011, 5:22:51 PM (13 years ago)

Author:

g7moreau

Message:

• Work on doc

File:

• trunk/oar/oar-parexec (modified) (3 diffs)

trunk/oar/oar-parexec

@@ -29 +29 @@
    ) || pod2usage( -verbose => 0 );
 pod2usage( -verbose => 2 ) if $help;
-pod2usage( -verbose => 2 ) if -e $file;
+pod2usage( -verbose => 2 ) if not -e $file;
 
 my @job = ();
@@ -147 +147 @@
  --help
 
-File name content can have
+
+=head1 DESCRIPTION
+
+C<oar-parexec> need to be execute inside an OAR job environment.
+because it need the two environment variable that OAR define by
+default:
+
+ OAR_NODE_FILE path to a file which content one node by line
+
+ OAR_WORKDIR   dir to launch job and do a chdir inside
+
+Content for the job file (option C<--file>) could have:
 
  - empty line
@@ -168 +179 @@
  oarsub -n test -l /core=6,walltime=00:35:00 "oar-parexec -f ./subjob.list.txt"
 
+=head1 SEE ALSO
+
+oar-dispatch, mpilauncher
+
+
 =head1 AUTHORS
 
-Gabriel Moreau (C) 2011
+Written by Gabriel Moreau, Grenoble - France
 
+
+=head1 LICENSE AND COPYRIGHT
+
+GPL version 2 or later and Perl equivalent
+
+Copyright (C) 2011 Gabriel Moreau.
+