X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fbook.xml;h=fc2829f84261bd3561eb85e2e984d20bb1ec3273;hb=HEAD;hp=566a9ee29f2189ab42700ea0a3ae29c8bddc405a;hpb=c1d953eee6c00432493bc364da6284704ccd9cc2;p=metaproxy-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index 566a9ee..fc2829f 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -1,6 +1,6 @@
@@ -26,7 +26,7 @@
&version;
- 2005-2011
+ 2005-2015
Index Data
@@ -39,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
@@ -72,7 +72,7 @@
Introduction
-
+
Metaproxy
is a stand alone program that acts as a universal router, proxy and
@@ -80,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
@@ -123,7 +123,7 @@
including examples.
-
+
Installation
@@ -138,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.
@@ -150,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.55.
@@ -165,10 +165,15 @@
We have successfully built Metaproxy using the compilers
- GCC version 4.0 and
- Microsoft Visual Studio 2003/2005.
+ GCC and
+ Microsoft Visual Studio.
+
+ As an option, Metaproxy may also be compiled with
+ USEMARCON support which allows for
+ MARC conversions for the filter.
+
Installation on Unix (from Source)
@@ -178,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
@@ -200,6 +213,18 @@
make install
+
+ USEMARCON (optional)
+
+ gunzip -c usemarcon317.tar.gz|tar xf -
+ cd usemarcon317
+ ./configure
+ make
+ su
+ make install
+
+
+
YAZ/YAZ++
@@ -228,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
@@ -237,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 /
@@ -265,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.
@@ -274,10 +299,8 @@
Installation on Debian GNU/Linux
- All dependencies for Metaproxy are available as
- Debian
- packages for the sarge (stable in 2005) and etch (testing in 2005)
- distributions.
+ All dependencies for Metaproxy are available as
+ Debian packages.
The procedures for Debian based systems, such as
@@ -286,7 +309,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
@@ -296,10 +319,12 @@
apt-get install libxslt1-dev
- apt-get install libyazpp2-dev
+ apt-get install libyazpp6-dev
apt-get install libboost-dev
+ apt-get install libboost-system-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
@@ -311,14 +336,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
@@ -331,7 +356,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.
@@ -344,9 +369,9 @@
Installation on Windows
- Metaproxy can be compiled with Microsoft
+ Metaproxy has been tested Microsoft
Visual Studio.
- Versions 2003 (C 7.1), 2005 (C 8.0) and 2008 (C 9.0) is known to work.
+ 2013 (C 12.0).
Boost
@@ -370,12 +395,10 @@
Libxslt can be downloaded
for Windows from
- here.
+ here.
- Libxslt has other dependencies, but these can all be downloaded
- from the same site. Get the following package:
- iconv, zlib, libxml2, libxslt.
+ Libxslt also requires libxml2 to operate.
@@ -392,7 +415,7 @@
YAZ++
Get YAZ++ as well.
- Version 1.1.0 or later is required.
+ Version 1.6.0 or later is required.
YAZ++ includes NMAKE makefiles, similar to those found in the
@@ -457,9 +480,9 @@
-
+
-
+
After successful compilation you'll find
metaproxy.exe in the
@@ -470,7 +493,7 @@
-
+
YAZ Proxy Comparison
@@ -490,22 +513,22 @@
Z39.50 server
- Using filter frontend_net
+ Using filter
Supported
SRU server
- Supported with filter sru_z3950
+ Supported with filter
Supported
Z39.50 client
- Supported with filter z3950_client
+ Supported with filter
Supported
SRU client
- Unsupported
+ Supported with filter
Unsupported
@@ -535,7 +558,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
@@ -597,7 +620,7 @@
USEMARCON
- Unsupported
+ Supported with record_transform
Supported
@@ -716,8 +739,8 @@
Filters
-
-
+
+
Introductory notes
@@ -755,7 +778,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
@@ -770,8 +793,8 @@
virt_db).
-
-
+
+
Overview of filter types
@@ -793,7 +816,7 @@
The filters are here listed in alphabetical order:
-
+
+