doc/orte/ortemanager.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>ortemanager</refentrytitle>
  17     <manvolnum>1</manvolnum>
  18   </refmeta>
  19   <refnamediv>
  20     <refname>ortemanager</refname>
  21     <refpurpose>the utility for discovery others applications and managers on the network</refpurpose>
  22   </refnamediv>
  23   <refsynopsisdiv>
  24     <cmdsynopsis>
  25       <command>ortemanager</command>
  26       <arg><option>-d <replaceable>domain</replaceable></option></arg>
  27       <arg><option>-p <replaceable>ip addresses</replaceable></option></arg>
  28       <arg><option>-k <replaceable>ip addresses</replaceable></option></arg>
  29       <arg><option>-R <replaceable>refresh</replaceable></option></arg>
  30       <arg><option>-P <replaceable>purge</replaceable></option></arg>
  31       <arg><option>-D <replaceable></replaceable></option></arg>
  32       <arg><option>-E <replaceable>expiration</replaceable></option></arg>
  33       <arg><option>-e <replaceable></replaceable></option></arg>
  34       <arg><option>-v <replaceable>verbosity</replaceable></option></arg>
  35       <arg><option>-l <replaceable>filename</replaceable></option></arg>
  36       <arg><option>-V</option></arg>
  37       <arg><option>-h</option></arg>
  38       <!-- <arg rep='repeat'><option><replaceable>file</replaceable></option></arg> -->
  39     </cmdsynopsis>
  40   </refsynopsisdiv>
  41   <refsect1>
  42     <title>Description</title>
  43     <para>
  44       Main purpose of the utility <command>ortemanager</command> is debug and
  45       test ORTE communication.
  46     </para>
  47   </refsect1>
  48   <refsect1>
  49     <title>OPTIONS</title>
  50     <variablelist>
  51       <varlistentry>
  52         <term><option>-d</option> <option>--domain</option></term>
  53         <listitem>
  54           <para>
  55             The number of working ORTE domain. Default is 0.
  56           </para>
  57         </listitem>
  58       </varlistentry>
  59       <varlistentry>
  60         <term><option>-p</option> <option>--peers</option></term>
  61         <listitem>
  62           <para>
  63             The IP addresses parsipiates in RTPS communication.
  64             See <xref linkend="orte-manager"/> for example of usage.
  65           </para>
  66         </listitem>
  67       </varlistentry>
  68       <varlistentry>
  69         <term><option>-R</option> <option>--refresh</option></term>
  70         <listitem>
  71           <para>
  72             The refresh time in manager. Default 60 seconds.
  73           </para>
  74         </listitem>
  75       </varlistentry>
  76       <varlistentry>
  77         <term><option>-P</option> <option>--purge</option></term>
  78         <listitem>
  79           <para>
  80             The searching time in local database for finding expired application.
  81             Default 60 seconds.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term><option>-E</option> <option>--expiration</option></term>
  87         <listitem>
  88           <para>
  89             Expiration time in other applications.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93       <varlistentry>
  94         <term><option>-m</option> <option>--minimumSeparation</option></term>
  95         <listitem>
  96           <para>
  97             The minimum time between two issues.
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101       <varlistentry>
 102         <term><option>-v</option> <option>--verbosity</option></term>
 103         <listitem>
 104           <para>
 105             Set verbosity level.
 106           </para>
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term><option>-l</option> <option>--logfile</option></term>
 111         <listitem>
 112           <para>
 113             All debug messages can be redirect into specific file.
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term><option>-V</option> <option>--version</option>
 119         </term>
 120         <listitem>
 121           <para>
 122             Print the version of <command>ortemanager</command>.
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>-h</option> <option>--help</option>
 128         </term>
 129         <listitem>
 130           <para>
 131             Print usage screen.
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135     </variablelist>
 136   </refsect1>
 137   <!--
 138   <refsect1>
 139     <title>BACKWARDS COMPATIBILITY</title>
 140
 141     <para>
 142       This.
 143     </para>
 144   </refsect1>
 145   <refsect1>
 146     <title>ENVIRONMENT</title>
 147     <para>
 148       The.
 149     </para>
 150   </refsect1>
 151   <refsect1>
 152     <title>COPYRIGHT</title>
 153     <para>
 154       This.
 155     </para>
 156   </refsect1>
 157   <refsect1>
 158     <title>SEE ALSO</title>
 159     <para>
 160       <citerefentry>
 161         <refentrytitle>readburst</refentrytitle><manvolnum>5</manvolnum>
 162       </citerefentry>
 163     </para>
 164   </refsect1>
 165   -->
 166 </refentry>
 167