prte-submit (PRRTE) 4.1.0
Usage: prte-submit [OPTION]...
Submit job to the PMIx Reference RTE
The following list of command line options are available. Note that
more detailed help for any option can be obtained by adding that
option to the help request as "--help <option>".
+----------------------+-----------------------------------------------+
| | General Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "-h" | "--help" | This help message |
+----------------------+-----------------------------------------------+
| "-h" | "--help | Help for the specified option |
| <arg0>" | |
+----------------------+-----------------------------------------------+
| "-v" | "--verbose" | Enable typical debug options |
+----------------------+-----------------------------------------------+
| "-V" | "--version" | Print version and exit |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Debug Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--display <arg0>" | Comma-delimited list of options for |
| | displaying information about the allocation |
| | and job. Allowed values: "allocation", |
| | "bind", "map", "map- devel", "topo". |
+----------------------+-----------------------------------------------+
| "--timeout | Timeout the job after the specified number of |
| <seconds>" | seconds |
+----------------------+-----------------------------------------------+
| "--spawn-timeout | Timeout the job if spawn takes more than the |
| <seconds>" | specified number of seconds |
+----------------------+-----------------------------------------------+
| "--get-stack-traces" | Get stack traces of all application procs on |
| | timeout |
+----------------------+-----------------------------------------------+
| "--report-state-on- | Report all job and process states upon |
| timeout" | timeout |
+----------------------+-----------------------------------------------+
| "--stop-on-exec" | If supported, stop each specified process at |
| | start of execution |
+----------------------+-----------------------------------------------+
| "--stop-in-init" | Direct the specified processes to stop in |
| | "PMIx_Init" |
+----------------------+-----------------------------------------------+
| "--stop-in-app" | Direct the specified processes to stop at an |
| | application-controlled location |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Output Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--output <args>" | Comma-delimited list of options that control |
| | how output is generated. Allowed values: |
| | "tag", "tag-detailed", "tag-fullname", |
| | "timestamp", "xml", "merge-stderr-to-stdout", |
| | "dir=DIRNAME", "file=filename". The "dir" |
| | option redirects output from application |
| | processes into |
| | "DIRNAME/job/rank/std[out,err,diag]". The |
| | file option redirects output from application |
| | processes into "filename.rank". In both |
| | cases, the provided name will be converted to |
| | an absolute path. Supported qualifiers |
| | include "NOCOPY" (do not copy the output to |
| | the stdout/stderr streams). |
+----------------------+-----------------------------------------------+
| "--report-child- | Return the exit status of the primary job |
| jobs-separately" | only |
+----------------------+-----------------------------------------------+
| "--xterm <ranks>" | Create a new xterm window and display output |
| | from the specified ranks there |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Input Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--stdin <ranks>" | Specify procs to receive stdin ["rank", |
| | "all", "none`, or comma- delimited list of |
| | integers] (default: ``0", indicating rank 0) |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Placement Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--map-by <type>" | Mapping Policy for job |
+----------------------+-----------------------------------------------+
| "--rank-by <type>" | Ranking Policy for job |
+----------------------+-----------------------------------------------+
| "--bind-to <type>" | Binding policy for job |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Launch Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--rtos <arg0>" | | Comma-delimited list of runtime directives |
| "--runtime-options | for the job (e.g., do not abort if a process |
| <arg0>" | exits on non-zero status) |
+----------------------+-----------------------------------------------+
| "-c" | "--np | Number of processes to run |
| <num_procs>" | |
+----------------------+-----------------------------------------------+
| "-n" | "--n | Number of processes to run |
| <num_procs>" | |
+----------------------+-----------------------------------------------+
| "-N <num_procs>" | Number of processes to run per node |
+----------------------+-----------------------------------------------+
| "--app <filename>" | Provide an appfile; ignore all other command |
| | line options |
+----------------------+-----------------------------------------------+
| "-H" | "--host | List of hosts to invoke processes on |
| <hosts>" | |
+----------------------+-----------------------------------------------+
| "--hostfile | Provide a hostfile |
| <filename>" | |
+----------------------+-----------------------------------------------+
| "--machinefile | Provide a hostfile (synonym for "--hostfile") |
| <filename>" | |
+----------------------+-----------------------------------------------+
| "--path <path>" | PATH to be used to look for executables to |
| | start processes |
+----------------------+-----------------------------------------------+
| "--pmixmca <key> | Pass context-specific PMIx MCA parameters; |
| <value>" | they are considered global if only one |
| | context is specified ("key" is the parameter |
| | name; "value" is the parameter value) |
+----------------------+-----------------------------------------------+
| "--gpmixmca <key> | Pass global PMIx MCA parameters that are |
| <value>" | applicable to all contexts ("key" is the |
| | parameter name; "value" is the parameter |
| | value) |
+----------------------+-----------------------------------------------+
| "--app-pmix-prefix <dir>" | Prefix to be used by app procs to look |
| | for their PMIx installation on remote nodes. |
| | This is the location of the top-level |
| | directory for the installation. In the |
| | absence of providing an application-specific |
| | prefix, the PMIx prefix (if given) used by |
| | PRRTE's own executables will be applied |
| | unless the "--no-app-prefix" directive is |
| | given. |
+----------------------+-----------------------------------------------+
| "--no-app-prefix" | Do not provide a prefix directive to this |
| | application. |
+----------------------+-----------------------------------------------+
| "--tune <filename>" | File(s) containing MCA params for tuning |
| | operations |
+----------------------+-----------------------------------------------+
| "--preload-files | Preload the comma separated list of files to |
| <filenames>" | the remote machines current working directory |
| | before starting the remote process. |
+----------------------+-----------------------------------------------+
| "--pset <name>" | User-specified name assigned to the processes |
| | in their given application |
+----------------------+-----------------------------------------------+
| "--rankfile | Name of file to specify explicit task mapping |
| <filename>" | |
+----------------------+-----------------------------------------------+
| "-s" | "--preload- | Preload the binary on the remote machine |
| binary" | before starting the remote process. |
+----------------------+-----------------------------------------------+
| "--set-cwd-to- | Set the working directory of the started |
| session-dir" | processes to their session directory |
+----------------------+-----------------------------------------------+
| "--show-progress" | Output a brief periodic report on launch |
| | progress |
+----------------------+-----------------------------------------------+
| "--wd <dir>" | Synonym for "--wdir" |
+----------------------+-----------------------------------------------+
| "--wdir <dir>" | Set the working directory of the started |
| | processes |
+----------------------+-----------------------------------------------+
| "-x <name>" | Export an environment variable, optionally |
| | specifying a value (e.g., "-x foo" exports |
| | the environment variable foo and takes its |
| | value from the current environment; "-x |
| | foo=bar" exports the environment variable |
| | name foo and sets its value to "bar" in the |
| | started processes; "-x foo*" exports all |
| | current environmental variables starting with |
| | "foo") |
+----------------------+-----------------------------------------------+
| "--set-env | Set the named environmental variable to the |
| <name>=<value>" | specified value. This will overwrite the |
| | existing value, if it exists. Equivalent to |
| | the "-x foo=val" option |
+----------------------+-----------------------------------------------+
| "--unset-env <name>" | Unset the named environmental variable. Note |
| | "--unset-env foo*" unsets all current |
| | environmental variables starting with "foo" |
+----------------------+-----------------------------------------------+
| "--append-env | Append the named environment variable with |
| <name[c]> <value>" | given value. The "[c]" must be appended to |
| | the name to specify the separator to be used |
| | when appending the value. |
+----------------------+-----------------------------------------------+
| "--prepend-env | Prepend the named environment variable with |
| <name[c]> <value>" | given value. The "[c]" must be appended to |
| | the name to specify the separator to be used |
| | when prepending the value. |
+----------------------+-----------------------------------------------+
| "--gpu-support <val>"| Direct application to either enable (true) or |
| | disable (false) its internal library's GPU |
| | support |
+----------------------+-----------------------------------------------+
+----------------------+-----------------------------------------------+
| | Specific Options |
+----------------------+-----------------------------------------------+
| Option | Description |
|======================|===============================================|
| "--do-not-connect" | Do not connect to a server |
+----------------------+-----------------------------------------------+
| "--dvm-uri <uri>" | Specify the URI of the DVM master, or the |
| | name of the file (specified as |
| | "file:filename") that contains that info |
+----------------------+-----------------------------------------------+
| "--namespace <name>" | Namespace of the daemon to which we should |
| | connect |
+----------------------+-----------------------------------------------+
| "--pid <pid>" | PID of the daemon to which we should connect |
| | (integer PID or "file:<filename>" for file |
| | containing the PID |
+----------------------+-----------------------------------------------+
| "--system-server- | First look for a system server and connect to |
| first" | it if found |
+----------------------+-----------------------------------------------+
| "--system-server- | Connect only to a system-level server |
| only" | |
+----------------------+-----------------------------------------------+
| "--tmpdir <dir>" | Set the root for the session directory tree |
+----------------------+-----------------------------------------------+
| "--wait-to-connect | Delay specified number of seconds before |
| <seconds>`" | trying to connect |
+----------------------+-----------------------------------------------+
| "--num-connect- | Max number of times to try to connect |
| retries <num>`" | |
+----------------------+-----------------------------------------------+
| "--personality | Specify the personality to be used |
| <name>" | |
+----------------------+-----------------------------------------------+
| "--report-pid | Print out PID on stdout ("-"), stderr ("+"), |
| <arg0>" | or a file [anything else] |
+----------------------+-----------------------------------------------+
| "--report-uri | Print out URI on stdout ("-"), stderr ("+"), |
| <arg0>" | or a file [anything else] |
+----------------------+-----------------------------------------------+
| "--allow-run-as- | Allow execution as root (**STRONGLY |
| root" | DISCOURAGED**) |
+----------------------+-----------------------------------------------+
| "--forward-signals | Comma-delimited list of additional signals |
| <signals>" | (names or integers) to forward to application |
| | processes ["none" => forward nothing]. |
| | Signals provided by default include |
| | "SIGTSTP", "SIGUSR1", "SIGUSR2", "SIGABRT", |
| | "SIGALRM", and "SIGCONT" |
+----------------------+-----------------------------------------------+
Report bugs to Report bugs to: https://github.com/openpmix/prrte
Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.