File: pattrs.1.html

package info (click to toggle)
openmpi 5.0.8-9
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 201,680 kB
  • sloc: ansic: 613,078; makefile: 42,350; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (207 lines) | stat: -rw-r--r-- 14,786 bytes parent folder | download
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>17.1.3. pattrs &mdash; OpenPMIx 5.0.8a1 documentation</title>
      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
      <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" />

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
        <script src="../../_static/doctools.js"></script>
        <script src="../../_static/sphinx_highlight.js"></script>
    <script src="../../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="17.1.4. pevent" href="pevent.1.html" />
    <link rel="prev" title="17.1.2. palloc" href="palloc.1.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../../index.html" class="icon icon-home">
            OpenPMIx
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../quickstart.html">1. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../getting-help.html">2. Getting help</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release-notes/index.html">3. Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../exceptions.html">4. Exceptions to the PMIx Standard</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installing-pmix/index.html">5. Building and installing PMIx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../how-things-work/index.html">6. How Things Work</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release-notes.html">7. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../history.html">8. History</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../versions.html">9. Version Numbers and Binary Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mca.html">10. The Modular Component Architecture (MCA)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../building-apps/index.html">11. Building PMIx applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/index.html">12. Developer’s guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">13. Contributing to OpenPMIx</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">14. License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security.html">15. OpenPMIx Security Policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../news/index.html">16. News</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">17. OpenPMIx manual pages</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.1. Commands (section 1)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="pmix_info.1.html">17.1.1. pmix_info</a></li>
<li class="toctree-l3"><a class="reference internal" href="palloc.1.html">17.1.2. palloc</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.1.3. pattrs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.3.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.3.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.3.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.3.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.3.5. EXAMPLES</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pevent.1.html">17.1.4. pevent</a></li>
<li class="toctree-l3"><a class="reference internal" href="plookup.1.html">17.1.5. plookup</a></li>
<li class="toctree-l3"><a class="reference internal" href="pmixcc.1.html">17.1.6. pmixcc</a></li>
<li class="toctree-l3"><a class="reference internal" href="pps.1.html">17.1.7. pps</a></li>
<li class="toctree-l3"><a class="reference internal" href="pquery.1.html">17.1.8. pquery</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../man3/index.html">17.2. APIs (section 3)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../man5/index.html">17.3. Config file manual pages (section 5)</a></li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../index.html">OpenPMIx</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../index.html"><span class="section-number">17. </span>OpenPMIx manual pages</a></li>
          <li class="breadcrumb-item"><a href="index.html"><span class="section-number">17.1. </span>Commands (section 1)</a></li>
      <li class="breadcrumb-item active"><span class="section-number">17.1.3. </span>pattrs</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../../_sources/man/man1/pattrs.1.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <style>
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
</style><div class="section" id="pattrs">
<span id="man1-pattrs"></span><h1><span class="section-number">17.1.3. </span>pattrs<a class="headerlink" href="#pattrs" title="Permalink to this heading"></a></h1>
<p>pattrs — Display information about supported attributes</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.3.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pattrs</span> <span class="pre">[options]</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.3.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pattrs</span></code> provides information on the attributes supported by the
client, server, and tool interfaces of the PMIx library being used.</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.3.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pattrs</span></code> accepts the following options:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">-h</span></code> | <code class="docutils literal notranslate"><span class="pre">--help</span> <span class="pre">&lt;arg0&gt;</span></code>: 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.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-v</span></code> | <code class="docutils literal notranslate"><span class="pre">--verbose</span></code>: Enable debug output.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-V</span></code> | <code class="docutils literal notranslate"><span class="pre">--version</span></code>: Print version and exit.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--pmixmca</span> <span class="pre">&lt;arg0&gt;</span> <span class="pre">&lt;arg1&gt;</span></code>: Set MCA parameter value</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--do-not-connect</span></code>: Do not connect to a server</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--uri</span> <span class="pre">&lt;arg0&gt;</span></code>: Specify the URI of the server to which we are to connect, or the name of the file (specified as <a class="reference external" href="file:filename">file:filename</a>) that contains that info</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--namespace</span> <span class="pre">&lt;arg0&gt;</span></code>: Namespace of the daemon to which we should connect</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--pid</span> <span class="pre">&lt;arg0&gt;</span></code>: PID of the daemon to which we should connect (int =&gt; PID or file:&lt;file&gt; for file containing the PID</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--system-server-first</span></code>: First look for a system server and connect to it if found</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--system-server</span></code>: Connect to a system-level server</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--tmpdir</span> <span class="pre">&lt;arg0&gt;</span></code>: Set the root for the session directory tree</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--wait-to-connect</span> <span class="pre">&lt;arg0&gt;</span></code>: Delay specified number of seconds before trying to connect</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--num-connect-retries</span> <span class="pre">&lt;arg0&gt;</span></code>: Max number of times to try to connect</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--client</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of client functions whose attributes are to be printed (function or “all”)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--server</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of server functions whose attributes are to be printed (function or “all”)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--tool</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of tool functions whose attributes are to be printed (function or “all”)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--host</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of host functions whose attributes are to be printed (function or “all”)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--client-fns</span></code>: List the functions supported in this client library</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--server-fns</span></code>: List the functions supported in this server library</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--tool-fns</span></code>: List the functions supported in this tool library</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--host-fns</span></code>: List the functions supported by this host environment</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.3.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 for successful completion or a non-zero error code. The command outputs the requested information to stdout.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.3.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>Examples of using this command.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../man5/openpmix.5.html#man5-openpmix"><span class="std std-ref">openpmix(5)</span></a></p>
</div>
</div>
</div>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="palloc.1.html" class="btn btn-neutral float-left" title="17.1.2. palloc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="pevent.1.html" class="btn btn-neutral float-right" title="17.1.4. pevent" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2014-2025, OpenPMIx Community.
      <span class="lastupdated">Last updated on 2025-05-30 16:40:24 UTC.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>