X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=be4611e2fc1c54cc898bb5cbabb7a19fe5232860;hb=e505b6cf2a7f6821264d82cd2e8869b2be38d0b2;hp=021a61089793a15cbf258a943ed48f6eaad95dc8;hpb=fc9684841bbfad0b625e7365b99bae7b7df737df;p=idzebra-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 021a610..be4611e 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,20 +1,39 @@ - + Installation - Zebra is very portable. An ANSI C compiler is required. We - primarily use GNU C on UNIX and Microsoft Visual C++ on Windows. + 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. - Zebra uses following components. Most of these are optional. + The software is regularly tested on + Debian GNU/Linux, + Redhat Linux, + Gentoo Linux, + SuSE Linux, + FreeBSD (i386), + MAC OSX, + SunOS 5.8 + (sparc), + Windows 2000. + + + + Zebra can be configured to use the following utilities (most of + which are optional): + - yaz (required) + yaz + (required) - Zebra uses lots of utilities provided by YAZ. Most notably - Z39.50 support. + Zebra uses YAZ to support Z39.50/SRW. Also the memory management + utilites from YAZ is used by Zebra. @@ -35,12 +54,12 @@ XML parser. If you're going to index real XML you should - install this (filter grs.xml). On most system, you should be able + install this (filter grs.xml). On most systems you should be able to find binary Expat packages. - + Perl (optional) @@ -52,7 +71,7 @@ - + Tcl (optional) @@ -63,13 +82,12 @@ - + Autoconf, - Automake + (optional) GNU Automake and Autoconf are only required if you're @@ -80,11 +98,12 @@ - Docbook and friends (optional) + Docbook + and friends (optional) 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: jadetex, docbook, docbook-dsssl, docbook-xml, docbook-utils. @@ -183,8 +202,141 @@ to configure. - WIN32 + 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. + + +