Move main YAZ manual to book.xml; use nxml YAZ-758
[yaz-moved-to-github.git] / doc / gfs-options.xml
index af2f56b..233e68a 100644 (file)
 -->
 
 <variablelist>
-
- <varlistentry><term><literal>-a </literal>
-   <replaceable>file</replaceable></term>
+ <varlistentry>
+  <term><literal>-a </literal>
+  <replaceable>file</replaceable></term>
   <listitem><para>
-    Specify a file for dumping PDUs (for diagnostic purposes).
+   Specify a file for dumping PDUs (for diagnostic purposes).
     The special name <literal>-</literal> (dash) sends output to
     <literal>stderr</literal>.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-S</literal></term>
-  <listitem><para>
-    Don't fork or make threads on connection requests. This is good for
-    debugging, but not recommended for real operation: Although the
-    server is asynchronous and non-blocking, it can be nice to keep
-    a software malfunction (okay then, a crash) from affecting all
-    current users.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-1</literal></term>
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-S</literal></term>
+  <listitem><para>
+   Don't fork or make threads on connection requests. This is good for
+   debugging, but not recommended for real operation: Although the
+   server is asynchronous and non-blocking, it can be nice to keep
+   a software malfunction (okay then, a crash) from affecting all
+   current users.
+   </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-1</literal></term>
   <listitem><para>
-    Like <literal>-S</literal> but after one session the server
-    exits. This mode is for debugging <emphasis>only</emphasis>.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-T</literal></term>
+   Like <literal>-S</literal> but after one session the server
+   exits. This mode is for debugging <emphasis>only</emphasis>.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-T</literal></term>
   <listitem><para>
-    Operate the server in threaded mode. The server creates a thread
-    for each connection rather than a fork a process. Only available
-    on UNIX systems that offers POSIX threads.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-s</literal></term>
+   Operate the server in threaded mode. The server creates a thread
+   for each connection rather than a fork a process. Only available
+   on UNIX systems that offers POSIX threads.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-s</literal></term>
   <listitem><para>
-    Use the SR protocol (obsolete).
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-z</literal></term>
-  <listitem><para>
-    Use the Z39.50 protocol (default). This option and <literal>-s</literal>
-    complement each other.
-    You can use both multiple times on the same command
-    line, between listener-specifications (see below). This way, you
-    can set up the server to listen for connections in both protocols
-    concurrently, on different local ports.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-l </literal>
-   <replaceable>file</replaceable></term>
+   Use the SR protocol (obsolete).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-z</literal></term>
+  <listitem><para>
+   Use the Z39.50 protocol (default). This option and <literal>-s</literal>
+   complement each other.
+   You can use both multiple times on the same command
+   line, between listener-specifications (see below). This way, you
+   can set up the server to listen for connections in both protocols
+   concurrently, on different local ports.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-l </literal><replaceable>file</replaceable></term>
   <listitem><para>The logfile.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-c </literal>
-   <replaceable>config</replaceable></term>
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-c </literal><replaceable>config</replaceable></term>
   <listitem><para>A user option that serves as a specifier for some
-    sort of configuration, usually a filename.
-    The argument to this option is transferred to member
-    <literal>configname</literal> of the
-    <literal>statserv_options_block</literal>.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-f </literal>
-   <replaceable>vconfig</replaceable></term>
+  sort of configuration, usually a filename.
+  The argument to this option is transferred to member
+  <literal>configname</literal> of the
+  <literal>statserv_options_block</literal>.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-f </literal><replaceable>vconfig</replaceable></term>
   <listitem><para>This specifies an XML file that describes
-    one or more YAZ frontend virtual servers.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-C </literal>
-   <replaceable>fname</replaceable></term>
+  one or more YAZ frontend virtual servers.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-C </literal><replaceable>fname</replaceable></term>
   <listitem><para>Sets SSL certificate file name for server (PEM).
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-v </literal>
-   <replaceable>level</replaceable></term>
-  <listitem><para>
-    The log level. Use a comma-separated list of members of the set
-    {fatal,debug,warn,log,malloc,all,none}.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-u </literal>
-   <replaceable>uid</replaceable></term>
-  <listitem><para>
-    Set user ID. Sets the real UID of the server process to that of the
-    given user. It's useful if you aren't comfortable with having the
-    server run as root, but you need to start it as such to bind a
-    privileged port.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-w </literal>
-   <replaceable>dir</replaceable></term>
-  <listitem><para>
-    The server changes to this directory during before listening
-    on incoming connections. This option is useful
-    when the server is operating from the <application>inetd</application>
-    daemon (see <literal>-i</literal>).
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-p </literal>
-   <replaceable>pidfile</replaceable></term>
-  <listitem><para>
-    Specifies that the server should write its Process ID to
-    file given by <replaceable>pidfile</replaceable>.
-    A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-i</literal></term>
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-v </literal><replaceable>level</replaceable></term>
   <listitem><para>
-    Use this to make the the server run from the
-    <application>inetd</application> server (UNIX only).
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-D</literal></term>
+   The log level. Use a comma-separated list of members of the set
+   {fatal,debug,warn,log,malloc,all,none}.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-u </literal><replaceable>uid</replaceable></term>
+  <listitem><para>
+   Set user ID. Sets the real UID of the server process to that of the
+   given user. It's useful if you aren't comfortable with having the
+   server run as root, but you need to start it as such to bind a
+   privileged port.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-w </literal><replaceable>dir</replaceable></term>
+  <listitem><para>
+   The server changes to this directory during before listening
+   on incoming connections. This option is useful
+   when the server is operating from the <application>inetd</application>
+   daemon (see <literal>-i</literal>).
+  </para></listitem>
+ </varlistentry>
+ <varlistentry><term>
+  <literal>-p </literal><replaceable>pidfile</replaceable>
+ </term>
+ <listitem><para>
+  Specifies that the server should write its Process ID to
+  file given by <replaceable>pidfile</replaceable>.
+  A typical location would be <filename>/var/run/yaz-ztest.pid</filename>.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-i</literal></term>
   <listitem><para>
-    Use this to make the server put itself in the background and
-    run as a daemon. If neither <literal>-i</literal> nor
-    <literal>-D</literal> is given, the server starts in the foreground.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-install</literal></term>
+   Use this to make the the server run from the
+   <application>inetd</application> server (UNIX only).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-D</literal></term>
   <listitem><para>
-    Use this to install the server as an NT service
-    (Windows NT/2000/XP only).
-    Control the server by going to the Services in the Control Panel.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-installa</literal></term>
+   Use this to make the server put itself in the background and
+   run as a daemon. If neither <literal>-i</literal> nor
+   <literal>-D</literal> is given, the server starts in the foreground.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-install</literal></term>
   <listitem><para>
-    Use this to install and activate the server as an NT service
-    (Windows NT/2000/XP only).
-    Control the server by going to the Services in the Control Panel.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-remove</literal></term>
+   Use this to install the server as an NT service
+   (Windows NT/2000/XP only).
+   Control the server by going to the Services in the Control Panel.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-installa</literal></term>
   <listitem><para>
-    Use this to remove the server from the NT services
-    (Windows NT/2000/XP only).
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-t </literal>
-   <replaceable>minutes</replaceable></term>
+   Use this to install and activate the server as an NT service
+   (Windows NT/2000/XP only).
+   Control the server by going to the Services in the Control Panel.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-remove</literal></term>
   <listitem><para>
-    Idle session timeout, in minutes.
-   </para></listitem></varlistentry>
-
- <varlistentry><term><literal>-k </literal>
-   <replaceable>size</replaceable></term>
+   Use this to remove the server from the NT services
+   (Windows NT/2000/XP only).
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-t </literal><replaceable>minutes</replaceable></term>
   <listitem><para>
-    Maximum record size/message size, in kilobytes.
-   </para></listitem>
+   Idle session timeout, in minutes.
+ </para></listitem>
  </varlistentry>
-
- <varlistentry><term><literal>-K</literal></term>
+ <varlistentry>
+  <term><literal>-k </literal><replaceable>size</replaceable></term>
   <listitem><para>
-    Forces no-keepalive for HTTP sessions. By default GFS will keep
-    sessions alive for HTTP 1.1 sessions (as defined by the standard).
-    Using this option will force GFS to close the connection for each
-    operation.
-   </para></listitem>
+   Maximum record size/message size, in kilobytes.
+  </para></listitem>
  </varlistentry>
-
- <varlistentry><term><literal>-r </literal>
-   <replaceable>size</replaceable></term>
+ <varlistentry>
+  <term><literal>-K</literal></term>
+  <listitem><para>
+   Forces no-keepalive for HTTP sessions. By default GFS will keep
+   sessions alive for HTTP 1.1 sessions (as defined by the standard).
+   Using this option will force GFS to close the connection for each
+   operation.
+  </para></listitem>
+ </varlistentry>
+ <varlistentry>
+  <term><literal>-r </literal><replaceable>size</replaceable></term>
   <listitem><para>
-    Maximum size of log file before rotation occurs, in kilobytes.
-    Default size is 1048576 k (=1 GB).
-   </para></listitem>
+   Maximum size of log file before rotation occurs, in kilobytes.
+   Default size is 1048576 k (=1 GB).
+  </para></listitem>
  </varlistentry>
-
- <varlistentry><term><literal>-d </literal>
-   <replaceable>daemon</replaceable></term>
-  <listitem><para>
-    Set name of daemon to be used in hosts access file.
-    See
-    <citerefentry>
-     <refentrytitle>hosts_access</refentrytitle>
-     <manvolnum>5</manvolnum>
-    </citerefentry>
-    and
-    <citerefentry>
-     <refentrytitle>tcpd</refentrytitle>
-     <manvolnum>8</manvolnum>
+ <varlistentry>
+  <term>
+   <literal>-d </literal><replaceable>daemon</replaceable>
+  </term>
+  <listitem><para>
+   Set name of daemon to be used in hosts access file.
+   See
+   <citerefentry>
+    <refentrytitle>hosts_access</refentrytitle>
+    <manvolnum>5</manvolnum>
+   </citerefentry>
+   and
+   <citerefentry>
+    <refentrytitle>tcpd</refentrytitle>
+    <manvolnum>8</manvolnum>
     </citerefentry>.
-   </para></listitem>
+  </para></listitem>
  </varlistentry>
-
- <varlistentry><term><literal>-m </literal>
-   <replaceable>time-format</replaceable></term>
+ <varlistentry>
+  <term><literal>-m </literal><replaceable>time-format</replaceable></term>
   <listitem><para>
    Sets the format of time-stamps in the log-file. Specify a string in
    the input format to <literal>strftime()</literal>.
-   </para></listitem>
+  </para></listitem>
  </varlistentry>
-
- <varlistentry><term><literal>-V </literal></term>
+ <varlistentry>
+  <term><literal>-V </literal></term>
   <listitem><para>
    Display YAZ version and exit.
-   </para></listitem>
+  </para></listitem>
  </varlistentry>
-
 </variablelist>
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document: "yaz.xml"
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->