Describe auth attribute for multi filter

[metaproxy-moved-to-github.git] / doc / multi.xml

diff --git a/doc/multi.xml b/doc/multi.xml
index db80beb..e4281d9 100644 (file)
--- a/doc/multi.xml
+++ b/doc/multi.xml
@@ -1,37 +1,87 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
-    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+    "http://www.oasis-open.org/docbook/xml/4.4/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">
+ <refentryinfo>
+  <productname>Metaproxy</productname>
+  <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
  <refmeta>
   <refentrytitle>multi</refentrytitle>
   <manvolnum>3mp</manvolnum>
-   <refmiscinfo>Metaproxy Module</refmiscinfo>
-</refmeta>
- 
+  <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
+ </refmeta>
+
  <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. The target element may also apply
+   credentials to be sent to the target. This is given by the
+   <literal>auth</literal> 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>
+  <para>
+   If an empty
+   <literal>&lt;hideerrors&gt;</literal>
+   element is placed inside the
+   <literal>multi</literal>
+   filter, then databases that reports diagnostics are not reported back
+   to the client, but simply ignored (unless every one of the databases report
+   diagnostics).
+  </para>
  </refsect1>
- 
+
+ <refsect1><title>SCHEMA</title>
+   <literallayout><xi:include
+                    xi:href="../xml/schema/filter_multi.rnc"
+                    xi:parse="text"
+                    xmlns:xi="http://www.w3.org/2001/XInclude" />
+   </literallayout>
+ </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">lx2.loc.gov:210/LCDB_MARC8</target>
+     <target route="route2">z3950.indexdata.com/gils</target>
+     <target route="route3" auth="myuser/mypass">localhost:9999</target>
+     <target route="other">*</target>
     </filter>
 ]]>
    </screen>
   </para>
- </refsect1> 
- 
+
+ </refsect1>
+
  <refsect1><title>SEE ALSO</title>
   <para>
    <citerefentry>
@@ -46,21 +96,13 @@
    </citerefentry>
   </para>
  </refsect1>
- 
+
  &copyright;
 </refentry>
 
 <!-- Keep this comment at the end of the file
 Local variables:
-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
+mode: nxml
+nxml-child-indent: 1
 End:
 -->