Renamed ztest-options.xml to gfs-options.xml. Added GFS common synopsis
authorAdam Dickmeiss <adam@indexdata.dk>
Sun, 13 Mar 2005 21:43:00 +0000 (21:43 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Sun, 13 Mar 2005 21:43:00 +0000 (21:43 +0000)
to gfs-synopsis.xml. Initial work on GFS virtual hosts.

doc/Makefile.am
doc/frontend.xml
doc/gfs-options.xml [new file with mode: 0644]
doc/gfs-synopsis.xml [new file with mode: 0644]
doc/gfs-virtual.xml [new file with mode: 0644]
doc/yaz-ztest-man.xml
doc/yaz.xml.in
doc/ztest-options.xml [deleted file]

index ba7fab7..de7ecd6 100644 (file)
@@ -1,11 +1,11 @@
-## $Id: Makefile.am,v 1.58 2004-12-15 09:10:12 adam Exp $
+## $Id: Makefile.am,v 1.59 2005-03-13 21:43:00 adam Exp $
 
 docdir=$(datadir)/doc/@PACKAGE@
 
 XMLFILES=yaz.xml.in introduction.xml installation.xml indexdata.xml \
  asn.xml tools.xml odr.xml comstack.xml frontend.xml license.xml \
- future.xml client.xml zoom.xml credits.xml ztest-options.xml \
- yaz-client-commands.xml soap.xml
+ future.xml client.xml zoom.xml credits.xml gfs-options.xml \
+ yaz-client-commands.xml soap.xml gfs-virtual.xml gfs-synopsis.xml
 
 HTMLFILES = \
  asn.external.html asn.html asn.oid.html asn.pdu.html asn.preparing.html \
@@ -19,7 +19,8 @@ HTMLFILES = \
  license.html license.other.html odr.debugging.html odr.html \
  odr.programming.html odr.use.html server.backendfunctions.html \
  server.backend.html server.frontend.html server.html server.invocation.html \
- server.main.html soap.html soap.http.html soap.xml.html soap.srw.html \
+ server.main.html server.vhosts.html \
+ soap.html soap.http.html soap.xml.html soap.srw.html \
  tools.html tools.marc.html tools.nmem.html tools.log.html tools.oid.html \
  yaz.html zoom.events.html zoom.html zoom.options.html zoom.query.html \
  zoom.records.html zoom.resultsets.html zoom.scan.html
@@ -43,7 +44,7 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(man_MANS) $(REFFILES) \
 yaz-client.1: $(srcdir)/yaz-client-man.xml $(srcdir)/yaz-client-commands.xml
        docbook2man $(srcdir)/yaz-client-man.xml
 
-yaz-ztest.8: yaz-ztest-man.xml ztest-options.xml
+yaz-ztest.8: yaz-ztest-man.xml gfs-options.xml gfs-synopsis.xml gfs-virtual.xml
        docbook2man $(srcdir)/yaz-ztest-man.xml
 
 yaz-config.8: yaz-config-man.xml
index 2ff6ed9..7ab9e83 100644 (file)
@@ -1,4 +1,4 @@
-<!-- $Id: frontend.xml,v 1.23 2004-06-15 09:33:12 adam Exp $ -->
+<!-- $Id: frontend.xml,v 1.24 2005-03-13 21:43:00 adam Exp $ -->
  <chapter id="server"><title>Generic server</title>
   <sect1><title>Introduction</title>
    
@@ -726,31 +726,13 @@ typedef struct bend_scan_rr {
     The finished application has the following
     invocation syntax (by way of <function>statserv_main()</function>):
    </para>
-   
-   <cmdsynopsis>
-    <command>appname</command>
-    <arg choice="opt"><option>-install</option></arg>
-    <arg choice="opt"><option>-installa</option></arg>
-    <arg choice="opt"><option>-remove</option></arg>
-    <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
-    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
-    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
-    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
-    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
-    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
-    <sbr/>
-    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
-    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
-    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
-    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
-    <arg choice="opt"><option>-ziDST1</option></arg>
-    <arg choice="opt" rep="repeat">listener-spec</arg>
-   </cmdsynopsis>
+
+   &gfs-synopsis;
    
    <para>
     The options are:
 
-    &ztest-options;
+    &gfs-options;
 
    </para>
    
@@ -832,6 +814,9 @@ typedef struct bend_scan_rr {
     </para>
    </example>
   </sect1>
+  <sect1 id="server.vhosts"><title>Virtual hosts</title>
+     &gfs-virtual;
+  </sect1>
  </chapter>
  
  <!-- Keep this comment at the end of the file
diff --git a/doc/gfs-options.xml b/doc/gfs-options.xml
new file mode 100644 (file)
index 0000000..6d56637
--- /dev/null
@@ -0,0 +1,190 @@
+<!-- 
+   $Id: gfs-options.xml,v 1.1 2005-03-13 21:43:00 adam Exp $
+   Options for generic frontend server and yaz-ztest.
+   Included in both manual and man page for yaz-ztest
+-->
+
+<variablelist>
+ <varlistentry><term><literal>-a </literal>
+   <replaceable>file</replaceable></term>
+  <listitem><para>
+    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>
+  <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>
+  <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>
+  <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>
+  <listitem><para>The logfile.
+   </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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <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>
+  <listitem><para>
+    Idle session timeout, in minutes.
+   </para></listitem></varlistentry>
+ <varlistentry><term><literal>-k </literal>
+   <replaceable>size</replaceable></term>
+  <listitem><para>
+    Maximum record size/message size, in kilobytes.
+   </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>
+    </citerefentry>.
+   </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
+End:
+-->
diff --git a/doc/gfs-synopsis.xml b/doc/gfs-synopsis.xml
new file mode 100644 (file)
index 0000000..ef76933
--- /dev/null
@@ -0,0 +1,41 @@
+<!-- 
+   $Id: gfs-synopsis.xml,v 1.1 2005-03-13 21:43:00 adam Exp $
+   cmd description of YAZ GFS application.
+   Included in both manual and man page for yaz-ztest
+-->
+
+<cmdsynopsis>
+ <command>&gfs-synopsis-app;</command>
+ <arg choice="opt"><option>-install</option></arg>
+ <arg choice="opt"><option>-installa</option></arg>
+ <arg choice="opt"><option>-remove</option></arg>
+ <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
+ <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
+ <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
+ <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
+ <arg choice="opt"><option>-f <replaceable>vconfig</replaceable></option></arg>
+ <arg choice="opt"><option>-C <replaceable>fname</replaceable></option></arg>
+ <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
+ <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
+ <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
+ <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
+ <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
+ <arg choice="opt"><option>-ziDST1</option></arg>
+ <arg choice="opt" rep="repeat">listener-spec</arg>
+</cmdsynopsis>
+
+<!-- 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
+End:
+-->
diff --git a/doc/gfs-virtual.xml b/doc/gfs-virtual.xml
new file mode 100644 (file)
index 0000000..d307f62
--- /dev/null
@@ -0,0 +1,89 @@
+<!-- 
+   $Id: gfs-virtual.xml,v 1.1 2005-03-13 21:43:00 adam Exp $
+   Description of the virtual hosts mechanism in YAZ GFS
+   Included in both manual and man page for yaz-ztest
+-->
+
+<para>
+ The Virtual hosts mechanism allows a YAZ frontend server to
+ support multiple backends. A backend is selected on the basis of
+ the TCP/IP binding (port+listening adddress) and/or the virtual host.
+</para>
+<para>
+ For the HTTP protocol, the virtual host is specified in the Host header.
+ For the Z39.50 protocol, the virtual host is specified as in the
+ Initialize Request in the OtherInfo, OID 1.2.840.10003.10.1000.81.1.
+</para>
+<note>
+ <para>
+  Not all Z39.50 clients allows the VHOST information to be set.
+  For those the selection of the backend must rely on the
+  TCP/IP information alone (port and address).
+ </para>
+</note>
+<para>
+ The YAZ frontend server uses XML to describe the backend
+ configurations. Command-line option <literal>-f</literal> 
+ specifies filename of the XML configuration.
+</para>
+<para>
+ The configuration uses the root element <literal>yazgfs</literal>.
+ This element includes a list of <literal>listen</literal> elements,
+ followed by one or more <literal>server</literal> elements.
+</para>
+<para>
+ The <literal>listen</literal> describes listener (transport end point),
+ such as TCP/IP, Unix file socket or SSL server.
+</para>
+<para>
+ The <literal>server</literal> describes a server and includes sub
+ elements which servers as parameters for this server.
+</para>
+<para>
+ The XML below configures a server with 2 listeners and 3 backend
+ servers. The server listens on port 9900 and 9901 identified 
+ with references "public9900" and "public9901".
+
+ [More to be written]
+ <screen>
+  <![CDATA[
+<yazgfs>
+  <listen id="public9900">tcp:@:9900</listen>
+  <listen id="public9901">tcp:@:9901</listen>
+  <server>
+    <host>host1</host>
+    <directory>/var/www/s1</directory>
+    <config>zebra1.cfg</config>
+  </server>
+  <server>
+    <host>host2</host>
+    <directory>/var/www/s2</directory>
+    <config>zebra2.cfg</config>
+  </server>
+  <server listenref="public9901">
+    <directory>/var/www/s3</directory>
+    <config>zebra3.cfg</config>
+    <cql2rpn>../etc/pqf.properties</cql2rpn>
+    <explain>
+      <my>explain</my>
+    </explain>
+  </server>
+ </yazgfs>
+]]>
+ </screen>
+</para>
+
+<!-- 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
+End:
+-->
index f0776cc..094a588 100644 (file)
@@ -1,7 +1,10 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-     <!ENTITY ztest-options SYSTEM "ztest-options.xml">
+     <!ENTITY gfs-options SYSTEM "gfs-options.xml">
+     <!ENTITY gfs-virtual SYSTEM "gfs-virtual.xml">
+     <!ENTITY gfs-synopsis SYSTEM "gfs-synopsis.xml">
+     <!ENTITY gfs-synopsis-app "yaz-ztest">
 ]>
-<!-- $Id: yaz-ztest-man.xml,v 1.5 2004-05-10 10:46:26 adam Exp $ -->
+<!-- $Id: yaz-ztest-man.xml,v 1.6 2005-03-13 21:43:00 adam Exp $ -->
 <refentry id="yaz-ztest">
  
  <refmeta>
  </refnamediv>
  
  <refsynopsisdiv>
-  <cmdsynopsis>
-   <command>yaz-ztest</command>
-   <arg choice="opt"><option>-install</option></arg>
-   <arg choice="opt"><option>-installa</option></arg>
-   <arg choice="opt"><option>-remove</option></arg>
-   <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
-   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
-   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
-   <arg choice="opt"><option>-C <replaceable>fname</replaceable></option></arg>
-   <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
-   <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
-   <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
-   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
-   <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
-   <arg choice="opt"><option>-ziDST1</option></arg>
-   <arg choice="opt" rep="repeat">listener-spec</arg>
-  </cmdsynopsis>
-
+  &gfs-synopsis;
  </refsynopsisdiv>
  <refsect1><title>DESCRIPTION</title>
   <para>
    The server acts as a real Z39.50 server but does not use a database.
    It returns a random hit count and returns a subset of a few built-in
    records.
-   </para>
-   <para>
-    The <replaceable>listener-spec</replaceable> consists of a transport
-    mode followed by a colon, followed by a listener address. The
-    transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
-    or <literal>ssl</literal>.
-   </para>
-   <para>
-    For TCP and SSL, an address has the form:
-    <screen>
-     hostname | IP-number [ : portnumber ]
-    </screen>
-   </para>
-   <para>
-    For UNIX local socket the address is the filename of the local socket.
-   </para>
-  </refsect1>
-  <refsect1>
-   <title>OPTIONS</title>
-   &ztest-options;
-  </refsect1>
-  <refsect1><title>FILES</title>
-   <para>
-    <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
-   </para>
-   <para>
-    <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
-   </para>
-  </refsect1>
-  <refsect1><title>SEE ALSO</title>
-   <para>
-    <citerefentry>
-     <refentrytitle>yaz</refentrytitle>
-     <manvolnum>7</manvolnum></citerefentry>
-   </para>
-   <para>
-    Section "Generic server" in the YAZ manual.
-   </para>
-  </refsect1>
+  </para>
+  <para>
+   The <replaceable>listener-spec</replaceable> consists of a transport
+   mode followed by a colon, followed by a listener address. The
+   transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
+   or <literal>ssl</literal>.
+  </para>
+  <para>
+   For TCP and SSL, an address has the form:
+   <screen>
+    hostname | IP-number [ : portnumber ]
+   </screen>
+  </para>
+  <para>
+   For UNIX local socket the address is the filename of the local socket.
+  </para>
+ </refsect1>
+ <refsect1>
+  <title>OPTIONS</title>
+  &gfs-options;
+ </refsect1>
+ <refsect1><title>FILES</title>
+  <para>
+   <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
+  </para>
+  <para>
+   <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
+  </para>
+ </refsect1>
+ <refsect1><title>VIRTUAL HOSTS</title>
+  &gfs-virtual;
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>yaz</refentrytitle>
+    <manvolnum>7</manvolnum></citerefentry>
+  </para>
+  <para>
+   Section "Generic server" in the YAZ manual.
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
index 52202f4..ba3712a 100644 (file)
      <!ENTITY app-license SYSTEM "license.xml">
      <!ENTITY app-indexdata SYSTEM "indexdata.xml">
      <!ENTITY app-credits SYSTEM "credits.xml">
-     <!ENTITY ztest-options SYSTEM "ztest-options.xml">
+     <!ENTITY gfs-options SYSTEM "gfs-options.xml">
+     <!ENTITY gfs-synopsis SYSTEM "gfs-synopsis.xml">
+     <!ENTITY gfs-virtual SYSTEM "gfs-virtual.xml">
      <!ENTITY yaz-client-commands SYSTEM "yaz-client-commands.xml">
      <!ENTITY asn "Z39.50 ASN.1">
      <!ENTITY odr "<acronym>ODR</acronym>">
      <!ENTITY comstack "<acronym>COMSTACK</acronym>">
      <!ENTITY zoom "<acronym>ZOOM</acronym>">
+     <!ENTITY gfs-synopsis-app "application">
 ]>
-<!-- $Id: yaz.xml.in,v 1.15 2005-01-15 19:47:09 adam Exp $ -->
+<!-- $Id: yaz.xml.in,v 1.16 2005-03-13 21:43:00 adam Exp $ -->
 <book id="yaz">
  <bookinfo>
   <title>YAZ User&apos;s Guide and Reference</title>
diff --git a/doc/ztest-options.xml b/doc/ztest-options.xml
deleted file mode 100644 (file)
index f7c4f93..0000000
+++ /dev/null
@@ -1,184 +0,0 @@
-<!-- 
-   $Id: ztest-options.xml,v 1.5 2004-05-10 10:46:26 adam Exp $
-   Options for generic frontend server and yaz-ztest.
-   Included in both manual and man page for yaz-ztest
--->
-
-<variablelist>
- <varlistentry><term><literal>-a </literal>
-   <replaceable>file</replaceable></term>
-  <listitem><para>
-    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>
-  <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>
-  <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>
-  <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>
-  <listitem><para>The logfile.
-   </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>-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>
-  <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>
-  <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>
-  <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>
-  <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>
-  <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>
-  <listitem><para>
-    Idle session timeout, in minutes.
-   </para></listitem></varlistentry>
- <varlistentry><term><literal>-k </literal>
-   <replaceable>size</replaceable></term>
-  <listitem><para>
-    Maximum record size/message size, in kilobytes.
-   </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>
-    </citerefentry>.
-   </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
-End:
--->