doc/yaz-ztest-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2      <!ENTITY ztest-options SYSTEM "ztest-options.xml">
   3 ]>
   4 <!-- $Id: yaz-ztest-man.xml,v 1.4 2004-04-28 22:44:59 adam Exp $ -->
   5 <refentry id="yaz-ztest">
   6
   7  <refmeta>
   8   <refentrytitle>yaz-ztest</refentrytitle>
   9   <manvolnum>8</manvolnum>
  10  </refmeta>
  11
  12  <refnamediv>
  13   <refname>yaz-ztest</refname>
  14   <refpurpose>Z39.50 Test Server</refpurpose>
  15  </refnamediv>
  16
  17  <refsynopsisdiv>
  18   <cmdsynopsis>
  19    <command>yaz-ztest</command>
  20    <arg choice="opt"><option>-install</option></arg>
  21    <arg choice="opt"><option>-installa</option></arg>
  22    <arg choice="opt"><option>-remove</option></arg>
  23    <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
  24    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
  25    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
  26    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
  27    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
  28    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
  29    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
  30    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
  31    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
  32    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
  33    <arg choice="opt"><option>-ziDST1</option></arg>
  34    <arg choice="opt" rep="repeat">listener-spec</arg>
  35   </cmdsynopsis>
  36
  37  </refsynopsisdiv>
  38  <refsect1><title>DESCRIPTION</title>
  39   <para>
  40    <command>yaz-ztest</command> is a Z39.50 test server that uses
  41    the YAZ frontend server API.
  42    The server acts as a real Z39.50 server but does not use a database.
  43    It returns a random hit count and returns a subset of a few built-in
  44    records.
  45    </para>
  46    <para>
  47     The <replaceable>listener-spec</replaceable> consists of a transport
  48     mode followed by a colon, followed by a listener address. The
  49     transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
  50     or <literal>ssl</literal>.
  51    </para>
  52    <para>
  53     For TCP and SSL, an address has the form:
  54     <screen>
  55      hostname | IP-number [ : portnumber ]
  56     </screen>
  57    </para>
  58    <para>
  59     For UNIX local socket the address is the filename of the local socket.
  60    </para>
  61   </refsect1>
  62   <refsect1>
  63    <title>OPTIONS</title>
  64    &ztest-options;
  65   </refsect1>
  66   <refsect1><title>FILES</title>
  67    <para>
  68     <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
  69    </para>
  70    <para>
  71     <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
  72    </para>
  73   </refsect1>
  74   <refsect1><title>SEE ALSO</title>
  75    <para>
  76     <citerefentry>
  77      <refentrytitle>yaz</refentrytitle>
  78      <manvolnum>7</manvolnum></citerefentry>
  79    </para>
  80    <para>
  81     Section "Generic server" in the YAZ manual.
  82    </para>
  83   </refsect1>
  84 </refentry>
  85
  86 <!-- Keep this comment at the end of the file
  87 Local variables:
  88 mode: sgml
  89 sgml-omittag:t
  90 sgml-shorttag:t
  91 sgml-minimize-attributes:nil
  92 sgml-always-quote-attributes:t
  93 sgml-indent-step:1
  94 sgml-indent-data:t
  95 sgml-parent-document:nil
  96 sgml-local-catalogs: nil
  97 sgml-namecase-general:t
  98 End:
  99 -->