X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=e4d3dbf741d2eb2fad629dbca4e9b832772c3fa7;hb=11edef8271df7f3598f94373720aea3a5b6b3ad5;hp=9f5043dffef47007f228ddf562ac703e1ba05646;hpb=ef5136dcb919eb176e876ce4d29f8906ee554212;p=idzebra-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 9f5043d..e4d3dbf 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,9 +1,12 @@ - + Installation Zebra is written in ANSI C and was implemented with portability in mind. - We primarily use GCC on UNIX and Microsoft Visual C++ on Windows. + We primarily use GCC on UNIX and + + Microsoft Visual C++ + on Windows. @@ -12,11 +15,11 @@ Redhat Linux, Gentoo Linux, SuSE Linux, - NetBSD (Cobalt), FreeBSD (i386), MAC OSX, - SunOS 5.8 (sparc), - Windows 2000 SP3. + SunOS 5.8 + (sparc), + Windows 2000. @@ -29,7 +32,7 @@ (required) - Zebra uses YAZ to support Z39.50/SRW. Also the memory management + Zebra uses YAZ to support Z39.50/ SRW. Also the memory management utilites from YAZ is used by Zebra. @@ -194,16 +197,302 @@ By default this will install the Zebra executables in /usr/local/bin, and the standard configuration files in - /usr/local/share/idzebra + /usr/local/share/idzebra-2.0 You can override this with the --prefix option to configure. + + GNU/Debian + GNU/Debian Linux on + i686 Platform + + Index Data provides pre-compiled GNU/Debian i686 + Linux packages at our Debian package archive, both for + the Sarge and the Etch release. + + + + To install these packages, you need to add two lines to your + /etc/apt/sources.list configuration file, + either the Sarge sources found at + + deb http://ftp.indexdata.dk/t/debian sarge main + deb-src http://ftp.indexdata.dk/t/debian sarge main + + or the Etch sources from + + deb http://ftp.indexdata.dk/t/debian etch main + deb-src http://ftp.indexdata.dk/t/debian etch main + + After refreshing the package cache with the command + + apt-get update + + as root, the + Zebra indexer is + easily installed issuing + + apt-get install idzebra-2.0 idzebra-2.0-doc + + + + + + Ubuntu/Debian and GNU/Debian on other platforms + + These Zebra + packages are specifically compiled for + GNU/Debian Linux systems. Installation on other + GNU/Debian systems is possible by + re-compilation the Debian way: you need to add only the + deb-src sources lines to the + /etc/apt/sources.list configuration file, + that is either the Sarge sources + + deb-src http://ftp.indexdata.dk/t/debian sarge main + + or the Etch sources + + deb-src http://ftp.indexdata.dk/t/debian etch main + + After refreshing the package cache with the command + + apt-get update + apt-get build-dep idzebra-2.0 + + as root, the + Zebra indexer is + recompiled and installed issuing + + apt-get source --compile idzebra-2.0 + + as normal user. + The compiled GNU/Debian packages can then be + installed as root issuing + + dpkg -i install idzebra-2.0*.deb libidzebra-2.0*.deb + + + + + WIN32 + 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. + + + + Zebra is shipped with "makefiles" for the NMAKE tool that comes + with + Microsoft Visual C++. + Version 6 has been tested. We expect that zebra compiles + with version 5 as well. + + + Start a command prompt and switch the sub directory + WIN where the file makefile + is located. Customize the installation by editing the + makefile file (for example by using notepad). + + The following summarizes the most important settings in that file: + + + DEBUG + + If set to 1, the software is + compiled with debugging libraries (code generation is + multi-threaded debug DLL). + If set to 0, the software is compiled with release libraries + (code generation is multi-threaded DLL). + + + + + YAZDIR + + Directory of YAZ source. Zebra's makefile expects to find + yaz.lib, yaz.dll + in yazdir/lib and + yazdir/bin respectively. + + + + + + HAVE_EXPAT, + EXPAT_DIR + + If HAVE_EXPAT is set to 1, Zebra is compiled + with Expat support. In this configuration, set + ZEBRA_DIR to the Expat source directory. + Windows version of Expat can be downloaded from + + SourceForge + . + + + + + HAVE_ICONV, + ICONV_DIR + + 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 + + this site + . + + + + + + BZIP2INCLUDE, + BZIP2LIB, + BZIP2DEF + + + Define these symbols if Zebra is to be compiled with + BZIP2 + record compression support. + + + + + + + + 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. + + + + When satisfied with the settings in the makefile, type + + nmake + + + + + If the nmake command is not found on your system + you probably haven't defined the environment variables required to + use that tool. To fix that, find and run the batch file + vcvars32.bat. You need to run it from within + the command prompt or set the environment variables "globally"; + otherwise it doesn't work. + + + + If you wish to recompile Zebra - for example if you modify + settings in the makefile you can delete + object files, etc by running. + + nmake clean + + + + The following files are generated upon successful compilation: + + + bin/zebraidx.exe + + The Zebra indexer. + + + bin/zebrasrv.exe + + The Zebra server. + + + + + + + + + + Upgrading from Zebra version 1.3.x + + 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 + + # profilePath - where to look for config files + profilePath: some/local/path:/usr/share/idzebra/tab + + must be changed to + + # profilePath - where to look for config files + profilePath: some/local/path:/usr/share/idzebra-2.0/tab + + # modulePath - where to look for loadable zebra modules + modulePath: /usr/lib/idzebra-2.0/ + + + + 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 + redirection to other fields. + For example the following snippet of + a custom custom/bib1.att + Bib-1 attribute set definition file is no + longer supported: + + att 1016 Any 1016,4,1005,62 + + and should be changed to + + att 1016 Any + + + + Similar behaviour can be expressed in the new release by defining + a new index Any:w in all GRS + *.abs record indexing configuration files. + The above example configuration needs to make the changes + from version 1.3.x indexing instructions + + xelm /*/alternative Body-of-text:w,Title:s,Title:w + xelm /*/title Body-of-text:w,Title:s,Title:w + + to version 2.0.0 indexing instructions + + xelm /*/alternative Any:w,Body-of-text:w,Title:s,Title:w + xelm /*/title Any:w,Body-of-text:w,Title:s,Title:w + + - [to be written] + It is also possible to map the numerical attribute value + @attr 1=1016 onto another already existing huge + index, in this example, one could for example use the mapping + + att 1016 Body-of-text + + with equivalent outcome without editing all GRS + *.abs record indexing configuration files. + + + Server installations which use the special + IDXPATH attribute set must add the following + line to the zebra.cfg configuration file: + + attset: idxpath.att + + +