doc/ztest-options.xml

   1 <!--
   2    $Id: ztest-options.xml,v 1.4 2004-01-17 01:20:12 adam Exp $
   3    Options for generic frontend server and yaz-ztest.
   4    Included in both manual and man page for yaz-ztest
   5 -->
   6
   7 <variablelist>
   8
   9  <varlistentry><term><literal>-a </literal>
  10    <replaceable>file</replaceable></term>
  11   <listitem><para>
  12     Specify a file for dumping PDUs (for diagnostic purposes).
  13     The special name <literal>-</literal> (dash) sends output to
  14     <literal>stderr</literal>.
  15    </para></listitem></varlistentry>
  16
  17  <varlistentry><term><literal>-S</literal></term>
  18   <listitem><para>
  19     Don't fork or make threads on connection requests. This is good for
  20     debugging, but not recommended for real operation: Although the
  21     server is asynchronous and non-blocking, it can be nice to keep
  22     a software malfunction (okay then, a crash) from affecting all
  23     current users.
  24    </para></listitem></varlistentry>
  25
  26  <varlistentry><term><literal>-1</literal></term>
  27   <listitem><para>
  28     Like <literal>-S</literal> but after one session the server
  29     exits. This mode is for debugging <emphasis>only</emphasis>.
  30    </para></listitem></varlistentry>
  31
  32  <varlistentry><term><literal>-T</literal></term>
  33   <listitem><para>
  34     Operate the server in threaded mode. The server creates a thread
  35     for each connection rather than a fork a process. Only available
  36     on UNIX systems that offers POSIX threads.
  37    </para></listitem></varlistentry>
  38
  39  <varlistentry><term><literal>-s</literal></term>
  40   <listitem><para>
  41     Use the SR protocol (obsolete).
  42    </para></listitem></varlistentry>
  43
  44  <varlistentry><term><literal>-z</literal></term>
  45   <listitem><para>
  46     Use the Z39.50 protocol (default). This option and <literal>-s</literal>
  47     complement each other.
  48     You can use both multiple times on the same command
  49     line, between listener-specifications (see below). This way, you
  50     can set up the server to listen for connections in both protocols
  51     concurrently, on different local ports.
  52    </para></listitem></varlistentry>
  53
  54  <varlistentry><term><literal>-l </literal>
  55    <replaceable>file</replaceable></term>
  56   <listitem><para>The logfile.
  57    </para></listitem></varlistentry>
  58
  59  <varlistentry><term><literal>-c </literal>
  60    <replaceable>config</replaceable></term>
  61   <listitem><para>A user option that serves as a specifier for some
  62     sort of configuration, usually a filename.
  63     The argument to this option is transferred to member
  64     <literal>configname</literal>of the
  65     <literal>statserv_options_block</literal>.
  66    </para></listitem></varlistentry>
  67
  68  <varlistentry><term><literal>-v </literal>
  69    <replaceable>level</replaceable></term>
  70   <listitem><para>
  71     The log level. Use a comma-separated list of members of the set
  72     {fatal,debug,warn,log,malloc,all,none}.
  73    </para></listitem></varlistentry>
  74
  75  <varlistentry><term><literal>-u </literal>
  76    <replaceable>uid</replaceable></term>
  77   <listitem><para>
  78     Set user ID. Sets the real UID of the server process to that of the
  79     given user. It's useful if you aren't comfortable with having the
  80     server run as root, but you need to start it as such to bind a
  81     privileged port.
  82    </para></listitem></varlistentry>
  83
  84  <varlistentry><term><literal>-w </literal>
  85    <replaceable>dir</replaceable></term>
  86   <listitem><para>
  87     The server changes to this directory during before listening
  88     on incoming connections. This option is useful
  89     when the server is operating from the <application>inetd</application>
  90     daemon (see <literal>-i</literal>).
  91    </para></listitem></varlistentry>
  92
  93  <varlistentry><term><literal>-p </literal>
  94    <replaceable>pidfile</replaceable></term>
  95   <listitem><para>
  96     Specifies that the server should write its Process ID to
  97     file given by <replaceable>pidfile</replaceable>.
  98     A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
  99    </para></listitem></varlistentry>
 100
 101  <varlistentry><term><literal>-i</literal></term>
 102   <listitem><para>
 103     Use this to make the the server run from the
 104     <application>inetd</application> server (UNIX only).
 105    </para></listitem></varlistentry>
 106
 107  <varlistentry><term><literal>-D</literal></term>
 108   <listitem><para>
 109     Use this to make the server put itself in the background and
 110     run as a daemon. If neither <literal>-i</literal> nor
 111     <literal>-D</literal> is given, the server starts in the foreground.
 112    </para></listitem></varlistentry>
 113
 114  <varlistentry><term><literal>-install</literal></term>
 115   <listitem><para>
 116     Use this to install the server as an NT service
 117     (Windows NT/2000/XP only).
 118     Control the server by going to the Services in the Control Panel.
 119    </para></listitem></varlistentry>
 120
 121  <varlistentry><term><literal>-installa</literal></term>
 122   <listitem><para>
 123     Use this to install and activate the server as an NT service
 124     (Windows NT/2000/XP only).
 125     Control the server by going to the Services in the Control Panel.
 126    </para></listitem></varlistentry>
 127
 128  <varlistentry><term><literal>-remove</literal></term>
 129   <listitem><para>
 130     Use this to remove the server from the NT services
 131     (Windows NT/2000/XP only).
 132    </para></listitem></varlistentry>
 133
 134  <varlistentry><term><literal>-t </literal>
 135    <replaceable>minutes</replaceable></term>
 136   <listitem><para>
 137     Idle session timeout, in minutes.
 138    </para></listitem></varlistentry>
 139
 140  <varlistentry><term><literal>-k </literal>
 141    <replaceable>size</replaceable></term>
 142   <listitem><para>
 143     Maximum record size/message size, in kilobytes.
 144    </para></listitem>
 145  </varlistentry>
 146
 147  <varlistentry><term><literal>-d </literal>
 148    <replaceable>daemon</replaceable></term>
 149   <listitem><para>
 150     Set name of daemon to be used in hosts access file.
 151     See
 152     <citerefentry>
 153      <refentrytitle>hosts_access</refentrytitle>
 154      <manvolnum>5</manvolnum>
 155     </citerefentry>
 156     and
 157     <citerefentry>
 158      <refentrytitle>tcpd</refentrytitle>
 159      <manvolnum>8</manvolnum>
 160     </citerefentry>.
 161    </para></listitem>
 162  </varlistentry>
 163
 164 </variablelist>
 165
 166 <!-- Keep this comment at the end of the file
 167 Local variables:
 168 mode: sgml
 169 sgml-omittag:t
 170 sgml-shorttag:t
 171 sgml-minimize-attributes:nil
 172 sgml-always-quote-attributes:t
 173 sgml-indent-step:1
 174 sgml-indent-data:t
 175 sgml-parent-document: "yaz.xml"
 176 sgml-local-catalogs: nil
 177 sgml-namecase-general:t
 178 End:
 179 -->