projects / metaproxy-moved-to-github.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update doc/common
[metaproxy-moved-to-github.git] / doc / book.xml
diff --git a/doc/book.xml b/doc/book.xml
index f65d15a..d8f8e3c 100644 (file)
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -1,25 +1,16 @@
 <?xml version="1.0" standalone="no"?>
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
-    "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" 
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" 
 [
 [
+     <!ENTITY copyright SYSTEM "copyright.xml">
      <!ENTITY % local SYSTEM "local.ent">
      %local;
      <!ENTITY manref SYSTEM "manref.xml">
      <!ENTITY % local SYSTEM "local.ent">
      %local;
      <!ENTITY manref SYSTEM "manref.xml">
-     <!ENTITY progref SYSTEM "progref.xml">
-     <!ENTITY % common SYSTEM "common/common.ent">
-     %common;
-     <!-- Next line allows imagedata/@format="PDF" and is taken from 
-         http://lists.oasis-open.org/archives/docbook/200303/msg00163.html
-     -->
-     <!ENTITY % local.notation.class "| PDF">
-     <!-- Next line is necessary for some XML parsers, for reasons I
-          don't understand.  I got this from
-         http://lists.oasis-open.org/archives/docbook/200303/msg00180.html
-     -->
-     <!NOTATION PDF SYSTEM "PDF">
+     <!ENTITY gpl2 SYSTEM "gpl-2.0.xml">
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
 ]>
-<!-- $Id: book.xml,v 1.54 2007-01-18 12:39:41 marc Exp $ -->
-<book id="metaproxy">
+<book>
  <bookinfo>
   <title>Metaproxy - User's Guide and Reference</title>
   <authorgroup>
  <bookinfo>
   <title>Metaproxy - User's Guide and Reference</title>
   <authorgroup>
@@ -35,8 +26,8 @@
   </authorgroup>
   <releaseinfo>&version;</releaseinfo>
   <copyright>
   </authorgroup>
   <releaseinfo>&version;</releaseinfo>
   <copyright>
-   <year>2005-2007</year>
-   <holder>Index Data ApS</holder>
+   <year>2005-2012</year>
+   <holder>Index Data</holder>
   </copyright>
   <abstract>
    <simpara>
   </copyright>
   <abstract>
    <simpara>
@@ -48,10 +39,9 @@
     processes, interprets and redirects requests from IR clients using
     standard protocols such as the binary
     <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink>
     processes, interprets and redirects requests from IR clients using
     standard protocols such as the binary
     <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink>
-    and  the information search and retireval 
-    web services <ulink url="&url.sru;">SRU</ulink>
-    and <ulink url="&url.srw;">SRW</ulink>, as
-    well as functioning as a limited
+    and  the information search and retrieval 
+    web service <ulink url="&url.sru;">SRU</ulink>
+    as well as functioning as a limited
     <ulink url="&url.http;">HTTP</ulink> server. 
    </simpara>
    <simpara>
     <ulink url="&url.http;">HTTP</ulink> server. 
    </simpara>
    <simpara>
@@ -65,10 +55,7 @@
     using the filter API.
    </simpara>
    <simpara>
     using the filter API.
    </simpara>
    <simpara>
-    Metaproxy is <emphasis>not</emphasis> open-source software, but
-    may be freely downloaded, unpacked, inspected, built and run for
-    evaluation purposes.  Deployment requires a separate, commercial,
-    license.
+    Metaproxy is covered by the GNU General Public License version 2.
    </simpara>
    <simpara>
     <inlinemediaobject>
    </simpara>
    <simpara>
     <inlinemediaobject>
@@ -86,13 +73,12 @@
  <chapter id="introduction">
   <title>Introduction</title>
   
  <chapter id="introduction">
   <title>Introduction</title>
   
-  
   <para>
    <ulink url="&url.metaproxy;">Metaproxy</ulink>
    is a stand alone program that acts as a universal router, proxy and
    encapsulated metasearcher for information retrieval protocols such
   <para>
    <ulink url="&url.metaproxy;">Metaproxy</ulink>
    is a stand alone program that acts as a universal router, proxy and
    encapsulated metasearcher for information retrieval protocols such
-   as <ulink url="&url.z39.50;">Z39.50</ulink>, and in the future
-   <ulink url="&url.sru;">SRU</ulink> and <ulink url="&url.srw;">SRW</ulink>.
+   as <ulink url="&url.z39.50;">Z39.50</ulink> and
+   <ulink url="&url.sru;">SRU</ulink>.
    To clients, it acts as a server of these protocols: it can be searched,
    records can be retrieved from it, etc. 
    To servers, it acts as a client: it searches in them,
    To clients, it acts as a server of these protocols: it can be searched,
    records can be retrieved from it, etc. 
    To servers, it acts as a client: it searches in them,
@@ -137,60 +123,6 @@
    including examples.
   </para>
  </chapter>
    including examples.
   </para>
  </chapter>
-
- <chapter id="license">
-  <title>The Metaproxy License</title>
-  <orderedlist numeration="arabic">
-   <listitem>
-    <para>
-     You are allowed to download this software for evaluation purposes.
-     You can unpack it, build it, run it, see how it works and how it fits
-     your needs, all at zero cost.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     You may NOT deploy the software.  For the purposes of this license,
-     deployment means running it for any purpose other than evaluation,
-     whether or not you or anyone else makes a profit from doing so.  If
-     you wish to deploy the software, you must first contact Index Data and
-     arrange to purchase a DEPLOYMENT LICENCE.  If you are unsure
-     whether or not your proposed use of the software constitutes
-     deployment, email us at <literal>info@indexdata.com</literal>
-     for clarification.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     You may modify your copy of the software (fix bugs, add features)
-     if you need to.  We encourage you to send your changes back to us for
-     integration into the master copy, but you are not obliged to do so.  You
-     may NOT pass your changes on to any other party.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     There is NO WARRANTY for this software, to the extent permitted by
-     applicable law.  We provide the software ``as is'' without warranty of
-     any kind, either expressed or implied, including, but not limited to, the
-     implied warranties of MERCHANTABILITY and FITNESS FOR A
-     PARTICULAR PURPOSE.  The entire risk as to the quality and
-     performance of the software is with you.  Should the software prove
-     defective, you assume the cost of all necessary servicing, repair or
-     correction.  In no event unless required by applicable law will we be
-     liable to you for damages, arising out of the use of the software,
-     including but not limited to loss of data or data being rendered
-     inaccurate.
-    </para>
-   </listitem>
-   <listitem>
-    <para>
-     All rights to the software are reserved by Index Data except where
-     this license explicitly says otherwise.
-    </para>
-   </listitem>
-  </orderedlist>
- </chapter>
  
  <chapter id="installation">
   <title>Installation</title>
  
  <chapter id="installation">
   <title>Installation</title>
@@ -217,7 +149,8 @@
      <listitem>
       <para>
        The popular C++ library. Initial versions of Metaproxy
      <listitem>
       <para>
        The popular C++ library. Initial versions of Metaproxy
-       was built with 1.33.0. Version 1.33.1 works too.
+       was built with 1.32 but this is no longer supported.
+       Metaproxy is known to work with Boost version 1.33 through 1.46.
       </para>
      </listitem>
     </varlistentry>
       </para>
      </listitem>
     </varlistentry>
@@ -233,7 +166,7 @@
   <para>
    We have successfully built Metaproxy using the compilers
    <ulink url="&url.gcc;">GCC</ulink> version 4.0 and
   <para>
    We have successfully built Metaproxy using the compilers
    <ulink url="&url.gcc;">GCC</ulink> version 4.0 and
-   <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink> 2003/2005.
+   <ulink url="&url.vstudio;">Microsoft Visual Studio</ulink> 2003/2005/2008.
   </para>
 
   <section id="installation.unix">
   </para>
 
   <section id="installation.unix">
@@ -244,67 +177,98 @@
     tools binary packages. If, for example, Libxml2/libxslt are already
     installed as development packages use those (and omit compilation).
    </para>
     tools binary packages. If, for example, Libxml2/libxslt are already
     installed as development packages use those (and omit compilation).
    </para>
-   
-   <para>
-    Libxml2/libxslt:
-   </para>
-   <screen>
-    gunzip -c libxml2-version.tar.gz|tar xf -
-    cd libxml2-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
-   <screen>
-    gunzip -c libxslt-version.tar.gz|tar xf -
-    cd libxslt-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
-   <para>
-    YAZ/YAZ++:
-   </para>
-   <screen>
-    gunzip -c yaz-version.tar.gz|tar xf -
-    cd yaz-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
-   <screen>
-    gunzip -c yazpp-version.tar.gz|tar xf -
-    cd yazpp-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
-   <para>
-    Boost:
-   </para>
-   <screen>
-    gunzip -c boost-version.tar.gz|tar xf -
-    cd boost-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
-   <para>
-    Metaproxy:
-   </para>
-   <screen>
-    gunzip -c metaproxy-version.tar.gz|tar xf -
-    cd metaproxy-version
-    ./configure
-    make
-    su
-    make install
-   </screen>
+
+   <section id="libxml2.fromsource">
+    <title>Libxml2/libxslt</title>
+    <para>
+     Libxml2/libxslt:
+    </para>
+    <screen>
+     gunzip -c libxml2-version.tar.gz|tar xf -
+     cd libxml2-version
+     ./configure
+     make
+     su
+     make install
+    </screen>
+    <screen>
+     gunzip -c libxslt-version.tar.gz|tar xf -
+     cd libxslt-version
+     ./configure
+     make
+     su
+     make install
+    </screen>
+   </section>
+   <section id="yaz.fromsource">
+    <title>YAZ/YAZ++</title>
+    <screen>
+     gunzip -c yaz-version.tar.gz|tar xf -
+     cd yaz-version
+     ./configure
+     make
+     su
+     make install
+    </screen>
+    <screen>
+     gunzip -c yazpp-version.tar.gz|tar xf -
+     cd yazpp-version
+     ./configure
+     make
+     su
+     make install
+    </screen>
+   </section>
+   <section>
+    <title id="boost.fromsource">Boost</title>
+    <para>
+     Metaproxy needs components thread and test from
+     Boost.
+    </para>
+    <screen>
+     gunzip -c boost-version.tar.gz|tar xf -
+     cd boost-version
+     ./configure --with-libraries=thread,test,regex --with-toolset=gcc
+     make
+     su
+     make install
+    </screen>
+    <para>
+     However, under the hood bjam is used. You can invoke that with
+    </para>
+    <screen>
+     ./bjam --toolset=gcc --with-thread --with-test --with-regex stage
+    </screen>
+    <para>
+     Replace <literal>stage</literal> with <literal>clean</literal> /
+     <literal>install</literal> to perform clean and install respectively.
+    </para>
+    <para>
+     Add <literal>--prefix=DIR</literal> to install Boost in other
+     prefix than <literal>/usr/local</literal>.
+    </para>
+   </section>
+   <section id="metaproxy.fromsource">
+    <title>Metaproxy</title>
+    <screen>
+     gunzip -c metaproxy-version.tar.gz|tar xf -
+     cd metaproxy-version
+     ./configure
+     make
+     su
+     make install
+    </screen>
+    <para>
+     You may have to tell configure where Boost is installed by supplying
+     options <literal>--with-boost</literal> and <literal>--with-boost-toolset</literal>.
+     The former sets the PREFIX for Boost (same as --prefix for Boost above).
+     The latter the compiler toolset (eg. gcc34).
+    </para>
+    <para>
+     Pass <literal>--help</literal> to configure to get a list of 
+     available options.
+    </para>
+   </section>
   </section>
 
   <section id="installation.debian">
   </section>
 
   <section id="installation.debian">
@@ -321,7 +285,10 @@
    </para>
    <para>
     There is currently no official Debian package for YAZ++.
    </para>
    <para>
     There is currently no official Debian package for YAZ++.
-    And the Debian package for YAZ is probably too old.
+    And the official Debian package for YAZ is probably too old.
+    But Index Data builds "new" versions of those for Debian (i386, amd64 only).
+   </para>
+   <para>
     Update the <filename>/etc/apt/sources.list</filename>
     to include the Index Data repository.
     See YAZ' <ulink url="&url.yaz.download.debian;">Download Debian</ulink>
     Update the <filename>/etc/apt/sources.list</filename>
     to include the Index Data repository.
     See YAZ' <ulink url="&url.yaz.download.debian;">Download Debian</ulink>
@@ -329,12 +296,11 @@
    </para>
    <screen>
     apt-get install libxslt1-dev
    </para>
    <screen>
     apt-get install libxslt1-dev
-    apt-get install libyazpp-dev
+    apt-get install libyazpp4-dev
     apt-get install libboost-dev
     apt-get install libboost-thread-dev
     apt-get install libboost-dev
     apt-get install libboost-thread-dev
-    apt-get install libboost-date-time-dev
-    apt-get install libboost-program-options-dev
     apt-get install libboost-test-dev
     apt-get install libboost-test-dev
+    apt-get install libboost-regex-dev
    </screen>
    <para>
     With these packages installed, the usual configure + make
    </screen>
    <para>
     With these packages installed, the usual configure + make
@@ -343,49 +309,55 @@
    </para>
   </section>
 
    </para>
   </section>
 
+  <section id="installation.rpm">
+   <title>Installation on RPM based Linux Systems</title>
+   <para>
+    All external dependencies for Metaproxy are available as 
+    RPM packages, either from your distribution site, or from the 
+    <ulink url="http://fr.rpmfind.net/">RPMfind</ulink> site.
+   </para>
+   <para>
+    For example, an installation of the requires Boost C++ development 
+    libraries on RedHat Fedora C4 and C5 can be done like this:
+    <screen> 
+    wget ftp://fr.rpmfind.net/wlinux/fedora/core/updates/testing/4/SRPMS/boost-1.33.0-3.fc4.src.rpm
+    sudo rpmbuild --buildroot src/ --rebuild -p fc4/boost-1.33.0-3.fc4.src.rpm
+    sudo rpm -U /usr/src/redhat/RPMS/i386/boost-*rpm
+    </screen>
+   </para>
+   <para>
+    The  <ulink url="&url.yaz;">YAZ</ulink> library is needed to
+    compile &metaproxy;, see there
+    for more information on available RPM packages.
+   </para>
+   <para>
+    There is currently no official RPM package for YAZ++.
+    See the <ulink url="&url.yazplusplus;">YAZ++</ulink> pages 
+    for more information on a Unix tarball install.
+   </para>
+   <para>
+    With these packages installed, the usual configure + make
+    procedure can be used for Metaproxy as outlined in
+    <xref linkend="installation.unix"/>.
+   </para>
+  </section>
+
   <section id="installation.windows">
    <title>Installation on Windows</title>
    <para>
     Metaproxy can be compiled with Microsoft
     <ulink url="&url.vstudio;">Visual Studio</ulink>.
   <section id="installation.windows">
    <title>Installation on Windows</title>
    <para>
     Metaproxy can be compiled with Microsoft
     <ulink url="&url.vstudio;">Visual Studio</ulink>.
-    Version 2003 (C 7.1) and 2005 (C 8.0) is known to work.
+    Versions 2003 (C 7.1), 2005 (C 8.0) and 2008 (C 9.0) are known to work.
    </para>
    <section id="installation.windows.boost">
     <title>Boost</title>
     <para>
    </para>
    <section id="installation.windows.boost">
     <title>Boost</title>
     <para>
-     Get Boost from its <ulink url="&url.boost;">home page</ulink>.
-     You also need Boost Jam (an alternative to make).
-     That's also available from the Boost home page.
-     The files to be downloaded are called something like:
-     <filename>boost_1_33-1.exe</filename>
-     and
-     <filename>boost-jam-3.1.12-1-ntx86.zip</filename>.
-     Unpack Boost Jam first. Put <filename>bjam.exe</filename>
-     in your system path. Make a command prompt and ensure
-     it can be found automatically. If not check the PATH.
-     The Boost .exe is a self-extracting exe with
-     complete source for Boost. Compile that source with
-     Boost Jam (An alternative to Make).
-     The compilation takes a while.
-     For Visual Studio 2003, use
-     <screen>
-      bjam "-sTOOLS=vc-7_1"
-     </screen>
-     Here <literal>vc-7_1</literal> refers to a "Toolset" (compiler system).
-     For Visual Studio 2005, use
-     <screen>
-      bjam "-sTOOLS=vc-8_0"
-     </screen>
-     To install the libraries in a common place, use
-     <screen>
-      bjam "-sTOOLS=vc-7_1" install
-     </screen>
-     (or vc-8_0 for VS 2005).
-    </para>
-    <para>
-     By default, the Boost build process installs the resulting
-     libraries + header files in
-     <literal>\boost\lib</literal>, <literal>\boost\include</literal>.
+     For Windows, it's easiest to get the precompiled Boost
+     package from <ulink url="&url.boost.windows.download;">here</ulink>.
+     Several versions of the Boost libraries may be selected when
+     installing Boost for windows. Please choose at least the
+     <emphasis>multithreaded</emphasis> (non-DLL) version because
+     the Metaproxy makefile uses that.
     </para>
     <para>
      For more information about installing Boost refer to the
     </para>
     <para>
      For more information about installing Boost refer to the
@@ -403,7 +375,7 @@
     </para>
     <para>
      Libxslt has other dependencies, but these can all be downloaded
     </para>
     <para>
      Libxslt has other dependencies, but these can all be downloaded
-     from the same site. Get the following:
+     from the same site. Get the following package:
      iconv, zlib, libxml2, libxslt.
     </para>
    </section>
      iconv, zlib, libxml2, libxslt.
     </para>
    </section>
@@ -421,9 +393,7 @@
     <title>YAZ++</title>
     <para>
      Get <ulink url="&url.yazplusplus;">YAZ++</ulink> as well.
     <title>YAZ++</title>
     <para>
      Get <ulink url="&url.yazplusplus;">YAZ++</ulink> as well.
-     Version 1.0 or later is required. For now get it from
-     Index Data's
-     <ulink url="&url.snapshot.download;">Snapshot area</ulink>.
+     Version 1.2.7 or later is required.
     </para>
     <para>
      YAZ++ includes NMAKE makefiles, similar to those found in the
     </para>
     <para>
      YAZ++ includes NMAKE makefiles, similar to those found in the
@@ -502,6 +472,153 @@
   </section>
  </chapter>
  
   </section>
  </chapter>
  
+<chapter id="yazproxy-comparison">
+ <title>YAZ Proxy Comparison</title>
+ <para>
+  The table below lists facilities either supported by either
+   <ulink url="&url.yazproxy;">YAZ Proxy</ulink> or Metaproxy.
+ </para>
+<table id="yazproxy-comparison-table">
+ <title>Metaproxy / YAZ Proxy comparison</title>
+ <tgroup cols="3">
+  <thead>
+   <row>
+    <entry>Facility</entry>
+    <entry>Metaproxy</entry>
+    <entry>YAZ Proxy</entry>
+   </row>
+  </thead>
+  <tbody>
+   <row>
+    <entry>Z39.50 server</entry>
+    <entry>Using filter <literal>frontend_net</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>SRU server</entry>
+    <entry>Supported with filter <literal>sru_z3950</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Z39.50 client</entry>
+    <entry>Supported with filter <literal>z3950_client</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>SRU client</entry>
+    <entry>Unsupported</entry>
+    <entry>Unsupported</entry>
+   </row>
+   <row>
+    <entry>Connection reuse</entry>
+    <entry>Supported with filter <literal>session_shared</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Connection share</entry>
+    <entry>Supported with filter <literal>session_shared</literal></entry>
+    <entry>Unsupported</entry>
+   </row>
+   <row>
+    <entry>Result set reuse</entry>
+    <entry>Supported with filter <literal>session_shared</literal></entry>
+    <entry>Within one Z39.50 session / HTTP keep-alive</entry>
+   </row>
+   <row>
+    <entry>Record cache</entry>
+    <entry>Supported by filter <literal>session_shared</literal></entry>
+    <entry>Supported for last result set within one Z39.50/HTTP-keep alive session</entry>
+   </row>
+   <row>
+    <entry>Z39.50 Virtual database, i.e. select any Z39.50 target for database</entry>
+    <entry>Supported with filter <literal>virt_db</literal></entry>
+    <entry>Unsupported</entry>
+   </row>
+   <row>
+    <entry>SRU Virtual database, i.e. select any Z39.50 target for path</entry>
+    <entry>Supported with filter <literal>virt_db</literal>, 
+     <literal>sru_z3950</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Multi target search</entry>
+    <entry>Supported with filter <literal>multi</literal> (round-robin)</entry>
+    <entry>Unsupported</entry>
+   </row>
+   <row>
+    <entry>Retrieval and search limits</entry>
+    <entry>Supported using filter <literal>limit</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Bandwidth limits</entry>
+    <entry>Supported using filter <literal>limit</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Connect limits</entry>
+    <entry>Supported by filter <literal>frontend_net</literal> (connect-max)</entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Retrieval sanity check and conversions</entry>
+    <entry>Supported using filter <literal>record_transform</literal></entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Query check</entry>
+    <entry>
+      Supported by <literal>query_rewrite</literal> which may be check
+      a query and throw diagnostics (errors)
+    </entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Query rewrite</entry>
+    <entry>Supported with <literal>query_rewrite</literal></entry>
+    <entry>Unsupported</entry>
+   </row>
+   <row>
+    <entry>Session invalidate for -1 hits</entry>
+    <entry>Unsupported</entry>
+    <entry>Supported</entry>
+   </row>
+   <row>
+    <entry>Architecture</entry>
+    <entry>Multi-threaded + select for networked modules such as
+      <literal>frontend_net</literal>)</entry>
+    <entry>Single-threaded using select</entry>
+   </row>
+
+   <row>
+    <entry>Extensability</entry>
+    <entry>Most functionality implemented as loadable modules</entry>
+    <entry>Unsupported and experimental</entry>
+   </row>
+
+   <row>
+    <entry><ulink url="&url.usemarcon;">USEMARCON</ulink></entry>
+    <entry>Unsupported</entry>
+    <entry>Supported</entry>
+   </row>
+
+   <row>
+    <entry>Portability</entry>
+    <entry>
+     Requires YAZ, YAZ++ and modern C++ compiler supporting
+     <ulink url="&url.boost;">Boost</ulink>.
+    </entry>
+    <entry>
+     Requires YAZ and YAZ++.
+     STL is not required so pretty much any C++ compiler out there should work.
+    </entry>
+   </row>
+
+  </tbody>
+ </tgroup>
+</table>
+</chapter>
+
  <chapter id="architecture">
   <title>The Metaproxy Architecture</title>
   <para>
  <chapter id="architecture">
   <title>The Metaproxy Architecture</title>
   <para>
@@ -582,7 +699,7 @@
       plugins that provide new filters.  The filter API is small and
       conceptually simple, but there are many details to master.  See
       the section below on
       plugins that provide new filters.  The filter API is small and
       conceptually simple, but there are many details to master.  See
       the section below on
-      <link linkend="extensions">extensions</link>.
+      <link linkend="filters">Filters</link>.
      </para>
     </listitem>
    </varlistentry>
      </para>
     </listitem>
    </varlistentry>
@@ -602,7 +719,7 @@
   <title>Filters</title>
   
   
   <title>Filters</title>
   
   
-  <section>
+  <section id="filters-introductory-notes">
    <title>Introductory notes</title>
    <para>
     It's useful to think of Metaproxy as an interpreter providing a small
    <title>Introductory notes</title>
    <para>
     It's useful to think of Metaproxy as an interpreter providing a small
@@ -701,7 +818,7 @@ Figure out what additional information we need in:
 
 -->
 
 
 -->
 
-   <section>
+   <section id="auth_simple">
     <title><literal>auth_simple</literal>
      (mp::filter::AuthSimple)</title>
     <para>
     <title><literal>auth_simple</literal>
      (mp::filter::AuthSimple)</title>
     <para>
@@ -720,7 +837,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="backend_test">
     <title><literal>backend_test</literal>
     (mp::filter::Backend_test)</title>
     <para>
     <title><literal>backend_test</literal>
     (mp::filter::Backend_test)</title>
     <para>
@@ -731,7 +848,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="bounce">
     <title><literal>bounce</literal>
     (mp::filter::Bounce)</title>
     <para>
     <title><literal>bounce</literal>
     (mp::filter::Bounce)</title>
     <para>
@@ -749,7 +866,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="cql_rpn">
     <title><literal>cql_rpn</literal>
     (mp::filter::CQLtoRPN)</title>
     <para>
     <title><literal>cql_rpn</literal>
     (mp::filter::CQLtoRPN)</title>
     <para>
@@ -762,7 +879,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="frontend_net">
     <title><literal>frontend_net</literal>
      (mp::filter::FrontendNet)</title>
     <para>
     <title><literal>frontend_net</literal>
      (mp::filter::FrontendNet)</title>
     <para>
@@ -773,7 +890,7 @@ Figure out what additional information we need in:
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="http_file">
     <title><literal>http_file</literal>
      (mp::filter::HttpFile)</title>
     <para>
     <title><literal>http_file</literal>
      (mp::filter::HttpFile)</title>
     <para>
@@ -790,7 +907,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="load_balance">
     <title><literal>load_balance</literal>
      (mp::filter::LoadBalance)</title>
     <para>
     <title><literal>load_balance</literal>
      (mp::filter::LoadBalance)</title>
     <para>
@@ -810,7 +927,7 @@ Figure out what additional information we need in:
    </para>
    </section>
       
    </para>
    </section>
       
-   <section>
+   <section id="log">
     <title><literal>log</literal>
      (mp::filter::Log)</title>
     <para>
     <title><literal>log</literal>
      (mp::filter::Log)</title>
     <para>
@@ -820,7 +937,7 @@ Figure out what additional information we need in:
    </para>
    </section>
 
    </para>
    </section>
 
-   <section>
+   <section id="multi">
    <title><literal>multi</literal>
      (mp::filter::Multi)</title>
     <para>
    <title><literal>multi</literal>
      (mp::filter::Multi)</title>
     <para>
@@ -831,7 +948,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="query_rewrite">
    <title><literal>query_rewrite</literal>
      (mp::filter::QueryRewrite)</title>
     <para>
    <title><literal>query_rewrite</literal>
      (mp::filter::QueryRewrite)</title>
     <para>
@@ -847,7 +964,7 @@ Figure out what additional information we need in:
    </section>
    
    
    </section>
    
    
-   <section>
+   <section id="record_transform">
     <title><literal>record_transform</literal>
     (mp::filter::RecordTransform)</title>
     <para>
     <title><literal>record_transform</literal>
     (mp::filter::RecordTransform)</title>
     <para>
@@ -861,7 +978,7 @@ Figure out what additional information we need in:
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="session_shared">
     <title><literal>session_shared</literal>
      (mp::filter::SessionShared)</title>
     <para>
     <title><literal>session_shared</literal>
      (mp::filter::SessionShared)</title>
     <para>
@@ -872,7 +989,7 @@ Figure out what additional information we need in:
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="sru_z3950">
     <title><literal>sru_z3950</literal>
     (mp::filter::SRUtoZ3950)</title>
     <para>
     <title><literal>sru_z3950</literal>
     (mp::filter::SRUtoZ3950)</title>
     <para>
@@ -894,7 +1011,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="template">
     <title><literal>template</literal>
      (mp::filter::Template)</title>
     <para>
     <title><literal>template</literal>
      (mp::filter::Template)</title>
     <para>
@@ -907,7 +1024,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="virt_db">
     <title><literal>virt_db</literal>
      (mp::filter::VirtualDB)</title>
     <para>
     <title><literal>virt_db</literal>
      (mp::filter::VirtualDB)</title>
     <para>
@@ -922,7 +1039,7 @@ Figure out what additional information we need in:
     </para>
    </section>
    
     </para>
    </section>
    
-   <section>
+   <section id="z3950_client">
     <title><literal>z3950_client</literal>
      (mp::filter::Z3950Client)</title>
     <para>
     <title><literal>z3950_client</literal>
      (mp::filter::Z3950Client)</title>
     <para>
@@ -940,7 +1057,7 @@ Figure out what additional information we need in:
   </section>
 
 
   </section>
 
 
-   <section>
+   <section id="zeerex_explain">
     <title><literal>zeerex_explain</literal>
      (mp::filter::ZeerexExplain)</title>
     <para>
     <title><literal>zeerex_explain</literal>
      (mp::filter::ZeerexExplain)</title>
     <para>
@@ -1008,7 +1125,7 @@ Figure out what additional information we need in:
   <title>Configuration: the Metaproxy configuration file format</title>
   
   
   <title>Configuration: the Metaproxy configuration file format</title>
   
   
-  <section>
+  <section id="configuration-introductory-notes">
    <title>Introductory notes</title>
    <para>
     If Metaproxy is an interpreter providing operations on packages, then
    <title>Introductory notes</title>
    <para>
     If Metaproxy is an interpreter providing operations on packages, then
@@ -1033,11 +1150,19 @@ Figure out what additional information we need in:
     &lt;metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0"&gt;
    </screen>
    <para>
     &lt;metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0"&gt;
    </screen>
    <para>
-    The top-level element is &lt;metaproxy&gt;.  This contains a
-    &lt;start&gt; element, a &lt;filters&gt; element and a
-    &lt;routes&gt; element, in that order.  &lt;filters&gt; is
-    optional; the other two are mandatory.  All three are
-    non-repeatable.
+    The top-level element is &lt;metaproxy&gt;.  This contains
+    a &lt;dlpath&gt; element,
+    a &lt;start&gt; element,
+    a &lt;filters&gt; element and
+    a &lt;routes&gt; element, in that order.  &lt;dlpath&gt; and
+    &lt;filters&gt; are optional; the other two are mandatory.
+    All four are non-repeatable.
+   </para>
+   <para>
+     The &lt;dlpath;&gt; element contains a text element which 
+     specifies the location of filter modules. This is only needed
+     if Metaproxy must load 3rd party filters (most filters with Metaproxy
+     are built into the Metaproxy application).
    </para>
   <para>
     The &lt;start&gt; element is empty, but carries a
    </para>
   <para>
     The &lt;start&gt; element is empty, but carries a
@@ -1090,6 +1215,7 @@ Figure out what additional information we need in:
    </para>
    <screen><![CDATA[<?xml version="1.0"?>
 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
    </para>
    <screen><![CDATA[<?xml version="1.0"?>
 <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0">
+  <dlpath>/usr/lib/metaproxy/modules</dlpath>
   <start route="start"/>
   <filters>
     <filter id="frontend" type="frontend_net">
   <start route="start"/>
   <filters>
     <filter id="frontend" type="frontend_net">
@@ -1190,7 +1316,7 @@ Figure out what additional information we need in:
   <title>Virtual databases and multi-database searching</title>
 
 
   <title>Virtual databases and multi-database searching</title>
 
 
-  <section>
+  <section id="multidb-introductory-notes">
    <title>Introductory notes</title>
    <para>
     Two of Metaproxy's filters are concerned with multiple-database
    <title>Introductory notes</title>
    <para>
     Two of Metaproxy's filters are concerned with multiple-database
@@ -1524,13 +1650,8 @@ Z>
     merges them into a single Search response, which is what
     eventually makes it back to the client.
    </para>
     merges them into a single Search response, which is what
     eventually makes it back to the client.
    </para>
-  </section>
-
 
 
-  <section id="multidb.picture">
-   <title>A picture is worth a thousand words (but only five hundred on 64-bit architectures)</title>
-   <simpara>
-    <inlinemediaobject>
+    <mediaobject>
      <imageobject>
       <imagedata fileref="multi.pdf" format="PDF" scale="50"/>
      </imageobject>
      <imageobject>
       <imagedata fileref="multi.pdf" format="PDF" scale="50"/>
      </imageobject>
@@ -1547,13 +1668,10 @@ Z>
        document.]
       </phrase>
      </textobject>
        document.]
       </phrase>
      </textobject>
-<!-- ### This used to work with an older version of DocBook
      <caption>
      <caption>
-      <para>Caption: progress of packages through filters.</para>
+      <para>A picture is worth a thousand words (but only five hundred on 64-bit architectures)</para>
      </caption>
      </caption>
--->
-    </inlinemediaobject>
-   </simpara>
+    </mediaobject>
   </section>
  </chapter>
 
   </section>
  </chapter>
 
@@ -1563,7 +1681,6 @@ Z>
   <para>
    Metaproxy can act as 
    <ulink url="&url.sru;">SRU</ulink> and 
   <para>
    Metaproxy can act as 
    <ulink url="&url.sru;">SRU</ulink> and 
-   <ulink url="&url.srw;">SRW</ulink> 
    web service server, which translates web service requests to 
    <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink> packages and
    sends them off to common available targets.
    web service server, which translates web service requests to 
    <ulink url="&url.z39.50;">ANSI/NISO Z39.50</ulink> packages and
    sends them off to common available targets.
@@ -1654,9 +1771,8 @@ Z>
    </tgroup>
   </table>
   <para> 
    </tgroup>
   </table>
   <para> 
-   A typical minimal example  <ulink url="&url.sru;">SRU</ulink> and 
-   <ulink url="&url.srw;">SRW</ulink> server configuration file is found
-   in the tarball distribution at 
+   A typical minimal example <ulink url="&url.sru;">SRU</ulink>
+   server configuration file is found in the tarball distribution at 
    <literal>etc/config-sru-to-z3950.xml</literal>.
   </para> 
   <para>
    <literal>etc/config-sru-to-z3950.xml</literal>.
   </para> 
   <para>
@@ -1682,7 +1798,7 @@ Z>
   <title>Classes in the Metaproxy source code</title>
 
 
   <title>Classes in the Metaproxy source code</title>
 
 
-  <section>
+  <section id="classes-introductory-notes">
    <title>Introductory notes</title>
    <para>
     <emphasis>Stop!  Do not read this!</emphasis>
    <title>Introductory notes</title>
    <para>
     <emphasis>Stop!  Do not read this!</emphasis>
@@ -1728,7 +1844,7 @@ Z>
     parentheses.
    </para>
 
     parentheses.
    </para>
 
-   <section>
+   <section id="class-FactoryFilter">
     <title><literal>mp::FactoryFilter</literal>
      (<filename>factory_filter.cpp</filename>)</title>
     <para>
     <title><literal>mp::FactoryFilter</literal>
      (<filename>factory_filter.cpp</filename>)</title>
     <para>
@@ -1743,7 +1859,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-FactoryStatic">
     <title><literal>mp::FactoryStatic</literal>
      (<filename>factory_static.cpp</filename>)</title>
     <para>
     <title><literal>mp::FactoryStatic</literal>
      (<filename>factory_static.cpp</filename>)</title>
     <para>
@@ -1758,7 +1874,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-filter-Base">
     <title><literal>mp::filter::Base</literal>
      (<filename>filter.cpp</filename>)</title>
     <para>
     <title><literal>mp::filter::Base</literal>
      (<filename>filter.cpp</filename>)</title>
     <para>
@@ -1775,7 +1891,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-AuthSimple">
     <title><literal>mp::filter::AuthSimple</literal>,
      <literal>Backend_test</literal>, etc.
      (<filename>filter_auth_simple.cpp</filename>,
     <title><literal>mp::filter::AuthSimple</literal>,
      <literal>Backend_test</literal>, etc.
      (<filename>filter_auth_simple.cpp</filename>,
@@ -1817,7 +1933,7 @@ Z>
     </itemizedlist>
    </section>
 
     </itemizedlist>
    </section>
 
-   <section>
+   <section id="class-Package">
     <title><literal>mp::Package</literal>
      (<filename>package.cpp</filename>)</title>
     <para>
     <title><literal>mp::Package</literal>
      (<filename>package.cpp</filename>)</title>
     <para>
@@ -1828,7 +1944,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-Pipe">
     <title><literal>mp::Pipe</literal>
      (<filename>pipe.cpp</filename>)</title>
     <para>
     <title><literal>mp::Pipe</literal>
      (<filename>pipe.cpp</filename>)</title>
     <para>
@@ -1838,7 +1954,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-RouterChain">
     <title><literal>mp::RouterChain</literal>
      (<filename>router_chain.cpp</filename>)</title>
     <para>
     <title><literal>mp::RouterChain</literal>
      (<filename>router_chain.cpp</filename>)</title>
     <para>
@@ -1846,7 +1962,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-RouterFleXML">
     <title><literal>mp::RouterFleXML</literal>
      (<filename>router_flexml.cpp</filename>)</title>
     <para>
     <title><literal>mp::RouterFleXML</literal>
      (<filename>router_flexml.cpp</filename>)</title>
     <para>
@@ -1854,7 +1970,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-Session">
     <title><literal>mp::Session</literal>
      (<filename>session.cpp</filename>)</title>
     <para>
     <title><literal>mp::Session</literal>
      (<filename>session.cpp</filename>)</title>
     <para>
@@ -1862,7 +1978,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-ThreadPoolSocketObserver">
     <title><literal>mp::ThreadPoolSocketObserver</literal>
      (<filename>thread_pool_observer.cpp</filename>)</title>
     <para>
     <title><literal>mp::ThreadPoolSocketObserver</literal>
      (<filename>thread_pool_observer.cpp</filename>)</title>
     <para>
@@ -1870,7 +1986,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-util">
     <title><literal>mp::util</literal>
      (<filename>util.cpp</filename>)</title>
     <para>
     <title><literal>mp::util</literal>
      (<filename>util.cpp</filename>)</title>
     <para>
@@ -1881,7 +1997,7 @@ Z>
     </para>
    </section>
 
     </para>
    </section>
 
-   <section>
+   <section id="class-xml">
     <title><literal>mp::xml</literal>
      (<filename>xmlutil.cpp</filename>)</title>
     <para>
     <title><literal>mp::xml</literal>
      (<filename>xmlutil.cpp</filename>)</title>
     <para>
@@ -1938,7 +2054,7 @@ Z>
  
  <reference id="reference">
   <title>Reference</title>
  
  <reference id="reference">
   <title>Reference</title>
-   <partintro>
+   <partintro id="reference-introduction">
     <para>
      The material in this chapter is drawn directly from the individual
      manual entries.  In particular, the Metaproxy invocation section is
     <para>
      The material in this chapter is drawn directly from the individual
      manual entries.  In particular, the Metaproxy invocation section is
@@ -1949,19 +2065,41 @@ Z>
    </partintro>
    &manref;
  </reference>
    </partintro>
    &manref;
  </reference>
+
+<appendix id="license">
+ <title>License</title>
+
+  &copyright;
+
+  <para>
+   Metaproxy is free software; you can redistribute it and/or modify it under
+   the terms of the GNU General Public License as published by the Free
+   Software Foundation; either version 2, or (at your option) any later
+   version.
+   </para>
+
+  <para>
+   Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
+   WARRANTY; without even the implied warranty of MERCHANTABILITY or
+   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+   for more details.
+  </para>
+  
+  <para>
+   You should have received a copy of the GNU General Public License
+   along with Metaproxy; see the file LICENSE.  If not, write to the
+   Free Software Foundation, 
+   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+   </para>
+  
+ </appendix>
+
+ &gpl2;
 </book>
 
 </book>
 
- <!-- Keep this comment at the end of the file
- Local variables:
- mode: sgml
- sgml-omittag:t
- sgml-shorttag:t
- sgml-minimize-attributes:nil
- sgml-always-quote-attributes:t
- sgml-indent-step:1
- sgml-indent-data:t
- sgml-parent-document: nil
- sgml-local-catalogs: nil
- sgml-namecase-general:t
- End:
- -->
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: nxml
+nxml-child-indent: 1
+End:
+-->
Z39.50/Web Router