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>-v <replaceable>loglevel</replaceable></option></arg>
33 <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
34 <arg choice="opt"><option>-D</option></arg>
35 <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
36 <arg choice="opt"><option>-m <replaceable>timeformat</replaceable></option></arg>
37 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
38 <arg choice="opt"><option>-t</option></arg>
39 <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
40 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
41 <arg choice="opt"><option>-X</option></arg>
45 <refsect1><title>DESCRIPTION</title>
48 <command>metaproxy</command> is the Metaproxy daemon
53 <refsect1><title>OPTIONS</title>
59 Displays help message.
64 <term>--version</term>
66 Displays Metaproxy version.
71 <term>-v <replaceable>loglevel</replaceable></term>
73 Specify YAZ log level (all, debug, log)
78 <term>--config <replaceable>config</replaceable></term>
80 Specify the configuration.
87 Puts Metaproxy in the background after startup.
92 <term>-l <replaceable>logfile</replaceable></term>
94 Specifies YAZ log file.
99 <term>-m <replaceable>timeformat</replaceable></term>
101 Sets the format of time-stamps for all logging performed via yaz_log.
104 url="http://pubs.opengroup.org/onlinepubs/009695399/functions/strftime.html">
106 man page for the format.
111 <term>-p <replaceable>pidfile</replaceable></term>
113 Specifies file which holds PID after startup.
120 Tests configuration. Returns exit code 0 on success; non-zero on failure.
125 <term>-u <replaceable>ID</replaceable></term>
127 Makes Metaproxy changes its identity to ID after startup.
132 <term>-w <replaceable>dir</replaceable></term>
134 Changes working directory to <replaceable>dir</replaceable>.
141 Makes Metaproxy operate in debug mode.
148 <refsect1><title>CONFIGURATION</title>
149 <para>Metaproxy's configuration is XML based. All elements
150 should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
153 The root element must be named <literal>metaproxy</literal> and
154 must specify a version. Currently the version must be
155 <literal>1.0</literal>. The children elements of metaproxy
162 Specifies the path for Loadable filter modules
170 Specifies the start route. Takes a <literal>route</literal>
171 attribute with the name of the route.
179 Specifies all filters. Includes one ore more
180 <literal>filter</literal> elements with filter-specific
181 configuration material.
189 Specifies all routes. Includes one or more
190 <literal>route</literal> elements. Each <literal>route</literal>
191 in turn includes one or more filter specifications.
198 The configuration is described in more detail in the
199 <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
202 <refsect1><title>EXAMPLES</title>
204 The configuration below specifies a simple Z39.50 proxy and
205 illustrates most configuration elements of Metaproxy.
208 <?xml version="1.0"?>
209 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
210 <dlpath>/usr/local/metaproxy/filters</dlpath>
211 <start route="start"/>
213 <filter id="frontend" type="frontend_net">
214 <threads>10</threads>
217 <filter id="backend" type="z3950_client">
218 <timeout>30</timeout>
219 <default_target>z3950.indexdata.dk</default_target>
224 <filter refid="frontend"/>
226 <message>log</message>
228 <filter refid="backend"/>
229 <filter type="bounce"/>
236 Start server with configuration in <filename>my.xml</filename>.
238 metaproxy --config my.xml
243 <refsect1><title>SCHEMA</title>
244 <literallayout><xi:include
245 xi:href="../xml/schema/metaproxy.rnc"
247 xmlns:xi="http://www.w3.org/2001/XInclude" />
251 <refsect1><title>FILES</title>
257 <refsect1><title>SEE ALSO</title>
260 <refentrytitle>auth_simple</refentrytitle>
261 <manvolnum>3mp</manvolnum>
264 <refentrytitle>backend_test</refentrytitle>
265 <manvolnum>3mp</manvolnum>
268 <refentrytitle>bounce</refentrytitle>
269 <manvolnum>3mp</manvolnum>
272 <refentrytitle>frontend_net</refentrytitle>
273 <manvolnum>3mp</manvolnum>
276 <refentrytitle>http_file</refentrytitle>
277 <manvolnum>3mp</manvolnum>
280 <refentrytitle>log</refentrytitle>
281 <manvolnum>3mp</manvolnum>
284 <refentrytitle>multi</refentrytitle>
285 <manvolnum>3mp</manvolnum>
288 <refentrytitle>query_rewrite</refentrytitle>
289 <manvolnum>3mp</manvolnum>
292 <refentrytitle>record_transform</refentrytitle>
293 <manvolnum>3mp</manvolnum>
296 <refentrytitle>session_shared</refentrytitle>
297 <manvolnum>3mp</manvolnum>
300 <refentrytitle>sru_z3950</refentrytitle>
301 <manvolnum>3mp</manvolnum>
304 <refentrytitle>template</refentrytitle>
305 <manvolnum>3mp</manvolnum>
308 <refentrytitle>virt_db</refentrytitle>
309 <manvolnum>3mp</manvolnum>
312 <refentrytitle>z3950_client</refentrytitle>
313 <manvolnum>3mp</manvolnum>
318 <ulink url="&url.metaproxy.doc;">manual</ulink>.
326 <!-- Keep this comment at the end of the file