Describe <hideunavailable>
[metaproxy-moved-to-github.git] / 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 ]>
5 <!-- $Id: multi.xml,v 1.5 2006-05-16 10:36:51 mike Exp $ -->
6 <refentry>
7  <refmeta>
8   <refentrytitle>multi</refentrytitle>
9   <manvolnum>3mp</manvolnum>
10    <refmiscinfo>Metaproxy Module</refmiscinfo>
11 </refmeta>
12  
13  <refnamediv>
14   <refname>multi</refname>
15   <refpurpose>package multiplexer</refpurpose>
16  </refnamediv>
17  
18  <refsect1><title>DESCRIPTION</title>
19   <para>
20    This filter multiplexes packages.
21   </para>
22  </refsect1>
23  
24  <refsect1><title>EXAMPLES</title>
25   <para>
26    A typical configuration looks like this:
27    <screen><![CDATA[
28     <filter type="multi">
29     </filter>
30 ]]>
31    </screen>
32   </para>
33   <para>
34    If an empty
35    <literal>&lt;hideunavailable&gt;</literal>
36    element is placed inside the
37    <literal>multi</literal>
38    filter, then unavailable databases are not reported to the client,
39    but simply ignored (unless every one of the databases is
40    unanavailable).
41   </para>
42  </refsect1> 
43  
44  <refsect1><title>SEE ALSO</title>
45   <para>
46    <citerefentry>
47     <refentrytitle>metaproxy</refentrytitle>
48     <manvolnum>1</manvolnum>
49    </citerefentry>
50   </para>
51   <para>
52    <citerefentry>
53     <refentrytitle>virt_db</refentrytitle>
54     <manvolnum>3mp</manvolnum>
55    </citerefentry>
56   </para>
57  </refsect1>
58  
59  &copyright;
60 </refentry>
61
62 <!-- Keep this comment at the end of the file
63 Local variables:
64 mode: sgml
65 sgml-omittag:t
66 sgml-shorttag:t
67 sgml-minimize-attributes:nil
68 sgml-always-quote-attributes:t
69 sgml-indent-step:1
70 sgml-indent-data:t
71 sgml-parent-document:nil
72 sgml-local-catalogs: nil
73 sgml-namecase-general:t
74 End:
75 -->