X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=8eaa1af38abd727c42fabb5a43f0ad24cb4819ab;hb=d753a6a3fe09080bd4b8209e14ff3338ea0b5044;hp=2eaf45f073f1a593860bdcc22c5b581fd338aa54;hpb=6224d984542604bf2a5ba588f1dac1bceb2a2d40;p=metaproxy-moved-to-github.git diff --git a/doc/book.xml b/doc/book.xml index 2eaf45f..8eaa1af 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -1,25 +1,16 @@ - %local; - %idcommon; - - - - ]> - + Metaproxy - User's Guide and Reference @@ -35,8 +26,8 @@ &version; - 2005-2009 - Index Data ApS + 2005-2013 + Index Data @@ -48,10 +39,10 @@ processes, interprets and redirects requests from IR clients using standard protocols such as the binary ANSI/NISO Z39.50 - and the information search and retrieval + and the information search and retrieval web service SRU as well as functioning as a limited - HTTP server. + HTTP server. Metaproxy is configured by an XML file which @@ -81,7 +72,7 @@ Introduction - + Metaproxy is a stand alone program that acts as a universal router, proxy and @@ -89,7 +80,7 @@ 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. + records can be retrieved from it, etc. To servers, it acts as a client: it searches in them, retrieves records from them, etc. it satisfies its clients' requests by transforming them, multiplexing them, forwarding them @@ -132,7 +123,7 @@ including examples. - + Installation @@ -147,7 +138,7 @@ Libxslt - This is an XSLT processor - based on + This is an XSLT processor - based on Libxml2. Both Libxml2 and Libxslt must be installed with the development components (header files, etc.) as well as the run-time libraries. @@ -159,7 +150,7 @@ The popular C++ library. Initial versions of Metaproxy was built with 1.32 but this is no longer supported. - Metaproxy is known to work with Boost version 1.33 through 1.38. + Metaproxy is known to work with Boost version 1.33 through 1.46. @@ -175,9 +166,14 @@ We have successfully built Metaproxy using the compilers GCC version 4.0 and - Microsoft Visual Studio 2003/2005. + Microsoft Visual Studio 2003/2005/2008. + + As an option, Metaproxy may also be compiled with + USEMARCON support which allows for + MARC conversions for the filter. +
Installation on Unix (from Source) @@ -187,6 +183,14 @@ installed as development packages use those (and omit compilation). + + + USEMARCON is not available + as a package at the moment, so Metaproxy must be built from source + if that is to be used. + + +
Libxml2/libxslt @@ -209,6 +213,18 @@ make install
+
+ USEMARCON (optional) + + gunzip -c usemarcon317.tar.gz|tar xf - + cd usemarcon317 + ./configure + make + su + make install + +
+
YAZ/YAZ++ @@ -237,7 +253,7 @@ gunzip -c boost-version.tar.gz|tar xf - cd boost-version - ./configure --with-libraries=thread,test --with-toolset=gcc + ./configure --with-libraries=thread,test,regex --with-toolset=gcc make su make install @@ -246,7 +262,7 @@ However, under the hood bjam is used. You can invoke that with - ./bjam --toolset=gcc --with-thread --with-test stage + ./bjam --toolset=gcc --with-thread --with-test --with-regex stage Replace stage with clean / @@ -274,7 +290,7 @@ The latter the compiler toolset (eg. gcc34). - Pass --help to configure to get a list of + Pass --help to configure to get a list of available options.
@@ -283,9 +299,9 @@
Installation on Debian GNU/Linux - All dependencies for Metaproxy are available as + All dependencies for Metaproxy are available as Debian - packages for the sarge (stable in 2005) and etch (testing in 2005) + packages for the squeeze (stable in 2012) and wheezy (testing in 2012) distributions. @@ -295,7 +311,7 @@ There is currently no official Debian package for YAZ++. And the official Debian package for YAZ is probably too old. - But Index Data bulds "new" versions of those for Debian (i386 only). + But Index Data builds "new" versions of those for Debian (i386, amd64 only). Update the /etc/apt/sources.list @@ -305,10 +321,11 @@ apt-get install libxslt1-dev - apt-get install libyazpp2-dev + apt-get install libyazpp4-dev apt-get install libboost-dev apt-get install libboost-thread-dev apt-get install libboost-test-dev + apt-get install libboost-regex-dev With these packages installed, the usual configure + make @@ -320,14 +337,14 @@
Installation on RPM based Linux Systems - All external dependencies for Metaproxy are available as - RPM packages, either from your distribution site, or from the + All external dependencies for Metaproxy are available as + RPM packages, either from your distribution site, or from the RPMfind site. - For example, an installation of the requires Boost C++ development + For example, an installation of the requires Boost C++ development libraries on RedHat Fedora C4 and C5 can be done like this: - + 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 @@ -340,7 +357,7 @@ There is currently no official RPM package for YAZ++. - See the YAZ++ pages + See the YAZ++ pages for more information on a Unix tarball install. @@ -355,7 +372,7 @@ Metaproxy can be compiled with Microsoft Visual Studio. - Versions 2003 (C 7.1), 2005 (C 8.0) and 2008 (C 9.0) is known to work. + Versions 2003 (C 7.1), 2005 (C 8.0) and 2008 (C 9.0) are known to work.
Boost @@ -401,7 +418,7 @@ YAZ++ Get YAZ++ as well. - Version 1.1.0 or later is required. + Version 1.2.7 or later is required. YAZ++ includes NMAKE makefiles, similar to those found in the @@ -466,9 +483,9 @@ - + - + After successful compilation you'll find metaproxy.exe in the @@ -479,7 +496,7 @@
- + YAZ Proxy Comparison @@ -544,7 +561,7 @@ SRU Virtual database, i.e. select any Z39.50 target for path - Supported with filter virt_db, + Supported with filter virt_db, sru_z3950 Supported @@ -606,7 +623,7 @@ USEMARCON - Unsupported + Supported with record_transform Supported @@ -725,8 +742,8 @@ Filters - - + +
Introductory notes @@ -764,7 +781,7 @@ others are sinks: they consume packages and return a result (backend_test, bounce, - http_file, + http_file, z3950_client); the others are true filters, that read, process and pass on the packages they are fed @@ -779,8 +796,8 @@ virt_db).
- - + +
Overview of filter types @@ -802,7 +819,7 @@ The filters are here listed in alphabetical order: - + - - +
@@ -1695,17 +1704,17 @@ Z> Combined SRU webservice and Z39.50 server configuration - Metaproxy can act as - SRU and - web service server, which translates web service requests to + Metaproxy can act as + SRU and + web service server, which translates web service requests to ANSI/NISO Z39.50 packages and sends them off to common available targets. A typical setup for this operation needs a filter route including the - following modules: + following modules: - + SRU/Z39.50 Server Filter Route Configuration @@ -1716,7 +1725,7 @@ Z> Purpose - + frontend_net @@ -1786,16 +1795,16 @@ Z>
- + A typical minimal example SRU - server configuration file is found in the tarball distribution at + server configuration file is found in the tarball distribution at etc/config-sru-to-z3950.xml. - + Off course, any other metaproxy modules can be integrated into a - SRU server solution, including, but not limited to, load balancing, - multiple target querying - (see ), and complex RPN query rewrites. + SRU server solution, including, but not limited to, load balancing, + multiple target querying + (see ), and complex RPN query rewrites. @@ -2066,8 +2075,8 @@ Z>
- - + + Reference @@ -2085,9 +2094,7 @@ Z> License - - Metaproxy, Copyright © 1995-2009 Index Data ApS. - + ©right; Metaproxy is free software; you can redistribute it and/or modify it under @@ -2102,30 +2109,22 @@ Z> FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + 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, + Free Software Foundation, 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - + &gpl2; - +