Replace indexdata.dk/gils with z3950.indexdata.com MP-624

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

diff --git a/doc/z3950_client.xml b/doc/z3950_client.xml
index 68cb126..ff59c11 100644 (file)
--- a/doc/z3950_client.xml
+++ b/doc/z3950_client.xml
@@ -1,4 +1,4 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 
+<!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 % idcommon SYSTEM "common/common.ent">
@@ -15,12 +15,12 @@
   <manvolnum>3mp</manvolnum>
   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>z3950_client</refname>
   <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
  </refnamediv>
- 
+
  <refsect1><title>DESCRIPTION</title>
   <para>
    This backend filter is a Z39.50 client. This modules
@@ -31,11 +31,27 @@
   </para>
   <para>
    <variablelist>
+    <varlistentry><term>connect-timeout</term>
+     <listitem>
+      <para>
+       Specifies how long the client will wait for TCP connect to
+       complete before giving up. Default value is 30 seconds.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>init-timeout</term>
+     <listitem>
+      <para>
+       Specifies how long the client will wait for Z39.50 Init response
+       before giving up. Default value is 10 seconds.
+      </para>
+     </listitem>
+    </varlistentry>
     <varlistentry><term>timeout</term>
      <listitem>
       <para>
-       Specifies how long the client will wait for any request
-       before giving up. Default value is 30 seconds.
+       Specifies how long the client will wait for any request other
+       than Init before giving up. Default value is 30 seconds.
       </para>
      </listitem>
     </varlistentry>
@@ -60,36 +76,63 @@
       <para>
        Is a boolean value (false, true). If true, the Z39.50 client will
        terminate Z39.50 sessions with a close APDU followed by a socket close.
-       If false (default), the Z39.50 client will be transparent and only 
+       If false (default), the Z39.50 client will be transparent and only
        send a close if the peer client does it too.
       </para>
      </listitem>
     </varlistentry>
+    <varlistentry><term>client_ip</term>
+     <listitem>
+      <para>
+       Is a boolean value (false, true). If true, the Z39.50 client will
+       as part of the Init Request include Client-IP information (the
+       Z39.50 equivalent of HTTP X-Forwarded-To information). By default
+       this is false (not included).
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>charset</term>
+     <listitem>
+      <para>
+       If set, holds Z39.50 negotiation charset (encoding) that is
+       sent via the Initialize Request. If Initalize Request already
+       contains negotaition information it will be left un-modified.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry><term>bind_host</term>
+     <listitem>
+      <para>
+       Is a boolean value (false, true). If true, the out going
+       TCP connection will be bound to the same as listening IP.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
- 
+
  <refsect1><title>SCHEMA</title>
    <literallayout><xi:include
                     xi:href="../xml/schema/filter_z3950_client.rnc"
-                    xi:parse="text"  
+                    xi:parse="text"
                     xmlns:xi="http://www.w3.org/2001/XInclude" />
    </literallayout>
  </refsect1>
- 
+
  <refsect1><title>EXAMPLES</title>
   <para>
    A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="z3950_client">
      <timeout>30</timeout>
-     <default_target>z3950.indexdata.dk</default_target>
+     <default_target>z3950.indexdata.com</default_target>
     </filter>
 ]]>
    </screen>
   </para>
- </refsect1> 
- 
+ </refsect1>
+
  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
@@ -104,7 +147,7 @@
    </citerefentry>
   </para>
  </refsect1>
- 
+
  &copyright;
 </refentry>