doc/yaz-ztest.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2      <!ENTITY ztest-options SYSTEM "ztest-options.xml">
   3 ]>
   4 <!-- $Id: yaz-ztest.sgml,v 1.1 2002-09-16 14:16:31 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>-a <replaceable>file</replaceable></option></arg>
  21    <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
  22    <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
  23    <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
  24    <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
  25    <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
  26    <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
  27    <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
  28    <arg choice="opt"><option>-ziST1</option></arg>
  29    <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
  30    <arg choice="opt" rep="repeat">listener-spec</arg>
  31   </cmdsynopsis>
  32
  33   <cmdsynopsis>
  34    <command>yaz-ztest-ssl</command>
  35    <arg rep="repeat" choice="opt"><option>option</option></arg>
  36    <arg choice="opt" rep="repeat">addr</arg>
  37   </cmdsynopsis>
  38
  39   <refsect1><title>DESCRIPTION</title>
  40    <para>
  41     <command>yaz-ztest</command> is a Z39.50 test server.
  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 build-in
  44     records.
  45    </para>
  46    <para>
  47     <command>yaz-ztest-ssl</command> is identical to
  48     <command>yaz-ztest</command> except that it supports SSL transport.
  49    </para>
  50    <para>
  51     The <replaceable>listener-spec</replaceable> consists of a transport
  52     mode followed by a colon, followed by a listener address. The
  53     transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
  54     or <literal>ssl</literal>.
  55    </para>
  56    <para>
  57     For TCP and SSL, an address has the form:
  58     <screen>
  59      hostname | IP-number [ : portnumber ]
  60     </screen>
  61    </para>
  62    <para>
  63     For UNIX local socket the address is the filename of the local socket.
  64    </para>
  65   </refsect1>
  66   <refsect1>
  67    <title>OPTIONS</title>
  68    &ztest-options;
  69   </refsect1>
  70   <refsect1><title>FILES</title>
  71    <para>
  72     <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
  73    </para>
  74    <para>
  75     <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
  76    </para>
  77   </refsect1>
  78   <refsect1><title>SEE ALSO</title>
  79    <para>
  80     yaz(7)
  81    </para>
  82    <para>
  83     Section "Generic server" in the YAZ manual.
  84    </para>
  85   </refsect1>
  86 </refentry>
  87
  88 <!-- Keep this comment at the end of the file
  89 Local variables:
  90 mode: sgml
  91 sgml-omittag:t
  92 sgml-shorttag:t
  93 sgml-minimize-attributes:nil
  94 sgml-always-quote-attributes:t
  95 sgml-indent-step:1
  96 sgml-indent-data:t
  97 sgml-parent-document:nil
  98 sgml-local-catalogs: nil
  99 sgml-namecase-general:t
 100 End:
 101 -->