doc/gfs-options.xml

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