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>-m <replaceable>timeformat</replaceable></option></arg>
36 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
37 <arg choice="opt"><option>-t</option></arg>
38 <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
39 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
40 <arg choice="opt"><option>-X</option></arg>
44 <refsect1><title>DESCRIPTION</title>
47 <command>metaproxy</command> is the Metaproxy daemon
52 <refsect1><title>OPTIONS</title>
58 Displays help message.
63 <term>--version</term>
65 Displays Metaproxy version.
70 <term>--config <replaceable>config</replaceable></term>
72 Specify the configuration.
79 Puts Metaproxy in the background after startup.
84 <term>-l <replaceable>logfile</replaceable></term>
86 Specifies YAZ log file.
91 <term>-m <replaceable>timeformat</replaceable></term>
93 Sets the format of time-stamps for all logging performed via yaz_log.
96 url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
98 man page for the format.
103 <term>-p <replaceable>pidfile</replaceable></term>
105 Specifies file which holds PID after startup.
112 Tests configuration. Returns exit code 0 on success; non-zero on failure.
117 <term>-u <replaceable>ID</replaceable></term>
119 Makes Metaproxy changes its identity to ID after startup.
124 <term>-w <replaceable>dir</replaceable></term>
126 Changes working directory to <replaceable>dir</replaceable>.
133 Makes Metaproxy operate in debug mode.
140 <refsect1><title>CONFIGURATION</title>
141 <para>Metaproxy's configuration is XML based. All elements
142 should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
145 The root element must be named <literal>metaproxy</literal> and
146 must specify a version. Currently the version must be
147 <literal>1.0</literal>. The children elements of metaproxy
154 Specifies the path for Loadable filter modules
162 Specifies the start route. Takes a <literal>route</literal>
163 attribute with the name of the route.
171 Specifies all filters. Includes one ore more
172 <literal>filter</literal> elements with filter-specific
173 configuration material.
181 Specifies all routes. Includes one or more
182 <literal>route</literal> elements. Each <literal>route</literal>
183 in turn includes one or more filter specifications.
190 The configuration is described in more detail in the
191 <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
194 <refsect1><title>EXAMPLES</title>
196 The configuration below specifies a simple Z39.50 proxy and
197 illustrates most configuration elements of Metaproxy.
200 <?xml version="1.0"?>
201 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
202 <dlpath>/usr/local/metaproxy/filters</dlpath>
203 <start route="start"/>
205 <filter id="frontend" type="frontend_net">
206 <threads>10</threads>
209 <filter id="backend" type="z3950_client">
210 <timeout>30</timeout>
211 <default_target>z3950.indexdata.dk</default_target>
216 <filter refid="frontend"/>
218 <message>log</message>
220 <filter refid="backend"/>
221 <filter type="bounce"/>
228 Start server with configuration in <filename>my.xml</filename>.
230 metaproxy --config my.xml
235 <refsect1><title>SCHEMA</title>
236 <literallayout><xi:include
237 xi:href="../xml/schema/metaproxy.rnc"
239 xmlns:xi="http://www.w3.org/2001/XInclude" />
243 <refsect1><title>FILES</title>
249 <refsect1><title>SEE ALSO</title>
252 <refentrytitle>auth_simple</refentrytitle>
253 <manvolnum>3mp</manvolnum>
256 <refentrytitle>backend_test</refentrytitle>
257 <manvolnum>3mp</manvolnum>
260 <refentrytitle>bounce</refentrytitle>
261 <manvolnum>3mp</manvolnum>
264 <refentrytitle>frontend_net</refentrytitle>
265 <manvolnum>3mp</manvolnum>
268 <refentrytitle>http_file</refentrytitle>
269 <manvolnum>3mp</manvolnum>
272 <refentrytitle>log</refentrytitle>
273 <manvolnum>3mp</manvolnum>
276 <refentrytitle>multi</refentrytitle>
277 <manvolnum>3mp</manvolnum>
280 <refentrytitle>query_rewrite</refentrytitle>
281 <manvolnum>3mp</manvolnum>
284 <refentrytitle>record_transform</refentrytitle>
285 <manvolnum>3mp</manvolnum>
288 <refentrytitle>session_shared</refentrytitle>
289 <manvolnum>3mp</manvolnum>
292 <refentrytitle>sru_z3950</refentrytitle>
293 <manvolnum>3mp</manvolnum>
296 <refentrytitle>template</refentrytitle>
297 <manvolnum>3mp</manvolnum>
300 <refentrytitle>virt_db</refentrytitle>
301 <manvolnum>3mp</manvolnum>
304 <refentrytitle>z3950_client</refentrytitle>
305 <manvolnum>3mp</manvolnum>
310 <ulink url="&url.metaproxy.doc;">manual</ulink>.
318 <!-- Keep this comment at the end of the file