X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Finstallation.xml;h=81ac880aafcab304aef4f6d0d666309a211701e1;hp=c19627fd029a6e14c5124580fe67b7e1d55c63e4;hb=972bceaa6386f904bc3e4845f1c5598656c5c6f2;hpb=37dc985516f52f34fc8434cc8beb982bb0c8988f diff --git a/doc/installation.xml b/doc/installation.xml index c19627f..81ac880 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,38 +1,47 @@ - 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), MAC OSX, - SunOS 5.8 + SunOS 5.9 (sparc), Windows 2000. - + - 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,24 +61,24 @@ (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) 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. - + Autoconf, @@ -78,21 +87,21 @@ 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. - + 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. @@ -102,27 +111,27 @@
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 system-dependent variables used during compilation. It uses those values to create a Makefile in each - directory of Zebra. + 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,41 +159,64 @@ 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. + + + index/*.so + + + The .so-files are &zebra; record filter modules. + There are modules for reading + &acro.marc; (mod-grs-marc.so), + &acro.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 + 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 + 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. You can override this with the --prefix option to configure. @@ -192,13 +224,13 @@
GNU/Debian
GNU/Debian Linux on - i686 Platform + 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. + the Sarge and the Etch release. - + To install these packages, you need to add two lines to your /etc/apt/sources.list configuration file, @@ -207,7 +239,7 @@ deb http://ftp.indexdata.dk/debian sarge main deb-src http://ftp.indexdata.dk/debian sarge main - or the Etch sources from + or the Etch sources from deb http://ftp.indexdata.dk/debian etch main deb-src http://ftp.indexdata.dk/debian etch main @@ -216,24 +248,24 @@ apt-get update - as root, the - Zebra indexer is + 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 + These &zebra; packages are specifically compiled for - GNU/Debian Linux systems. Installation on other + 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 + 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 @@ -248,11 +280,11 @@ apt-get update apt-get build-dep idzebra-2.0 - as root, the - Zebra indexer is + as root, the + &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 @@ -265,15 +297,15 @@
WIN32 - The easiest way to install Zebra on Windows is by downloading - an installer from - here. + 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. @@ -283,9 +315,9 @@ 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 @@ -296,63 +328,63 @@ (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 + 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 + + 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 + Define these symbols if &zebra; is to be compiled with BZIP2 record compression support. - + - 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. @@ -372,8 +404,8 @@ - If you wish to recompile Zebra - for example if you modify - settings in the makefile you can delete + 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 @@ -381,66 +413,68 @@ The following files are generated upon successful compilation: - + bin/zebraidx.exe - The Zebra indexer. + The &zebra; indexer. - + bin/zebrasrv.exe - The Zebra server. + The &zebra; server. - + - +
- Upgrading from Zebra version 1.3.x + 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 + &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 + 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/ + modulePath: /usr/lib/idzebra-2.0/modules + + + The internal binary register structures have changed; all &zebra; + databases must be re-indexed after upgrade. + + - 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. + 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 @@ -455,26 +489,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 - +
- +