Use entity idcommon rather than common. Fix acronym entities.
[yaz-moved-to-github.git] / doc / yaz-ztest-man.xml
index f0776cc..396b292 100644 (file)
@@ -1,8 +1,21 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-     <!ENTITY ztest-options SYSTEM "ztest-options.xml">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
+     <!ENTITY gfs-synopsis-app "yaz-ztest">
+     <!ENTITY reference-tools-cql-map 'section "Specifiction of CQL to RPN mappings"'>
 ]>
-<!-- $Id: yaz-ztest-man.xml,v 1.5 2004-05-10 10:46:26 adam Exp $ -->
+<!-- $Id: yaz-ztest-man.xml,v 1.16 2007-05-22 11:10:08 adam Exp $ -->
 <refentry id="yaz-ztest">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  
  <refmeta>
   <refentrytitle>yaz-ztest</refentrytitle>
  </refnamediv>
  
  <refsynopsisdiv>
-  <cmdsynopsis>
-   <command>yaz-ztest</command>
-   <arg choice="opt"><option>-install</option></arg>
-   <arg choice="opt"><option>-installa</option></arg>
-   <arg choice="opt"><option>-remove</option></arg>
-   <arg choice="opt"><option>-a <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-v <replaceable>level</replaceable></option></arg>
-   <arg choice="opt"><option>-l <replaceable>file</replaceable></option></arg>
-   <arg choice="opt"><option>-u <replaceable>uid</replaceable></option></arg>
-   <arg choice="opt"><option>-c <replaceable>config</replaceable></option></arg>
-   <arg choice="opt"><option>-C <replaceable>fname</replaceable></option></arg>
-   <arg choice="opt"><option>-t <replaceable>minutes</replaceable></option></arg>
-   <arg choice="opt"><option>-k <replaceable>kilobytes</replaceable></option></arg>
-   <arg choice="opt"><option>-d <replaceable>daemon</replaceable></option></arg>
-   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
-   <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
-   <arg choice="opt"><option>-ziDST1</option></arg>
-   <arg choice="opt" rep="repeat">listener-spec</arg>
-  </cmdsynopsis>
-
+  &gfs-synopsis;
  </refsynopsisdiv>
  <refsect1><title>DESCRIPTION</title>
   <para>
    <command>yaz-ztest</command> is a Z39.50 test server that uses
-   the YAZ frontend server API.
+   the YAZ generic frontend server API.
    The server acts as a real Z39.50 server but does not use a database.
    It returns a random hit count and returns a subset of a few built-in
    records.
-   </para>
-   <para>
-    The <replaceable>listener-spec</replaceable> consists of a transport
-    mode followed by a colon, followed by a listener address. The
-    transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
-    or <literal>ssl</literal>.
-   </para>
-   <para>
-    For TCP and SSL, an address has the form:
-    <screen>
-     hostname | IP-number [ : portnumber ]
-    </screen>
-   </para>
-   <para>
-    For UNIX local socket the address is the filename of the local socket.
-   </para>
-  </refsect1>
-  <refsect1>
-   <title>OPTIONS</title>
-   &ztest-options;
-  </refsect1>
-  <refsect1><title>FILES</title>
-   <para>
-    <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
-   </para>
-   <para>
-    <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
-   </para>
-  </refsect1>
-  <refsect1><title>SEE ALSO</title>
-   <para>
-    <citerefentry>
-     <refentrytitle>yaz</refentrytitle>
-     <manvolnum>7</manvolnum></citerefentry>
-   </para>
-   <para>
-    Section "Generic server" in the YAZ manual.
-   </para>
-  </refsect1>
+  </para>
+  <para>
+   The <replaceable>listener-spec</replaceable> consists of a transport
+   mode followed by a colon, followed by a listener address. The
+   transport mode is either <literal>tcp</literal>, <literal>unix</literal>,
+   or <literal>ssl</literal>.
+  </para>
+  <para>
+   For TCP and SSL, an address has the form:
+   <screen>
+    hostname | IP-number [ : portnumber ]
+   </screen>
+  </para>
+  <para>
+   For UNIX local socket the address is the filename of the local socket.
+  </para>
+ </refsect1>
+ <refsect1>
+  <title>OPTIONS</title>
+  &gfs-options;
+ </refsect1>
+ <refsect1><title>VIRTUAL HOSTS</title>
+  &gfs-virtual;
+ </refsect1>
+ <refsect1><title>FILES</title>
+  <para>
+   <filename>yaz-&lt;version&gt;/ztest/yaz-ztest.c</filename>
+  </para>
+  <para>
+   <filename>yaz-&lt;version&gt;/include/yaz/backend.h</filename>
+  </para>
+ </refsect1>
+ <refsect1 id="tools.retrieval"><title>Retrieval Facility</title>
+  <para>
+   Refer to the "Retrieval Facility" in the YAZ manual
+ </para>
+ </refsect1>
+ <refsect1 id="cql.to.rpn"><title>CQL to RPN conversions</title>
+  <para>
+   Refer to the "Specification of CQL to RPN mappings" in YAZ manual.
+  </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   <citerefentry>
+    <refentrytitle>yaz</refentrytitle>
+    <manvolnum>7</manvolnum>
+   </citerefentry>
+   <citerefentry>
+    <refentrytitle>yaz-log</refentrytitle>
+    <manvolnum>7</manvolnum>
+   </citerefentry>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file