193 lines
4.6 KiB
Groff
193 lines
4.6 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "PMIX_INFO" "1" "Feb 14, 2025" "" "OpenPMIx"
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.sp
|
|
pmix_info — Display information about the PMIx installation
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBpmix_info [options]\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBpmix_info\fP provides detailed information about the PMIx
|
|
installation. It can be useful for at least three common scenarios:
|
|
.INDENT 0.0
|
|
.IP 1. 3
|
|
Checking local configuration and seeing how PMIx was installed.
|
|
.IP 2. 3
|
|
Submitting bug reports / help requests to the PMIx community
|
|
(see \fI\%Getting help\fP).
|
|
.IP 3. 3
|
|
Seeing a list of installed PMIx plugins and querying what MCA
|
|
parameters they support.
|
|
.UNINDENT
|
|
.SH OPTIONS
|
|
.sp
|
|
\fBpmix_info\fP accepts the following options:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fB\-h\fP | \fB\-\-help <arg0>\fP: 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.
|
|
.IP \(bu 2
|
|
\fB\-v\fP | \fB\-\-verbose\fP: Enable debug output.
|
|
.IP \(bu 2
|
|
\fB\-V\fP | \fB\-\-version\fP: Print version and exit.
|
|
.IP \(bu 2
|
|
\fB\-a\fP | \fB\-\-all\fP: Show all configuration options and MCA
|
|
parameters.
|
|
.IP \(bu 2
|
|
\fB\-\-arch\fP: Show architecture on which PMIx was compiled.
|
|
.IP \(bu 2
|
|
\fB\-c\fP | \fB\-\-config\fP: Show configuration options
|
|
.IP \(bu 2
|
|
\fB\-\-hostname\fP: Show the hostname on which PMIx was configured
|
|
and built.
|
|
.IP \(bu 2
|
|
\fB\-\-internal\fP: Show internal MCA parameters (not meant to be
|
|
modified by users).
|
|
.IP \(bu 2
|
|
\fB\-\-param <arg0>:<arg1>,<arg2>\fP: 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).
|
|
.IP \(bu 2
|
|
\fB\-\-path <type>\fP: Show paths that PMIx was configured
|
|
with. Accepts the following parameters: \fBprefix\fP, \fBbindir\fP,
|
|
\fBlibdir\fP, \fBincdir\fP, \fBpkglibdir\fP, \fBsysconfdir\fP\&.
|
|
.IP \(bu 2
|
|
\fB\-\-pretty\-print\fP: When used in conjunction with other parameters, the output is
|
|
displayed in “prettyprint” format (default)
|
|
.IP \(bu 2
|
|
\fB\-\-parsable\fP: When used in conjunction with other parameters, the output is
|
|
displayed in a machine\-parsable format
|
|
.IP \(bu 2
|
|
\fB\-\-parseable\fP: Synonym for \fB\-\-parsable\fP
|
|
.IP \(bu 2
|
|
\fB\-\-show\-failed\fP: Show the components that failed to load along with the reason why they failed
|
|
.IP \(bu 2
|
|
\fB\-\-selected\-only\fP: Show only variables from selected components.
|
|
.UNINDENT
|
|
.SH EXIT STATUS
|
|
.sp
|
|
Returns 0 if successful, non\-zero if an error is encountered
|
|
.SH EXAMPLES
|
|
.sp
|
|
Examples of using this command.
|
|
.sp
|
|
Show the default output of options and listing of installed
|
|
components in a human\-readable / prettyprint format:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Show the default output of options and listing of installed components
|
|
in a machine\-parsable format:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info \-\-parsable
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Show the MCA parameters of the “opa” PNET component in a
|
|
human\-readable / prettyprint format:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info \-\-param pnet opa
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Show the “bindir” that PMIx was configured with:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info \-\-path bindir
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Show the version of PMIx version numbers in a prettyprint format:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info \-\-version
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
Show \fIall\fP 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.:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
pmix_info \-\-all
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.sp
|
|
\fBSEE ALSO:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
\fI\%openpmix(5)\fP
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH COPYRIGHT
|
|
2014-2025, The OpenPMIx Community
|
|
.\" Generated by docutils manpage writer.
|
|
.
|