doc/metaproxy.xml

   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">
   5      %idcommon;
   6 ]>
   7 <refentry id="ref-metaproxy">
   8  <refmeta>
   9   <refentrytitle>metaproxy</refentrytitle>
  10   <manvolnum>1</manvolnum>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>metaproxy</refname>
  15   <refpurpose>Metaproxy - server</refpurpose>
  16  </refnamediv>
  17
  18  <refsynopsisdiv>
  19   <cmdsynopsis>
  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>
  30   </cmdsynopsis>
  31  </refsynopsisdiv>
  32
  33  <refsect1><title>DESCRIPTION</title>
  34
  35   <para>
  36    <command>metaproxy</command> is the Metaproxy daemon
  37   </para>
  38
  39  </refsect1>
  40
  41  <refsect1><title>OPTIONS</title>
  42
  43   <variablelist>
  44    <varlistentry>
  45     <term>--help</term>
  46     <listitem><para>
  47       Displays help message.
  48      </para></listitem>
  49    </varlistentry>
  50
  51    <varlistentry>
  52     <term>--version</term>
  53     <listitem><para>
  54       Displays Metaproxy version.
  55      </para></listitem>
  56    </varlistentry>
  57
  58    <varlistentry>
  59     <term>--config <replaceable>config</replaceable></term>
  60     <listitem><para>
  61       Specify the configuration.
  62      </para></listitem>
  63    </varlistentry>
  64
  65    <varlistentry>
  66     <term>-D</term>
  67     <listitem><para>
  68       Puts Metaproxy in the background after startup.
  69      </para></listitem>
  70    </varlistentry>
  71
  72    <varlistentry>
  73     <term>-l <replaceable>logfile</replaceable></term>
  74     <listitem><para>
  75       Specifies YAZ log file.
  76      </para></listitem>
  77    </varlistentry>
  78
  79    <varlistentry>
  80     <term>-p <replaceable>pidfile</replaceable></term>
  81     <listitem><para>
  82       Specifies file which holds PID after startup.
  83      </para></listitem>
  84    </varlistentry>
  85
  86    <varlistentry>
  87     <term>-u <replaceable>ID</replaceable></term>
  88     <listitem><para>
  89       Makes Metaproxy changes its identity to ID after startup.
  90      </para></listitem>
  91    </varlistentry>
  92
  93    <varlistentry>
  94     <term>-w <replaceable>dir</replaceable></term>
  95     <listitem><para>
  96       Changes working directory to <replaceable>dir</replaceable>.
  97      </para></listitem>
  98    </varlistentry>
  99
 100    <varlistentry>
 101     <term>-X</term>
 102     <listitem><para>
 103       Makes Metaproxy operate in debug mode.
 104      </para></listitem>
 105    </varlistentry>
 106
 107   </variablelist>
 108  </refsect1>
 109
 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>.
 113    </para>
 114    <para>
 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
 118      are:
 119      <variablelist>
 120        <varlistentry>
 121          <term>dlpath</term>
 122          <listitem>
 123            <para>
 124              Specifies the path for Loadable filter modules
 125            </para>
 126          </listitem>
 127        </varlistentry>
 128        <varlistentry>
 129          <term>start</term>
 130          <listitem>
 131            <para>
 132              Specifies the start route. Takes a <literal>route</literal>
 133              attribute with the name of the route.
 134            </para>
 135          </listitem>
 136        </varlistentry>
 137        <varlistentry>
 138          <term>filters</term>
 139          <listitem>
 140            <para>
 141              Specifies all filters. Includes one ore more
 142              <literal>filter</literal> elements with filter-specific
 143              configuration material.
 144            </para>
 145          </listitem>
 146        </varlistentry>
 147        <varlistentry>
 148          <term>routes</term>
 149          <listitem>
 150            <para>
 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.
 154            </para>
 155          </listitem>
 156        </varlistentry>
 157      </variablelist>
 158    </para>
 159    <para>
 160      The configuration is described in more detail in the
 161      <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
 162    </para>
 163  </refsect1>
 164  <refsect1><title>EXAMPLES</title>
 165    <para>
 166      The configuration below specifies a simple Z39.50 proxy and
 167      illustrates most configuration elements of Metaproxy.
 168    </para>
 169    <screen><![CDATA[
 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"/>
 174   <filters>
 175     <filter id="frontend" type="frontend_net">
 176       <threads>10</threads>
 177       <port>@:9000</port>
 178     </filter>
 179     <filter id="backend" type="z3950_client">
 180      <timeout>30</timeout>
 181      <default_target>z3950.indexdata.dk</default_target>
 182     </filter>
 183   </filters>
 184   <routes>
 185     <route id="start">
 186       <filter refid="frontend"/>
 187       <filter type="log">
 188         <message>log</message>
 189       </filter>
 190       <filter refid="backend"/>
 191       <filter type="bounce"/>
 192     </route>
 193   </routes>
 194 </metaproxy>
 195 ]]>
 196    </screen>
 197    <para>
 198      Start server with configuration in <filename>my.xml</filename>.
 199      <screen>
 200        metaproxy --config my.xml
 201      </screen>
 202    </para>
 203  </refsect1>
 204
 205  <refsect1><title>FILES</title>
 206   <para>
 207    None important.
 208   </para>
 209  </refsect1>
 210
 211  <refsect1><title>SEE ALSO</title>
 212   <para>
 213    <citerefentry>
 214     <refentrytitle>auth_simple</refentrytitle>
 215     <manvolnum>3mp</manvolnum>
 216    </citerefentry>,
 217    <citerefentry>
 218     <refentrytitle>backend_test</refentrytitle>
 219     <manvolnum>3mp</manvolnum>
 220    </citerefentry>,
 221    <citerefentry>
 222     <refentrytitle>bounce</refentrytitle>
 223     <manvolnum>3mp</manvolnum>
 224    </citerefentry>,
 225    <citerefentry>
 226     <refentrytitle>frontend_net</refentrytitle>
 227     <manvolnum>3mp</manvolnum>
 228    </citerefentry>,
 229    <citerefentry>
 230     <refentrytitle>http_file</refentrytitle>
 231     <manvolnum>3mp</manvolnum>
 232    </citerefentry>,
 233    <citerefentry>
 234     <refentrytitle>log</refentrytitle>
 235     <manvolnum>3mp</manvolnum>
 236    </citerefentry>,
 237    <citerefentry>
 238     <refentrytitle>multi</refentrytitle>
 239     <manvolnum>3mp</manvolnum>
 240    </citerefentry>,
 241    <citerefentry>
 242     <refentrytitle>query_rewrite</refentrytitle>
 243     <manvolnum>3mp</manvolnum>
 244    </citerefentry>,
 245    <citerefentry>
 246     <refentrytitle>record_transform</refentrytitle>
 247     <manvolnum>3mp</manvolnum>
 248    </citerefentry>,
 249    <citerefentry>
 250     <refentrytitle>session_shared</refentrytitle>
 251     <manvolnum>3mp</manvolnum>
 252    </citerefentry>,
 253    <citerefentry>
 254     <refentrytitle>sru_z3950</refentrytitle>
 255     <manvolnum>3mp</manvolnum>
 256    </citerefentry>,
 257    <citerefentry>
 258     <refentrytitle>template</refentrytitle>
 259     <manvolnum>3mp</manvolnum>
 260    </citerefentry>,
 261    <citerefentry>
 262     <refentrytitle>virt_db</refentrytitle>
 263     <manvolnum>3mp</manvolnum>
 264    </citerefentry>,
 265    <citerefentry>
 266     <refentrytitle>z3950_client</refentrytitle>
 267     <manvolnum>3mp</manvolnum>
 268    </citerefentry>.
 269   </para>
 270   <para>
 271    The Metaproxy
 272    <ulink url="&url.metaproxy.doc;">manual</ulink>.
 273   </para>
 274  </refsect1>
 275
 276  &copyright;
 277
 278 </refentry>
 279
 280 <!-- Keep this comment at the end of the file
 281 Local variables:
 282 mode: sgml
 283 sgml-omittag:t
 284 sgml-shorttag:t
 285 sgml-minimize-attributes:nil
 286 sgml-always-quote-attributes:t
 287 sgml-indent-step:1
 288 sgml-indent-data:t
 289 sgml-parent-document:nil
 290 sgml-local-catalogs: nil
 291 sgml-namecase-general:t
 292 End:
 293 -->