X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmulti.xml;h=e4ec61953687ceee2d784e4f7f40ea9a159ebfea;hb=45d155e02c30dff521e54975952148ff72db9a9a;hp=b8106e45cf049916be53ca9e9db6a07b94bf02d5;hpb=271eaaa60ec419d64669cf0e9b5753d05365b798;p=metaproxy-moved-to-github.git

diff --git a/doc/multi.xml b/doc/multi.xml
index b8106e4..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.3 2006-04-24 12:50:24 marc Exp $ -->
-<refentry>
+<refentry id="ref-multi">
  <refmeta>
   <refentrytitle>multi</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,13 +13,33 @@
  
  <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>
@@ -26,10 +47,14 @@
    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>
@@ -50,9 +75,17 @@
  &copyright;
 </refentry>
 
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
 Local variables:
-mode: nxml
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
 End:
 -->
-