Updated copyright headers. Omit CVS ID.
[metaproxy-moved-to-github.git] / doc / book.xml
index 1d29506..332600f 100644 (file)
@@ -18,7 +18,6 @@
      -->
      <!NOTATION PDF SYSTEM "PDF">
 ]>
-<!-- $Id: book.xml,v 1.60 2007-05-22 11:05:45 adam Exp $ -->
 <book id="metaproxy">
  <bookinfo>
   <title>Metaproxy - User's Guide and Reference</title>
     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>
@@ -87,8 +85,8 @@
    <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,
      <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 / 1.34.
       </para>
      </listitem>
     </varlistentry>
    </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 bulds "new" versions of those for Debian (i386 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>
    </para>
    <screen>
     apt-get install libxslt1-dev
-    apt-get install libyazpp-dev
+    apt-get install libyazpp2-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
    </screen>
    <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>
      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>
     <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.0.3 or later is required.
     </para>
     <para>
      YAZ++ includes NMAKE makefiles, similar to those found in the
@@ -1684,7 +1655,6 @@ Z>
   <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.
@@ -1775,9 +1745,8 @@ Z>
    </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>