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