# -*- text -*-
#
# Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
# Copyright (c) 2022      IBM Corporation.  All rights reserved.
# $COPYRIGHT$
#
# Additional copyrights may follow
#
# $HEADER$
#
#
[version]
%s (%s) %s

%s
#
[usage]
%s (%s) %s

Usage: %s [OPTION]...
Initiate an instance of the PMIx Reference RTE (PRRTE) DVM

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      *****/

-h|--help                            This help message
-h|--help <arg0>                     Help for the specified option
-v|--verbose                         Enable typical debug options
-V|--version                         Print version and exit


/*****       Debug Options       *****/

   --debug-daemons                   Debug daemons - if not set, any "verbose" settings will be limited to
                                     the DVM controller to reduce clutter
   --debug-daemons-file              Enable debugging of any PRRTE daemons used by this application, storing
                                     their verbose output in files
   --leave-session-attached          Do not discard stdout/stderr of remote PRRTE daemons
   --test-suicide <arg0>             Direct that the specified daemon suicide after delay
   --display <arg0>                  Comma-delimited list of options for displaying information


/*****       DVM Options        *****/

   --runtime-options <arg0>          Comma-delimited list of runtime directives for the job (e.g., show
                                     progress reports on DVM startup for large systems)
   --default-hostfile <arg0>         Provide a default hostfile
-H|--host <arg0>                     List of hosts to use for the DVM
   --hostfile <arg0>                 Provide a hostfile
   --machinefile <arg0>              Provide a hostfile (synonym for "hostfile")
   --pmixmca <arg0> <arg1>           Pass PMIx MCA parameters
   --prtemca <arg0> <arg1>           Pass PRTE MCA parameters to the DVM
   --show-progress                   Output a brief periodic report on DVM startup progress
-x <arg0>                            Export an environment variable, optionally specifying a value
   --allow-run-as-root               Allow execution as root (STRONGLY DISCOURAGED)
   --daemonize                       Daemonize the DVM daemons into the background
   --forward-signals <arg0>          Additional signals (names or integers) to forward
   --keepalive <arg0>                Pipe to monitor - DVM will terminate upon closure
   --launch-agent <arg0>             Name of daemon executable used to start processes on remote nodes
                                     (default: prted)
   --max-vm-size <arg0>              Max number of daemons to start
   --no-ready-msg                    Do not print a DVM ready message
   --noprefix                        Disable automatic --prefix behavior
   --prefix <arg0>                   Prefix to be used to look for RTE executables
   --report-pid <arg0>               Printout pid on stdout [-], stderr [+], or a file [anything else]
   --report-uri <arg0>               Printout URI on stdout [-], stderr [+], or a file [anything else]
   --set-sid                         Direct the DVM daemons to separate from the current session
   --singleton <arg0>                ID of the singleton process that started us
   --system-server                   Start the DVM as the system server
   --tmpdir <arg0>                   Set the root for the session directory tree
   --tune <arg0>                     File(s) containing MCA params for tuning DVM operations
   --timeout <arg0>                  Timeout DVM startup if time exceeds the specified number of seconds

Report bugs to %s
#
[prtemca]
#include#help-schizo-cli#prtemca
#
[pmixmca]
#include#help-schizo-cli#pmixmca
#
[tune]
#include#help-schizo-cli#tune
#
[no-ready-msg]
Do not print a DVM ready message
#
[daemonize]
Daemonize the DVM daemons and controller into the background
#
[system-server]
Start the DVM controller and its daemons as the system server on their nodes
#
[set-sid]
Direct the DVM (controller and daemons) to separate from the current session
#
[report-pid]
Printout DVM controller's PID on stdout [-], stderr [+], or a file [anything else]
#
[report-uri]
Printout DVM controller's URI on stdout [-], stderr [+], or a file [anything else]
#
[test-suicide]
Test DVM cleanup upon daemon failure by having one daemon suicide after delay
#
[default-hostfile]
Specify a default hostfile.

#include#help-schizo-cli#dvm-hostfile
#
[singleton]
DVM is being started by a singleton process (i.e., one not started by a DVM) - the
argument must be the PMIx ID of the singleton process that started us
#
[keepalive]
Pipe for DVM controller to monitor - DVM will terminate upon closure
#
[launch-agent]
Name of daemon executable used to start processes on remote nodes (default: prted).
This is the executable the DVM controller shall start on each remote node when
establishing the DVM.
#
[max-vm-size]
Maximum number of daemons to start - sets the maximum size of the DVM.
#
[debug-daemons]
Debug daemon output enabled. This is a somewhat limited stream of information normally
used to simply confirm that the daemons started. Includes leaving the output streams
open.
#
[debug-daemons-file]
#include#help-schizo-cli#debug-daemons-file
#
[leave-session-attached]
#include#help-schizo-cli#leave-session-attached
#
[tmpdir]
Define the root location for the PRRTE session directory tree

#include#help-schizo-cli#tmpdir
#
[prefix]
#include#help-schizo-cli#prefix
#
[noprefix]
#include#help-schizo-cli#no-prefix
#
[forward-signals]
#include#help-schizo-cli#forward-signals
#
[allow-run-as-root]
#include#help-schizo-cli#allow-run-as-root
#
[no-aggregate-help]
Do not aggregate "show_help" output. PRRTE defaults to aggregating messages generated
by its "show_help" subsystem so that only one is printed out per topic (along with the
number of processes that reported the same issue). This is done to avoid users receiving
a flood of one-per-process error messages, all containing the identical error report.
Setting this option turns off the aggregation, thereby allowing the user to see duplicate
reports from multiple processes.
#
[timeout]
Timeout DVM startup if time exceeds the specified number of seconds. The DVM startup
will abort after the specified interval.
#
[x]
#include#help-schizo-cli#x
#
[show-progress]
Output a brief periodic report on DVM startup progress
#
[hostfile]
#include#help-schizo-cli#dvm-hostfile
#
[machinefile]
Provide a hostfile (synonym for "hostfile")

#include#help-schizo-cli#dvm-hostfile
#
[host]
#include#help-schizo-cli#dash-host
#
[display]
#include#help-schizo-cli#display
#
#
#  DEPRECATED OPTIONS
#
