X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=9b641bdae3630689c64b82f2cd46d3f5b316cf81;hb=456a4e8d37159ea87c0451ab62eb3a9b1b485170;hp=1d2950652c7b5aadc450d91f9a252e520bc30643;hpb=601933683c68801e86c4f1380b70a8972eaa1cb1;p=metaproxy-moved-to-github.git diff --git a/doc/book.xml b/doc/book.xml index 1d29506..9b641bd 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -18,7 +18,6 @@ --> ]> - Metaproxy - User's Guide and Reference @@ -48,10 +47,9 @@ processes, interprets and redirects requests from IR clients using standard protocols such as the binary ANSI/NISO Z39.50 - and the information search and retireval - web services SRU - and SRW, as - well as functioning as a limited + and the information search and retrieval + web service SRU + as well as functioning as a limited HTTP server. @@ -87,8 +85,8 @@ Metaproxy is a stand alone program that acts as a universal router, proxy and encapsulated metasearcher for information retrieval protocols such - as Z39.50, and in the future - SRU and SRW. + as Z39.50 and + SRU. 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, @@ -159,7 +157,8 @@ 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.38. @@ -186,67 +185,98 @@ tools binary packages. If, for example, Libxml2/libxslt are already installed as development packages use those (and omit compilation). - - - Libxml2/libxslt: - - - gunzip -c libxml2-version.tar.gz|tar xf - - cd libxml2-version - ./configure - make - su - make install - - - gunzip -c libxslt-version.tar.gz|tar xf - - cd libxslt-version - ./configure - make - su - make install - - - YAZ/YAZ++: - - - gunzip -c yaz-version.tar.gz|tar xf - - cd yaz-version - ./configure - make - su - make install - - - gunzip -c yazpp-version.tar.gz|tar xf - - cd yazpp-version - ./configure - make - su - make install - - - Boost: - - - gunzip -c boost-version.tar.gz|tar xf - - cd boost-version - ./configure - make - su - make install - - - Metaproxy: - - - gunzip -c metaproxy-version.tar.gz|tar xf - - cd metaproxy-version - ./configure - make - su - make install - + +
+ Libxml2/libxslt + + Libxml2/libxslt: + + + gunzip -c libxml2-version.tar.gz|tar xf - + cd libxml2-version + ./configure + make + su + make install + + + gunzip -c libxslt-version.tar.gz|tar xf - + cd libxslt-version + ./configure + make + su + make install + +
+
+ YAZ/YAZ++ + + gunzip -c yaz-version.tar.gz|tar xf - + cd yaz-version + ./configure + make + su + make install + + + gunzip -c yazpp-version.tar.gz|tar xf - + cd yazpp-version + ./configure + make + su + make install + +
+
+ Boost + + Metaproxy needs components thread and test from + Boost. + + + gunzip -c boost-version.tar.gz|tar xf - + cd boost-version + ./configure --with-libraries=thread,test --with-toolset=gcc + make + su + make install + + + However, under the hood bjam is used. You can invoke that with + + + ./bjam --toolset=gcc --with-thread --with-test stage + + + Replace stage with clean / + install to perform clean and install respectively. + + + Add --prefix=DIR to install Boost in other + prefix than /usr/local. + +
+
+ Metaproxy + + gunzip -c metaproxy-version.tar.gz|tar xf - + cd metaproxy-version + ./configure + make + su + make install + + + You may have to tell configure where Boost is installed by supplying + options --with-boost and --with-boost-toolset. + The former sets the PREFIX for Boost (same as --prefix for Boost above). + The latter the compiler toolset (eg. gcc34). + + + Pass --help to configure to get a list of + available options. + +
@@ -263,7 +293,10 @@ 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). + + Update the /etc/apt/sources.list to include the Index Data repository. See YAZ' Download Debian @@ -271,11 +304,9 @@ 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 @@ -323,44 +354,17 @@ Metaproxy can be compiled with Microsoft Visual Studio. - 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) is known to work.
Boost - Get Boost from its home page. - 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: - boost_1_33-1.exe - and - boost-jam-3.1.12-1-ntx86.zip. - Unpack Boost Jam first. Put bjam.exe - 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 - - bjam "-sTOOLS=vc-7_1" - - Here vc-7_1 refers to a "Toolset" (compiler system). - For Visual Studio 2005, use - - bjam "-sTOOLS=vc-8_0" - - To install the libraries in a common place, use - - bjam "-sTOOLS=vc-7_1" install - - (or vc-8_0 for VS 2005). - - - By default, the Boost build process installs the resulting - libraries + header files in - \boost\lib, \boost\include. + For Windows, it's easiest to get the precompiled Boost + package from here. + Several versions of the Boost libraries may be selected when + installing Boost for windows. Please choose at least the + multithreaded (non-DLL) version because + the Metaproxy makefile uses that. For more information about installing Boost refer to the @@ -378,7 +382,7 @@ 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.
@@ -396,9 +400,7 @@ YAZ++ Get YAZ++ as well. - Version 1.0 or later is required. For now get it from - Index Data's - Snapshot area. + Version 1.1.0 or later is required. YAZ++ includes NMAKE makefiles, similar to those found in the @@ -1154,11 +1156,19 @@ Figure out what additional information we need in: <metaproxy xmlns="http://indexdata.com/metaproxy" version="1.0"> - The top-level element is <metaproxy>. This contains a - <start> element, a <filters> element and a - <routes> element, in that order. <filters> is - optional; the other two are mandatory. All three are - non-repeatable. + The top-level element is <metaproxy>. This contains + a <dlpath> element, + a <start> element, + a <filters> element and + a <routes> element, in that order. <dlpath> and + <filters> are optional; the other two are mandatory. + All four are non-repeatable. + + + The <dlpath;> 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). The <start> element is empty, but carries a @@ -1211,6 +1221,7 @@ Figure out what additional information we need in: + /usr/lib/metaproxy/modules @@ -1684,7 +1695,6 @@ Z> Metaproxy can act as SRU and - SRW web service server, which translates web service requests to ANSI/NISO Z39.50 packages and sends them off to common available targets. @@ -1775,9 +1785,8 @@ Z> - A typical minimal example SRU and - SRW server configuration file is found - in the tarball distribution at + A typical minimal example SRU + server configuration file is found in the tarball distribution at etc/config-sru-to-z3950.xml.