14ec6a072920cc0d94f269ca254344e6ebe5fdd0
[idzebra-moved-to-github.git] / doc / installation.xml
1 <chapter id="installation">
2
3 <title>Installation</title>
4
5 <para>
6 An ANSI C compiler is required to compile the Zebra
7 server system &mdash; <literal remap="tt">gcc</literal> works fine if your own system doesn't
8 provide an adequate compiler.
9 </para>
10
11 <para>
12 Unpack the distribution archive. The <literal remap="tt">configure</literal> shell script
13 attempts to guess correct values for various system-dependent variables
14 used during compilation. It uses those values to create a 'Makefile' in
15 each 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 remap="tt">CC</literal> environment variable. If not set, <literal remap="tt">cc</literal>
30 will be used. The <literal remap="tt">CFLAGS</literal> environment variable holds
31 options to be passed to the C compiler. If you're using a Bourne-shell
32 compatible shell you may pass something like this:
33
34 <screen>
35   CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
36 </screen>
37
38 </para>
39
40 <para>
41 When configured build the software by typing:
42
43 <screen>
44   make
45 </screen>
46  
47 </para>
48
49 <para>
50 As an option you may type <literal remap="tt">make depend</literal> to create
51 source file dependencies for the package. This is only needed,
52 however, if you alter the source.
53 </para>
54
55 <para>
56 If successful, two executables have been created in the sub-directory
57 <literal remap="tt">index</literal>.
58 <variablelist>
59
60 <varlistentry>
61 <term><literal remap="tt">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 remap="tt">zebraidx</literal></term>
70 <listitem>
71 <para>
72 The administrative tool for the search index.
73 </para>
74 </listitem>
75 </varlistentry>
76 </variablelist>
77 </para>
78
79 </chapter>