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