X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=0266ac2fca638ed46bf93d1a003a283f7c63228f;hb=6b553b7b42f0a2940c9765b9811e5db44ba8265f;hp=e0269a2d499afa92c057e2ece03c1618ab5df785;hpb=1801257818390335cae90e54d488d7294d17848b;p=idzebra-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index e0269a2..0266ac2 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,15 +1,23 @@ - + Installation Zebra is written in ANSI C and was implemented with portability in mind. - We primarily use GNU C on UNIX and Microsoft Visual C++ on Windows. + We primarily use GCC on UNIX and + Microsoft Visual C++ on Windows. - The software is regularly tested on Debian GNU/Linux, Redhat Linux, - Gentoo Linux, NetBSD (Cobalt qube), FreeBSD (i386), MAC OSX, - SunOS 5.8 (sparc), Windows 2000 SP3. + The software is regularly tested on + Debian GNU/Linux, + Redhat Linux, + Gentoo Linux, + SuSE Linux, + FreeBSD (i386), + MAC OSX, + SunOS 5.9 + (sparc), + Windows 2000. @@ -18,16 +26,18 @@ - yaz (required) + yaz + (required) - Zebra uses YAZ to support Z39.50/SRW. Also the memory management - utilites from YAZ is used by Zebra. + Zebra uses YAZ to support Z39.50 / + SRU. + Also the memory management utilites from YAZ is used by Zebra. - iconv + iconv (optional) @@ -38,7 +48,7 @@ - Expat + Expat (optional) @@ -50,19 +60,7 @@ - Perl (optional) - - - Perl is required if you're going to use the Zebra perl - filter facility or the Zebra perl API. Perl is preinstalled - on many Unixes. We've not tried the Perl extension on - Windows ourselves. - - - - - - Tcl (optional) + Tcl (optional) Tcl is required if you need to use the Tcl record filter @@ -74,8 +72,8 @@ - Autoconf, - Automake + Autoconf, + Automake (optional) @@ -87,23 +85,23 @@ - Docbook + Docbook and friends (optional) These tools are only required if you're writing - Documentation for Zebra. You need the following - Debian packages: jadetex, docbook, docbook-dsssl, - docbook-xml, docbook-utils. + documentation for Zebra. You need the following + Debian packages: docbook, docbook-xml, docbook-xsl, + docbook-utils, xsltproc. - UNIX +
UNIX - On Unix, gcc works fine, but any native + On Unix, GCC works fine, but any native C compiler should be possible to use as long as it is ANSI C compliant. @@ -174,9 +172,30 @@ + + + index/*.so + + + The .so-files are Zebra record filter modules. + There are modules for reading + MARC (mod-grs-marc.so), + XML (mod-grs-xml.so) , etc. + + + + - + + + + Using configure option --disable-shared builds + 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 as root type @@ -186,16 +205,301 @@ 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. If + shared modules are built, these are installed in + /usr/local/lib/idzebra-2.0/modules. You can override this with the --prefix option to configure. - - WIN32 +
+ +
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/debian sarge main + deb-src http://ftp.indexdata.dk/debian sarge main + + or the Etch sources from + + deb http://ftp.indexdata.dk/debian etch main + deb-src http://ftp.indexdata.dk/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/debian sarge main + + or the Etch sources + + deb-src http://ftp.indexdata.dk/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 2003 and 2005 has been tested. We expect that zebra compiles + with version 6 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 + + - [to be written] + 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/modules + + + + + 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 + + + + 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 + + +
+