added example explain record
[metaproxy-moved-to-github.git] / doc / metaproxy.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: metaproxy.xml,v 1.5 2006-10-12 12:02:19 marc Exp $ -->
6 <refentry>
7  <refmeta>
8   <refentrytitle>metaproxy</refentrytitle>
9   <manvolnum>1</manvolnum>
10  </refmeta>
11  
12  <refnamediv>
13   <refname>metaproxy</refname>
14   <refpurpose>Metaproxy - daemon</refpurpose>
15  </refnamediv>
16  
17  <refsynopsisdiv>
18   <cmdsynopsis>
19    <command>metaproxy</command>
20    <arg choice="opt"><option>--help</option></arg>
21    <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
22   </cmdsynopsis>
23  </refsynopsisdiv>
24  
25  <refsect1><title>DESCRIPTION</title>
26
27   <para>
28    <command>metaproxy</command> is the Metaproxy daemon
29   </para>
30
31  </refsect1>
32  
33  <refsect1><title>OPTIONS</title>
34   
35   <variablelist>
36    <varlistentry>
37     <term>--help</term>
38     <listitem><para>
39       Displays help message.
40      </para></listitem>
41    </varlistentry>
42
43    <varlistentry>
44     <term>--config <replaceable>config</replaceable></term>
45     <listitem><para>
46       Specify the configuration.
47      </para></listitem>
48    </varlistentry>
49
50   </variablelist>
51  </refsect1>
52
53  <refsect1><title>EXAMPLES</title>
54   <para>
55    Start server with configuration in <filename>my.xml</filename>.
56    <screen>
57     metaproxy --config my.xml
58    </screen>
59   </para>
60  </refsect1> 
61
62  <refsect1><title>FILES</title>
63   <para>
64    None important.
65   </para>
66  </refsect1>
67
68  <refsect1><title>SEE ALSO</title>
69   <para>
70    <citerefentry>
71     <refentrytitle>auth_simple</refentrytitle>
72     <manvolnum>3mp</manvolnum>
73    </citerefentry>,
74    <citerefentry>
75     <refentrytitle>backend_test</refentrytitle>
76     <manvolnum>3mp</manvolnum>
77    </citerefentry>,
78    <citerefentry>
79     <refentrytitle>bounce</refentrytitle>
80     <manvolnum>3mp</manvolnum>
81    </citerefentry>,
82    <citerefentry>
83     <refentrytitle>frontend_net</refentrytitle>
84     <manvolnum>3mp</manvolnum>
85    </citerefentry>,
86    <citerefentry>
87     <refentrytitle>http_file</refentrytitle>
88     <manvolnum>3mp</manvolnum>
89    </citerefentry>,
90    <citerefentry>
91     <refentrytitle>log</refentrytitle>
92     <manvolnum>3mp</manvolnum>
93    </citerefentry>,
94    <citerefentry>
95     <refentrytitle>multi</refentrytitle>
96     <manvolnum>3mp</manvolnum>
97    </citerefentry>,
98    <citerefentry>
99     <refentrytitle>query_rewrite</refentrytitle>
100     <manvolnum>3mp</manvolnum>
101    </citerefentry>,
102    <citerefentry>
103     <refentrytitle>record_transform</refentrytitle>
104     <manvolnum>3mp</manvolnum>
105    </citerefentry>,
106    <citerefentry>
107     <refentrytitle>session_shared</refentrytitle>
108     <manvolnum>3mp</manvolnum>
109    </citerefentry>,
110    <citerefentry>
111     <refentrytitle>sru_z3950</refentrytitle>
112     <manvolnum>3mp</manvolnum>
113    </citerefentry>,
114    <citerefentry>
115     <refentrytitle>template</refentrytitle>
116     <manvolnum>3mp</manvolnum>
117    </citerefentry>,
118    <citerefentry>
119     <refentrytitle>virt_db</refentrytitle>
120     <manvolnum>3mp</manvolnum>
121    </citerefentry>,
122    <citerefentry>
123     <refentrytitle>z3950_client</refentrytitle>
124     <manvolnum>3mp</manvolnum>
125    </citerefentry>.
126   </para>
127   <para>
128    The Metaproxy
129    <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
130   </para>
131  </refsect1>
132
133  &copyright;
134
135 </refentry>
136
137 <!-- Keep this comment at the end of the file
138 Local variables:
139 mode: sgml
140 sgml-omittag:t
141 sgml-shorttag:t
142 sgml-minimize-attributes:nil
143 sgml-always-quote-attributes:t
144 sgml-indent-step:1
145 sgml-indent-data:t
146 sgml-parent-document:nil
147 sgml-local-catalogs: nil
148 sgml-namecase-general:t
149 End:
150 -->