man pages

[yaz-moved-to-github.git] / doc / ztest-options.xml

diff --git a/doc/ztest-options.xml b/doc/ztest-options.xml
new file mode 100644 (file)
index 0000000..3d08766
--- /dev/null
+++ b/doc/ztest-options.xml
@@ -0,0 +1,140 @@
+<!-- 
+   $Id: ztest-options.xml,v 1.1 2002-09-16 14:16:31 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, e.g. 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>-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>-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>-install</literal></term>
+  <listitem><para>
+    Use this to install the server as an NT service
+    (Windows 2000/NT 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 2000/NT 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>
+ 
+</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:
+-->