1 | .\" Man page contributed by Dirk Eddelbuettel <edd@debian.org> |
---|
2 | .\" and released under the BSD license |
---|
3 | .\" Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved. |
---|
4 | .TH OMPI_INFO 1 "Dec 08, 2009" "1.4" "Open MPI" |
---|
5 | .SH NAME |
---|
6 | ompi_info - Display information about the Open MPI installation |
---|
7 | . |
---|
8 | .\" ************************** |
---|
9 | .\" Synopsis Section |
---|
10 | .\" ************************** |
---|
11 | .SH SYNOPSIS |
---|
12 | .B ompi_info [options] |
---|
13 | . |
---|
14 | .\" ************************** |
---|
15 | .\" Description Section |
---|
16 | .\" ************************** |
---|
17 | .SH DESCRIPTION |
---|
18 | .PP |
---|
19 | .B ompi_info |
---|
20 | provides detailed information about the Open MPI installation. It can |
---|
21 | be useful for at least three common scenarios: |
---|
22 | .PP |
---|
23 | 1. Checking local configuration and seeing how Open MPI was installed. |
---|
24 | .PP |
---|
25 | 2. Submitting bug reports / help requests to the Open MPI community |
---|
26 | (see |
---|
27 | .IR http://www.open-mpi.org/community/help/ ) |
---|
28 | .PP |
---|
29 | 3. Seeing a list of installed Open MPI plugins and querying what |
---|
30 | MCA parameters they support. |
---|
31 | . |
---|
32 | .\" ************************** |
---|
33 | .\" Options Section |
---|
34 | .\" ************************** |
---|
35 | .SH OPTIONS |
---|
36 | .B ompi_info |
---|
37 | accepts the following options: |
---|
38 | .TP 8 |
---|
39 | .I \-a|\-\-all |
---|
40 | Show all configuration options and MCA parameters |
---|
41 | .TP 8 |
---|
42 | .I \-\-arch |
---|
43 | Show architecture Open MPI was compiled on |
---|
44 | .TP 8 |
---|
45 | .I \-c|\-\-config |
---|
46 | Show configuration options |
---|
47 | .TP 8 |
---|
48 | .I \-gmca|\-\-gmca <param> <value> |
---|
49 | Pass global MCA parameters that are applicable to all contexts. |
---|
50 | .TP 8 |
---|
51 | .I \-h|\-\-help |
---|
52 | Shows help / usage message |
---|
53 | .TP 8 |
---|
54 | .I \-\-hostname |
---|
55 | Show the hostname that Open MPI was configured and built on |
---|
56 | .TP 8 |
---|
57 | .I \-\-internal |
---|
58 | Show internal MCA parameters (not meant to be modified by users) |
---|
59 | .TP 8 |
---|
60 | .I \-mca|\-\-mca <param> <value> |
---|
61 | Pass context-specific MCA parameters; they are considered global if --gmca is |
---|
62 | not used and only one context is specified. |
---|
63 | .TP 8 |
---|
64 | .I \-\-param <type> <component> |
---|
65 | Show MCA parameters. The first parameter is the type of the component |
---|
66 | to display; the second parameter is the specific component to display |
---|
67 | (or the keyword "all", meaning "display all components of this type"). |
---|
68 | .TP 8 |
---|
69 | .I \-\-parsable |
---|
70 | When used in conjunction with other parameters, the output is |
---|
71 | displayed in a machine-parsable format |
---|
72 | .I \-\-parseable |
---|
73 | Synonym for --parsable |
---|
74 | .TP 8 |
---|
75 | .I \-\-path <type> |
---|
76 | Show paths that Open MPI was configured with. Accepts the following |
---|
77 | parameters: prefix, bindir, libdir, incdir, pkglibdir, sysconfdir. |
---|
78 | .TP 8 |
---|
79 | .I \-\-pretty |
---|
80 | When used in conjunction with other parameters, the output is |
---|
81 | displayed in 'prettyprint' format (default) |
---|
82 | .TP 8 |
---|
83 | .I \-v|\-\-version <component> <scope> |
---|
84 | Show version of Open MPI or a component. <component> can be the |
---|
85 | keywords "ompi" or "all", the name of a framework (e.g., "coll" shows |
---|
86 | all components in the coll framework), or the name of a specific |
---|
87 | component (e.g., "pls:rsh" shows the information from the rsh PLS |
---|
88 | component). <scope> can be one of: full, major, minor, release, |
---|
89 | greek, svn. |
---|
90 | . |
---|
91 | .\" ************************** |
---|
92 | .\" Examples Section |
---|
93 | .\" ************************** |
---|
94 | .SH EXAMPLES |
---|
95 | .TP 4 |
---|
96 | ompi_info |
---|
97 | Show the default output of options and listing of installed |
---|
98 | components in a human-readable / prettyprint format. |
---|
99 | . |
---|
100 | . |
---|
101 | .TP |
---|
102 | ompi_info --parsable |
---|
103 | Show the default output of options and listing of installed |
---|
104 | components in a machine-parsable format. |
---|
105 | . |
---|
106 | . |
---|
107 | .TP |
---|
108 | ompi_info --param btl openib |
---|
109 | Show the MCA parameters of the "openib" BTL component in a |
---|
110 | human-readable / prettyprint format. |
---|
111 | . |
---|
112 | . |
---|
113 | .TP |
---|
114 | ompi_info --param btl openib --parsable |
---|
115 | Show the MCA parameters of the "openib" BTL component in a |
---|
116 | machine-parsable format. |
---|
117 | . |
---|
118 | . |
---|
119 | .TP |
---|
120 | ompi_info --path bindir |
---|
121 | Show the "bindir" that Open MPI was configured with. |
---|
122 | . |
---|
123 | . |
---|
124 | .TP |
---|
125 | ompi_info --version ompi full --parsable |
---|
126 | Show the full version numbers of Open MPI (including the ORTE and OPAL |
---|
127 | version numbers) in a machine-readable format. |
---|
128 | . |
---|
129 | . |
---|
130 | .TP |
---|
131 | ompi_info --version btl major |
---|
132 | Show the major version number of all BTL components in a prettyprint |
---|
133 | format. |
---|
134 | . |
---|
135 | . |
---|
136 | .TP |
---|
137 | ompi_info --version btl:tcp minor |
---|
138 | Show the minor version number of the TCP BTL component in a |
---|
139 | prettyprint format. |
---|
140 | . |
---|
141 | . |
---|
142 | .TP |
---|
143 | ompi_info --all |
---|
144 | Show |
---|
145 | .I all |
---|
146 | information about the Open MPI installation, including all components |
---|
147 | that can be found, the MCA parameters that they support, versions of |
---|
148 | Open MPI and the components, etc. |
---|
149 | . |
---|
150 | . |
---|
151 | .\" ************************** |
---|
152 | .\" Authors Section |
---|
153 | .\" ************************** |
---|
154 | .SH AUTHORS |
---|
155 | The Open MPI maintainers -- see |
---|
156 | .I http://www.openmpi.org/ |
---|
157 | or the file |
---|
158 | .IR AUTHORS . |
---|
159 | .PP |
---|
160 | This manual page was originally contributed by Dirk Eddelbuettel |
---|
161 | <edd@debian.org>, one of the Debian GNU/Linux maintainers for Open |
---|
162 | MPI, and may be used by others. |
---|