# -*- text -*-
#
# Copyright (c) 2025      Nanook Consulting  All rights reserved.
# $COPYRIGHT$
#
# Additional copyrights may follow
#
# $HEADER$
#
# This is the US/English general help file for PRTE's pterm.
#
[usage]

%s (%s) %s

Usage: %s [OPTION]...

Terminate an instance of the PMIx Reference RTE (PRRTE) DVM

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

* Specific Options

+----------------------+-----------------------------------------------+
| Option               | Description                                   |
|======================|===============================================|
| "--pmixmca <key>     | Pass context-specific PMIx MCA parameters     |
| <value>"             | ("key" is the parameter name; "value" is the  |
|                      | parameter value)                              |
+----------------------+-----------------------------------------------+
| "--dvm-uri <uri>"    | Specify the URI of the DVM daemon on this     |
|                      | node, or the name of the file (specified as   |
|                      | "file:filename") that contains that info      |
+----------------------+-----------------------------------------------+
| "--num-connect-      | Max number of times to try to connect (int)   |
| retries <num>"       |                                               |
+----------------------+-----------------------------------------------+
| "--pid <pid>"        | PID of the daemon to which we should connect  |
|                      | (integer PID or "file:<filename>" for file    |
|                      | containing the PID)                           |
+----------------------+-----------------------------------------------+
| "--namespace <name>" | Namespace of the daemon we are to connect to  |
+----------------------+-----------------------------------------------+
| "--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"                |                                               |
+----------------------+-----------------------------------------------+
| "--wait-to-connect   | Delay specified number of seconds before      |
| <seconds>"           | trying to connect                             |
+----------------------+-----------------------------------------------+
| "--allow-run-as-     | Accepted for symmetry with the other PRRTE    |
| root"                | tools - pterm launches nothing, so no         |
|                      | root-execution guard applies                  |
+----------------------+-----------------------------------------------+

%s
#
[version]

%s (%s) %s

%s
#
[allow-run-as-root]

Accepted for symmetry with the other PRRTE tools - pterm launches
nothing, so no root-execution guard applies
#
[dvm-uri]

Specify the URI of the DVM daemon on this node to connect to, or the
name of the file (specified as "file:<filename>") that contains that
info. A daemon's URI names a socket on the daemon's own node, so it
can be used only there.
#
[num-connect-retries]

Maximum number of times to try to connect to the DVM daemon.
#
[pid]

PID of the DVM daemon on this node to connect to, given either as an
integer or as "file:<filename>" naming a file that contains the PID.
#
[namespace]

Namespace of the DVM to connect to. The connection is made to that
DVM's daemon on this node.
#
[system-server-first]

First look on this node for a daemon of a system-level DVM and
connect to it if found; otherwise, fall back to searching this node
for any other DVM daemon.
#
[system-server-only]

Connect only to a daemon of a system-level DVM on this node —
abort if one is not found.
#
[wait-to-connect]

Delay the specified number of seconds between attempts to connect to
the DVM daemon.
#
[pmixmca]

Pass a PMIx MCA parameter

Syntax: "--pmixmca <key> <value>", where "key" is the parameter name and
"value" is the parameter value.
#
[no-args]

The %s command does not accept arguments other than those specifically
defined by the command. The following were not recognized:

   Args: %s

Please see "%s --help" for a description of all accepted command
options.
