Blame src/pm/gforker/mpiexec.txt

Packit Service c5cf8c
/*D
Packit Service c5cf8c
    mpiexec - Run an MPI program
Packit Service c5cf8c
Packit Service c5cf8c
   Synopsis:
Packit Service c5cf8c
.vb
Packit Service c5cf8c
    mpiexec args executable pgmargs [ : args executable pgmargs ... ]
Packit Service c5cf8c
.ve
Packit Service c5cf8c
   where 'args' are command line arguments for 'mpiexec' (see below), 
Packit Service c5cf8c
   'executable' is the name of an executable MPI program, and 'pgmargs'
Packit Service c5cf8c
   are command line arguments for the executable.  Multiple executables 
Packit Service c5cf8c
   can be specified by using the colon notation (for MPMD - Multiple Program
Packit Service c5cf8c
   Multiple Data applications).
Packit Service c5cf8c
Packit Service c5cf8c
   Standard Parameters:
Packit Service c5cf8c
Packit Service c5cf8c
.N mpiexecstdargs
Packit Service c5cf8c
Packit Service c5cf8c
   Environment Variables:
Packit Service c5cf8c
   The following environment variables affect the behavior of 'mpiexec'\:
Packit Service c5cf8c
+  MPIEXEC_UNIVERSE_SIZE - Sets the maximum number of processes to allow.
Packit Service c5cf8c
.  MPIEXEC_TIMEOUT - Maximum running time in seconds.  'mpiexec' will
Packit Service c5cf8c
   terminate MPI programs that take longer than the value specified by
Packit Service c5cf8c
   'MPIEXEC_TIMEOUT'.  This version of 'mpiexec' (forker process manager)
Packit Service c5cf8c
   sets a default timelimit of 3 minutes (180 seconds) since the forker
Packit Service c5cf8c
   process manager is intended for debugging applications.
Packit Service c5cf8c
.  MPIEXEC_PREFIX_DEFAULT - If this environment variable is set, output
Packit Service c5cf8c
   to standard output is prefixed by the rank in 'MPI_COMM_WORLD' of the 
Packit Service c5cf8c
   process and output to standard error is prefixed by the rank and the 
Packit Service c5cf8c
   text '(err)'; both are followed by an angle bracket ('>').  If
Packit Service c5cf8c
   this variable is not set, there is no prefix.
Packit Service c5cf8c
.  MPIEXEC_PREFIX_STDOUT - Set the prefix for output from standard output.
Packit Service c5cf8c
   This is a string containing text and (optionally) the expression '%d';
Packit Service c5cf8c
   if '%d' is seen, it is replaced by the rank in 'MPI_COMM_WORLD' of the 
Packit Service c5cf8c
   process.  If there is more than one 'MPI_COMM_WORLD'; for example, 
Packit Service c5cf8c
   if 'MPI_Comm_spawn' is used, the expression '%w' is replaced with a
Packit Service c5cf8c
   numeric `world number`, assigned by 'mpiexec'.  The expression '%%' 
Packit Service c5cf8c
   produces a single percent character.
Packit Service c5cf8c
.  MPIEXEC_PREFIX_STDERR - Like 'MPIEXEC_PREFIX_STDOUT', but for output from
Packit Service c5cf8c
   standard error.
Packit Service c5cf8c
.  MPIEXEC_STDIN_DEST - Sets the destination process for input from standard in,
Packit Service c5cf8c
   by rank in the corresponding 'MPI_COMM_WORLD'.
Packit Service c5cf8c
.  MPIEXEC_STDOUTBUF - Sets the buffering mode for standard output.  Valid
Packit Service c5cf8c
   values are 'NONE' (no buffering), 'LINE' (buffering by lines), and
Packit Service c5cf8c
   'BLOCK' (buffering by blocks of characters; the size of the block is
Packit Service c5cf8c
   implementation defined).  The default is 'NONE'.
Packit Service c5cf8c
-  MPIEXEC_STDERRBUF - Like 'MPIEXEC_STDOUTBUF', but for standard error.
Packit Service c5cf8c
Packit Service c5cf8c
   Note that the 'MPIEXEC_PREFIX_xxx' and 'MPIEXEC_STDIN_DEST' variables
Packit Service c5cf8c
   are not fully implemented.
Packit Service c5cf8c
Packit Service c5cf8c
   Startup Environment:
Packit Service c5cf8c
   All of the users environment variables are provided to each of the 
Packit Service c5cf8c
   created processes.  This is not required by the MPI standard, but 
Packit Service c5cf8c
   is often very convenient.  
Packit Service c5cf8c
Packit Service c5cf8c
   Return Status:
Packit Service c5cf8c
   'mpiexec' returns the maximum of the exit status values of all of the
Packit Service c5cf8c
   processes created by 'mpiexec'.  
Packit Service c5cf8c
Packit Service c5cf8c
   Notes:
Packit Service c5cf8c
   A few additional enviroment variables are defined for the use of
Packit Service c5cf8c
   developers and in debugging.  These are
Packit Service c5cf8c
Packit Service c5cf8c
.  MPIEXEC_DEBUG - If set, 'mpiexec' will write additional information
Packit Service c5cf8c
   about the steps that it is taking.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
D*/