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>-X</option></arg>
  29   </cmdsynopsis>
  30  </refsynopsisdiv>
  31
  32  <refsect1><title>DESCRIPTION</title>
  33
  34   <para>
  35    <command>metaproxy</command> is the Metaproxy daemon
  36   </para>
  37
  38  </refsect1>
  39
  40  <refsect1><title>OPTIONS</title>
  41
  42   <variablelist>
  43    <varlistentry>
  44     <term>--help</term>
  45     <listitem><para>
  46       Displays help message.
  47      </para></listitem>
  48    </varlistentry>
  49
  50    <varlistentry>
  51     <term>--version</term>
  52     <listitem><para>
  53       Displays Metaproxy version.
  54      </para></listitem>
  55    </varlistentry>
  56
  57    <varlistentry>
  58     <term>--config <replaceable>config</replaceable></term>
  59     <listitem><para>
  60       Specify the configuration.
  61      </para></listitem>
  62    </varlistentry>
  63
  64    <varlistentry>
  65     <term>-D</term>
  66     <listitem><para>
  67       Puts Metaproxy in the background after startup.
  68      </para></listitem>
  69    </varlistentry>
  70
  71    <varlistentry>
  72     <term>-l <replaceable>logfile</replaceable></term>
  73     <listitem><para>
  74       Specifies YAZ log file.
  75      </para></listitem>
  76    </varlistentry>
  77
  78    <varlistentry>
  79     <term>-p <replaceable>pidfile</replaceable></term>
  80     <listitem><para>
  81       Specifies file which holds PID after startup.
  82      </para></listitem>
  83    </varlistentry>
  84
  85    <varlistentry>
  86     <term>-u <replaceable>ID</replaceable></term>
  87     <listitem><para>
  88       Makes Metaproxy changes its identity to ID after startup.
  89      </para></listitem>
  90    </varlistentry>
  91
  92    <varlistentry>
  93     <term>-X</term>
  94     <listitem><para>
  95       Makes Metaproxy operate in debug mode.
  96      </para></listitem>
  97    </varlistentry>
  98
  99   </variablelist>
 100  </refsect1>
 101
 102  <refsect1><title>EXAMPLES</title>
 103   <para>
 104    Start server with configuration in <filename>my.xml</filename>.
 105    <screen>
 106     metaproxy --config my.xml
 107    </screen>
 108   </para>
 109  </refsect1>
 110
 111  <refsect1><title>FILES</title>
 112   <para>
 113    None important.
 114   </para>
 115  </refsect1>
 116
 117  <refsect1><title>SEE ALSO</title>
 118   <para>
 119    <citerefentry>
 120     <refentrytitle>auth_simple</refentrytitle>
 121     <manvolnum>3mp</manvolnum>
 122    </citerefentry>,
 123    <citerefentry>
 124     <refentrytitle>backend_test</refentrytitle>
 125     <manvolnum>3mp</manvolnum>
 126    </citerefentry>,
 127    <citerefentry>
 128     <refentrytitle>bounce</refentrytitle>
 129     <manvolnum>3mp</manvolnum>
 130    </citerefentry>,
 131    <citerefentry>
 132     <refentrytitle>frontend_net</refentrytitle>
 133     <manvolnum>3mp</manvolnum>
 134    </citerefentry>,
 135    <citerefentry>
 136     <refentrytitle>http_file</refentrytitle>
 137     <manvolnum>3mp</manvolnum>
 138    </citerefentry>,
 139    <citerefentry>
 140     <refentrytitle>log</refentrytitle>
 141     <manvolnum>3mp</manvolnum>
 142    </citerefentry>,
 143    <citerefentry>
 144     <refentrytitle>multi</refentrytitle>
 145     <manvolnum>3mp</manvolnum>
 146    </citerefentry>,
 147    <citerefentry>
 148     <refentrytitle>query_rewrite</refentrytitle>
 149     <manvolnum>3mp</manvolnum>
 150    </citerefentry>,
 151    <citerefentry>
 152     <refentrytitle>record_transform</refentrytitle>
 153     <manvolnum>3mp</manvolnum>
 154    </citerefentry>,
 155    <citerefentry>
 156     <refentrytitle>session_shared</refentrytitle>
 157     <manvolnum>3mp</manvolnum>
 158    </citerefentry>,
 159    <citerefentry>
 160     <refentrytitle>sru_z3950</refentrytitle>
 161     <manvolnum>3mp</manvolnum>
 162    </citerefentry>,
 163    <citerefentry>
 164     <refentrytitle>template</refentrytitle>
 165     <manvolnum>3mp</manvolnum>
 166    </citerefentry>,
 167    <citerefentry>
 168     <refentrytitle>virt_db</refentrytitle>
 169     <manvolnum>3mp</manvolnum>
 170    </citerefentry>,
 171    <citerefentry>
 172     <refentrytitle>z3950_client</refentrytitle>
 173     <manvolnum>3mp</manvolnum>
 174    </citerefentry>.
 175   </para>
 176   <para>
 177    The Metaproxy
 178    <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
 179   </para>
 180  </refsect1>
 181
 182  &copyright;
 183
 184 </refentry>
 185
 186 <!-- Keep this comment at the end of the file
 187 Local variables:
 188 mode: sgml
 189 sgml-omittag:t
 190 sgml-shorttag:t
 191 sgml-minimize-attributes:nil
 192 sgml-always-quote-attributes:t
 193 sgml-indent-step:1
 194 sgml-indent-data:t
 195 sgml-parent-document:nil
 196 sgml-local-catalogs: nil
 197 sgml-namecase-general:t
 198 End:
 199 -->