X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Finstallation.xml;h=021a61089793a15cbf258a943ed48f6eaad95dc8;hb=fc9684841bbfad0b625e7365b99bae7b7df737df;hp=14ec6a072920cc0d94f269ca254344e6ebe5fdd0;hpb=a31f9b2d25006c89ae7e9fb5870c0d222ee88a3a;p=idzebra-moved-to-github.git diff --git a/doc/installation.xml b/doc/installation.xml index 14ec6a0..021a610 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,79 +1,205 @@ - + + + Installation + + Zebra is very portable. An ANSI C compiler is required. We + primarily use GNU C on UNIX and Microsoft Visual C++ on Windows. + -Installation + + Zebra uses following components. Most of these are optional. + + + yaz (required) + + + Zebra uses lots of utilities provided by YAZ. Most notably + Z39.50 support. + + + + + iconv + (optional) + + + Character set conversion. This is required if you're + going to use any other character set than UTF-8 and ISO-8859-1 + for records. Note that some Unixes has iconv built-in. + + + + + Expat + (optional) + + + XML parser. If you're going to index real XML you should + install this (filter grs.xml). On most system, you should be able + to find binary Expat packages. + + + - -An ANSI C compiler is required to compile the Zebra -server system — gcc works fine if your own system doesn't -provide an adequate compiler. - + + 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. + + + - -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. - + + 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 + Unices and Windows. + + + - -To run the configure script type: + + + Autoconf, + CC environment variable. If not set, cc -will be used. 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 - - - - - -When configured build the software by typing: - - - make - - - - - -As an option you may type make depend to create -source file dependencies for the package. This is only needed, -however, if you alter the source. - - - -If successful, two executables have been created in the sub-directory -index. - - - -zebrasrv - - -The Z39.50 server and search engine. - - - - -zebraidx - - -The administrative tool for the search index. - - - - - - - + UNIX + + On Unix, gcc works fine, but any native + C compiler should be possible to use as long as it is + 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. + + + + To run the configure script type: + + + ./configure + + + + + + The configure script attempts to use C compiler specified by + the CC environment variable. + If this is not set, cc or GNU C will be used. + 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 + + + + The configure script support various options: you can see what they + are with + + ./configure --help + + + + + Once the build environment is configured, build the software by + typing: + + make + + + + + If the build is successful, two executables are created in the + sub-directory index: + + + + zebrasrv + + + The Z39.50 server and search engine. + + + + + zebraidx + + + The administrative indexing tool. + + + + + + + + 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 + /usr/local/bin, + and the standard configuration files in + /usr/local/share/idzebra + You can override this with the --prefix option + to configure. + + + WIN32 + + + + + +