1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3 <!ENTITY copyright SYSTEM "copyright.xml">
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % idcommon SYSTEM "common/common.ent">
9 <refentry id="ref-metaproxy">
11 <productname>Metaproxy</productname>
12 <productnumber>&version;</productnumber>
13 <info><orgname>Index Data</orgname></info>
17 <refentrytitle>metaproxy</refentrytitle>
18 <manvolnum>1</manvolnum>
19 <refmiscinfo class="manual">Commands</refmiscinfo>
23 <refname>metaproxy</refname>
24 <refpurpose>Metaproxy - server</refpurpose>
29 <command>metaproxy</command>
30 <arg choice="opt"><option>--help</option></arg>
31 <arg choice="opt"><option>--version</option></arg>
32 <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
33 <arg choice="opt"><option>-D</option></arg>
34 <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
35 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
36 <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
37 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
38 <arg choice="opt"><option>-X</option></arg>
42 <refsect1><title>DESCRIPTION</title>
45 <command>metaproxy</command> is the Metaproxy daemon
50 <refsect1><title>OPTIONS</title>
56 Displays help message.
61 <term>--version</term>
63 Displays Metaproxy version.
68 <term>--config <replaceable>config</replaceable></term>
70 Specify the configuration.
77 Puts Metaproxy in the background after startup.
82 <term>-l <replaceable>logfile</replaceable></term>
84 Specifies YAZ log file.
89 <term>-p <replaceable>pidfile</replaceable></term>
91 Specifies file which holds PID after startup.
96 <term>-u <replaceable>ID</replaceable></term>
98 Makes Metaproxy changes its identity to ID after startup.
103 <term>-w <replaceable>dir</replaceable></term>
105 Changes working directory to <replaceable>dir</replaceable>.
112 Makes Metaproxy operate in debug mode.
119 <refsect1><title>CONFIGURATION</title>
120 <para>Metaproxy's configuration is XML based. All elements
121 should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
124 The root element must be named <literal>metaproxy</literal> and
125 must specify a version. Currently the version must be
126 <literal>1.0</literal>. The children elements of metaproxy
133 Specifies the path for Loadable filter modules
141 Specifies the start route. Takes a <literal>route</literal>
142 attribute with the name of the route.
150 Specifies all filters. Includes one ore more
151 <literal>filter</literal> elements with filter-specific
152 configuration material.
160 Specifies all routes. Includes one or more
161 <literal>route</literal> elements. Each <literal>route</literal>
162 in turn includes one or more filter specifications.
169 The configuration is described in more detail in the
170 <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
173 <refsect1><title>EXAMPLES</title>
175 The configuration below specifies a simple Z39.50 proxy and
176 illustrates most configuration elements of Metaproxy.
179 <?xml version="1.0"?>
180 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
181 <dlpath>/usr/local/metaproxy/filters</dlpath>
182 <start route="start"/>
184 <filter id="frontend" type="frontend_net">
185 <threads>10</threads>
188 <filter id="backend" type="z3950_client">
189 <timeout>30</timeout>
190 <default_target>z3950.indexdata.dk</default_target>
195 <filter refid="frontend"/>
197 <message>log</message>
199 <filter refid="backend"/>
200 <filter type="bounce"/>
207 Start server with configuration in <filename>my.xml</filename>.
209 metaproxy --config my.xml
214 <refsect1><title>SCHEMA</title>
215 <literallayout><xi:include
216 xi:href="../xml/schema/metaproxy.rnc"
218 xmlns:xi="http://www.w3.org/2001/XInclude" />
222 <refsect1><title>FILES</title>
228 <refsect1><title>SEE ALSO</title>
231 <refentrytitle>auth_simple</refentrytitle>
232 <manvolnum>3mp</manvolnum>
235 <refentrytitle>backend_test</refentrytitle>
236 <manvolnum>3mp</manvolnum>
239 <refentrytitle>bounce</refentrytitle>
240 <manvolnum>3mp</manvolnum>
243 <refentrytitle>frontend_net</refentrytitle>
244 <manvolnum>3mp</manvolnum>
247 <refentrytitle>http_file</refentrytitle>
248 <manvolnum>3mp</manvolnum>
251 <refentrytitle>log</refentrytitle>
252 <manvolnum>3mp</manvolnum>
255 <refentrytitle>multi</refentrytitle>
256 <manvolnum>3mp</manvolnum>
259 <refentrytitle>query_rewrite</refentrytitle>
260 <manvolnum>3mp</manvolnum>
263 <refentrytitle>record_transform</refentrytitle>
264 <manvolnum>3mp</manvolnum>
267 <refentrytitle>session_shared</refentrytitle>
268 <manvolnum>3mp</manvolnum>
271 <refentrytitle>sru_z3950</refentrytitle>
272 <manvolnum>3mp</manvolnum>
275 <refentrytitle>template</refentrytitle>
276 <manvolnum>3mp</manvolnum>
279 <refentrytitle>virt_db</refentrytitle>
280 <manvolnum>3mp</manvolnum>
283 <refentrytitle>z3950_client</refentrytitle>
284 <manvolnum>3mp</manvolnum>
289 <ulink url="&url.metaproxy.doc;">manual</ulink>.
297 <!-- Keep this comment at the end of the file
302 sgml-minimize-attributes:nil
303 sgml-always-quote-attributes:t
306 sgml-parent-document:nil
307 sgml-local-catalogs: nil
308 sgml-namecase-general:t