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 % idcommon SYSTEM "common/common.ent">
7 <refentry id="ref-metaproxy">
9 <productname>Metaproxy</productname>
10 <info><orgname>Index Data</orgname></info>
14 <refentrytitle>metaproxy</refentrytitle>
15 <manvolnum>1</manvolnum>
16 <refmiscinfo class="manual">Commands</refmiscinfo>
20 <refname>metaproxy</refname>
21 <refpurpose>Metaproxy - server</refpurpose>
26 <command>metaproxy</command>
27 <arg choice="opt"><option>--help</option></arg>
28 <arg choice="opt"><option>--version</option></arg>
29 <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
30 <arg choice="opt"><option>-D</option></arg>
31 <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
32 <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
33 <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
34 <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
35 <arg choice="opt"><option>-X</option></arg>
39 <refsect1><title>DESCRIPTION</title>
42 <command>metaproxy</command> is the Metaproxy daemon
47 <refsect1><title>OPTIONS</title>
53 Displays help message.
58 <term>--version</term>
60 Displays Metaproxy version.
65 <term>--config <replaceable>config</replaceable></term>
67 Specify the configuration.
74 Puts Metaproxy in the background after startup.
79 <term>-l <replaceable>logfile</replaceable></term>
81 Specifies YAZ log file.
86 <term>-p <replaceable>pidfile</replaceable></term>
88 Specifies file which holds PID after startup.
93 <term>-u <replaceable>ID</replaceable></term>
95 Makes Metaproxy changes its identity to ID after startup.
100 <term>-w <replaceable>dir</replaceable></term>
102 Changes working directory to <replaceable>dir</replaceable>.
109 Makes Metaproxy operate in debug mode.
116 <refsect1><title>CONFIGURATION</title>
117 <para>Metaproxy's configuration is XML based. All elements
118 should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
121 The root element must be named <literal>metaproxy</literal> and
122 must specify a version. Currently the version must be
123 <literal>1.0</literal>. The children elements of metaproxy
130 Specifies the path for Loadable filter modules
138 Specifies the start route. Takes a <literal>route</literal>
139 attribute with the name of the route.
147 Specifies all filters. Includes one ore more
148 <literal>filter</literal> elements with filter-specific
149 configuration material.
157 Specifies all routes. Includes one or more
158 <literal>route</literal> elements. Each <literal>route</literal>
159 in turn includes one or more filter specifications.
166 The configuration is described in more detail in the
167 <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
170 <refsect1><title>EXAMPLES</title>
172 The configuration below specifies a simple Z39.50 proxy and
173 illustrates most configuration elements of Metaproxy.
176 <?xml version="1.0"?>
177 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
178 <dlpath>/usr/local/metaproxy/filters</dlpath>
179 <start route="start"/>
181 <filter id="frontend" type="frontend_net">
182 <threads>10</threads>
185 <filter id="backend" type="z3950_client">
186 <timeout>30</timeout>
187 <default_target>z3950.indexdata.dk</default_target>
192 <filter refid="frontend"/>
194 <message>log</message>
196 <filter refid="backend"/>
197 <filter type="bounce"/>
204 Start server with configuration in <filename>my.xml</filename>.
206 metaproxy --config my.xml
211 <refsect1><title>FILES</title>
217 <refsect1><title>SEE ALSO</title>
220 <refentrytitle>auth_simple</refentrytitle>
221 <manvolnum>3mp</manvolnum>
224 <refentrytitle>backend_test</refentrytitle>
225 <manvolnum>3mp</manvolnum>
228 <refentrytitle>bounce</refentrytitle>
229 <manvolnum>3mp</manvolnum>
232 <refentrytitle>frontend_net</refentrytitle>
233 <manvolnum>3mp</manvolnum>
236 <refentrytitle>http_file</refentrytitle>
237 <manvolnum>3mp</manvolnum>
240 <refentrytitle>log</refentrytitle>
241 <manvolnum>3mp</manvolnum>
244 <refentrytitle>multi</refentrytitle>
245 <manvolnum>3mp</manvolnum>
248 <refentrytitle>query_rewrite</refentrytitle>
249 <manvolnum>3mp</manvolnum>
252 <refentrytitle>record_transform</refentrytitle>
253 <manvolnum>3mp</manvolnum>
256 <refentrytitle>session_shared</refentrytitle>
257 <manvolnum>3mp</manvolnum>
260 <refentrytitle>sru_z3950</refentrytitle>
261 <manvolnum>3mp</manvolnum>
264 <refentrytitle>template</refentrytitle>
265 <manvolnum>3mp</manvolnum>
268 <refentrytitle>virt_db</refentrytitle>
269 <manvolnum>3mp</manvolnum>
272 <refentrytitle>z3950_client</refentrytitle>
273 <manvolnum>3mp</manvolnum>
278 <ulink url="&url.metaproxy.doc;">manual</ulink>.
286 <!-- Keep this comment at the end of the file
291 sgml-minimize-attributes:nil
292 sgml-always-quote-attributes:t
295 sgml-parent-document:nil
296 sgml-local-catalogs: nil
297 sgml-namecase-general:t