From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 16 Dec 2008 15:03:10 +0000 (+0100)
Subject: Added section about configuration. Mention dlpath.
X-Git-Tag: v1.0.16~27
X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;ds=sidebyside;h=2e969993c3f131b9e8fa75ac45c2567c7b0e59b8;p=metaproxy-moved-to-github.git

Added section about configuration. Mention dlpath.
---

diff --git a/doc/common b/doc/common
index 95d92dd..eee76a1 160000
--- a/doc/common
+++ b/doc/common
@@ -1 +1 @@
-Subproject commit 95d92dd6e49fe3807fd1d6c664b3883580290103
+Subproject commit eee76a15493cb3f93cf6b88b9b7d87db17cdc85f
diff --git a/doc/metaproxy.xml b/doc/metaproxy.xml
index 2d871bd..3ae0919 100644
--- a/doc/metaproxy.xml
+++ b/doc/metaproxy.xml
@@ -107,13 +107,99 @@
   </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>
@@ -183,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>