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    </variablelist>
  69   </para>
  70  </refsect1>
  71
  72  <refsect1><title>SCHEMA</title>
  73    <literallayout><xi:include
  74                      xi:href="../xml/schema/filter_z3950_client.rnc"
  75                      xi:parse="text"
  76                      xmlns:xi="http://www.w3.org/2001/XInclude" />
  77    </literallayout>
  78  </refsect1>
  79
  80  <refsect1><title>EXAMPLES</title>
  81   <para>
  82    A typical configuration looks like this:
  83    <screen><![CDATA[
  84     <filter type="z3950_client">
  85      <timeout>30</timeout>
  86      <default_target>z3950.indexdata.dk</default_target>
  87     </filter>
  88 ]]>
  89    </screen>
  90   </para>
  91  </refsect1>
  92
  93  <refsect1><title>SEE ALSO</title>
  94   <para>
  95    <citerefentry>
  96     <refentrytitle>metaproxy</refentrytitle>
  97     <manvolnum>1</manvolnum>
  98    </citerefentry>
  99   </para>
 100   <para>
 101    <citerefentry>
 102     <refentrytitle>backend_test</refentrytitle>
 103     <manvolnum>3mp</manvolnum>
 104    </citerefentry>
 105   </para>
 106  </refsect1>
 107
 108  &copyright;
 109 </refentry>
 110
 111 <!-- Keep this comment at the end of the file
 112 Local variables:
 113 mode: nxml
 114 nxml-child-indent: 1
 115 End:
 116 -->