z3950_client filter: force_apdu facility

[metaproxy-moved-to-github.git] / doc / sru_z3950.xml

diff --git a/doc/sru_z3950.xml b/doc/sru_z3950.xml
index 3454254..334b660 100644 (file)
--- a/doc/sru_z3950.xml
+++ b/doc/sru_z3950.xml
@@ -1,15 +1,19 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
-    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
- <!ENTITY % common SYSTEM "common/common.ent">
-     %common;
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: sru_z3950.xml,v 1.6 2007-05-09 21:23:08 adam Exp $ -->
 <refentry id="ref-sru_z3950">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>sru_z3950</refentrytitle>
   <manvolnum>3mp</manvolnum>
-  <refmiscinfo>Metaproxy Module</refmiscinfo>
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
  
  <refnamediv>
@@ -56,9 +60,30 @@
   <para>
    This filter does not handle CQL-to-PQF translations. In case that
    the backends do not understand CQL, you need to append the
-   <literal>cql_pqf</literal> metaproxy filter. This filter
-   still needs to be implemented.
-   </para>
+   <literal>cql_pqf</literal> metaproxy filter.
+  </para>
+  <para>
+    This module supports the following SRU extra parameters:
+    <variablelist>
+      <varlistentry>
+       <term>x-target</term>
+       <listitem>
+         <para>
+           Specifies backend Z39.50 target.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>x-max-sockets</term>
+       <listitem>
+         <para>
+           Specifies maximum number of sockets to use for a Z39.50 backend
+           client (for one given target host/db).
+         </para>
+       </listitem>
+      </varlistentry>
+    </variablelist>
+  </para>
  </refsect1>
 
  <refsect1><title>EXAMPLES</title>