X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=d0670d17d24322850fab4cb9ed891da98d542465;hp=0266ac2fca638ed46bf93d1a003a283f7c63228f;hb=e4c6861efeeea654bfb00c5f0239ee258629d77f;hpb=213c8c2649191ea7385934f5ac039928362b96ed diff --git a/doc/installation.xml b/doc/installation.xml index 0266ac2..d0670d1 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,8 +1,7 @@ - Installation - Zebra is written in ANSI C and was implemented with portability in mind. + &zebra; is written in &acro.ansi; C and was implemented with portability in mind. We primarily use GCC on UNIX and Microsoft Visual C++ on Windows. @@ -10,7 +9,7 @@ The software is regularly tested on Debian GNU/Linux, - Redhat Linux, + Red Hat Linux, Gentoo Linux, SuSE Linux, FreeBSD (i386), @@ -21,18 +20,28 @@ - Zebra can be configured to use the following utilities (most of + &zebra; can be configured to use the following utilities (most of which are optional): - yaz + &yaz; (required) - Zebra uses YAZ to support Z39.50 / - SRU. - Also the memory management utilites from YAZ is used by Zebra. + &zebra; uses &yaz; to support &acro.z3950; / + &acro.sru;. + Zebra also uses a lot of other utilities (not related to networking), + such as memory management and XML support. + + + For the DOM XML + / ALVIS + record filters, &yaz; must be compiled with + Libxml2 + and + Libxslt + support and Libxml2 must be version 2.6.15 or later. @@ -52,7 +61,7 @@ (optional) - XML parser. If you're going to index real XML you should + &acro.xml; parser. If you're going to index real &acro.xml; you should install this (filter grs.xml). On most systems you should be able to find binary Expat packages. @@ -64,7 +73,7 @@ Tcl is required if you need to use the Tcl record filter - for Zebra. You can find binary packages for Tcl for many + for &zebra;. You can find binary packages for Tcl for many Unices and Windows. @@ -78,8 +87,8 @@ GNU Automake and Autoconf are only required if you're - using the CVS version of Zebra. You do not need these - if you have fetched a Zebra tar. + using the CVS version of &zebra;. You do not need these + if you have fetched a &zebra; tar. @@ -90,7 +99,7 @@ These tools are only required if you're writing - documentation for Zebra. You need the following + documentation for &zebra;. You need the following Debian packages: docbook, docbook-xml, docbook-xsl, docbook-utils, xsltproc. @@ -103,7 +112,7 @@ On Unix, GCC works fine, but any native C compiler should be possible to use as long as it is - ANSI C compliant. + &acro.ansi; C compliant. @@ -111,7 +120,7 @@ shell script attempts to guess correct values for various system-dependent variables used during compilation. It uses those values to create a Makefile in each - directory of Zebra. + directory of &zebra;. @@ -160,7 +169,7 @@ zebrasrv - The Z39.50 server and search engine. + The &acro.z3950; server and search engine. @@ -177,10 +186,10 @@ index/*.so - The .so-files are Zebra record filter modules. + The .so-files are &zebra; record filter modules. There are modules for reading - MARC (mod-grs-marc.so), - XML (mod-grs-xml.so) , etc. + &acro.marc; (mod-grs-marc.so), + &acro.xml; (mod-grs-xml.so) , etc. @@ -191,18 +200,18 @@ Using configure option --disable-shared builds - Zebra statically and links "in" Zebra filter code statically, i.e. + &zebra; statically and links "in" &zebra; filter code statically, i.e. no .so-files are generated - You can now use Zebra. If you wish to install it system-wide, then + You can now use &zebra;. If you wish to install it system-wide, then as root type make install - By default this will install the Zebra executables in + By default this will install the &zebra; executables in /usr/local/bin, and the standard configuration files in /usr/local/share/idzebra-2.0. If @@ -240,7 +249,7 @@ apt-get update as root, the - Zebra indexer is + &zebra; indexer is easily installed issuing apt-get install idzebra-2.0 idzebra-2.0-doc @@ -251,7 +260,7 @@
Ubuntu/Debian and GNU/Debian on other platforms - These Zebra + These &zebra; packages are specifically compiled for GNU/Debian Linux systems. Installation on other GNU/Debian systems is possible by @@ -272,10 +281,10 @@ apt-get build-dep idzebra-2.0 as root, the - Zebra indexer is + &zebra; indexer is recompiled and installed issuing - apt-get source --compile idzebra-2.0 + fakeroot apt-get source --compile idzebra-2.0 as normal user. The compiled GNU/Debian packages can then be @@ -288,15 +297,15 @@
WIN32 - The easiest way to install Zebra on Windows is by downloading + The easiest way to install &zebra; on Windows is by downloading an installer from here. The installer comes with source too - in case you wish to - compile Zebra with different Compiler options. + compile &zebra; with different Compiler options. - Zebra is shipped with "makefiles" for the NMAKE tool that comes + &zebra; is shipped with "makefiles" for the NMAKE tool that comes with Microsoft Visual C++. Version 2003 and 2005 has been tested. We expect that zebra compiles with version 6 as well. @@ -323,7 +332,7 @@ YAZDIR - Directory of YAZ source. Zebra's makefile expects to find + Directory of &yaz; source. &zebra;'s makefile expects to find yaz.lib, yaz.dll in yazdir/lib and yazdir/bin respectively. @@ -335,7 +344,7 @@ HAVE_EXPAT, EXPAT_DIR - If HAVE_EXPAT is set to 1, Zebra is compiled + If HAVE_EXPAT is set to 1, &zebra; is compiled with Expat support. In this configuration, set ZEBRA_DIR to the Expat source directory. @@ -348,7 +357,7 @@ HAVE_ICONV, ICONV_DIR - If HAVE_ICONV is set to 1, Zebra is compiled + If HAVE_ICONV is set to 1, &zebra; is compiled with iconv support. In this configuration, set ICONV_DIR to the iconv source directory. Iconv binaries can be downloaded from @@ -363,7 +372,7 @@ BZIP2DEF - Define these symbols if Zebra is to be compiled with + Define these symbols if &zebra; is to be compiled with BZIP2 record compression support. @@ -372,10 +381,10 @@ - The DEBUG setting in the makefile for Zebra must + The DEBUG setting in the makefile for &zebra; must be set to the same value as DEBUG setting in the - makefile for YAZ. - If not, the Zebra server/indexer will crash. + makefile for &yaz;. + If not, the &zebra; server/indexer will crash. @@ -395,7 +404,7 @@ - If you wish to recompile Zebra - for example if you modify + If you wish to recompile &zebra; - for example if you modify settings in the makefile you can delete object files, etc by running. @@ -408,12 +417,12 @@ bin/zebraidx.exe - The Zebra indexer. + The &zebra; indexer. bin/zebrasrv.exe - The Zebra server. + The &zebra; server. @@ -423,9 +432,9 @@
- Upgrading from Zebra version 1.3.x + Upgrading from &zebra; version 1.3.x - Zebra's installation directories have changed a bit. In addition, + &zebra;'s installation directories have changed a bit. In addition, the new loadable modules must be defined in the master zebra.cfg configuration file. The old version 1.3.x configuration options @@ -444,16 +453,16 @@ - The internal binary register structures have changed; all Zebra + The internal binary register structures have changed; all &zebra; databases must be re-indexed after upgrade. - The attribute set defintion files may no longer contain + The attribute set definition files may no longer contain redirection to other fields. For example the following snippet of a custom custom/bib1.att - Bib-1 attribute set definition file is no + &acro.bib1; attribute set definition file is no longer supported: att 1016 Any 1016,4,1005,62 @@ -465,7 +474,7 @@ Similar behaviour can be expressed in the new release by defining - a new index Any:w in all GRS + a new index Any:w in all &acro.grs1; *.abs record indexing configuration files. The above example configuration needs to make the changes from version 1.3.x indexing instructions @@ -486,13 +495,13 @@ att 1016 Body-of-text - with equivalent outcome without editing all GRS + with equivalent outcome without editing all &acro.grs1; *.abs record indexing configuration files. Server installations which use the special - IDXPATH attribute set must add the following + &acro.idxpath; attribute set must add the following line to the zebra.cfg configuration file: attset: idxpath.att