-<!-- $Id: installation.xml,v 1.11 2003-03-27 13:38:13 adam Exp $ -->
+<!-- $Id: installation.xml,v 1.14 2003-11-29 16:47:22 adam Exp $ -->
<chapter id="installation">
<title>Installation</title>
<para>
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.
+ We primarily use <ulink url="http://gcc.gnu.org/">GCC</ulink> on UNIX and
+ <ulink url="http://msdn.microsoft.com/vstudio/">
+ Microsoft Visual C++</ulink>
+ on Windows.
</para>
<para>
<ulink url="http://www.redhat.com/">Redhat Linux</ulink>,
<ulink url="http://www.gentoo.org/">Gentoo Linux</ulink>,
<ulink url="http://www.suse.com/">SuSE Linux</ulink>,
- <ulink url="http://www.netbsd.org/Ports/cobalt/">NetBSD (Cobalt)</ulink>,
<ulink url="http://www.freebsd.org/">FreeBSD (i386)</ulink>,
<ulink url="http://www.apple.com/macosx/">MAC OSX</ulink>,
- <ulink url="http://wwws.sun.com/software/solaris/">SunOS 5.8 (sparc)</ulink>,
- <ulink url="http://www.microsoft.com/windows2000/">Windows 2000 SP3</ulink>.
+ <ulink url="http://wwws.sun.com/software/solaris/">SunOS 5.8
+ (sparc)</ulink>,
+ <ulink url="http://www.microsoft.com/windows2000/">Windows 2000</ulink>.
</para>
<para>
</para>
</sect1>
<sect1 id="installation.win32"><title>WIN32</title>
+ <para>The easiest way to install Zebra on Windows is by downloading
+ an installer from
+ <ulink url="http://ftp.indexdata.dk/pub/zebra/win32/">here</ulink>.
+ The installer comes with source too - in case you wish to
+ compile Zebra with different Compiler options.
+ </para>
+
+ <para>
+ Zebra is shipped with "makefiles" for the NMAKE tool that comes
+ with <ulink url="http://msdn.microsoft.com/vstudio/">
+ Microsoft Visual C++</ulink>.
+ Version 6 has been tested. We expect that zebra compiles
+ with version 5 as well.
+ </para>
+ <para>
+ Start a command prompt and switch the sub directory
+ <filename>WIN</filename> where the file <filename>makefile</filename>
+ is located. Customize the installation by editing the
+ <filename>makefile</filename> file (for example by using notepad).
+
+ The following summarizes the most important settings in that file:
+
+ <variablelist>
+ <varlistentry><term><literal>DEBUG</literal></term>
+ <listitem><para>
+ 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).
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>YAZDIR</literal></term>
+ <listitem><para>
+ Directory of YAZ source. Zebra's makefile expects to find
+ <filename>yaz.lib</filename>, <filename>yaz.dll</filename>
+ in <replaceable>yazdir</replaceable><literal>/lib</literal> and
+ <replaceable>yazdir</replaceable><literal>/bin</literal> respectively.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>HAVE_EXPAT</literal>,
+ <literal>EXPAT_DIR</literal></term>
+ <listitem><para>
+ If <literal>HAVE_EXPAT</literal> is set to 1, Zebra is compiled
+ with Expat support. In this configuration, set
+ <literal>ZEBRA_DIR</literal> to the Expat source directory.
+ Windows version of Expat can be downloaded from
+ <ulink url="http://sourceforge.net/projects/expat/">
+ SourceForge
+ </ulink>.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>HAVE_ICONV</literal>,
+ <literal>ICONV_DIR</literal></term>
+ <listitem><para>
+ If <literal>HAVE_ICONV</literal> is set to 1, Zebra is compiled
+ with iconv support. In this configuration, set
+ <literal>ICONV_DIR</literal> to the iconv source directory.
+ Iconv binaries can be downloaded from
+ <ulink url="http://www.zlatkovic.com/projects/libxml/binaries.html">
+ this site
+ </ulink>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><literal>BZIP2INCLUDE</literal>,
+ <literal>BZIP2LIB</literal>,
+ <literal>BZIP2DEF</literal>
+ </term>
+ <listitem><para>
+ Define these symbols if Zebra is to be compiled with
+ <ulink url="http://sources.redhat.com/bzip2/">BZIP2</ulink>
+ record compression support.
+ </para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </para>
+ <warning>
+ <para>
+ The <literal>DEBUG</literal> setting in the makefile for Zebra must
+ be set to the same value as <literal>DEBUG</literal> setting in the
+ makefile for YAZ.
+ If not, the Zebra server/indexer will crash.
+ </para>
+ </warning>
+ <para>
+ When satisfied with the settings in the makefile, type
+ <screen>
+ nmake
+ </screen>
+ </para>
+ <note>
+ <para>
+ If the <filename>nmake</filename> 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
+ <filename>vcvars32.bat</filename>. You need to run it from within
+ the command prompt or set the environment variables "globally";
+ otherwise it doesn't work.
+ </para>
+ </note>
<para>
- [to be written]
+ If you wish to recompile Zebra - for example if you modify
+ settings in the <filename>makefile</filename> you can delete
+ object files, etc by running.
+ <screen>
+ nmake clean
+ </screen>
+ </para>
+ <para>
+ The following files are generated upon successful compilation:
+
+ <variablelist>
+ <varlistentry><term><filename>bin/zebraidx.exe</filename></term>
+ <listitem><para>
+ The Zebra indexer.
+ </para></listitem></varlistentry>
+
+ <varlistentry><term><filename>bin/zebrasrv.exe</filename></term>
+ <listitem><para>
+ The Zebra server.
+ </para></listitem></varlistentry>
+
+ </variablelist>
+
</para>
</sect1>
</chapter>
projects / idzebra-moved-to-github.git / blobdiff