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