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