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