PMIX_INFO(1)                       OpenPMIx                       PMIX_INFO(1)


pmix_info -- Display information about the PMIx installation

SYNOPSIS
       pmix_info [options]

DESCRIPTION
       pmix_info provides detailed information about the PMIx installation. It
       can be useful for at least three common scenarios:

       1. Checking local configuration and seeing how PMIx was installed.

       2. Submitting bug reports / help requests to the PMIx community (see
          Getting help).

       3. Seeing a list of installed PMIx plugins and querying what MCA
          parameters they support.

OPTIONS
       pmix_info accepts the following options:

       o -h | --help <arg0>: Show help message. If the optional argument is
         not provided, then a generalized help message similar to the
         information provided here is returned. If an argument is provided,
         then a more detailed help message for that specific command line
         option is returned.

       o -v | --verbose: Enable debug output.

       o -V | --version: Print version and exit.

       o -a | --all: Show all configuration options and MCA parameters.

       o --arch: Show architecture on which PMIx was compiled.

       o -c | --config: Show configuration options

       o --hostname: Show the hostname on which PMIx was configured and built.

       o --internal: Show internal MCA parameters (not meant to be modified by
         users).

       o --param <arg0>:<arg1>,<arg2>: Show MCA parameters.  The first
         parameter is the framework (or the keyword "all"); the second
         parameter is a comma-delimited list of specific component names (if
         only <arg0> is given, then all components will be reported).

       o --path <type>: Show paths that PMIx was configured with. Accepts the
         following parameters: prefix, bindir, libdir, incdir, pkglibdir,
         sysconfdir.

       o --pretty-print: When used in conjunction with other parameters, the
         output is displayed in "prettyprint" format (default)

       o --parsable: When used in conjunction with other parameters, the
         output is displayed in a machine-parsable format

       o --parseable: Synonym for --parsable

       o --show-failed: Show the components that failed to load along with the
         reason why they failed

       o --selected-only: Show only variables from selected components.

EXIT STATUS
       Returns 0 if successful, non-zero if an error is encountered

EXAMPLES
       Examples of using this command.

       Show the default output of options and listing of installed components
       in a human-readable / prettyprint format:

          pmix_info

       Show the default output of options and listing of installed components
       in a machine-parsable format:

          pmix_info --parsable

       Show the MCA parameters of the "opa" PNET component in a human-readable
       / prettyprint format:

          pmix_info --param pnet opa

       Show the "bindir" that PMIx was configured with:

          pmix_info --path bindir

       Show the version of PMIx version numbers in a prettyprint format:

          pmix_info --version

       Show all information about the PMIx installation, including all
       components that can be found, all the MCA parameters that they support,
       versions of PMIx and the components, etc.:

          pmix_info --all

       SEE ALSO:
          openpmix(5)

COPYRIGHT
       2014-2024, The OpenPMIx Community

                                March 21, 2024                    PMIX_INFO(1)