doc/z3950_client.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % common SYSTEM "common/common.ent">
   5      %common;
   6 ]>
   7 <!-- $Id: z3950_client.xml,v 1.6 2007-01-26 14:49:21 adam Exp $ -->
   8 <refentry>
   9  <refmeta>
  10   <refentrytitle>z3950_client</refentrytitle>
  11   <manvolnum>3mp</manvolnum>
  12    <refmiscinfo>Metaproxy Module</refmiscinfo>
  13 </refmeta>
  14
  15  <refnamediv>
  16   <refname>z3950_client</refname>
  17   <refpurpose>Metaproxy Z39.50 Backend Client Module</refpurpose>
  18  </refnamediv>
  19
  20  <refsect1><title>DESCRIPTION</title>
  21   <para>
  22    This backend filter is a Z39.50 client. This modules
  23    proxies all Z39.50 packages to a target. HTTP packages are ignored.
  24    The address of the backend target (host) can be given as part of the
  25    Initialize Request (Virtual host) or the default target may be specified
  26    in the configuration.
  27   </para>
  28   <para>
  29    <variablelist>
  30     <varlistentry><term>timeout</term>
  31      <listitem>
  32       <para>
  33        Specifies how long the client will wait for any request
  34        before giving up. Default value is 30 seconds.
  35       </para>
  36      </listitem>
  37     </varlistentry>
  38     <varlistentry><term>default_target</term>
  39      <listitem>
  40       <para>
  41        Specifies the target (host) for the Z39.50 server to be used
  42        if the Init Request does not indicate otherwise.
  43       </para>
  44      </listitem>
  45     </varlistentry>
  46     <varlistentry><term>force_target</term>
  47      <listitem>
  48       <para>
  49        Specifies the target (host) for the Z39.50 server to be used
  50        always (regardless of Init Request vhost).
  51       </para>
  52      </listitem>
  53     </varlistentry>
  54    </variablelist>
  55   </para>
  56  </refsect1>
  57
  58  <refsect1><title>EXAMPLES</title>
  59   <para>
  60    A typical configuration looks like this:
  61    <screen><![CDATA[
  62     <filter type="z3950_client">
  63      <timeout>30</timeout>
  64      <default_target>z3950.indexdata.dk</default_target>
  65     </filter>
  66 ]]>
  67    </screen>
  68   </para>
  69  </refsect1>
  70
  71  <refsect1><title>SEE ALSO</title>
  72   <para>
  73    <citerefentry>
  74     <refentrytitle>metaproxy</refentrytitle>
  75     <manvolnum>1</manvolnum>
  76    </citerefentry>
  77   </para>
  78   <para>
  79    <citerefentry>
  80     <refentrytitle>backend_test</refentrytitle>
  81     <manvolnum>3mp</manvolnum>
  82    </citerefentry>
  83   </para>
  84  </refsect1>
  85
  86  &copyright;
  87 </refentry>
  88
  89 <!-- Keep this comment at the end of the file
  90 Local variables:
  91 mode: sgml
  92 sgml-omittag:t
  93 sgml-shorttag:t
  94 sgml-minimize-attributes:nil
  95 sgml-always-quote-attributes:t
  96 sgml-indent-step:1
  97 sgml-indent-data:t
  98 sgml-parent-document:nil
  99 sgml-local-catalogs: nil
 100 sgml-namecase-general:t
 101 End:
 102 -->