1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
.. _oshmem_info:
oshmem_info
===========
.. include_body
oshmem_info - Display information about the OpenSHMEM installation
SYNOPSIS
--------
``oshmem_info [options]``
DESCRIPTION
-----------
``oshmem_info`` provides detailed information about the OpenSHMEM
installation. It can be useful for at least three common scenarios:
1. Checking local configuration and seeing how OpenSHMEM was
installed.
2. Submitting bug reports / help requests to the OpenSHMEM
community
(see :doc:`Getting help </getting-help>`).
3. Seeing a list of installed OpenSHMEM plugins and querying what MCA
parameters they support.
.. note:: ``oshmem_info`` defaults to only showing a few MCA parameters
by default (i.e., level 1 parameters). Use the ``--level``
option to enable showing more options (see the :ref:`LEVELS
<man1-oshmem_info-levels>` section for more information).
OPTIONS
-------
``oshmem_info`` accepts the following options:
* ``-a``, ``--all``: Show all configuration options and MCA parameters
* ``--arch``: Show architecture OpenSHMEM was compiled on
* ``-c``, ``--config``: Show configuration options
* ``-gmca``, ``--gmca <param> <value>*``: Pass global MCA parameters
that are applicable to all contexts.
* ``-h``, ``--help*``: Shows help / usage message
* ``--hostname``: Show the hostname that OpenSHMEM was configured
and built on
* ``--internal``: Show internal MCA parameters (not meant to be
modified by users)
* ``--level``: Show only variables with at most this level (1-9). The
default is 1 unless ``--all`` is specified without ``--level`` in
which case the default is 9. See the :ref:`LEVELS
<man1-oshmem_info-levels>` section for more information.
* ``-mca``, ``--mca <param> <value>``: Pass context-specific MCA
parameters; they are considered global if
``--gmca`` is not used and only one context is specified.
* ``--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").
* ``--parsable``: When used in conjunction with other parameters,
the output is displayed in a machine-parsable format ``--parseable``
Synonym for ``--parsable``.
* ``--path <type>``: Show paths that OpenSHMEM was configured
with. Accepts the following parameters: ``prefix``, ``bindir``,
``libdir``, ``incdir``, ``pkglibdir``, ``sysconfdir``.
* ``--pretty``: When used in conjunction with other parameters, the
output is displayed in prettyprint format (default)
* ``--selected-only``: Show only variables from selected components.
* ``-V``, ``--version*``: Show version of OpenSHMEM.
.. _man1-oshmem_info-levels:
LEVELS
------
#. Basic information of interest to users
#. Detailed information of interest to users
#. All remaining information of interest to users
#. Basic information required for tuning
#. Detailed information required for tuning
#. All remaining information required for tuning
#. Basic information for OpenSHMEM implementors
#. Detailed information for OpenSHMEM implementors
#. All remaining information for OpenSHMEM implementors
EXAMPLES
--------
.. code:: sh
shell$ oshmem_info
Show the default output of options and listing of installed components
in a human-readable / prettyprint format.
.. code:: sh
shell$ oshmem_info --parsable
Show the default output of options and listing of installed components
in a machine-parsable format.
.. code:: sh
shell$ oshmem_info --param btl openib
Show the MCA parameters of the "openib" BTL component in a
human-readable / prettyprint format.
.. code:: sh
shell$ oshmem_info --param btl openib --parsable
Show the MCA parameters of the "openib" BTL component in a
machine-parsable format.
.. code:: sh
shell$ oshmem_info --path bindir
Show the "bindir" that OpenSHMEM was configured with.
.. code:: sh
shell$ oshmem_info --version ompi full --parsable
Show the full version numbers of OpenSHMEM (including the ORTE
and OPAL version numbers) in a machine-readable format.
.. code:: sh
shell$ oshmem_info --version btl major
Show the major version number of all BTL components in a prettyprint
format.
.. code:: sh
shell$ oshmem_info --version btl:tcp minor
Show the minor version number of the TCP BTL component in a
prettyprint format.
.. code:: sh
shell$ oshmem_info --all
Show *all* information about the OpenSHMEM installation, including all
components that can be found, the MCA parameters that they support,
versions of OpenSHMEM and the components, etc.
|
