# -*- 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 of a framework, or of     |
| >[:<component1>,<co  | only the listed components of it (a comma-    |
| mponent2>]"          | delimited list after the colon). The keyword  |
|                      | "all" shows every parameter. May be repeated. |
+----------------------+-----------------------------------------------+
| "--params <framework | Synonym for "--param"                         |
| >[:<component1>,<co  |                                               |
| mponent2>]"          |                                               |
+----------------------+-----------------------------------------------+
| "-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 "all" or one of the installation      |
|                      | directories, e.g., "prefix", "bindir",        |
|                      | "libdir", "incdir", "mandir", "pkglibdir",    |
|                      | "sysconfdir" (see "--help path" for the full  |
|                      | list). May be repeated.                       |
+----------------------+-----------------------------------------------+
| "--show-version      | Show version of PRRTE or of components. The   |
| [<what> [<part>]]"   | first argument is "prte", "all", a framework  |
|                      | name (all components in that framework), or   |
|                      | "framework:component". The optional second    |
|                      | argument selects the part of the version:     |
|                      | "full" (default), "major", "minor",           |
|                      | "release", "greek", "repo". With no argument, |
|                      | show PRRTE's version and every component's.   |
+----------------------+-----------------------------------------------+
| "--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 <framework>[:<component>[,<component>...]]"

Show the MCA parameters of a framework. Given only a framework name
(e.g., "--param rmaps"), every parameter of the framework and of all
its components is shown; a comma-delimited list of component names
after a colon (e.g., "--param rmaps:ppr,round_robin") restricts the
output to those components. The keyword "all", given either as
"--param all" or as the component list, selects everything.

The framework and its components are one argument: "--param rmaps ppr"
is refused, because "ppr" is taken as a stray argument. The option may
be repeated to show several frameworks.
#
[params]

Syntax: "--params <framework>[:<component>[,<component>...]]"

Synonym for "--param".
#
[show-version]

Syntax: "--show-version [<what> [<part>]]"

Show the version of PRRTE or of some of its components. "<what>" is
one of:

* "prte" or "all": PRRTE's own version plus that of every component

* "<framework>": the version of every component in that framework

* "<framework>:<component>": the version of that one component

The optional "<part>" selects which part of the version to show:
"full" (the default), "major", "minor", "release", "greek", or
"repo". Given with no argument, the option shows PRRTE's version and
every component's.

Note that this is distinct from "-V"/"--version", which only prints the
version of the prte_info tool itself.
#
[bad-param-value]

The "--%s" option was given a value it cannot interpret:

   Value: %s

The expected form is "<framework>[:<component>[,<component>...]]"
(e.g., "rmaps" or "rmaps:ppr,round_robin"), or the keyword "all".
#
[unknown-framework]

There is no framework or parameter type named "%s" in this
installation, so there are no parameters to show for it.

Run "%s --all" for the list of components and the frameworks they
belong to.
#
[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 "all" or any
of: "prefix", "exec_prefix", "bindir", "sbindir", "libdir", "incdir",
"mandir", "pkglibdir", "libexecdir", "datarootdir", "datadir",
"sysconfdir", "sharedstatedir", "localstatedir", "infodir",
"pkgdatadir", "pkgincludedir". The option may be repeated to show
several paths.
#
[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.
