b7a1778f93
Eddelbuettel, one of the Debian/GNU Linux maintainers of the Open MPI package. * Updated the contributed man page with some examples and updated option descriptions, and other small things. * Made the --hostname option work again. * Made the --version option work like it's supposed to. * Updated help strings that are displayed via --help to be a bit more descriptive in the parameters that various options accept. This commit was SVN r15260.
162 строки
4.4 KiB
Groff
162 строки
4.4 KiB
Groff
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
|
.\" and released under the BSD license
|
|
.TH OMPI_INFO 1 "July 2006" "Open MPI" "OPEN MPI COMMANDS"
|
|
.SH NAME
|
|
ompi_info - Display information about the Open MPI installation
|
|
.
|
|
.\" **************************
|
|
.\" Synopsis Section
|
|
.\" **************************
|
|
.SH SYNOPSIS
|
|
.B ompi_info [options]
|
|
.
|
|
.\" **************************
|
|
.\" Description Section
|
|
.\" **************************
|
|
.SH DESCRIPTION
|
|
.PP
|
|
.B ompi_info
|
|
provides detailed information about the Open MPI installation. It can
|
|
be useful for at least three common scenarios:
|
|
.PP
|
|
1. Checking local configuration and seeing how Open MPI was installed.
|
|
.PP
|
|
2. Submitting bug reports / help requests to the Open MPI community
|
|
(see
|
|
.IR http://www.open-mpi.org/community/help/ )
|
|
.PP
|
|
3. Seeing a list of installed Open MPI plugins and querying what
|
|
MCA parameters they support.
|
|
.
|
|
.\" **************************
|
|
.\" Options Section
|
|
.\" **************************
|
|
.SH OPTIONS
|
|
.B ompi_info
|
|
accepts the following options:
|
|
.TP 8
|
|
.I \-a|\-\-all
|
|
Show all configuration options and MCA parameters
|
|
.TP 8
|
|
.I \-\-arch
|
|
Show architecture Open MPI was compiled on
|
|
.TP 8
|
|
.I \-c|\-\-config
|
|
Show configuration options
|
|
.TP 8
|
|
.I \-gmca|\-\-gmca <param> <value>
|
|
Pass global MCA parameters that are applicable to all contexts.
|
|
.TP 8
|
|
.I \-h|\-\-help
|
|
Shows help / usage message
|
|
.TP 8
|
|
.I \-\-hostname
|
|
Show the hostname that Open MPI was configured and built on
|
|
.TP 8
|
|
.I \-\-internal
|
|
Show internal MCA parameters (not meant to be modified by users)
|
|
.TP 8
|
|
.I \-mca|\-\-mca <param> <value>
|
|
Pass context-specific MCA parameters; they are considered global if --gmca is
|
|
not used and only one context is specified.
|
|
.TP 8
|
|
.I \-\-param <type> <component>
|
|
Show MCA parameters. The first parameter is the type of the component
|
|
to display; the second parameter is the specific component to display
|
|
(or the keyword "all", meaning "display all components of this type").
|
|
.TP 8
|
|
.I \-\-parsable
|
|
When used in conjunction with other parameters, the output is
|
|
displayed in a machine-parsable format
|
|
.I \-\-parseable
|
|
Synonym for --parsable
|
|
.TP 8
|
|
.I \-\-path <type>
|
|
Show paths that Open MPI was configured with. Accepts the following
|
|
parameters: prefix, bindir, libdir, incdir, pkglibdir, sysconfdir.
|
|
.TP 8
|
|
.I \-\-pretty
|
|
When used in conjunction with other parameters, the output is
|
|
displayed in 'prettyprint' format (default)
|
|
.TP 8
|
|
.I \-v|\-\-version <component> <scope>
|
|
Show version of Open MPI or a component. <component> can be the
|
|
keywords "ompi" or "all", the name of a framework (e.g., "coll" shows
|
|
all components in the coll framework), or the name of a specific
|
|
component (e.g., "pls:rsh" shows the information from the rsh PLS
|
|
component). <scope> can be one of: full, major, minor, release,
|
|
greek, svn.
|
|
.
|
|
.\" **************************
|
|
.\" Examples Section
|
|
.\" **************************
|
|
.SH EXAMPLES
|
|
.TP 4
|
|
ompi_info
|
|
Show the default output of options and listing of installed
|
|
components in a human-readable / prettyprint format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --parsable
|
|
Show the default output of options and listing of installed
|
|
components in a machine-parsable format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --param btl openib
|
|
Show the MCA parameters of the "openib" BTL component in a
|
|
human-readable / prettyprint format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --param btl openib --parsable
|
|
Show the MCA parameters of the "openib" BTL component in a
|
|
machine-parsable format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --path bindir
|
|
Show the "bindir" that Open MPI was configured with.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --version ompi full --parsable
|
|
Show the full version numbers of Open MPI (including the ORTE and OPAL
|
|
version numbers) in a machine-readable format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --version btl major
|
|
Show the major version number of all BTL components in a prettyprint
|
|
format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --version btl:tcp minor
|
|
Show the minor version number of the TCP BTL component in a
|
|
prettyprint format.
|
|
.
|
|
.
|
|
.TP
|
|
ompi_info --all
|
|
Show
|
|
.I all
|
|
information about the Open MPI installation, including all components
|
|
that can be found, the MCA parameters that they support, versions of
|
|
Open MPI and the components, etc.
|
|
.
|
|
.
|
|
.\" **************************
|
|
.\" Authors Section
|
|
.\" **************************
|
|
.SH AUTHORS
|
|
The Open MPI maintainers -- see
|
|
.I http://www.openmpi.org/
|
|
or the file
|
|
.IR AUTHORS .
|
|
.PP
|
|
This manual page was originally contributed by Dirk Eddelbuettel
|
|
<edd@debian.org>, one of the Debian GNU/Linux maintainers for Open
|
|
MPI, and may be used by others.
|