X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fmetaproxy.xml;h=3ae0919d84a0d104dda45c1e3b91d8cb7cb204d1;hb=60d4816be16dc740e99f01ca4c6f2e086b6b5a78;hp=b10ea05d9f19eb329a79925a0f8cc99af8a4a120;hpb=601933683c68801e86c4f1380b70a8972eaa1cb1;p=metaproxy-moved-to-github.git

diff --git a/doc/metaproxy.xml b/doc/metaproxy.xml
index b10ea05..3ae0919 100644
--- a/doc/metaproxy.xml
+++ b/doc/metaproxy.xml
@@ -4,7 +4,6 @@
  <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: metaproxy.xml,v 1.8 2007-05-22 11:05:45 adam Exp $ -->
 <refentry id="ref-metaproxy">
  <refmeta>
   <refentrytitle>metaproxy</refentrytitle>
@@ -13,14 +12,21 @@
  
  <refnamediv>
   <refname>metaproxy</refname>
-  <refpurpose>Metaproxy - daemon</refpurpose>
+  <refpurpose>Metaproxy - server</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>metaproxy</command>
    <arg choice="opt"><option>--help</option></arg>
+   <arg choice="opt"><option>--version</option></arg>
    <arg choice="opt"><option>--config <replaceable>config</replaceable></option></arg>
+   <arg choice="opt"><option>-D</option></arg>
+   <arg choice="opt"><option>-l <replaceable>logfile</replaceable></option></arg>
+   <arg choice="opt"><option>-p <replaceable>pidfile</replaceable></option></arg>
+   <arg choice="opt"><option>-u <replaceable>ID</replaceable></option></arg>
+   <arg choice="opt"><option>-w <replaceable>dir</replaceable></option></arg>
+   <arg choice="opt"><option>-X</option></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
  
@@ -43,22 +49,157 @@
    </varlistentry>
 
    <varlistentry>
+    <term>--version</term>
+    <listitem><para>
+      Displays Metaproxy version.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term>--config <replaceable>config</replaceable></term>
     <listitem><para>
       Specify the configuration.
      </para></listitem>
    </varlistentry>
 
+   <varlistentry>
+    <term>-D</term>
+    <listitem><para>
+      Puts Metaproxy in the background after startup.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-l <replaceable>logfile</replaceable></term>
+    <listitem><para>
+      Specifies YAZ log file.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-p <replaceable>pidfile</replaceable></term>
+    <listitem><para>
+      Specifies file which holds PID after startup.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-u <replaceable>ID</replaceable></term>
+    <listitem><para>
+      Makes Metaproxy changes its identity to ID after startup.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-w <replaceable>dir</replaceable></term>
+    <listitem><para>
+      Changes working directory to <replaceable>dir</replaceable>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-X</term>
+    <listitem><para>
+      Makes Metaproxy operate in debug mode.
+     </para></listitem>
+   </varlistentry>
+
   </variablelist>
  </refsect1>
 
+ <refsect1><title>CONFIGURATION</title>
+   <para>Metaproxy's configuration is XML based. All elements
+     should be in namespace <literal>http://indexdata.com/metaproxy</literal>.
+   </para>
+   <para>
+     The root element must be named <literal>metaproxy</literal> and
+     must specify a version. Currently the version must be
+     <literal>1.0</literal>. The children elements of metaproxy
+     are:
+     <variablelist>
+       <varlistentry>
+	 <term>dlpath</term>
+	 <listitem>
+	   <para>
+	     Specifies the path for Loadable filter modules
+	   </para>
+	 </listitem>
+       </varlistentry>
+       <varlistentry>
+	 <term>start</term>
+	 <listitem>
+	   <para>
+	     Specifies the start route. Takes a <literal>route</literal>
+	     attribute with the name of the route.
+	   </para>
+	 </listitem>
+       </varlistentry>
+       <varlistentry>
+	 <term>filters</term>
+	 <listitem>
+	   <para>
+	     Specifies all filters. Includes one ore more 
+	     <literal>filter</literal> elements with filter-specific
+	     configuration material.
+	   </para>
+	 </listitem>
+       </varlistentry>
+       <varlistentry>
+	 <term>routes</term>
+	 <listitem>
+	   <para>
+	     Specifies all routes. Includes one or more
+	     <literal>route</literal> elements. Each <literal>route</literal>
+	     in turn includes one or more filter specifications.
+	   </para>
+	 </listitem>
+       </varlistentry>
+     </variablelist>
+   </para>
+   <para>
+     The configuration is described in more detail in the
+     <ulink url="&url.metaproxy.doc;">Metaproxy manual</ulink>.
+   </para>
+ </refsect1>
  <refsect1><title>EXAMPLES</title>
-  <para>
-   Start server with configuration in <filename>my.xml</filename>.
-   <screen>
-    metaproxy --config my.xml
+   <para>
+     The configuration below specifies a simple Z39.50 proxy and
+     illustrates most configuration elements of Metaproxy.
+   </para>
+   <screen><![CDATA[
+<?xml version="1.0"?>
+<metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
+  <dlpath>/usr/local/metaproxy/filters</dlpath>
+  <start route="start"/>
+  <filters>
+    <filter id="frontend" type="frontend_net">
+      <threads>10</threads>
+      <port>@:9000</port>
+    </filter>
+    <filter id="backend" type="z3950_client">
+     <timeout>30</timeout>
+     <default_target>z3950.indexdata.dk</default_target>
+    </filter>
+  </filters>
+  <routes>  
+    <route id="start">
+      <filter refid="frontend"/>
+      <filter type="log">
+        <message>log</message>
+      </filter>
+      <filter refid="backend"/>
+      <filter type="bounce"/>
+    </route>
+  </routes>
+</metaproxy>
+]]>
    </screen>
-  </para>
+   <para>
+     Start server with configuration in <filename>my.xml</filename>.
+     <screen>
+       metaproxy --config my.xml
+     </screen>
+   </para>
  </refsect1> 
 
  <refsect1><title>FILES</title>
@@ -128,7 +269,7 @@
   </para>
   <para>
    The Metaproxy
-   <ulink url="http://www.indexdata.com/metaproxy/doc/">manual</ulink>.
+   <ulink url="&url.metaproxy.doc;">manual</ulink>.
   </para>
  </refsect1>