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    </variablelist>
  59   </para>
  60  </refsect1>
  61
  62  <refsect1><title>EXAMPLES</title>
  63   <para>
  64    A typical configuration looks like this:
  65    <screen><![CDATA[
  66     <filter type="z3950_client">
  67      <timeout>30</timeout>
  68      <default_target>z3950.indexdata.dk</default_target>
  69     </filter>
  70 ]]>
  71    </screen>
  72   </para>
  73  </refsect1>
  74
  75  <refsect1><title>SEE ALSO</title>
  76   <para>
  77    <citerefentry>
  78     <refentrytitle>metaproxy</refentrytitle>
  79     <manvolnum>1</manvolnum>
  80    </citerefentry>
  81   </para>
  82   <para>
  83    <citerefentry>
  84     <refentrytitle>backend_test</refentrytitle>
  85     <manvolnum>3mp</manvolnum>
  86    </citerefentry>
  87   </para>
  88  </refsect1>
  89
  90  &copyright;
  91 </refentry>
  92
  93 <!-- Keep this comment at the end of the file
  94 Local variables:
  95 mode: sgml
  96 sgml-omittag:t
  97 sgml-shorttag:t
  98 sgml-minimize-attributes:nil
  99 sgml-always-quote-attributes:t
 100 sgml-indent-step:1
 101 sgml-indent-data:t
 102 sgml-parent-document:nil
 103 sgml-local-catalogs: nil
 104 sgml-namecase-general:t
 105 End:
 106 -->