Upgrade MPIs on linux

This commit is contained in:
Bassem Girgis
2025-03-19 12:53:34 -05:00
parent d29ef955f5
commit a6198ecc7b
5503 changed files with 962014 additions and 56494 deletions

View File

@@ -0,0 +1,150 @@
<!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. OpenPMIx manual pages &mdash; OpenPMIx 5.0.5 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. Commands (section 1)" href="man1/index.html" />
<link rel="prev" title="16.5. PMIx v1.x series" href="../news/news-v1.x.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="current reference internal" href="#">17. OpenPMIx manual pages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="man1/index.html">17.1. Commands (section 1)</a></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 active"><span class="section-number">17. </span>OpenPMIx manual pages</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/man/index.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="openpmix-manual-pages">
<h1><span class="section-number">17. </span>OpenPMIx manual pages<a class="headerlink" href="#openpmix-manual-pages" title="Permalink to this heading"></a></h1>
<p>All of the content in this section is also installed as individual
manual (“man”) pages in a OpenPMIx installation. If your man page search
path includes the location where OpenPMIx installed its man pages (which
defaults to <code class="docutils literal notranslate"><span class="pre">$prefix/share/man</span></code>), you can invoke commands similar to
the following to see the same content that you see in these HTML
pages:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>man<span class="w"> </span>PMIx_Abort
</pre></div>
</div>
<p>OpenPMIx man pages, by section:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="man3/index.html">17.2. APIs (section 3)</a></li>
<li class="toctree-l1"><a class="reference internal" href="man5/index.html">17.3. Config file manual pages (section 5)</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../news/news-v1.x.html" class="btn btn-neutral float-left" title="16.5. PMIx v1.x series" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="man1/index.html" class="btn btn-neutral float-right" title="17.1. Commands (section 1)" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,156 @@
<!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. Commands (section 1) &mdash; OpenPMIx 5.0.5 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.1. pmix_info" href="pmix_info.1.html" />
<link rel="prev" title="17. OpenPMIx manual pages" href="../index.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="current reference internal" href="#">17.1. Commands (section 1)</a><ul>
<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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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 active"><span class="section-number">17.1. </span>Commands (section 1)</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/index.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="commands-section-1">
<h1><span class="section-number">17.1. </span>Commands (section 1)<a class="headerlink" href="#commands-section-1" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="pmix_info.1.html">17.1.1. pmix_info</a></li>
<li class="toctree-l1"><a class="reference internal" href="palloc.1.html">17.1.2. palloc</a></li>
<li class="toctree-l1"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></li>
<li class="toctree-l1"><a class="reference internal" href="pevent.1.html">17.1.4. pevent</a></li>
<li class="toctree-l1"><a class="reference internal" href="plookup.1.html">17.1.5. plookup</a></li>
<li class="toctree-l1"><a class="reference internal" href="pmixcc.1.html">17.1.6. pmixcc</a></li>
<li class="toctree-l1"><a class="reference internal" href="pps.1.html">17.1.7. pps</a></li>
<li class="toctree-l1"><a class="reference internal" href="pquery.1.html">17.1.8. pquery</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="17. OpenPMIx manual pages" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pmix_info.1.html" class="btn btn-neutral float-right" title="17.1.1. pmix_info" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,229 @@
<!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.2. palloc &mdash; OpenPMIx 5.0.5 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.3. pattrs" href="pattrs.1.html" />
<link rel="prev" title="17.1.1. pmix_info" href="pmix_info.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 current"><a class="current reference internal" href="#">17.1.2. palloc</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.2.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.2.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.2.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.2.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.2.5. EXAMPLES</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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.2. </span>palloc</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/palloc.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="palloc">
<span id="man1-palloc"></span><h1><span class="section-number">17.1.2. </span>palloc<a class="headerlink" href="#palloc" title="Permalink to this heading"></a></h1>
<p>palloc — Request a resource allocation</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.2.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">palloc</span> <span class="pre">[options]</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.2.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">palloc</span></code> allows a user to request an allocation of resources,
either as part of a job script or for an interactive session.
In addition to describing the requested resources, users can
provide a job script or application to be executed upon establishment
of the resulting session.</p>
<p>Note that <code class="docutils literal notranslate"><span class="pre">palloc</span></code> can also be used to <em>modify</em> an existing
allocation or allocation request - e.g., extending its time limit,
or changing the allocated resources.</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.2.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">palloc</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">--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 <code class="docutils literal notranslate"><span class="pre">file:filename</span></code>) 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">--nspace</span> <span class="pre">&lt;arg0&gt;</span></code>: Synonym for <code class="docutils literal notranslate"><span class="pre">namespace</span></code></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 (<code class="docutils literal notranslate"><span class="pre">int</span></code> =&gt; <code class="docutils literal notranslate"><span class="pre">PID</span></code>
or <code class="docutils literal notranslate"><span class="pre">file:&lt;file&gt;</span></code> 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-only</span></code>: Connect only to a system-level server</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--system-controller</span></code>: Connect to the system controller</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">--connect-order</span> <span class="pre">&lt;arg0&gt;</span></code>: Specify search order for server connections - e.g., scheduler, system controller, system-level server, or local server</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">--request-id</span> <span class="pre">&lt;arg0&gt;</span></code>: String identifier for this allocation request</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-q</span></code> | <code class="docutils literal notranslate"><span class="pre">--queue</span> <span class="pre">&lt;arg0&gt;</span></code>: Scheduler queue this request should be passed to for processing</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-N</span></code> | <code class="docutils literal notranslate"><span class="pre">--nodes</span> <span class="pre">&lt;arg0&gt;</span></code>: Number of nodes to be allocated</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-i</span></code> | <code class="docutils literal notranslate"><span class="pre">--image</span> <span class="pre">&lt;arg0&gt;</span></code>: OS image to be provisioned on allocated nodes prior to initiating execution of specified job, or turning nodes over to an interactive session</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-x</span></code> | <code class="docutils literal notranslate"><span class="pre">--exclude</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of nodes that are to be excluded from consideration for scheduling this allocation</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--wait-all-nodes</span></code>: Wait for all nodes to be ready before starting execution of the specified job.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-w</span></code> | <code class="docutils literal notranslate"><span class="pre">--nodelist</span> <span class="pre">&lt;arg0&gt;</span></code>: Comma-delimited list of ranges of specific nodes being requested [e.g., host0[1-5],host128]. Can also pass the argument as a filename using the “file:&lt;path&gt;” syntax. Ordering of names and/or duplicate names are ignored.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--uid</span> <span class="pre">&lt;arg0&gt;</span></code>: Assign the resulting allocation to the specified user ID</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--gid</span> <span class="pre">&lt;arg0&gt;</span></code>: Assign the resulting allocation to the specified group ID</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-t</span></code> | <code class="docutils literal notranslate"><span class="pre">--time</span> <span class="pre">&lt;arg0&gt;</span></code>: Time limit on the assigned allocation.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--signal</span> <span class="pre">&lt;arg0&gt;[&#64;arg1]</span></code>: Send all processes executing within the allocated session the specified signal when it reaches the (optional) specified seconds of its end time.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-s</span></code> | <code class="docutils literal notranslate"><span class="pre">--share</span></code>: Allocated resources can be shared with other allocations.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--extend</span>&#160;&#160; <span class="pre">&lt;arg0&gt;</span></code>:Extend the specified existing session ID per the rest of the given request.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--shrink</span> <span class="pre">&lt;arg0&gt;</span></code>: Shrink the specified existing session ID per the rest of the given request.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--no-shell</span></code>: Immediately exit after allocating resources, without running a command.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--begin</span> <span class="pre">&lt;arg0&gt;</span></code>: Direct the scheduler to defer allocation until the specified time.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-I``|</span> <span class="pre">``--immediate</span> <span class="pre">&lt;arg0&gt;</span></code>: Exit if resources are not available within the time period specified.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-d</span></code> | <code class="docutils literal notranslate"><span class="pre">--dependency</span> <span class="pre">&lt;arg0&gt;</span></code>: Defer the start of this session until the specified dependencies have successfully completed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--do-not-wait</span></code>: Submit the allocation request to the scheduler, but do not wait for the allocation to be assigned. Intended for use when submitting a job for batch execution.</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.2.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 for success, non-zero error code if a problem occurred. Note that success does not necessarily translate to success of the requested operation, depending upon provided options, but may instead mean that the request has been accepted for processing.</p>
<p>The command outputs the integer session ID of the resulting allocation, or if executed with the <code class="docutils literal notranslate"><span class="pre">--do-not-wait</span></code> option, a message indicating
if the request has been accepted for processing. Any command line arguments following the provided
options are taken as the job script or executable to be run within the allocation (once assigned) and its attendant
argv array. In this case, the allocation will terminate once the provide job script or executable completes.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.2.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="pmix_info.1.html" class="btn btn-neutral float-left" title="17.1.1. pmix_info" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pattrs.1.html" class="btn btn-neutral float-right" title="17.1.3. pattrs" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,205 @@
<!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.5 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,191 @@
<!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.4. pevent &mdash; OpenPMIx 5.0.5 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.5. plookup" href="plookup.1.html" />
<link rel="prev" title="17.1.3. pattrs" href="pattrs.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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.1.4. pevent</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.4.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.4.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.4.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.4.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.4.5. EXAMPLES</a></li>
</ul>
</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.4. </span>pevent</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/pevent.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="pevent">
<span id="man1-pevent"></span><h1><span class="section-number">17.1.4. </span>pevent<a class="headerlink" href="#pevent" title="Permalink to this heading"></a></h1>
<p>pevent — inject specified event into the system</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.4.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pevent</span> <span class="pre">[options]</span> <span class="pre">&lt;EVENT&gt;</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.4.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pevent</span></code> requests that the specified event be passed to
processes in the given range.</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.4.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pevent</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">--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">--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">--range</span> <span class="pre">&lt;arg0&gt;</span></code>: Range of event to be sent. If not provided, the request will default to the <code class="docutils literal notranslate"><span class="pre">PMIX_GLOBAL</span></code> range</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.4.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 if the event was successfully sent, a non-zero error code if otherwise.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.4.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="pattrs.1.html" class="btn btn-neutral float-left" title="17.1.3. pattrs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="plookup.1.html" class="btn btn-neutral float-right" title="17.1.5. plookup" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,192 @@
<!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.5. plookup &mdash; OpenPMIx 5.0.5 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.6. pmixcc" href="pmixcc.1.html" />
<link rel="prev" title="17.1.4. pevent" href="pevent.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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></li>
<li class="toctree-l3"><a class="reference internal" href="pevent.1.html">17.1.4. pevent</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.1.5. plookup</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.5.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.5.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.5.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.5.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.5.5. EXAMPLES</a></li>
</ul>
</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.5. </span>plookup</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/plookup.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="plookup">
<span id="man1-plookup"></span><h1><span class="section-number">17.1.5. </span>plookup<a class="headerlink" href="#plookup" title="Permalink to this heading"></a></h1>
<p>plookup — lookup the value of keys posted using the <code class="docutils literal notranslate"><span class="pre">PMIx_Publish</span></code> API</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.5.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">plookup</span> <span class="pre">[options]</span> <span class="pre">&lt;KEY1&gt;,&lt;KEY2&gt;,...</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.5.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">plookup</span></code> performs a <code class="docutils literal notranslate"><span class="pre">PMIx_Lookup</span></code> for each of the provided
keys and returns the results</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.5.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">plookup</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">--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">--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">--timeout</span> <span class="pre">&lt;arg0&gt;</span></code>: Max number of seconds to wait for data to become available</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--wait</span></code>: Wait for data to become available if not immediately present</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.5.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 upon success, or else a non-zero error code. Prints any returned values to stdout.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.5.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="pevent.1.html" class="btn btn-neutral float-left" title="17.1.4. pevent" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pmixcc.1.html" class="btn btn-neutral float-right" title="17.1.6. pmixcc" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,245 @@
<!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.1. pmix_info &mdash; OpenPMIx 5.0.5 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.2. palloc" href="palloc.1.html" />
<link rel="prev" title="17.1. Commands (section 1)" href="index.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 current"><a class="current reference internal" href="#">17.1.1. pmix_info</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.1.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.1.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.1.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.1.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.1.5. EXAMPLES</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="palloc.1.html">17.1.2. palloc</a></li>
<li class="toctree-l3"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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.1. </span>pmix_info</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/pmix_info.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="pmix-info">
<span id="man1-pmix-info"></span><h1><span class="section-number">17.1.1. </span>pmix_info<a class="headerlink" href="#pmix-info" title="Permalink to this heading"></a></h1>
<p>pmix_info — Display information about the PMIx installation</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.1.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmix_info</span> <span class="pre">[options]</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.1.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmix_info</span></code> provides detailed information about the PMIx
installation. It can be useful for at least three common scenarios:</p>
<ol class="arabic simple">
<li><p>Checking local configuration and seeing how PMIx was installed.</p></li>
<li><p>Submitting bug reports / help requests to the PMIx community
(see <a class="reference internal" href="../../getting-help.html"><span class="doc">Getting help</span></a>).</p></li>
<li><p>Seeing a list of installed PMIx plugins and querying what MCA
parameters they support.</p></li>
</ol>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.1.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmix_info</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">-a</span></code> | <code class="docutils literal notranslate"><span class="pre">--all</span></code>: Show all configuration options and MCA
parameters.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--arch</span></code>: Show architecture on which PMIx was compiled.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-c</span></code> | <code class="docutils literal notranslate"><span class="pre">--config</span></code>: Show configuration options</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--hostname</span></code>: Show the hostname on which PMIx was configured
and built.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--internal</span></code>: Show internal MCA parameters (not meant to be
modified by users).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--param</span> <span class="pre">&lt;arg0&gt;:&lt;arg1&gt;,&lt;arg2&gt;</span></code>: 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 &lt;arg0&gt;
is given, then all components will be reported).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--path</span> <span class="pre">&lt;type&gt;</span></code>: Show paths that PMIx was configured
with. Accepts the following parameters: <code class="docutils literal notranslate"><span class="pre">prefix</span></code>, <code class="docutils literal notranslate"><span class="pre">bindir</span></code>,
<code class="docutils literal notranslate"><span class="pre">libdir</span></code>, <code class="docutils literal notranslate"><span class="pre">incdir</span></code>, <code class="docutils literal notranslate"><span class="pre">pkglibdir</span></code>, <code class="docutils literal notranslate"><span class="pre">sysconfdir</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--pretty-print</span></code>: When used in conjunction with other parameters, the output is
displayed in “prettyprint” format (default)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--parsable</span></code>: When used in conjunction with other parameters, the output is
displayed in a machine-parsable format</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--parseable</span></code>: Synonym for <code class="docutils literal notranslate"><span class="pre">--parsable</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--show-failed</span></code>: Show the components that failed to load along with the reason why they failed</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--selected-only</span></code>: Show only variables from selected components.</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.1.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 if successful, non-zero if an error is encountered</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.1.5. </span>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<p>Examples of using this command.</p>
<p>Show the default output of options and listing of installed
components in a human-readable / prettyprint format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span>
</pre></div>
</div>
<p>Show the default output of options and listing of installed components
in a machine-parsable format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span> <span class="o">--</span><span class="n">parsable</span>
</pre></div>
</div>
<p>Show the MCA parameters of the “opa” PNET component in a
human-readable / prettyprint format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span> <span class="o">--</span><span class="n">param</span> <span class="n">pnet</span> <span class="n">opa</span>
</pre></div>
</div>
<p>Show the “bindir” that PMIx was configured with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span> <span class="o">--</span><span class="n">path</span> <span class="n">bindir</span>
</pre></div>
</div>
<p>Show the version of PMIx version numbers in a prettyprint format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span> <span class="o">--</span><span class="n">version</span>
</pre></div>
</div>
<p>Show <em>all</em> 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.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pmix_info</span> <span class="o">--</span><span class="nb">all</span>
</pre></div>
</div>
<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="index.html" class="btn btn-neutral float-left" title="17.1. Commands (section 1)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="palloc.1.html" class="btn btn-neutral float-right" title="17.1.2. palloc" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,228 @@
<!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.6. pmixcc &mdash; OpenPMIx 5.0.5 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.7. pps" href="pps.1.html" />
<link rel="prev" title="17.1.5. plookup" href="plookup.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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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 current"><a class="current reference internal" href="#">17.1.6. pmixcc</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.6.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.6.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.6.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.6.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.6.5. EXAMPLES</a></li>
</ul>
</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.6. </span>pmixcc</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/pmixcc.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="pmixcc">
<span id="man1-pmixcc"></span><h1><span class="section-number">17.1.6. </span>pmixcc<a class="headerlink" href="#pmixcc" title="Permalink to this heading"></a></h1>
<p>pmixcc — wrapper compiler for PMIx-based applications or tools</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.6.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmixcc</span> <span class="pre">[options]</span> <span class="pre">&lt;file&gt;</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.6.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmixcc</span></code> is a wrapper compiler that can be used to build PMIx-based
applications or tools.</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.6.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pmixcc</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></code>: Show help message</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--help={common|optimizers|params|target|warnings|[^]{joined|separate|undocumented}}[,...].</span></code>: Display specific types of command line options</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">-dumpspecs</span></code>: Display all of the built in spec strings.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-dumpversion</span></code>: Display the version of the compiler.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-dumpmachine</span></code>: Display the compiler’s target processor.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-foffload=&lt;targets&gt;</span></code>: Specify offloading targets.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-search-dirs</span></code>: Display the directories in the compiler’s search path.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-libgcc-file-name</span></code>: Display the name of the compiler’s companion library.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-file-name=&lt;lib&gt;</span></code>: Display the full path to library &lt;lib&gt;.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-prog-name=&lt;prog&gt;</span></code>: Display the full path to compiler component &lt;prog&gt;.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-multiarch</span></code>: Display the target’s normalized GNU triplet, used as a component in the library path.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-multi-directory</span></code>: Display the root directory for versions of libgcc.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-multi-lib</span></code>: Display the mapping between command line options and multiple library search directories.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-multi-os-directory</span></code>: Display the relative path to OS libraries.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-sysroot</span></code>: Display the target libraries directory.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-print-sysroot-headers-suffix</span></code>: Display the sysroot suffix used to find headers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Wa,&lt;options&gt;</span></code>: Pass comma-separated &lt;options&gt; on to the assembler.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Wp,&lt;options&gt;</span></code>: Pass comma-separated &lt;options&gt; on to the preprocessor.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Wl,&lt;options&gt;</span></code>: Pass comma-separated &lt;options&gt; on to the linker.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Xassembler</span> <span class="pre">&lt;arg&gt;</span></code>: Pass &lt;arg&gt; on to the assembler.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Xpreprocessor</span> <span class="pre">&lt;arg&gt;</span></code>: Pass &lt;arg&gt; on to the preprocessor.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-Xlinker</span> <span class="pre">&lt;arg&gt;</span></code>: Pass &lt;arg&gt; on to the linker.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-save-temps</span></code>: Do not delete intermediate files.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-save-temps=&lt;arg&gt;</span></code>: Do not delete intermediate files.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-no-canonical-prefixes</span></code>: Do not canonicalize paths when building relative prefixes to other gcc components.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-pipe</span></code>: Use pipes rather than intermediate files.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-time</span></code>: Time the execution of each subprocess.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-specs=&lt;file&gt;</span></code>: Override built-in specs with the contents of &lt;file&gt;.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-std=&lt;standard&gt;</span></code>: Assume that the input sources are for &lt;standard&gt;.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">--sysroot=&lt;directory&gt;</span></code>: Use &lt;directory&gt; as the root directory for headers and libraries.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-B</span> <span class="pre">&lt;directory&gt;</span></code>: Add &lt;directory&gt; to the compiler’s search paths.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-v</span></code>: Display the programs invoked by the compiler.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-###</span></code>: Like -v but options quoted and commands not executed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-E</span></code>: Preprocess only; do not compile, assemble or link.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-S</span></code>: Compile only; do not assemble or link.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-c</span></code>: Compile and assemble, but do not link.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-o</span> <span class="pre">&lt;file&gt;</span></code>: Place the output into &lt;file&gt;.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-pie</span></code>: Create a dynamically linked position independent executable.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-shared</span></code>: Create a shared library.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-x</span> <span class="pre">&lt;language&gt;</span></code>: Specify the language of the following input files.
Permissible languages include: c c++ assembler none
‘none’ means revert to the default behavior of
guessing the language based on the file’s extension.</p></li>
</ul>
<p>Options starting with <code class="docutils literal notranslate"><span class="pre">-g</span></code>, <code class="docutils literal notranslate"><span class="pre">-f</span></code>, <code class="docutils literal notranslate"><span class="pre">-m</span></code>, <code class="docutils literal notranslate"><span class="pre">-O</span></code>, <code class="docutils literal notranslate"><span class="pre">-W</span></code>, or <code class="docutils literal notranslate"><span class="pre">--param</span></code> are automatically
passed on to the various sub-processes invoked by the compiler. In order to pass
other options on to these processes the <code class="docutils literal notranslate"><span class="pre">-W&lt;letter&gt;</span></code> options must be used.</p>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.6.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 if build is successful, a non-zero error code if otherwise.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.6.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="plookup.1.html" class="btn btn-neutral float-left" title="17.1.5. plookup" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pps.1.html" class="btn btn-neutral float-right" title="17.1.7. pps" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,197 @@
<!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.7. pps &mdash; OpenPMIx 5.0.5 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.8. pquery" href="pquery.1.html" />
<link rel="prev" title="17.1.6. pmixcc" href="pmixcc.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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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 current"><a class="current reference internal" href="#">17.1.7. pps</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.7.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.7.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.7.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.7.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.7.5. EXAMPLES</a></li>
</ul>
</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.7. </span>pps</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/pps.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="pps">
<span id="man1-pps"></span><h1><span class="section-number">17.1.7. </span>pps<a class="headerlink" href="#pps" title="Permalink to this heading"></a></h1>
<p>pps — report identity of jobs running
in the system</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.7.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pps</span> <span class="pre">[options]</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.7.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pps</span></code> provides the namespace of jobs currently executing
in the system.</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.7.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pps</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">--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">--nodes</span></code>: Display Node Information</p></li>
</ul>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.7.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 for success, a non-zero error code otherwise.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.7.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="pmixcc.1.html" class="btn btn-neutral float-left" title="17.1.6. pmixcc" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="pquery.1.html" class="btn btn-neutral float-right" title="17.1.8. pquery" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,204 @@
<!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.8. pquery &mdash; OpenPMIx 5.0.5 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.2. APIs (section 3)" href="../man3/index.html" />
<link rel="prev" title="17.1.7. pps" href="pps.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"><a class="reference internal" href="pattrs.1.html">17.1.3. pattrs</a></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 current"><a class="current reference internal" href="#">17.1.8. pquery</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.1.8.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.1.8.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#options">17.1.8.3. OPTIONS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#exit-status">17.1.8.4. EXIT STATUS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#examples">17.1.8.5. EXAMPLES</a></li>
</ul>
</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.8. </span>pquery</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man1/pquery.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="pquery">
<span id="man1-pquery"></span><h1><span class="section-number">17.1.8. </span>pquery<a class="headerlink" href="#pquery" title="Permalink to this heading"></a></h1>
<p>pquery — query information from the host environment</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.1.8.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pquery</span> <span class="pre">[options]</span> <span class="pre">&lt;KEY1&gt;,&lt;KEY2&gt;,...</span></code></p>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.1.8.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pquery</span></code> requests the host environment for values associated
with the provided keys</p>
</div>
<div class="section" id="options">
<h2><span class="section-number">17.1.8.3. </span>OPTIONS<a class="headerlink" href="#options" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pquery</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">--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>
</ul>
<p>Keys passed to pquery may optionally include one or more qualifiers, with the
individual qualifiers delimited by semi-colons. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pquery &quot;PMIX_STORAGE_XFER_SIZE[PMIX_STORAGE_ID=lustre1,lustre2;PMIX_STORAGE_PATH=foo]&quot;&quot;
</pre></div>
</div>
</div>
<div class="section" id="exit-status">
<h2><span class="section-number">17.1.8.4. </span>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this heading"></a></h2>
<p>Returns 0 for success, or a non-zero value otherwise. Values returned by the query
are printed to stdout.</p>
</div>
<div class="section" id="examples">
<h2><span class="section-number">17.1.8.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="pps.1.html" class="btn btn-neutral float-left" title="17.1.7. pps" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../man3/index.html" class="btn btn-neutral float-right" title="17.2. APIs (section 3)" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,210 @@
<!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.2.1. PMIx_Abort &mdash; OpenPMIx 5.0.5 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.2.2. PMIx_Init" href="PMIx_Init.3.html" />
<link rel="prev" title="17.2. APIs (section 3)" href="index.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.2. APIs (section 3)</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.2.1. PMIx_Abort</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.2.1.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#arguments">17.2.1.2. ARGUMENTS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.2.1.3. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#return-value">17.2.1.4. RETURN VALUE</a></li>
<li class="toctree-l4"><a class="reference internal" href="#errors">17.2.1.5. ERRORS</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Init.3.html">17.2.2. PMIx_Init</a></li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Finalize.3.html">17.2.3. PMIx_Finalize</a></li>
</ul>
</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.2. </span>APIs (section 3)</a></li>
<li class="breadcrumb-item active"><span class="section-number">17.2.1. </span>PMIx_Abort</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man3/PMIx_Abort.3.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="pmix-abort">
<span id="man3-pmix-abort"></span><h1><span class="section-number">17.2.1. </span>PMIx_Abort<a class="headerlink" href="#pmix-abort" title="Permalink to this heading"></a></h1>
<p>PMIx_Abort - Abort the specified processes</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.2.1.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;pmix.h&gt;</span>
<span class="n">pmix_status_t</span><span class="w"> </span><span class="nf">PMIx_Abort</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="n">status</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">msg</span><span class="p">[],</span>
<span class="w"> </span><span class="n">pmix_proc_t</span><span class="w"> </span><span class="n">procs</span><span class="p">[],</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">nprocs</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="arguments">
<h2><span class="section-number">17.2.1.2. </span>ARGUMENTS<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">status</span></code>: Status value to be returned. A value of zero is
permitted by PMIx, but may not be returned by some resource
managers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">msg</span></code>: A string message to be displayed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">procs</span></code>: An array of <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code> structures defining the
processes to be aborted. A NULL for the proc array indicates that
all processes in the caller’s namespace are to be aborted. A
wildcard value for the rank in any structure indicates that all
processes in that namespace are to be aborted.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">nprocs</span></code>: Number of <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code> structures in the <code class="docutils literal notranslate"><span class="pre">procs</span></code>
array.</p></li>
</ul>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.2.1.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Request that the provided array of procs be aborted, returning the
provided status and printing the provided message. A NULL for the
<code class="docutils literal notranslate"><span class="pre">procs</span></code> array indicates that all processes in the caller’s namespace
are to be aborted.</p>
<p>The response to this request is somewhat dependent on the specific
resource manager and its configuration (e.g., some resource managers
will not abort the application if the provided status is zero unless
specifically configured to do so), and thus lies outside the control
of PMIx itself. However, the client will inform the RM of the request
that the application be aborted, regardless of the value of the
provided status.</p>
<p>Passing a NULL <code class="docutils literal notranslate"><span class="pre">msg</span></code> parameter is allowed. Note that race conditions
caused by multiple processes calling <code class="docutils literal notranslate"><span class="pre">PMIx_Abort</span></code> are left to the server
implementation to resolve with regard to which status is returned and
what messages (if any) are printed.</p>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">17.2.1.4. </span>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2>
<p>Returns <code class="docutils literal notranslate"><span class="pre">PMIX_SUCCESS</span></code> on success. On error, a negative value
corresponding to a PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned.</p>
</div>
<div class="section" id="errors">
<h2><span class="section-number">17.2.1.5. </span>ERRORS<a class="headerlink" href="#errors" title="Permalink to this heading"></a></h2>
<p>PMIx errno values are defined in <code class="docutils literal notranslate"><span class="pre">pmix_common.h</span></code>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>PMIx_Commit(3),
<a class="reference internal" href="PMIx_Finalize.3.html#man3-pmix-finalize"><span class="std std-ref">PMIx_Finalize(3)</span></a>,
<a class="reference internal" href="PMIx_Init.3.html#man3-pmix-init"><span class="std std-ref">PMIx_Init(3)</span></a>,
PMIx_Initialized(3),
PMIx_Put(3),
pmiAddInstance(3),
pmiAddMetric(3)</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="17.2. APIs (section 3)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PMIx_Init.3.html" class="btn btn-neutral float-right" title="17.2.2. PMIx_Init" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,179 @@
<!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.2.3. PMIx_Finalize &mdash; OpenPMIx 5.0.5 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.3. Config file manual pages (section 5)" href="../man5/index.html" />
<link rel="prev" title="17.2.2. PMIx_Init" href="PMIx_Init.3.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.2. APIs (section 3)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="PMIx_Abort.3.html">17.2.1. PMIx_Abort</a></li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Init.3.html">17.2.2. PMIx_Init</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.2.3. PMIx_Finalize</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.2.3.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.2.3.2. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#return-value">17.2.3.3. RETURN VALUE</a></li>
<li class="toctree-l4"><a class="reference internal" href="#errors">17.2.3.4. ERRORS</a></li>
</ul>
</li>
</ul>
</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.2. </span>APIs (section 3)</a></li>
<li class="breadcrumb-item active"><span class="section-number">17.2.3. </span>PMIx_Finalize</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man3/PMIx_Finalize.3.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="pmix-finalize">
<span id="man3-pmix-finalize"></span><h1><span class="section-number">17.2.3. </span>PMIx_Finalize<a class="headerlink" href="#pmix-finalize" title="Permalink to this heading"></a></h1>
<p>PMIx_Finalize - Finalize the PMIx Client</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.2.3.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;pmix.h&gt;</span>
<span class="n">pmix_status_t</span><span class="w"> </span><span class="nf">PMIx_Finalize</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.2.3.2. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Finalize the PMIx client, closing the connection with the local PMIx
server.</p>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">17.2.3.3. </span>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2>
<p>Returns <code class="docutils literal notranslate"><span class="pre">PMIX_SUCCESS</span></code> on success. On error, a negative value
corresponding to a PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned.</p>
</div>
<div class="section" id="errors">
<h2><span class="section-number">17.2.3.4. </span>ERRORS<a class="headerlink" href="#errors" title="Permalink to this heading"></a></h2>
<p>PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> values are defined in <code class="docutils literal notranslate"><span class="pre">pmix_common.h</span></code>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="PMIx_Abort.3.html#man3-pmix-abort"><span class="std std-ref">PMIx_Abort(3)</span></a>,
PMIx_Commit(3),
<a class="reference internal" href="PMIx_Init.3.html#man3-pmix-init"><span class="std std-ref">PMIx_Init(3)</span></a>,
PMIx_Initialized(3),
PMIx_Put(3),
pmiAddInstance(3),
pmiAddMetric(3)</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="PMIx_Init.3.html" class="btn btn-neutral float-left" title="17.2.2. PMIx_Init" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../man5/index.html" class="btn btn-neutral float-right" title="17.3. Config file manual pages (section 5)" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,201 @@
<!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.2.2. PMIx_Init &mdash; OpenPMIx 5.0.5 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.2.3. PMIx_Finalize" href="PMIx_Finalize.3.html" />
<link rel="prev" title="17.2.1. PMIx_Abort" href="PMIx_Abort.3.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.2. APIs (section 3)</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="PMIx_Abort.3.html">17.2.1. PMIx_Abort</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.2.2. PMIx_Init</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#synopsis">17.2.2.1. SYNOPSIS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#arguments">17.2.2.2. ARGUMENTS</a></li>
<li class="toctree-l4"><a class="reference internal" href="#description">17.2.2.3. DESCRIPTION</a></li>
<li class="toctree-l4"><a class="reference internal" href="#return-value">17.2.2.4. RETURN VALUE</a></li>
<li class="toctree-l4"><a class="reference internal" href="#errors">17.2.2.5. ERRORS</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Finalize.3.html">17.2.3. PMIx_Finalize</a></li>
</ul>
</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.2. </span>APIs (section 3)</a></li>
<li class="breadcrumb-item active"><span class="section-number">17.2.2. </span>PMIx_Init</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man3/PMIx_Init.3.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="pmix-init">
<span id="man3-pmix-init"></span><h1><span class="section-number">17.2.2. </span>PMIx_Init<a class="headerlink" href="#pmix-init" title="Permalink to this heading"></a></h1>
<p>PMIx_Init - Initialize the PMIx Client</p>
<div class="section" id="synopsis">
<h2><span class="section-number">17.2.2.1. </span>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;pmix.h&gt;</span>
<span class="n">pmix_status_t</span><span class="w"> </span><span class="nf">PMIx_Init</span><span class="p">(</span><span class="n">pmix_proc_t</span><span class="w"> </span><span class="o">*</span><span class="n">proc</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="arguments">
<h2><span class="section-number">17.2.2.2. </span>ARGUMENTS<a class="headerlink" href="#arguments" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">proc</span></code>: Pointer to a <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code> object in which the client’s
namespace and rank are to be returned.</p></li>
</ul>
</div>
<div class="section" id="description">
<h2><span class="section-number">17.2.2.3. </span>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
<p>Initialize the PMIx client, returning the process identifier assigned
to this client’s application in the provided <code class="docutils literal notranslate"><span class="pre">pmix_proc_t</span></code>
struct. Passing a parameter of NULL for this parameter is allowed if
the user wishes solely to initialize the PMIx system and does not
require return of the identifier at that time.</p>
<p>When called, the PMIx client will check for the required connection
information of the local PMIx server and will establish the
connection. If the information is not found, or the server connection
fails, then an appropriate error constant will be returned.</p>
<p>If successful, the function will return <code class="docutils literal notranslate"><span class="pre">PMIX_SUCCESS</span></code> and will fill
the provided structure with the server-assigned namespace and rank of
the process within the application.</p>
<p>Note that the PMIx client library is referenced counted, and so
multiple calls to <code class="docutils literal notranslate"><span class="pre">PMIx_Init</span></code> are allowed. Thus, one way to obtain
the namespace and rank of the process is to simply call <code class="docutils literal notranslate"><span class="pre">PMIx_Init</span></code>
with a non-NULL parameter.</p>
</div>
<div class="section" id="return-value">
<h2><span class="section-number">17.2.2.4. </span>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this heading"></a></h2>
<p>Returns <code class="docutils literal notranslate"><span class="pre">PMIX_SUCCESS</span></code> on success. On error, a negative value
corresponding to a PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> is returned.</p>
</div>
<div class="section" id="errors">
<h2><span class="section-number">17.2.2.5. </span>ERRORS<a class="headerlink" href="#errors" title="Permalink to this heading"></a></h2>
<p>PMIx <code class="docutils literal notranslate"><span class="pre">errno</span></code> values are defined in <code class="docutils literal notranslate"><span class="pre">pmix_common.h</span></code>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>PMIx_Initialized(3),
<a class="reference internal" href="PMIx_Abort.3.html#man3-pmix-abort"><span class="std std-ref">PMIx_Abort(3)</span></a>,
PMIx_Commit(3),
<a class="reference internal" href="PMIx_Finalize.3.html#man3-pmix-finalize"><span class="std std-ref">PMIx_Finalize(3)</span></a>,
PMIx_Put(3),
pmiAddInstance(3),
pmiAddMetric(3)</p>
</div>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="PMIx_Abort.3.html" class="btn btn-neutral float-left" title="17.2.1. PMIx_Abort" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PMIx_Finalize.3.html" class="btn btn-neutral float-right" title="17.2.3. PMIx_Finalize" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,150 @@
<!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.2. APIs (section 3) &mdash; OpenPMIx 5.0.5 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.2.1. PMIx_Abort" href="PMIx_Abort.3.html" />
<link rel="prev" title="17.1.8. pquery" href="../man1/pquery.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">17.2. APIs (section 3)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Abort.3.html">17.2.1. PMIx_Abort</a></li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Init.3.html">17.2.2. PMIx_Init</a></li>
<li class="toctree-l3"><a class="reference internal" href="PMIx_Finalize.3.html">17.2.3. PMIx_Finalize</a></li>
</ul>
</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 active"><span class="section-number">17.2. </span>APIs (section 3)</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man3/index.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="apis-section-3">
<h1><span class="section-number">17.2. </span>APIs (section 3)<a class="headerlink" href="#apis-section-3" title="Permalink to this heading"></a></h1>
<div class="error admonition">
<p class="admonition-title">PMIx Docs TODO</p>
<p>Need to supply all the rest of the man pages for section 3.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="PMIx_Abort.3.html">17.2.1. PMIx_Abort</a></li>
<li class="toctree-l1"><a class="reference internal" href="PMIx_Init.3.html">17.2.2. PMIx_Init</a></li>
<li class="toctree-l1"><a class="reference internal" href="PMIx_Finalize.3.html">17.2.3. PMIx_Finalize</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../man1/pquery.1.html" class="btn btn-neutral float-left" title="17.1.8. pquery" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="PMIx_Abort.3.html" class="btn btn-neutral float-right" title="17.2.1. PMIx_Abort" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,142 @@
<!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.3. Config file manual pages (section 5) &mdash; OpenPMIx 5.0.5 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.3.1. OpenPMIx" href="openpmix.5.html" />
<link rel="prev" title="17.2.3. PMIx_Finalize" href="../man3/PMIx_Finalize.3.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../man3/index.html">17.2. APIs (section 3)</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">17.3. Config file manual pages (section 5)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="openpmix.5.html">17.3.1. OpenPMIx</a></li>
</ul>
</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 active"><span class="section-number">17.3. </span>Config file manual pages (section 5)</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man5/index.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="config-file-manual-pages-section-5">
<h1><span class="section-number">17.3. </span>Config file manual pages (section 5)<a class="headerlink" href="#config-file-manual-pages-section-5" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="openpmix.5.html">17.3.1. OpenPMIx</a></li>
</ul>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../man3/PMIx_Finalize.3.html" class="btn btn-neutral float-left" title="17.2.3. PMIx_Finalize" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="openpmix.5.html" class="btn btn-neutral float-right" title="17.3.1. OpenPMIx" 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, The OpenPMIx Community.</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>

View File

@@ -0,0 +1,141 @@
<!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.3.1. OpenPMIx &mdash; OpenPMIx 5.0.5 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="prev" title="17.3. Config file manual pages (section 5)" href="index.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"><a class="reference internal" href="../man1/index.html">17.1. Commands (section 1)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../man3/index.html">17.2. APIs (section 3)</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">17.3. Config file manual pages (section 5)</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">17.3.1. OpenPMIx</a></li>
</ul>
</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.3. </span>Config file manual pages (section 5)</a></li>
<li class="breadcrumb-item active"><span class="section-number">17.3.1. </span>OpenPMIx</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/man/man5/openpmix.5.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="openpmix">
<span id="man5-openpmix"></span><h1><span class="section-number">17.3.1. </span>OpenPMIx<a class="headerlink" href="#openpmix" title="Permalink to this heading"></a></h1>
<p>Write more here.</p>
<div class="error admonition">
<p class="admonition-title">PMIx Docs TODO</p>
<p>Need to write this man page.</p>
</div>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="17.3. Config file manual pages (section 5)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2014-2025, The OpenPMIx Community.</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>