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.1 2003-10-27 12:21:24 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>-w <replaceable>dir</replaceable></option></arg>
  29    <arg choice="opt"><option>-ziST1</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  </refsynopsisdiv>
  40   <refsect1><title>DESCRIPTION</title>
  41    <para>
  42     <command>yaz-ztest</command> is a Z39.50 test server.
  43     The server acts as a real Z39.50 server but does not use a database.
  44     It returns a random hit count and returns a subset of a few built-in
  45     records.
  46    </para>
  47    <para>
  48     <command>yaz-ztest-ssl</command> is identical to
  49     <command>yaz-ztest</command> except that it supports SSL transport.
  50    </para>
  51    <para>
  52     The <replaceable>listener-spec</replaceable> consists of a transport
  53     mode followed by a colon, followed by a listener address. The
  54     transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
  55     or <literal>ssl</literal> (<command>yaz-ztest-ssl</command> only).
  56    </para>
  57    <para>
  58     For TCP and SSL, an address has the form:
  59     <screen>
  60      hostname | IP-number [ : portnumber ]
  61     </screen>
  62    </para>
  63    <para>
  64     For UNIX local socket the address is the filename of the local socket.
  65    </para>
  66   </refsect1>
  67   <refsect1>
  68    <title>OPTIONS</title>
  69    &ztest-options;
  70   </refsect1>
  71   <refsect1><title>FILES</title>
  72    <para>
  73     <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
  74    </para>
  75    <para>
  76     <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
  77    </para>
  78   </refsect1>
  79   <refsect1><title>SEE ALSO</title>
  80    <para>
  81     <citerefentry>
  82      <refentrytitle>yaz</refentrytitle>
  83      <manvolnum>7</manvolnum></citerefentry>
  84    </para>
  85    <para>
  86     Section "Generic server" in the YAZ manual.
  87    </para>
  88   </refsect1>
  89 </refentry>
  90
  91 <!-- Keep this comment at the end of the file
  92 Local variables:
  93 mode: sgml
  94 sgml-omittag:t
  95 sgml-shorttag:t
  96 sgml-minimize-attributes:nil
  97 sgml-always-quote-attributes:t
  98 sgml-indent-step:1
  99 sgml-indent-data:t
 100 sgml-parent-document:nil
 101 sgml-local-catalogs: nil
 102 sgml-namecase-general:t
 103 End:
 104 -->