21.1.2. prte_info
prte_info — Display information about the PRRTE installation
21.1.2.1. SYNOPSIS
prte_info [options]
21.1.2.2. DESCRIPTION
prte_info provides detailed information about the PRRTE
installation. It can be useful for at least three common scenarios:
Checking local configuration and seeing how PRRTE was installed.
Submitting bug reports / help requests to the PRRTE community (see Getting help).
Seeing a list of installed PRRTE plugins and querying what MCA parameters they support.
Given no options, prte_info shows the PRRTE version, its
installation prefix, the architecture it was built for, a summary of
its configuration, and the version of every installed component.
prte_info is also installed as prte-info. prte_info --help
<option> prints the full description of an option.
21.1.2.3. OPTIONS
General options
21.1.2.3.1. -h | --help [<option>]
Print the list of options, or the full help for the named option.
21.1.2.3.2. -v | --verbose
Enable debug output.
21.1.2.3.3. -V | --version
Print the version of the prte_info tool itself and exit. See
--show-version for the versions of PRRTE and its components.
MCA parameters
21.1.2.3.4. --prtemca <key> <value>
Pass a PRRTE MCA parameter.
Syntax: --prtemca <key> <value>, where key is the parameter
name and value is the parameter value.
21.1.2.3.5. --pmixmca <key> <value>
Pass a PMIx MCA parameter
Syntax: --pmixmca <key> <value>, where key is the parameter
name and value is the parameter value.
What to show
21.1.2.3.6. -a | --all
Show all configuration options and MCA parameters.
21.1.2.3.7. --arch
Show architecture on which PRRTE was compiled.
21.1.2.3.8. -c | --config
Show configuration options used to configure PRRTE.
21.1.2.3.9. --hostname
Show the hostname upon which PRRTE was configured and built.
21.1.2.3.10. --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.
21.1.2.3.11. --params <framework>[:<component>[,<component>...]]
Synonym for --param.
21.1.2.3.12. --internal
Show internal MCA parameters (i.e., parameters not meant to be modified by users).
21.1.2.3.13. -t | --type <type>
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.
21.1.2.3.14. --path <type>
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.
21.1.2.3.15. --show-version [<what> [<part>]]
Show the version of PRRTE or of some of its components. <what> is
one of:
prteorall: 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.
21.1.2.3.16. --include-pmix
Include PMIx params and build info in output.
21.1.2.3.17. --show-failed
Show the components that failed to load, along with the reason why they failed.
21.1.2.3.18. --selected-only
Show only variables from selected (active) components.
Output format
21.1.2.3.19. --pretty-print
When used in conjunction with other parameters, the output is displayed in “pretty-print” format (default).
21.1.2.3.20. --parsable | --parseable
When used in conjunction with other parameters, the output is displayed in a machine-parsable format.
21.1.2.3.21. --color <hue>
Control color coding of the output: auto (the default —
color only when stdout is a terminal), never, or always.
21.1.2.4. EXIT STATUS
Returns 0 if successful, non-zero if an error is encountered.
21.1.2.5. EXAMPLES
Show the default output of options and listing of installed components in a human-readable / prettyprint format:
prte_info
Show the default output of options and listing of installed components in a machine-parsable format:
prte_info --parsable
Show the MCA parameters of the ppr and round_robin RMAPS
components in a human-readable / prettyprint format:
prte_info --param rmaps:ppr,round_robin
Show the bindir that PRRTE was configured with:
prte_info --path bindir
Show the versions of PRRTE and all of its components:
prte_info --show-version
Show all information about the PRRTE installation, including all components that can be found, all the MCA parameters that they support, versions of PRRTE and the components, etc.:
prte_info --all