doc/gfs-options.xml

   1 <!--
   2    Options for generic frontend server and yaz-ztest.
   3    Included in both manual and man page for yaz-ztest
   4 -->
   5
   6 <variablelist>
   7  <varlistentry>
   8   <term><literal>-a </literal>
   9   <replaceable>file</replaceable></term>
  10   <listitem><para>
  11    Specify a file for dumping PDUs (for diagnostic purposes).
  12     The special name <literal>-</literal> (dash) sends output to
  13     <literal>stderr</literal>.
  14   </para></listitem>
  15  </varlistentry>
  16  <varlistentry>
  17   <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>
  25  </varlistentry>
  26  <varlistentry>
  27   <term><literal>-1</literal></term>
  28   <listitem><para>
  29    Like <literal>-S</literal> but after one session the server
  30    exits. This mode is for debugging <emphasis>only</emphasis>.
  31  </para></listitem>
  32  </varlistentry>
  33  <varlistentry>
  34   <term><literal>-T</literal></term>
  35   <listitem><para>
  36    Operate the server in threaded mode. The server creates a thread
  37    for each connection rather than a fork a process. Only available
  38    on UNIX systems that offers POSIX threads.
  39   </para></listitem>
  40  </varlistentry>
  41  <varlistentry>
  42   <term><literal>-s</literal></term>
  43   <listitem><para>
  44    Use the SR protocol (obsolete).
  45  </para></listitem>
  46  </varlistentry>
  47  <varlistentry>
  48   <term><literal>-z</literal></term>
  49   <listitem><para>
  50    Use the Z39.50 protocol (default). This option and <literal>-s</literal>
  51    complement each other.
  52    You can use both multiple times on the same command
  53    line, between listener-specifications (see below). This way, you
  54    can set up the server to listen for connections in both protocols
  55    concurrently, on different local ports.
  56   </para></listitem>
  57  </varlistentry>
  58  <varlistentry>
  59   <term><literal>-l </literal><replaceable>file</replaceable></term>
  60   <listitem><para>The logfile.
  61   </para></listitem>
  62  </varlistentry>
  63  <varlistentry>
  64   <term><literal>-c </literal><replaceable>config</replaceable></term>
  65   <listitem><para>A user option that serves as a specifier for some
  66   sort of configuration, usually a filename.
  67   The argument to this option is transferred to member
  68   <literal>configname</literal> of the
  69   <literal>statserv_options_block</literal>.
  70   </para></listitem>
  71  </varlistentry>
  72  <varlistentry>
  73   <term><literal>-f </literal><replaceable>vconfig</replaceable></term>
  74   <listitem><para>This specifies an XML file that describes
  75   one or more YAZ frontend virtual servers.
  76   </para></listitem>
  77  </varlistentry>
  78  <varlistentry>
  79   <term><literal>-C </literal><replaceable>fname</replaceable></term>
  80   <listitem><para>Sets SSL certificate file name for server (PEM).
  81  </para></listitem>
  82  </varlistentry>
  83  <varlistentry>
  84   <term><literal>-v </literal><replaceable>level</replaceable></term>
  85   <listitem><para>
  86    The log level. Use a comma-separated list of members of the set
  87    {fatal,debug,warn,log,malloc,all,none}.
  88   </para></listitem>
  89  </varlistentry>
  90  <varlistentry>
  91   <term><literal>-u </literal><replaceable>uid</replaceable></term>
  92   <listitem><para>
  93    Set user ID. Sets the real UID of the server process to that of the
  94    given user. It's useful if you aren't comfortable with having the
  95    server run as root, but you need to start it as such to bind a
  96    privileged port.
  97   </para></listitem>
  98  </varlistentry>
  99  <varlistentry>
 100   <term><literal>-w </literal><replaceable>dir</replaceable></term>
 101   <listitem><para>
 102    The server changes to this directory during before listening
 103    on incoming connections. This option is useful
 104    when the server is operating from the <application>inetd</application>
 105    daemon (see <literal>-i</literal>).
 106   </para></listitem>
 107  </varlistentry>
 108  <varlistentry><term>
 109   <literal>-p </literal><replaceable>pidfile</replaceable>
 110  </term>
 111  <listitem><para>
 112   Specifies that the server should write its Process ID to
 113   file given by <replaceable>pidfile</replaceable>.
 114   A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
 115  </para></listitem>
 116  </varlistentry>
 117  <varlistentry>
 118   <term><literal>-i</literal></term>
 119   <listitem><para>
 120    Use this to make the the server run from the
 121    <application>inetd</application> server (UNIX only).
 122  </para></listitem>
 123  </varlistentry>
 124  <varlistentry>
 125   <term><literal>-D</literal></term>
 126   <listitem><para>
 127    Use this to make the server put itself in the background and
 128    run as a daemon. If neither <literal>-i</literal> nor
 129    <literal>-D</literal> is given, the server starts in the foreground.
 130   </para></listitem>
 131  </varlistentry>
 132  <varlistentry>
 133   <term><literal>-install</literal></term>
 134   <listitem><para>
 135    Use this to install the server as an NT service
 136    (Windows NT/2000/XP only).
 137    Control the server by going to the Services in the Control Panel.
 138  </para></listitem>
 139  </varlistentry>
 140  <varlistentry>
 141   <term><literal>-installa</literal></term>
 142   <listitem><para>
 143    Use this to install the server as an NT service and mark it as "auto-start.
 144    Control the server by going to the Services in the Control Panel.
 145   </para></listitem>
 146  </varlistentry>
 147  <varlistentry>
 148   <term><literal>-remove</literal></term>
 149   <listitem><para>
 150    Use this to remove the server from the NT services
 151    (Windows NT/2000/XP only).
 152  </para></listitem>
 153  </varlistentry>
 154  <varlistentry>
 155   <term><literal>-t </literal><replaceable>minutes</replaceable></term>
 156   <listitem><para>
 157    Idle session timeout, in minutes.
 158  </para></listitem>
 159  </varlistentry>
 160  <varlistentry>
 161   <term><literal>-k </literal><replaceable>size</replaceable></term>
 162   <listitem><para>
 163    Maximum record size/message size, in kilobytes.
 164   </para></listitem>
 165  </varlistentry>
 166  <varlistentry>
 167   <term><literal>-K</literal></term>
 168   <listitem><para>
 169    Forces no-keepalive for HTTP sessions. By default GFS will keep
 170    sessions alive for HTTP 1.1 sessions (as defined by the standard).
 171    Using this option will force GFS to close the connection for each
 172    operation.
 173   </para></listitem>
 174  </varlistentry>
 175  <varlistentry>
 176   <term><literal>-r </literal><replaceable>size</replaceable></term>
 177   <listitem><para>
 178    Maximum size of log file before rotation occurs, in kilobytes.
 179    Default size is 1048576 k (=1 GB).
 180   </para></listitem>
 181  </varlistentry>
 182  <varlistentry>
 183   <term>
 184    <literal>-d </literal><replaceable>daemon</replaceable>
 185   </term>
 186   <listitem><para>
 187    Set name of daemon to be used in hosts access file.
 188    See
 189    <citerefentry>
 190     <refentrytitle>hosts_access</refentrytitle>
 191     <manvolnum>5</manvolnum>
 192    </citerefentry>
 193    and
 194    <citerefentry>
 195     <refentrytitle>tcpd</refentrytitle>
 196     <manvolnum>8</manvolnum>
 197     </citerefentry>.
 198   </para></listitem>
 199  </varlistentry>
 200  <varlistentry>
 201   <term><literal>-m </literal><replaceable>time-format</replaceable></term>
 202   <listitem><para>
 203    Sets the format of time-stamps in the log-file. Specify a string in
 204    the input format to <literal>strftime()</literal>.
 205   </para></listitem>
 206  </varlistentry>
 207  <varlistentry>
 208   <term><literal>-V </literal></term>
 209   <listitem><para>
 210    Display YAZ version and exit.
 211   </para></listitem>
 212  </varlistentry>
 213 </variablelist>
 214
 215 <!-- Keep this comment at the end of the file
 216 Local variables:
 217 mode: nxml
 218 nxml-child-indent: 1
 219 End:
 220 -->