doc/orte/orteping.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry>
   3   <!--
   4   <refentryinfo>
   5     <address>
   6       <email>petr@smoliku.cz</email>
   7     </address>
   8     <author>
   9       <firstname>Petr</firstname>
  10       <surname>Smolik</surname>
  11     </author>
  12     <date>2004-11-02</date>
  13   </refentryinfo>
  14   -->
  15   <refmeta>
  16     <refentrytitle>orteping</refentrytitle>
  17     <manvolnum>1</manvolnum>
  18   </refmeta>
  19   <refnamediv>
  20     <refname>orteping</refname>
  21     <refpurpose>the utility for debugging and testing of ORTE communication</refpurpose>
  22   </refnamediv>
  23   <refsynopsisdiv>
  24     <cmdsynopsis>
  25       <command>orteping</command>
  26       <arg><option>-d <replaceable>domain</replaceable></option></arg>
  27       <arg><option>-p <replaceable></replaceable></option></arg>
  28       <arg><option>-S <replaceable>strength</replaceable></option></arg>
  29       <arg><option>-D <replaceable>delay</replaceable></option></arg>
  30       <arg><option>-s <replaceable></replaceable></option></arg>
  31       <arg><option>-R <replaceable>refresh</replaceable></option></arg>
  32       <arg><option>-P <replaceable>purge</replaceable></option></arg>
  33       <arg><option>-E <replaceable>expiration</replaceable></option></arg>
  34       <arg><option>-m <replaceable>minimumSeparation</replaceable></option></arg>
  35       <arg><option>-v <replaceable>verbosity</replaceable></option></arg>
  36       <arg><option>-q <replaceable></replaceable></option></arg>
  37       <arg><option>-l <replaceable>filename</replaceable></option></arg>
  38       <arg><option>-V</option></arg>
  39       <arg><option>-h</option></arg>
  40       <!-- <arg rep='repeat'><option><replaceable>file</replaceable></option></arg> -->
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43   <refsect1>
  44     <title>Description</title>
  45     <para>
  46       Main purpose of the utility <command>orteping</command> is debug and
  47       test ORTE communication.
  48     </para>
  49   </refsect1>
  50   <refsect1>
  51     <title>OPTIONS</title>
  52     <variablelist>
  53       <varlistentry>
  54         <term><option>-d</option> <option>--domain</option></term>
  55         <listitem>
  56           <para>
  57             The number of working ORTE domain. Default is 0.
  58           </para>
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><option>-p</option> <option>--publisher</option></term>
  63         <listitem>
  64           <para>
  65             Create a publisher with Topic - Ping and Type - PingData.
  66             The publisher will publish a issue with period by
  67             parameter delay.
  68           </para>
  69         </listitem>
  70       </varlistentry>
  71       <varlistentry>
  72         <term><option>-s</option> <option>--strength</option></term>
  73         <listitem>
  74           <para>
  75             Setups relative weight against other publishers. Default is 1.
  76           </para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term><option>-D</option> <option>--delay</option></term>
  81         <listitem>
  82           <para>
  83             The time between two issues. Default 1 second.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87       <varlistentry>
  88         <term><option>-s</option> <option>--subscriber</option></term>
  89         <listitem>
  90           <para>
  91             Create a subscriber with Topic - Ping and Type - PingData.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95       <varlistentry>
  96         <term><option>-R</option> <option>--refresh</option></term>
  97         <listitem>
  98           <para>
  99             The refresh time in manager. Default 60 seconds.
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><option>-P</option> <option>--purge</option></term>
 105         <listitem>
 106           <para>
 107             The searching time in local database for finding expired application.
 108             Default 60 seconds.
 109           </para>
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term><option>-E</option> <option>--expiration</option></term>
 114         <listitem>
 115           <para>
 116             Expiration time in other applications.
 117           </para>
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><option>-m</option> <option>--minimumSeparation</option></term>
 122         <listitem>
 123           <para>
 124             The minimum time between two issues.
 125           </para>
 126         </listitem>
 127       </varlistentry>
 128       <varlistentry>
 129         <term><option>-v</option> <option>--verbosity</option></term>
 130         <listitem>
 131           <para>
 132             Set verbosity level.
 133           </para>
 134         </listitem>
 135       </varlistentry>
 136       <varlistentry>
 137         <term><option>-q</option> <option>--quite</option></term>
 138         <listitem>
 139           <para>
 140             Nothing messages will be printed on screen. It can be useful
 141             for testing maximal throughput.
 142           </para>
 143         </listitem>
 144       </varlistentry>
 145       <varlistentry>
 146         <term><option>-l</option> <option>--logfile</option></term>
 147         <listitem>
 148           <para>
 149             All debug messages can be redirect into specific file.
 150           </para>
 151         </listitem>
 152       </varlistentry>
 153       <varlistentry>
 154         <term><option>-V</option> <option>--version</option>
 155         </term>
 156         <listitem>
 157           <para>
 158             Print the version of <command>orteping</command>.
 159           </para>
 160         </listitem>
 161       </varlistentry>
 162       <varlistentry>
 163         <term><option>-h</option> <option>--help</option>
 164         </term>
 165         <listitem>
 166           <para>
 167             Print usage screen.
 168           </para>
 169         </listitem>
 170       </varlistentry>
 171     </variablelist>
 172   </refsect1>
 173   <!--
 174   <refsect1>
 175     <title>BACKWARDS COMPATIBILITY</title>
 176
 177     <para>
 178       This.
 179     </para>
 180   </refsect1>
 181   <refsect1>
 182     <title>ENVIRONMENT</title>
 183     <para>
 184       The.
 185     </para>
 186   </refsect1>
 187   <refsect1>
 188     <title>COPYRIGHT</title>
 189     <para>
 190       This.
 191     </para>
 192   </refsect1>
 193   <refsect1>
 194     <title>SEE ALSO</title>
 195     <para>
 196       <citerefentry>
 197         <refentrytitle>readburst</refentrytitle><manvolnum>5</manvolnum>
 198       </citerefentry>
 199     </para>
 200   </refsect1>
 201   -->
 202 </refentry>
 203