\hypertarget{orte_2util_2show__help_8h}{\section{orte/util/show\+\_\+help.h File Reference}
\label{orte_2util_2show__help_8h}\index{orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}}
}


Populates global structure with system-\/specific information.  


{\ttfamily \#include \char`\"{}orte\+\_\+config.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}orte/types.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}orte/mca/rml/rml\+\_\+types.\+h\char`\"{}}\\*
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
B\+E\+G\+I\+N\+\_\+\+C\+\_\+\+D\+E\+C\+L\+S O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2util_2show__help_8h_ad2c1e4128021428eb573340b57337c3f}{orte\+\_\+show\+\_\+help\+\_\+init} (void)
\begin{DoxyCompactList}\small\item\em Initializes the output stream system and opens a default \char`\"{}verbose\char`\"{} stream. \end{DoxyCompactList}\item 
\hypertarget{orte_2util_2show__help_8h_abe185668935cc75912a42880a2be1f47}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C bool \hyperlink{orte_2util_2show__help_8h_abe185668935cc75912a42880a2be1f47}{orte\+\_\+show\+\_\+help\+\_\+is\+\_\+available} (void)}\label{orte_2util_2show__help_8h_abe185668935cc75912a42880a2be1f47}

\begin{DoxyCompactList}\small\item\em Allow other parts of the code base to know if the O\+R\+T\+E show\+\_\+help system is available or not (does not necessarily indicate that aggregating is available; on no-\/\+O\+R\+T\+E systems, O\+R\+T\+E show\+\_\+help is available, but aggregating is not). \end{DoxyCompactList}\item 
O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void \hyperlink{orte_2util_2show__help_8h_a14455b1be69c628cae89a0208ee0ce96}{orte\+\_\+show\+\_\+help\+\_\+finalize} (void)
\begin{DoxyCompactList}\small\item\em Shut down the output stream system. \end{DoxyCompactList}\item 
O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2util_2show__help_8h_a26cc59040695654429e9651119eb46d7}{orte\+\_\+show\+\_\+help} (const char $\ast$filename, const char $\ast$topic, bool want\+\_\+error\+\_\+header,...)
\begin{DoxyCompactList}\small\item\em Show help. \end{DoxyCompactList}\item 
\hypertarget{orte_2util_2show__help_8h_a3a61d28f813b9ad36763e37c28c06093}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2util_2show__help_8h_a3a61d28f813b9ad36763e37c28c06093}{orte\+\_\+show\+\_\+help\+\_\+norender} (const char $\ast$filename, const char $\ast$topic, bool want\+\_\+error\+\_\+header, const char $\ast$output)}\label{orte_2util_2show__help_8h_a3a61d28f813b9ad36763e37c28c06093}

\begin{DoxyCompactList}\small\item\em Exactly the same as orte\+\_\+show\+\_\+help, but pass in a rendered string, rather than a varargs list which must be rendered. \end{DoxyCompactList}\item 
O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int \hyperlink{orte_2util_2show__help_8h_a52ed74f1aa76a45a94d0dbe3881b82a7}{orte\+\_\+show\+\_\+help\+\_\+suppress} (const char $\ast$filename, const char $\ast$topic)
\begin{DoxyCompactList}\small\item\em Pretend that this message has already been shown. \end{DoxyCompactList}\item 
\hypertarget{orte_2util_2show__help_8h_a85394d88ffc255d05b99e9f99a4e581a}{O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void {\bfseries orte\+\_\+show\+\_\+help\+\_\+recv} (int status, \hyperlink{structorte__process__name__t}{orte\+\_\+process\+\_\+name\+\_\+t} $\ast$sender, \hyperlink{structopal__buffer__t}{opal\+\_\+buffer\+\_\+t} $\ast$buffer, \hyperlink{rml__types_8h_ab0683f653b0908cf6520469d91559917}{orte\+\_\+rml\+\_\+tag\+\_\+t} tag, void $\ast$cbdata)}\label{orte_2util_2show__help_8h_a85394d88ffc255d05b99e9f99a4e581a}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Populates global structure with system-\/specific information. 

Notes\+: add limits.\+h, compute size of integer and other types via sizeof(type)$\ast$\+C\+H\+A\+R\+\_\+\+B\+I\+T 

\subsection{Function Documentation}
\hypertarget{orte_2util_2show__help_8h_a26cc59040695654429e9651119eb46d7}{\index{orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}!orte\+\_\+show\+\_\+help@{orte\+\_\+show\+\_\+help}}
\index{orte\+\_\+show\+\_\+help@{orte\+\_\+show\+\_\+help}!orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}}
\subsubsection[{orte\+\_\+show\+\_\+help}]{\setlength{\rightskip}{0pt plus 5cm}O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int orte\+\_\+show\+\_\+help (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{filename, }
\item[{const char $\ast$}]{topic, }
\item[{bool}]{want\+\_\+error\+\_\+header, }
\item[{}]{...}
\end{DoxyParamCaption}
)}}\label{orte_2util_2show__help_8h_a26cc59040695654429e9651119eb46d7}


Show help. 

Sends show help messages to the H\+N\+P if on a backend node. Note that aggregation is not currently supported on H\+N\+P-\/less systems (e.\+g., cray). 

References opal\+\_\+show\+\_\+help\+\_\+vstring(), and orte\+\_\+show\+\_\+help\+\_\+norender().



Referenced by mca\+\_\+btl\+\_\+base\+\_\+select(), mca\+\_\+btl\+\_\+ud\+\_\+component\+\_\+init(), mca\+\_\+coll\+\_\+base\+\_\+comm\+\_\+select(), mca\+\_\+coll\+\_\+base\+\_\+find\+\_\+available(), ompi\+\_\+mpi\+\_\+abort(), ompi\+\_\+mpi\+\_\+finalize(), ompi\+\_\+mpi\+\_\+init(), ompi\+\_\+proc\+\_\+complete\+\_\+init(), ompi\+\_\+proc\+\_\+refresh(), ompi\+\_\+proc\+\_\+unpack(), orte\+\_\+ess\+\_\+base\+\_\+orted\+\_\+setup(), orte\+\_\+init(), orte\+\_\+odls\+\_\+base\+\_\+open(), orte\+\_\+plm\+\_\+submit\+\_\+launch(), orte\+\_\+ras\+\_\+gridengine\+\_\+allocate(), orte\+\_\+rmaps\+\_\+base\+\_\+filter\+\_\+nodes(), orte\+\_\+rmaps\+\_\+base\+\_\+get\+\_\+target\+\_\+nodes(), orte\+\_\+rmaps\+\_\+base\+\_\+open(), orte\+\_\+show\+\_\+help\+\_\+init(), and orte\+\_\+util\+\_\+add\+\_\+hostfile\+\_\+nodes().

\hypertarget{orte_2util_2show__help_8h_a14455b1be69c628cae89a0208ee0ce96}{\index{orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}!orte\+\_\+show\+\_\+help\+\_\+finalize@{orte\+\_\+show\+\_\+help\+\_\+finalize}}
\index{orte\+\_\+show\+\_\+help\+\_\+finalize@{orte\+\_\+show\+\_\+help\+\_\+finalize}!orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}}
\subsubsection[{orte\+\_\+show\+\_\+help\+\_\+finalize}]{\setlength{\rightskip}{0pt plus 5cm}O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C void orte\+\_\+show\+\_\+help\+\_\+finalize (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{orte_2util_2show__help_8h_a14455b1be69c628cae89a0208ee0ce96}


Shut down the output stream system. 

Shut down the output stream system, including the default verbose stream. 

References O\+B\+J\+\_\+\+D\+E\+S\+T\+R\+U\+C\+T, orte\+\_\+rml, and orte\+\_\+rml\+\_\+module\+\_\+t\+::recv\+\_\+cancel.



Referenced by orte\+\_\+finalize().

\hypertarget{orte_2util_2show__help_8h_ad2c1e4128021428eb573340b57337c3f}{\index{orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}!orte\+\_\+show\+\_\+help\+\_\+init@{orte\+\_\+show\+\_\+help\+\_\+init}}
\index{orte\+\_\+show\+\_\+help\+\_\+init@{orte\+\_\+show\+\_\+help\+\_\+init}!orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}}
\subsubsection[{orte\+\_\+show\+\_\+help\+\_\+init}]{\setlength{\rightskip}{0pt plus 5cm}B\+E\+G\+I\+N\+\_\+\+C\+\_\+\+D\+E\+C\+L\+S O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int orte\+\_\+show\+\_\+help\+\_\+init (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{orte_2util_2show__help_8h_ad2c1e4128021428eb573340b57337c3f}


Initializes the output stream system and opens a default \char`\"{}verbose\char`\"{} stream. 


\begin{DoxyRetVals}{Return values}
{\em success} & Upon success. \\
\hline
{\em error} & Upon failure.\\
\hline
\end{DoxyRetVals}
This should be the first function invoked in the output subsystem. After this call, the default \char`\"{}verbose\char`\"{} stream is open and can be written to via calls to orte\+\_\+output\+\_\+verbose() and orte\+\_\+output\+\_\+error().

By definition, the default verbose stream has a handle I\+D of 0, and has a verbose level of 0. 

References O\+B\+J\+\_\+\+C\+O\+N\+S\+T\+R\+U\+C\+T, O\+P\+A\+L\+\_\+\+O\+U\+T\+P\+U\+T\+\_\+\+V\+E\+R\+B\+O\+S\+E, and orte\+\_\+show\+\_\+help().



Referenced by orte\+\_\+init().

\hypertarget{orte_2util_2show__help_8h_a52ed74f1aa76a45a94d0dbe3881b82a7}{\index{orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}!orte\+\_\+show\+\_\+help\+\_\+suppress@{orte\+\_\+show\+\_\+help\+\_\+suppress}}
\index{orte\+\_\+show\+\_\+help\+\_\+suppress@{orte\+\_\+show\+\_\+help\+\_\+suppress}!orte/util/show\+\_\+help.\+h@{orte/util/show\+\_\+help.\+h}}
\subsubsection[{orte\+\_\+show\+\_\+help\+\_\+suppress}]{\setlength{\rightskip}{0pt plus 5cm}O\+R\+T\+E\+\_\+\+D\+E\+C\+L\+S\+P\+E\+C int orte\+\_\+show\+\_\+help\+\_\+suppress (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{filename, }
\item[{const char $\ast$}]{topic}
\end{DoxyParamCaption}
)}}\label{orte_2util_2show__help_8h_a52ed74f1aa76a45a94d0dbe3881b82a7}


Pretend that this message has already been shown. 

Sends a control message to the H\+N\+P that will effecitvely suppress this message from being shown. Primitive $\ast$-\/wildcarding is possible.

Not currently supported on H\+N\+P-\/less systems (e.\+g., cray). 

References orte\+\_\+proc\+\_\+info\+\_\+t\+::my\+\_\+hnp\+\_\+uri, O\+B\+J\+\_\+\+C\+O\+N\+S\+T\+R\+U\+C\+T, O\+B\+J\+\_\+\+D\+E\+S\+T\+R\+U\+C\+T, O\+P\+A\+L\+\_\+\+I\+N\+T8, O\+P\+A\+L\+\_\+\+S\+T\+R\+I\+N\+G, O\+R\+T\+E\+\_\+\+P\+R\+O\+C\+\_\+\+M\+Y\+\_\+\+N\+A\+M\+E, orte\+\_\+process\+\_\+info, orte\+\_\+rml, orte\+\_\+routed, and orte\+\_\+rml\+\_\+module\+\_\+t\+::send\+\_\+buffer.

