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