All sorts of minor and semi-major improvements.
[idzebra-moved-to-github.git] / doc / installation.xml
1 <chapter id="installation">
2  <!-- $Id: installation.xml,v 1.6 2002-12-01 23:26:26 mike Exp $ -->
3  <title>Installation</title>
4  <para>
5   An ANSI C compiler is required to compile the Zebra
6   server system &mdash; <literal>gcc</literal> works fine if your
7   own system doesn't provide an adequate compiler.
8  </para>
9  
10  <para>
11   Unpack the distribution archive. The <literal>configure</literal>
12   shell script attempts to guess correct values for various
13   system-dependent variables used during compilation.
14   It uses those values to create a <literal>Makefile</literal> in each
15   directory of Zebra.
16  </para>
17  
18  <para>
19   To run the configure script type:
20
21   <screen>
22   ./configure
23   </screen>
24
25  </para>
26  
27  <para>
28   The configure script attempts to use C compiler specified by
29   the <literal>CC</literal> environment variable.
30   If this is not set, <literal>cc</literal> or GNU C will be used.
31   The <literal>CFLAGS</literal> environment variable holds
32   options to be passed to the C compiler. If you're using a
33   Bourne-shell compatible shell you may pass something like this:
34   
35   <screen>
36   CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
37   </screen>
38  </para>
39  <para>
40   The configure script support various options: you can see what they
41   are with
42   <screen>
43   ./configure --help
44   </screen>
45  </para>
46  
47  <para>
48   Once the build environment is configured, build the software by
49   typing:
50   <screen>
51   make
52   </screen>
53  </para>
54  
55  <para>
56   If the build is successful, two executables are created in the
57   sub-directory <literal>index</literal>:
58   <variablelist>
59    
60    <varlistentry>
61     <term><literal>zebrasrv</literal></term>
62     <listitem>
63      <para>
64       The Z39.50 server and search engine.
65      </para>
66     </listitem>
67    </varlistentry>
68    <varlistentry>
69     <term><literal>zebraidx</literal></term>
70     <listitem>
71      <para>
72       The administrative indexing tool.
73      </para>
74     </listitem>
75    </varlistentry>
76   </variablelist>
77  </para>
78  
79  <para>
80   You can now use Zebra. If you wish to install it system-wide, then
81   as root type
82   <screen>
83     make install
84   </screen>
85   By default this will install the Zebra executables in 
86   <filename>/usr/local/bin</filename>,
87   and the standard configuration files in 
88   <filename>/usr/local/share/idzebra</filename>
89   You can override this with the <literal>--prefix</literal> option
90   to configure.
91  </para>
92 </chapter>
93  <!-- Keep this comment at the end of the file
94  Local variables:
95  mode: sgml
96  sgml-omittag:t
97  sgml-shorttag:t
98  sgml-minimize-attributes:nil
99  sgml-always-quote-attributes:t
100  sgml-indent-step:1
101  sgml-indent-data:t
102  sgml-parent-document: "zebra.xml"
103  sgml-local-catalogs: nil
104  sgml-namecase-general:t
105  End:
106  -->