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 <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>EXAMPLES</title>
 111   <para>
 112    Start server with configuration in <filename>my.xml</filename>.
 113    <screen>
 114     metaproxy --config my.xml
 115    </screen>
 116   </para>
 117  </refsect1>
 118
 119  <refsect1><title>FILES</title>
 120   <para>
 121    None important.
 122   </para>
 123  </refsect1>
 124
 125  <refsect1><title>SEE ALSO</title>
 126   <para>
 127    <citerefentry>
 128     <refentrytitle>auth_simple</refentrytitle>
 129     <manvolnum>3mp</manvolnum>
 130    </citerefentry>,
 131    <citerefentry>
 132     <refentrytitle>backend_test</refentrytitle>
 133     <manvolnum>3mp</manvolnum>
 134    </citerefentry>,
 135    <citerefentry>
 136     <refentrytitle>bounce</refentrytitle>
 137     <manvolnum>3mp</manvolnum>
 138    </citerefentry>,
 139    <citerefentry>
 140     <refentrytitle>frontend_net</refentrytitle>
 141     <manvolnum>3mp</manvolnum>
 142    </citerefentry>,
 143    <citerefentry>
 144     <refentrytitle>http_file</refentrytitle>
 145     <manvolnum>3mp</manvolnum>
 146    </citerefentry>,
 147    <citerefentry>
 148     <refentrytitle>log</refentrytitle>
 149     <manvolnum>3mp</manvolnum>
 150    </citerefentry>,
 151    <citerefentry>
 152     <refentrytitle>multi</refentrytitle>
 153     <manvolnum>3mp</manvolnum>
 154    </citerefentry>,
 155    <citerefentry>
 156     <refentrytitle>query_rewrite</refentrytitle>
 157     <manvolnum>3mp</manvolnum>
 158    </citerefentry>,
 159    <citerefentry>
 160     <refentrytitle>record_transform</refentrytitle>
 161     <manvolnum>3mp</manvolnum>
 162    </citerefentry>,
 163    <citerefentry>
 164     <refentrytitle>session_shared</refentrytitle>
 165     <manvolnum>3mp</manvolnum>
 166    </citerefentry>,
 167    <citerefentry>
 168     <refentrytitle>sru_z3950</refentrytitle>
 169     <manvolnum>3mp</manvolnum>
 170    </citerefentry>,
 171    <citerefentry>
 172     <refentrytitle>template</refentrytitle>
 173     <manvolnum>3mp</manvolnum>
 174    </citerefentry>,
 175    <citerefentry>
 176     <refentrytitle>virt_db</refentrytitle>
 177     <manvolnum>3mp</manvolnum>
 178    </citerefentry>,
 179    <citerefentry>
 180     <refentrytitle>z3950_client</refentrytitle>
 181     <manvolnum>3mp</manvolnum>
 182    </citerefentry>.
 183   </para>
 184   <para>
 185    The Metaproxy
 186    <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
 187   </para>
 188  </refsect1>
 189
 190  &copyright;
 191
 192 </refentry>
 193
 194 <!-- Keep this comment at the end of the file
 195 Local variables:
 196 mode: sgml
 197 sgml-omittag:t
 198 sgml-shorttag:t
 199 sgml-minimize-attributes:nil
 200 sgml-always-quote-attributes:t
 201 sgml-indent-step:1
 202 sgml-indent-data:t
 203 sgml-parent-document:nil
 204 sgml-local-catalogs: nil
 205 sgml-namecase-general:t
 206 End:
 207 -->