X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fz3950_client.xml;h=893473774e918c698f185ad1290116241324fc9a;hb=b0c61b7f8b17d876c88347a96c246c47493140da;hp=56ac2f8fbf025d550e4b8afd73895d4cd3b3dc98;hpb=a7d0816d8e587b0743cdfda1cbb2321315be7946;p=metaproxy-moved-to-github.git

diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml
index 56ac2f8..8934737 100644
--- a/doc/z3950_client.xml
+++ b/doc/z3950_client.xml
@@ -1,9 +1,10 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: z3950_client.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
-<refentry>
+<refentry id="ref-z3950_client">
  <refmeta>
   <refentrytitle>z3950_client</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,21 +13,54 @@
  
  <refnamediv>
   <refname>z3950_client</refname>
-  <refpurpose>backend module Z39.50 client</refpurpose>
+  <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
-   This backend filter is a Z39.50 client.
+   This backend filter is a Z39.50 client. This modules
+   proxies all Z39.50 packages to a target. HTTP packages are ignored.
+   The address of the backend target (host) can be given as part of the
+   Initialize Request (Virtual host) or the default target may be specified
+   in the configuration.
+  </para>
+  <para>
+   <variablelist>
+    <varlistentry><term>timeout</term>
+     <listitem>
+      <para>
+       Specifies how long the client will wait for any request
+       before giving up. Default value is 30 seconds.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>default_target</term>
+     <listitem>
+      <para>
+       Specifies the target (host) for the Z39.50 server to be used
+       if the Init Request does not indicate otherwise.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>force_target</term>
+     <listitem>
+      <para>
+       Specifies the target (host) for the Z39.50 server to be used
+       always (regardless of Init Request vhost).
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
   </para>
  </refsect1>
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="z3950_client">
      <timeout>30</timeout>
+     <default_target>z3950.indexdata.dk</default_target>
     </filter>
 ]]>
    </screen>