Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Brennan Carson rename manpages #10

Merged
merged 2 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ EXTRA_DIST = \
# explicitly listed.

PRTE_MAN1 = \
prte.1 \
prte_info.1 \
prted.1 \
prterun.1 \
prun.1 \
pterm.1
ompi-prte.1 \
ompi-prte_info.1 \
ompi-prted.1 \
ompi-prterun.1 \
ompi-prun.1 \
ompi-pterm.1

PRTE_MAN5 = \
prte.5
ompi-prte.5

MAN_OUTDIR = $(OUTDIR)/man

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ as a Distributed Virtual Machine (DVM) in two ways. First, the
``prte`` command can be executed at a shell prompt. This will discover
the available resources (either from hostfile or as allocated by a
resource manager) and start a PRRTE shepherd daemon (:ref:`prted(1)
<man1-prted>`) on each of the indicated nodes.
<man1-ompi-prted>`) on each of the indicated nodes.

The other method, however, is to bootstrap the DVM at time of cluster
startup. Bootstrapping PRRTE allows the DVM to serve as the system-level
Expand Down
12 changes: 6 additions & 6 deletions docs/man/man1/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Commands (section 1)
.. toctree::
:maxdepth: 1

prte.1.rst
prte_info.1.rst
prted.1.rst
prterun.1.rst
prun.1.rst
pterm.1.rst
ompi-prte.1.rst
ompi-prte_info.1.rst
ompi-prted.1.rst
ompi-prterun.1.rst
ompi-prun.1.rst
ompi-pterm.1.rst
16 changes: 8 additions & 8 deletions docs/man/man1/prte.1.rst → docs/man/man1/ompi-prte.1.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
.. _man1-prte:
.. _man1-ompi-prte:

prte
====
ompi-prte
=========

prte |mdash| instantiate an instance of PRRTE DVM
ompi-prte |mdash| instantiate an instance of PRRTE DVM

SYNOPSIS
--------

.. code:: sh

shell$ prte ...options...
shell$ ompi-prte ...options...

DESCRIPTION
-----------

``prte`` instantiates an instance of the PMIx Reference Run Time
``ompi-prte`` instantiates an instance of the PMIx Reference Run Time
Environment (PRRTE) distributed virtual machine (DVM).

Extensive help documentation for this command is provided through
``prte --help [topic]``.
``ompi-prte --help [topic]``.

At least for now, that content is not available in man page form.
Pull requests to add all the content (via repeatable infrastructure)
would be greatly appreciated.

.. seealso::
:ref:`prterun(1) <man1-prterun>`
:ref:`ompi-prterun(1) <man1-ompi-prterun>`
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
.. _man1-prte_info:
.. _man1-ompi-prte_info:

prte_info
=========
ompi-prte_info
==============

prte_info |mdash| Provide detailed information on your PRRTE installation
ompi-prte_info |mdash| Provide detailed information on your PRRTE installation

SYNOPSIS
--------

.. code:: sh

prte_info ...options...
ompi-prte_info ...options...

DESCRIPTION
-----------

``prte_info`` provide detailed information on your PMIx Reference Run
``ompi-prte_info`` provide detailed information on your PMIx Reference Run
Time (PRRTE) installation.

Extensive help documentation for this command is provided through
``prte_info --help [topic]``.
``ompi-prte_info --help [topic]``.

At least for now, that content is not available in man page form.
Pull requests to add all the content (via repeatable infrastructure)
would be greatly appreciated.

.. seealso::
:ref:`prte(1) <man1-prte>`
:ref:`ompi-prte(1) <man1-ompi-prte>`
16 changes: 8 additions & 8 deletions docs/man/man1/prted.1.rst → docs/man/man1/ompi-prted.1.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
.. _man1-prted:
.. _man1-ompi-prted:

prted
=====
ompi-prted
==========

prted |mdash| helper daemon for PRRTE
ompi-prted |mdash| helper daemon for PRRTE

SYNOPSIS
--------

.. code:: sh

shell$ prted ...options...
shell$ ompi-prted ...options...

DESCRIPTION
-----------

``prted`` is the back end helper daemon for PMIx Reference Runtime
``ompi-prted`` is the back end helper daemon for PMIx Reference Runtime
Environment (PRRTE).

Extensive help documentation for this command is provided through
``prted --help [topic]``.
``ompi-prted --help [topic]``.

At least for now, that content is not available in man page form.
Pull requests to add all the content (via repeatable infrastructure)
would be greatly appreciated.

.. seealso::
:ref:`prte(1) <man1-prte>`
:ref:`ompi-prte(1) <man1-ompi-prte>`
18 changes: 9 additions & 9 deletions docs/man/man1/prterun.1.rst → docs/man/man1/ompi-prterun.1.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
.. _man1-prterun:
.. _man1-ompi-prterun:

prterun
========
ompi-prterun
============

prterun |mdash| launch an application with a default DVM
ompi-prterun |mdash| launch an application with a default DVM

SYNOPSIS
--------

.. code:: sh

shell$ prterun ...options...
shell$ ompi-prterun ...options...

DESCRIPTION
-----------

``prterun`` submits a job to the PMIx Reference Runtime Environment
``ompi-prterun`` submits a job to the PMIx Reference Runtime Environment
(PRRTE). A default set of distributed virtual
machine (DVM) options are used; use :ref:`prun(1) <man1-prun>` if you
machine (DVM) options are used; use :ref:`ompi-prun(1) <man1-ompi-prun>` if you
wish to utilize specific DVM options.

Much of this same help documentation for this command is also provided
through ``prun --help [topic]``.
through ``ompi-prun --help [topic]``.

.. admonition:: PRRTE Docs TODO
:class: error
Expand All @@ -46,4 +46,4 @@ EXIT STATUS
Description of the various exit statuses of this command.

.. seealso::
:ref:`prte(1) <man1-prte>`
:ref:`ompi-prte(1) <man1-ompi-prte>`
16 changes: 8 additions & 8 deletions docs/man/man1/prun.1.rst → docs/man/man1/ompi-prun.1.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
.. _man1-prun:
.. _man1-ompi-prun:

prun
=====
ompi-prun
=========

prun |mdash| launch an application
ompi-prun |mdash| launch an application

SYNOPSIS
--------

.. code:: sh

shell$ prun ...options...
shell$ ompi-prun ...options...

DESCRIPTION
-----------

``prun`` submits a job to the PMIx Reference Runtime Environment
``ompi-prun`` submits a job to the PMIx Reference Runtime Environment
(PRRTE). The user has control over various distributed virtual
machine (DVM) options.

Much of this same help documentation for this command is also provided
through ``prun --help [topic]``.
through ``ompi-prun --help [topic]``.

.. admonition:: PRRTE Docs TODO
:class: error
Expand All @@ -41,4 +41,4 @@ DEPRECATED COMMAND LINE OPTIONS


.. seealso::
:ref:`prte(1) <man1-prte>`
:ref:`ompi-prte(1) <man1-ompi-prte>`
16 changes: 8 additions & 8 deletions docs/man/man1/pterm.1.rst → docs/man/man1/ompi-pterm.1.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
.. _man1-pterm:
.. _man1-ompi-pterm:

pterm
=====
ompi-pterm
==========

pterm |mdash| terminate an instance of the PRRTE DVM
ompi-pterm |mdash| terminate an instance of the PRRTE DVM

SYNOPSIS
--------

.. code:: sh

shell$ pterm ...options...
shell$ ompi-pterm ...options...

DESCRIPTION
-----------

``pterm`` terminates an instance of the PMIx Reference Runtime
``ompi-pterm`` terminates an instance of the PMIx Reference Runtime
Environment (PRRTE) distributed virtual machine (DVM).

Extensive help documentation for this command is provided through
``pterm --help [topic]``.
``ompi-pterm --help [topic]``.

At least for now, that content is not available in man page form.
Pull requests to add all the content (via repeatable infrastructure)
would be greatly appreciated.

.. seealso::
:ref:`prte(1) <man1-prte>`
:ref:`ompi-prte(1) <man1-ompi-prte>`
2 changes: 1 addition & 1 deletion docs/man/man5/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Config file manual pages (section 5)
.. toctree::
:maxdepth: 1

prte.5.rst
ompi-prte.5.rst
6 changes: 3 additions & 3 deletions docs/man/man5/prte.5.rst → docs/man/man5/ompi-prte.5.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _man5-prte:
.. _man5-ompi-prte:

prte
====
ompi-prte
=========

PMIx Reference Runtime Environment (PRRTE) - General information

Expand Down
Loading