doc/yaz-ztest-man.xml

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