X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=9e48fd7c880a435484a7d41fb8331a998eb18959;hp=328c1c24fdd0594fefd2c5d8eacc97ff77bd115e;hb=65fef82ef22eb87bc6a569cc934bd0284be854cf;hpb=5ca4e60e990af6ad6b62ebff855d7b642f37c3ec diff --git a/doc/installation.xml b/doc/installation.xml index 328c1c2..9e48fd7 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,16 +1,15 @@ - Installation - &zebra; is written in ANSI C and was implemented with portability in mind. - We primarily use GCC on UNIX and + &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. The software is regularly tested on Debian GNU/Linux, - Redhat Linux, + Red Hat Linux, Gentoo Linux, SuSE Linux, FreeBSD (i386), @@ -19,20 +18,30 @@ (sparc), Windows 2000. - + &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,13 +61,13 @@ (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. - + Tcl (optional) @@ -69,7 +78,7 @@ - + Autoconf, @@ -83,7 +92,7 @@ - + Docbook and friends (optional) @@ -102,10 +111,10 @@
UNIX On Unix, GCC works fine, but any native - C compiler should be possible to use as long as it is - ANSI C compliant. + C compiler should be possible to use as long as it is + &acro.ansi; C compliant. - + Unpack the distribution archive. The configure shell script attempts to guess correct values for various @@ -113,16 +122,16 @@ It uses those values to create a Makefile in each directory of &zebra;. - + To run the configure script type: - + ./configure - + - + The configure script attempts to use C compiler specified by the CC environment variable. @@ -130,7 +139,7 @@ The CFLAGS environment variable holds options to be passed to the C compiler. If you're using a Bourne-shell compatible shell you may pass something like this: - + CC=/opt/ccs/bin/cc CFLAGS=-O ./configure @@ -142,7 +151,7 @@ ./configure --help - + Once the build environment is configured, build the software by typing: @@ -150,22 +159,22 @@ make - + If the build is successful, two executables are created in the sub-directory index: - + zebrasrv - The Z39.50 server and search engine. + The &acro.z3950; server and search engine. - zebraidx + zebraidx The administrative indexing tool. @@ -174,13 +183,13 @@ - index/*.so + 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. + There are modules for reading + &acro.marc; (mod-grs-marc.so), + &acro.xml; (mod-grs-xml.so) , etc. @@ -202,9 +211,9 @@ 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 + and the standard configuration files in /usr/local/share/idzebra-2.0. If shared modules are built, these are installed in /usr/local/lib/idzebra-2.0/modules. @@ -215,31 +224,22 @@
GNU/Debian
GNU/Debian Linux on - i686 Platform + amd64/i386 Platform - Index Data provides pre-compiled GNU/Debian i686 Linux packages - at our Debian package archive, both for - the Sarge and the Etch release. + Index Data provides pre-compiled GNU/Debian and Ubuntu packages + at our Debian package archive, both for recent releases. - + - 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 - + For Debian, refer to + + for how to configure APT. For Ubuntu, refer to + . After refreshing the package cache with the command apt-get update - as root, the + as root, the &zebra; indexer is easily installed issuing @@ -247,31 +247,23 @@
- +
- Ubuntu/Debian and GNU/Debian on other platforms + GNU/Debian and Ubuntu on other architectures These &zebra; packages are specifically compiled for - GNU/Debian Linux systems. Installation on other + GNU/Debian Linux systems and Ubuntu. 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 + 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 + as root, the &zebra; indexer is recompiled and installed issuing @@ -289,26 +281,25 @@
WIN32 The easiest way to install &zebra; on Windows is by downloading - an installer from + 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. + Version 2003, 2005 and 2008 has been tested. 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 @@ -319,44 +310,44 @@ (code generation is multi-threaded DLL). - + YAZDIR - Directory of YAZ source. &zebra;'s makefile expects to find - yaz.lib, yaz.dll + 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 + 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 + with iconv support. In this configuration, set ICONV_DIR to the iconv source directory. Iconv binaries can be downloaded from this site. - + BZIP2INCLUDE, BZIP2LIB, @@ -367,14 +358,14 @@ 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. + makefile for &yaz;. If not, the &zebra; server/indexer will crash. @@ -396,7 +387,7 @@ If you wish to recompile &zebra; - for example if you modify - settings in the makefile you can delete + settings in the makefile you can delete object files, etc by running. nmake clean @@ -404,20 +395,20 @@ The following files are generated upon successful compilation: - + bin/zebraidx.exe The &zebra; indexer. - + bin/zebrasrv.exe The &zebra; server. - + - +
@@ -426,14 +417,14 @@ 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 + 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 + must be changed to # profilePath - where to look for config files profilePath: some/local/path:/usr/share/idzebra-2.0/tab @@ -449,23 +440,23 @@ - The attribute set defintion files may no longer contain - redirection to other fields. + 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 + a custom custom/bib1.att + &acro.bib1; attribute set definition file is no longer supported: att 1016 Any 1016,4,1005,62 - and should be changed to + 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 + 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 @@ -480,26 +471,26 @@ - It is also possible to map the numerical attribute value + 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 + 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 - +
- +