doc/multi.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-multi">
   8  <refentryinfo>
   9   <productname>Metaproxy</productname>
  10   <info><orgname>Index Data</orgname></info>
  11  </refentryinfo>
  12
  13  <refmeta>
  14   <refentrytitle>multi</refentrytitle>
  15   <manvolnum>3mp</manvolnum>
  16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
  17  </refmeta>
  18
  19  <refnamediv>
  20   <refname>multi</refname>
  21   <refpurpose>Metaproxy Package Multiplexer Module</refpurpose>
  22  </refnamediv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    This filter multiplexes packages.
  27   </para>
  28   <para>
  29    The multi filter consists of zero or more
  30    <literal>&lt;target&gt;</literal> elements.
  31    If a target matches a given target specified as CDATA in the
  32    target element, the multi filter will route traffic to the route
  33    given by the route attribute.
  34   </para>
  35   <para>
  36    A target element is not required for multi-plexing to work.
  37    It merely serves as a way to route differently.
  38   </para>
  39   <para>
  40    If an empty
  41    <literal>&lt;hideunavailable&gt;</literal>
  42    element is placed inside the
  43    <literal>multi</literal>
  44    filter, then unavailable databases are not reported to the client,
  45    but simply ignored (unless every one of the databases is
  46    unavailable).
  47   </para>
  48  </refsect1>
  49
  50  <refsect1><title>EXAMPLES</title>
  51   <para>
  52    A typical configuration looks like this:
  53    <screen><![CDATA[
  54     <filter type="multi">
  55      <target route="route1">z3950.loc.gov:7090/voyager</target>
  56      <target route="route2">bagel.indexdata.dk/gils</target>
  57      <target route="other">*</target>
  58     </filter>
  59 ]]>
  60    </screen>
  61   </para>
  62
  63  </refsect1>
  64
  65  <refsect1><title>SEE ALSO</title>
  66   <para>
  67    <citerefentry>
  68     <refentrytitle>metaproxy</refentrytitle>
  69     <manvolnum>1</manvolnum>
  70    </citerefentry>
  71   </para>
  72   <para>
  73    <citerefentry>
  74     <refentrytitle>virt_db</refentrytitle>
  75     <manvolnum>3mp</manvolnum>
  76    </citerefentry>
  77   </para>
  78  </refsect1>
  79
  80  &copyright;
  81 </refentry>
  82
  83 <!-- Keep this comment at the end of the file
  84 Local variables:
  85 mode: sgml
  86 sgml-omittag:t
  87 sgml-shorttag:t
  88 sgml-minimize-attributes:nil
  89 sgml-always-quote-attributes:t
  90 sgml-indent-step:1
  91 sgml-indent-data:t
  92 sgml-parent-document:nil
  93 sgml-local-catalogs: nil
  94 sgml-namecase-general:t
  95 End:
  96 -->