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