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

%s (%s) %s

%s
#
[usage]

%s (%s) %s

Usage: "%s [OPTION]..."

Provide detailed information on your PRRTE installation.

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>".

+----------------------+-----------------------------------------------+
| Option               | Description                                   |
|======================|===============================================|
| "-h" | "--help"      | This help message                             |
+----------------------+-----------------------------------------------+
| "-h <arg0>" |        | Help for the specified option                 |
| "--help <arg0>"      |                                               |
+----------------------+-----------------------------------------------+
| "-V" | "--version"   | Print version and exit                        |
|======================|===============================================|
| "--pmixmca <key>     | Pass context-specific PMIx MCA parameters     |
| <value>"             | ("key" is the parameter name; "value" is the  |
|                      | parameter value)                              |
+----------------------+-----------------------------------------------+
| "--prtemca <key>     | Pass context-specific PRRTE MCA parameters    |
| <value>"             | ("key" is the parameter name; "value" is the  |
|                      | parameter value)                              |
|======================|===============================================|
| "-a" | "--all"       | Show all configuration options and MCA        |
|                      | parameters                                    |
+----------------------+-----------------------------------------------+
| "--arch"             | Show architecture on which PRRTE was compiled |
+----------------------+-----------------------------------------------+
| "-c" | "--config"    | Show configuration options                    |
+----------------------+-----------------------------------------------+
| "--hostname"         | Show the hostname on which PRRTE was          |
|                      | configured and built                          |
+----------------------+-----------------------------------------------+
| "--internal"         | Show internal MCA parameters (not meant to be |
|                      | modified by users)                            |
+----------------------+-----------------------------------------------+
| "--param <framework  | Show MCA parameters.  The first parameter is  |
| >:<component1>,<com  | the framework (or the keyword "all"); the     |
| ponent2>"            | second parameter is a comma-delimited list of |
|                      | specific component names (if only             |
|                      | "<framework>" is given, then all components   |
|                      | will be reported).                            |
+----------------------+-----------------------------------------------+
| "--params <framework | Synonym for "--param"                         |
| >:<component1>,<com  |                                               |
| ponent2>"            |                                               |
+----------------------+-----------------------------------------------+
| "-t" | "--type       | Show MCA parameters of the specified type.    |
| <type>"              | Accepts the following parameters:             |
|                      | "unsigned_int", "unsigned_long",              |
|                      | "unsigned_long_long", "size_t", "string",     |
|                      | "version_string", "bool", and "double".       |
+----------------------+-----------------------------------------------+
| "--path <type>"      | Show paths with which PRRTE was configured.   |
|                      | Accepts the following parameters: "prefix",   |
|                      | "bindir", "libdir", "incdir", "mandir",       |
|                      | "pkglibdir", "sysconfdir".                    |
+----------------------+-----------------------------------------------+
| "--show-version      | Show version of PRRTE or a component.  The    |
| <type>:<part>"       | first parameter can be the keywords "prte",   |
|                      | "all", or a framework name (indicating all    |
|                      | components in a framework), or a              |
|                      | "framework:component" string (indicating a    |
|                      | specific component).  The second parameter    |
|                      | can be one of: "full", "major", "minor",      |
|                      | "release", "greek", "git".                    |
+----------------------+-----------------------------------------------+
| "--include-pmix"     | Include PMIx params and build info in output  |
+----------------------+-----------------------------------------------+
| "--pretty-print"     | When used in conjunction with other           |
|                      | parameters, display the output in "pretty-    |
|                      | print" format (default)                       |
+----------------------+-----------------------------------------------+
| "--parsable"         | When used in conjunction with other           |
|                      | parameters, display the output in a machine-  |
|                      | parsable format                               |
+----------------------+-----------------------------------------------+
| "--parseable"        | Synonym for "--parsable"                      |
+----------------------+-----------------------------------------------+
| "--color <hue>"      | Control color coding: "auto" (default),       |
|                      | "never", "always"                             |
+----------------------+-----------------------------------------------+
| "--show-failed"      | Show the components that failed to load,      |
|                      | along with the reason why they failed         |
+----------------------+-----------------------------------------------+
| "--selected-only"    | Show only variables from selected (active)    |
|                      | components                                    |
+----------------------+-----------------------------------------------+

%s
#
[pmixmca]

Pass a PMIx MCA parameter

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

Pass a PRRTE MCA parameter

Syntax: "--prtemca <key> <value>", where "key" is the parameter name
and "value" is the parameter value.
#
[param]

Syntax: "--param <arg0> <arg1>"

Show MCA parameters.  The first parameter is the framework (or the
keyword "all"); the second parameter is the specific component name
(or the keyword "all").
#
[params]

Syntax: "--params <arg0> <arg1>"

Synonym for "--param".
#
[type]

Syntax: "--type <arg0>"

Show MCA parameters of the type specified in the parameter. Accepts
the following parameters: "unsigned_int", "unsigned_long",
"unsigned_long_long", "size_t", "string", "version_string", "bool",
and "double".
#
[pretty-print]

Syntax: "--pretty-print"

When used in conjunction with other parameters, the output is
displayed in "pretty-print" format (default)
#
[parsable]

Syntax: "--parsable"

When used in conjunction with other parameters, the output is
displayed in a machine-parsable format
#
[parseable]

Syntax: "--parseable"

Synonym for "--parsable"
#
[color]

Syntax: "--color <hue>"

Control color coding of the output: "auto" (the default - color only
when stdout is a terminal), "never", or "always"
#
[show-failed]

Syntax: "--show-failed"

Show the components that failed to load, along with the reason why
they failed
#
[selected-only]

Syntax: "--selected-only"

Show only variables from selected (active) components
#
[internal]

Syntax: "--internal"

Show internal MCA parameters (i.e., parameters not meant to be
modified by users)
#
[path]

Syntax: "--path <arg0>"

Show the paths with which PRRTE was configured.  Accepts the following
parameters: "prefix", "bindir", "libdir", "incdir", "mandir",
"pkglibdir", "sysconfdir".
#
[arch]

Syntax: "--arch" Show architecture on which PRRTE was compiled
#
[config]

Syntax: "-c" or "--config"

Show configuration options used to configure PRRTE
#
[hostname]

Syntax: "--hostname"

Show the hostname upon which PRRTE was configured and built
#
[all]

Syntax: "-a" or "--all"

Show all configuration options and MCA parameters
#
[include-pmix]

Syntax: "--include-pmix"

Include PMIx params and build info in output
#
[lib-call-fail]

A library call unexpectedly failed.  This is a terminal error; please
show this message to a PRTE wizard:

   Library call: %s Source file: %s Source line number: %d

Aborting...

#
[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.
