X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fmulti.xml;h=e4ec61953687ceee2d784e4f7f40ea9a159ebfea;hb=6224d984542604bf2a5ba588f1dac1bceb2a2d40;hp=db80beb13de041a7e5c376789c5959b4026ccf62;hpb=a7d0816d8e587b0743cdfda1cbb2321315be7946;p=metaproxy-moved-to-github.git

diff --git a/doc/multi.xml b/doc/multi.xml
index db80beb..e4ec619 100644
--- a/doc/multi.xml
+++ b/doc/multi.xml
@@ -1,9 +1,10 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
  <!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: multi.xml,v 1.1 2006-03-27 13:41:40 adam Exp $ -->
-<refentry>
+<refentry id="ref-multi">
  <refmeta>
   <refentrytitle>multi</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,24 +13,48 @@
  
  <refnamediv>
   <refname>multi</refname>
-  <refpurpose>package multiplexer</refpurpose>
+  <refpurpose>Metaproxy Package Multiplexer Module</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
   <para>
    This filter multiplexes packages.
   </para>
+  <para>
+   The multi filter consists of zero or more
+   <literal>&lt;target&gt;</literal> elements.
+   If a target matches a given target specified as CDATA in the
+   target element, the multi filter will route traffic to the route
+   given by the route attribute.
+  </para>
+  <para>
+   A target element is not required for multi-plexing to work.
+   It merely serves as a way to route differently. 
+  </para>
+  <para>
+   If an empty
+   <literal>&lt;hideunavailable&gt;</literal>
+   element is placed inside the
+   <literal>multi</literal>
+   filter, then unavailable databases are not reported to the client,
+   but simply ignored (unless every one of the databases is
+   unavailable).
+  </para>
  </refsect1>
  
  <refsect1><title>EXAMPLES</title>
   <para>
-   A typical configuration looks as likes:
+   A typical configuration looks like this:
    <screen><![CDATA[
     <filter type="multi">
+     <target route="route1">z3950.loc.gov:7090/voyager</target>
+     <target route="route2">bagel.indexdata.dk/gils</target>
+     <target route="other">*</target>
     </filter>
 ]]>
    </screen>
   </para>
+
  </refsect1> 
  
  <refsect1><title>SEE ALSO</title>