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