GPL v2.

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

diff --git a/doc/multi.xml b/doc/multi.xml
index 54afb63..d4c5b72 100644 (file)
--- a/doc/multi.xml
+++ b/doc/multi.xml
@@ -1,9 +1,11 @@
 <!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 % common SYSTEM "common/common.ent">
+     %common;
 ]>
-<!-- $Id: multi.xml,v 1.4 2006-04-25 12:48:52 marc Exp $ -->
-<refentry>
+<!-- $Id: multi.xml,v 1.8 2007-05-09 21:23:08 adam Exp $ -->
+<refentry id="ref-multi">
  <refmeta>
   <refentrytitle>multi</refentrytitle>
   <manvolnum>3mp</manvolnum>
@@ -12,7 +14,7 @@
  
  <refnamediv>
   <refname>multi</refname>
-  <refpurpose>package multiplexer</refpurpose>
+  <refpurpose>Metaproxy Package Multiplexer Module</refpurpose>
  </refnamediv>
  
  <refsect1><title>DESCRIPTION</title>
@@ -30,6 +32,15 @@
 ]]>
    </screen>
   </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>SEE ALSO</title>