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