X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fmetaproxy.xml;h=3ae0919d84a0d104dda45c1e3b91d8cb7cb204d1;hb=66ed48c630abf19ec779a29c5d2b67a9938685a5;hp=2d871bdcc2a48b95a5246979ec088be08591f249;hpb=2155eee0022f1e7a0bff561318d66d006dbb65e8;p=metaproxy-moved-to-github.git
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 @@
+ CONFIGURATION
+ Metaproxy's configuration is XML based. All elements
+ should be in namespace http://indexdata.com/metaproxy.
+
+
+ The root element must be named metaproxy and
+ must specify a version. Currently the version must be
+ 1.0. The children elements of metaproxy
+ are:
+
+
+ dlpath
+
+
+ Specifies the path for Loadable filter modules
+
+
+
+
+ start
+
+
+ Specifies the start route. Takes a route
+ attribute with the name of the route.
+
+
+
+
+ filters
+
+
+ Specifies all filters. Includes one ore more
+ filter elements with filter-specific
+ configuration material.
+
+
+
+
+ routes
+
+
+ Specifies all routes. Includes one or more
+ route elements. Each route
+ in turn includes one or more filter specifications.
+
+
+
+
+
+
+ The configuration is described in more detail in the
+ Metaproxy manual.
+
+
EXAMPLES
-
- Start server with configuration in my.xml.
-
- metaproxy --config my.xml
+
+ The configuration below specifies a simple Z39.50 proxy and
+ illustrates most configuration elements of Metaproxy.
+
+
+
+ /usr/local/metaproxy/filters
+
+
+
+ 10
+ @:9000
+
+
+ 30
+ z3950.indexdata.dk
+
+
+
+
+
+
+ log
+
+
+
+
+
+
+]]>
-
+
+ Start server with configuration in my.xml.
+
+ metaproxy --config my.xml
+
+
FILES
@@ -183,7 +269,7 @@
The Metaproxy
- manual.
+ manual.