Added and finalized ompi- prefix updates for PRRTE manpages.

Added ompi- prefix for all instances of prte commands within both the man/man1 and man/man5 directories, and also renamed necessary files to accommodate changes. Updated and corrected ompi- prefix for prrte manpages Finalized changes to prrte manpages with -ompi prefix Signed-off-by: Brennan Carson <[email protected]>
uofl-capstone-open-mpi · Dec 5, 2024 · 65f9968 · 65f9968
1 parent 143b956
commit 65f9968
Show file tree

Hide file tree

Showing 9 changed files with 59 additions and 59 deletions.
diff --git a/docs/man/man1/index.rst b/docs/man/man1/index.rst
@@ -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
diff --git a/docs/man/man1/prte.1.rst → docs/man/man1/ompi-prte.1.rst b/docs/man/man1/prte.1.rst → docs/man/man1/ompi-prte.1.rst
@@ -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>`
diff --git a/docs/man/man1/prte_info.1.rst → docs/man/man1/ompi-prte_info.1.rst b/docs/man/man1/prte_info.1.rst → docs/man/man1/ompi-prte_info.1.rst
@@ -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>`
diff --git a/docs/man/man1/prted.1.rst → docs/man/man1/ompi-prted.1.rst b/docs/man/man1/prted.1.rst → docs/man/man1/ompi-prted.1.rst
@@ -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>`
diff --git a/docs/man/man1/prterun.1.rst → docs/man/man1/ompi-prterun.1.rst b/docs/man/man1/prterun.1.rst → docs/man/man1/ompi-prterun.1.rst
@@ -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
@@ -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>`
diff --git a/docs/man/man1/prun.1.rst → docs/man/man1/ompi-prun.1.rst b/docs/man/man1/prun.1.rst → docs/man/man1/ompi-prun.1.rst
@@ -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
@@ -41,4 +41,4 @@ DEPRECATED COMMAND LINE OPTIONS
 
 
 .. seealso::
-   :ref:`prte(1) <man1-prte>`
+   :ref:`ompi-prte(1) <man1-ompi-prte>`
diff --git a/docs/man/man1/pterm.1.rst → docs/man/man1/ompi-pterm.1.rst b/docs/man/man1/pterm.1.rst → docs/man/man1/ompi-pterm.1.rst
@@ -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>`
diff --git a/docs/man/man5/index.rst b/docs/man/man5/index.rst
@@ -4,4 +4,4 @@ Config file manual pages (section 5)
 .. toctree::
    :maxdepth: 1
 
-   prte.5.rst
+   ompi-prte.5.rst
diff --git a/docs/man/man5/prte.5.rst → docs/man/man5/ompi-prte.5.rst b/docs/man/man5/prte.5.rst → docs/man/man5/ompi-prte.5.rst
@@ -1,7 +1,7 @@
-.. _man5-prte:
+.. _man5-ompi-prte:
 
-prte
-====
+ompi-prte
+=========
 
 PMIx Reference Runtime Environment (PRRTE) - General information