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">
7 <refentry id="ref-metaproxy">
9 <refentrytitle>metaproxy</refentrytitle>
10 <manvolnum>1</manvolnum>
14 <refname>metaproxy</refname>
15 <refpurpose>Metaproxy - server</refpurpose>
20 <command>metaproxy</command>
21 <arg choice="opt"><option>--help</option></arg>
22 <arg choice="opt"><option>--version</option></arg>
23 <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
24 <arg choice="opt"><option>-D</option></arg>
25 <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
26 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
27 <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
28 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
29 <arg choice="opt"><option>-X</option></arg>
33 <refsect1><title>DESCRIPTION</title>
36 <command>metaproxy</command> is the Metaproxy daemon
41 <refsect1><title>OPTIONS</title>
47 Displays help message.
52 <term>--version</term>
54 Displays Metaproxy version.
59 <term>--config <replaceable>config</replaceable></term>
61 Specify the configuration.
68 Puts Metaproxy in the background after startup.
73 <term>-l <replaceable>logfile</replaceable></term>
75 Specifies YAZ log file.
80 <term>-p <replaceable>pidfile</replaceable></term>
82 Specifies file which holds PID after startup.
87 <term>-u <replaceable>ID</replaceable></term>
89 Makes Metaproxy changes its identity to ID after startup.
94 <term>-w <replaceable>dir</replaceable></term>
96 Changes working directory to <replaceable>dir</replaceable>.
103 Makes Metaproxy operate in debug mode.
110 <refsect1><title>CONFIGURATION</title>
111 <para>Metaproxy's configuration is XML based. All elements
112 should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
115 The root element must be named <literal>metaproxy</literal> and
116 must specify a version. Currently the version must be
117 <literal>1.0</literal>. The children elements of metaproxy
124 Specifies the path for Loadable filter modules
132 Specifies the start route. Takes a <literal>route</literal>
133 attribute with the name of the route.
141 Specifies all filters. Includes one ore more
142 <literal>filter</literal> elements with filter-specific
143 configuration material.
151 Specifies all routes. Includes one or more
152 <literal>route</literal> elements. Each <literal>route</literal>
153 in turn includes one or more filter specifications.
160 The configuration is described in more detail in the
161 <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
164 <refsect1><title>EXAMPLES</title>
166 The configuration below specifies a simple Z39.50 proxy and
167 illustrates most configuration elements of Metaproxy.
170 <?xml version="1.0"?>
171 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
172 <dlpath>/usr/local/metaproxy/filters</dlpath>
173 <start route="start"/>
175 <filter id="frontend" type="frontend_net">
176 <threads>10</threads>
179 <filter id="backend" type="z3950_client">
180 <timeout>30</timeout>
181 <default_target>z3950.indexdata.dk</default_target>
186 <filter refid="frontend"/>
188 <message>log</message>
190 <filter refid="backend"/>
191 <filter type="bounce"/>
198 Start server with configuration in <filename>my.xml</filename>.
200 metaproxy --config my.xml
205 <refsect1><title>FILES</title>
211 <refsect1><title>SEE ALSO</title>
214 <refentrytitle>auth_simple</refentrytitle>
215 <manvolnum>3mp</manvolnum>
218 <refentrytitle>backend_test</refentrytitle>
219 <manvolnum>3mp</manvolnum>
222 <refentrytitle>bounce</refentrytitle>
223 <manvolnum>3mp</manvolnum>
226 <refentrytitle>frontend_net</refentrytitle>
227 <manvolnum>3mp</manvolnum>
230 <refentrytitle>http_file</refentrytitle>
231 <manvolnum>3mp</manvolnum>
234 <refentrytitle>log</refentrytitle>
235 <manvolnum>3mp</manvolnum>
238 <refentrytitle>multi</refentrytitle>
239 <manvolnum>3mp</manvolnum>
242 <refentrytitle>query_rewrite</refentrytitle>
243 <manvolnum>3mp</manvolnum>
246 <refentrytitle>record_transform</refentrytitle>
247 <manvolnum>3mp</manvolnum>
250 <refentrytitle>session_shared</refentrytitle>
251 <manvolnum>3mp</manvolnum>
254 <refentrytitle>sru_z3950</refentrytitle>
255 <manvolnum>3mp</manvolnum>
258 <refentrytitle>template</refentrytitle>
259 <manvolnum>3mp</manvolnum>
262 <refentrytitle>virt_db</refentrytitle>
263 <manvolnum>3mp</manvolnum>
266 <refentrytitle>z3950_client</refentrytitle>
267 <manvolnum>3mp</manvolnum>
272 <ulink url="&url.metaproxy.doc;">manual</ulink>.
280 <!-- Keep this comment at the end of the file
285 sgml-minimize-attributes:nil
286 sgml-always-quote-attributes:t
289 sgml-parent-document:nil
290 sgml-local-catalogs: nil
291 sgml-namecase-general:t