doc/yaz-ztest-man.xml

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