doc/metaproxy.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
   3  <!ENTITY copyright SYSTEM "copyright.xml">
   4  <!ENTITY % idcommon SYSTEM "common/common.ent">
   5      %idcommon;
   6 ]>
   7 <!-- $Id: metaproxy.xml,v 1.9 2008-02-20 12:39:34 adam Exp $ -->
   8 <refentry id="ref-metaproxy">
   9  <refmeta>
  10   <refentrytitle>metaproxy</refentrytitle>
  11   <manvolnum>1</manvolnum>
  12  </refmeta>
  13
  14  <refnamediv>
  15   <refname>metaproxy</refname>
  16   <refpurpose>Metaproxy - server</refpurpose>
  17  </refnamediv>
  18
  19  <refsynopsisdiv>
  20   <cmdsynopsis>
  21    <command>metaproxy</command>
  22    <arg choice="opt"><option>--help</option></arg>
  23    <arg choice="opt"><option>--version</option></arg>
  24    <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
  25    <arg choice="opt"><option>-D</option></arg>
  26    <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
  27    <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
  28    <arg choice="opt"><option>-u <replaceable>ID</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>-X</term>
  95     <listitem><para>
  96       Makes Metaproxy operate in debug mode.
  97      </para></listitem>
  98    </varlistentry>
  99
 100   </variablelist>
 101  </refsect1>
 102
 103  <refsect1><title>EXAMPLES</title>
 104   <para>
 105    Start server with configuration in <filename>my.xml</filename>.
 106    <screen>
 107     metaproxy --config my.xml
 108    </screen>
 109   </para>
 110  </refsect1>
 111
 112  <refsect1><title>FILES</title>
 113   <para>
 114    None important.
 115   </para>
 116  </refsect1>
 117
 118  <refsect1><title>SEE ALSO</title>
 119   <para>
 120    <citerefentry>
 121     <refentrytitle>auth_simple</refentrytitle>
 122     <manvolnum>3mp</manvolnum>
 123    </citerefentry>,
 124    <citerefentry>
 125     <refentrytitle>backend_test</refentrytitle>
 126     <manvolnum>3mp</manvolnum>
 127    </citerefentry>,
 128    <citerefentry>
 129     <refentrytitle>bounce</refentrytitle>
 130     <manvolnum>3mp</manvolnum>
 131    </citerefentry>,
 132    <citerefentry>
 133     <refentrytitle>frontend_net</refentrytitle>
 134     <manvolnum>3mp</manvolnum>
 135    </citerefentry>,
 136    <citerefentry>
 137     <refentrytitle>http_file</refentrytitle>
 138     <manvolnum>3mp</manvolnum>
 139    </citerefentry>,
 140    <citerefentry>
 141     <refentrytitle>log</refentrytitle>
 142     <manvolnum>3mp</manvolnum>
 143    </citerefentry>,
 144    <citerefentry>
 145     <refentrytitle>multi</refentrytitle>
 146     <manvolnum>3mp</manvolnum>
 147    </citerefentry>,
 148    <citerefentry>
 149     <refentrytitle>query_rewrite</refentrytitle>
 150     <manvolnum>3mp</manvolnum>
 151    </citerefentry>,
 152    <citerefentry>
 153     <refentrytitle>record_transform</refentrytitle>
 154     <manvolnum>3mp</manvolnum>
 155    </citerefentry>,
 156    <citerefentry>
 157     <refentrytitle>session_shared</refentrytitle>
 158     <manvolnum>3mp</manvolnum>
 159    </citerefentry>,
 160    <citerefentry>
 161     <refentrytitle>sru_z3950</refentrytitle>
 162     <manvolnum>3mp</manvolnum>
 163    </citerefentry>,
 164    <citerefentry>
 165     <refentrytitle>template</refentrytitle>
 166     <manvolnum>3mp</manvolnum>
 167    </citerefentry>,
 168    <citerefentry>
 169     <refentrytitle>virt_db</refentrytitle>
 170     <manvolnum>3mp</manvolnum>
 171    </citerefentry>,
 172    <citerefentry>
 173     <refentrytitle>z3950_client</refentrytitle>
 174     <manvolnum>3mp</manvolnum>
 175    </citerefentry>.
 176   </para>
 177   <para>
 178    The Metaproxy
 179    <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
 180   </para>
 181  </refsect1>
 182
 183  &copyright;
 184
 185 </refentry>
 186
 187 <!-- Keep this comment at the end of the file
 188 Local variables:
 189 mode: sgml
 190 sgml-omittag:t
 191 sgml-shorttag:t
 192 sgml-minimize-attributes:nil
 193 sgml-always-quote-attributes:t
 194 sgml-indent-step:1
 195 sgml-indent-data:t
 196 sgml-parent-document:nil
 197 sgml-local-catalogs: nil
 198 sgml-namecase-general:t
 199 End:
 200 -->