doc/z3950_client.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-z3950_client">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <info><orgname>Index Data</orgname></info>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>z3950_client</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>z3950_client</refname>
  21   <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    This backend filter is a Z39.50 client. This modules
  27    proxies all Z39.50 packages to a target. HTTP packages are ignored.
  28    The address of the backend target (host) can be given as part of the
  29    Initialize Request (Virtual host) or the default target may be specified
  30    in the configuration.
  31   </para>
  32   <para>
  33    <variablelist>
  34     <varlistentry><term>timeout</term>
  35      <listitem>
  36       <para>
  37        Specifies how long the client will wait for any request
  38        before giving up. Default value is 30 seconds.
  39       </para>
  40      </listitem>
  41     </varlistentry>
  42     <varlistentry><term>default_target</term>
  43      <listitem>
  44       <para>
  45        Specifies the target (host) for the Z39.50 server to be used
  46        if the Init Request does not indicate otherwise.
  47       </para>
  48      </listitem>
  49     </varlistentry>
  50     <varlistentry><term>force_target</term>
  51      <listitem>
  52       <para>
  53        Specifies the target (host) for the Z39.50 server to be used
  54        always (regardless of Init Request vhost).
  55       </para>
  56      </listitem>
  57     </varlistentry>
  58     <varlistentry><term>force_close</term>
  59      <listitem>
  60       <para>
  61        Is a boolean value (false, true). If true, the Z39.50 client will
  62        terminate Z39.50 sessions with a close APDU followed by a socket close.
  63        If false (default), the Z39.50 client will be transparent and only
  64        send a close if the peer client does it too.
  65       </para>
  66      </listitem>
  67     </varlistentry>
  68     <varlistentry><term>client_ip</term>
  69      <listitem>
  70       <para>
  71        Is a boolean value (false, true). If true, the Z39.50 client will
  72        as part of the Init Request include Client-IP information (the
  73        Z39.50 equivalent of HTTP X-Forwarded-To information). By default
  74        this is false (not included).
  75       </para>
  76      </listitem>
  77     </varlistentry>
  78     <varlistentry><term>charset</term>
  79      <listitem>
  80       <para>
  81        If set, holds Z39.50 negotiation charset (encoding) that is
  82        sent via the Initialize Request. If Initalize Request already
  83        contains negotaition information it will be left un-modified.
  84       </para>
  85      </listitem>
  86     </varlistentry>
  87     <varlistentry><term>bind_host</term>
  88      <listitem>
  89       <para>
  90        Is a boolean value (false, true). If true, the out going
  91        TCP connection will be bound to the same as listening IP.
  92       </para>
  93      </listitem>
  94     </varlistentry>
  95    </variablelist>
  96   </para>
  97  </refsect1>
  98
  99  <refsect1><title>SCHEMA</title>
 100    <literallayout><xi:include
 101                      xi:href="../xml/schema/filter_z3950_client.rnc"
 102                      xi:parse="text"
 103                      xmlns:xi="http://www.w3.org/2001/XInclude" />
 104    </literallayout>
 105  </refsect1>
 106
 107  <refsect1><title>EXAMPLES</title>
 108   <para>
 109    A typical configuration looks like this:
 110    <screen><![CDATA[
 111     <filter type="z3950_client">
 112      <timeout>30</timeout>
 113      <default_target>z3950.indexdata.dk</default_target>
 114     </filter>
 115 ]]>
 116    </screen>
 117   </para>
 118  </refsect1>
 119
 120  <refsect1><title>SEE ALSO</title>
 121   <para>
 122    <citerefentry>
 123     <refentrytitle>metaproxy</refentrytitle>
 124     <manvolnum>1</manvolnum>
 125    </citerefentry>
 126   </para>
 127   <para>
 128    <citerefentry>
 129     <refentrytitle>backend_test</refentrytitle>
 130     <manvolnum>3mp</manvolnum>
 131    </citerefentry>
 132   </para>
 133  </refsect1>
 134
 135  &copyright;
 136 </refentry>
 137
 138 <!-- Keep this comment at the end of the file
 139 Local variables:
 140 mode: nxml
 141 nxml-child-indent: 1
 142 End:
 143 -->