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