doc/ztest-options.xml

   1 <!--
   2    $Id: ztest-options.xml,v 1.5 2004-05-10 10:46:26 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>-C </literal>
  69    <replaceable>fname</replaceable></term>
  70   <listitem><para>Sets SSL certificate file name for server (PEM).
  71    </para></listitem></varlistentry>
  72
  73  <varlistentry><term><literal>-v </literal>
  74    <replaceable>level</replaceable></term>
  75   <listitem><para>
  76     The log level. Use a comma-separated list of members of the set
  77     {fatal,debug,warn,log,malloc,all,none}.
  78    </para></listitem></varlistentry>
  79
  80  <varlistentry><term><literal>-u </literal>
  81    <replaceable>uid</replaceable></term>
  82   <listitem><para>
  83     Set user ID. Sets the real UID of the server process to that of the
  84     given user. It's useful if you aren't comfortable with having the
  85     server run as root, but you need to start it as such to bind a
  86     privileged port.
  87    </para></listitem></varlistentry>
  88
  89  <varlistentry><term><literal>-w </literal>
  90    <replaceable>dir</replaceable></term>
  91   <listitem><para>
  92     The server changes to this directory during before listening
  93     on incoming connections. This option is useful
  94     when the server is operating from the <application>inetd</application>
  95     daemon (see <literal>-i</literal>).
  96    </para></listitem></varlistentry>
  97
  98  <varlistentry><term><literal>-p </literal>
  99    <replaceable>pidfile</replaceable></term>
 100   <listitem><para>
 101     Specifies that the server should write its Process ID to
 102     file given by <replaceable>pidfile</replaceable>.
 103     A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
 104    </para></listitem></varlistentry>
 105
 106  <varlistentry><term><literal>-i</literal></term>
 107   <listitem><para>
 108     Use this to make the the server run from the
 109     <application>inetd</application> server (UNIX only).
 110    </para></listitem></varlistentry>
 111
 112  <varlistentry><term><literal>-D</literal></term>
 113   <listitem><para>
 114     Use this to make the server put itself in the background and
 115     run as a daemon. If neither <literal>-i</literal> nor
 116     <literal>-D</literal> is given, the server starts in the foreground.
 117    </para></listitem></varlistentry>
 118
 119  <varlistentry><term><literal>-install</literal></term>
 120   <listitem><para>
 121     Use this to install the server as an NT service
 122     (Windows NT/2000/XP only).
 123     Control the server by going to the Services in the Control Panel.
 124    </para></listitem></varlistentry>
 125
 126  <varlistentry><term><literal>-installa</literal></term>
 127   <listitem><para>
 128     Use this to install and activate the server as an NT service
 129     (Windows NT/2000/XP only).
 130     Control the server by going to the Services in the Control Panel.
 131    </para></listitem></varlistentry>
 132
 133  <varlistentry><term><literal>-remove</literal></term>
 134   <listitem><para>
 135     Use this to remove the server from the NT services
 136     (Windows NT/2000/XP only).
 137    </para></listitem></varlistentry>
 138
 139  <varlistentry><term><literal>-t </literal>
 140    <replaceable>minutes</replaceable></term>
 141   <listitem><para>
 142     Idle session timeout, in minutes.
 143    </para></listitem></varlistentry>
 144
 145  <varlistentry><term><literal>-k </literal>
 146    <replaceable>size</replaceable></term>
 147   <listitem><para>
 148     Maximum record size/message size, in kilobytes.
 149    </para></listitem>
 150  </varlistentry>
 151
 152  <varlistentry><term><literal>-d </literal>
 153    <replaceable>daemon</replaceable></term>
 154   <listitem><para>
 155     Set name of daemon to be used in hosts access file.
 156     See
 157     <citerefentry>
 158      <refentrytitle>hosts_access</refentrytitle>
 159      <manvolnum>5</manvolnum>
 160     </citerefentry>
 161     and
 162     <citerefentry>
 163      <refentrytitle>tcpd</refentrytitle>
 164      <manvolnum>8</manvolnum>
 165     </citerefentry>.
 166    </para></listitem>
 167  </varlistentry>
 168
 169 </variablelist>
 170
 171 <!-- Keep this comment at the end of the file
 172 Local variables:
 173 mode: sgml
 174 sgml-omittag:t
 175 sgml-shorttag:t
 176 sgml-minimize-attributes:nil
 177 sgml-always-quote-attributes:t
 178 sgml-indent-step:1
 179 sgml-indent-data:t
 180 sgml-parent-document: "yaz.xml"
 181 sgml-local-catalogs: nil
 182 sgml-namecase-general:t
 183 End:
 184 -->