Minor fixes, especially in the beginning
[idzebra-moved-to-github.git] / doc / installation.xml
1 <chapter id="installation">
2  <!-- $Id: installation.xml,v 1.4 2002-04-10 14:47:49 heikki 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 'Makefile' in each directory of Zebra.
15  </para>
16  
17  <para>
18   To run the configure script type:
19
20   <screen>
21   ./configure
22   </screen>
23
24  </para>
25  
26  <para>
27   The configure script attempts to use C compiler specified by
28   the <literal>CC</literal> environment variable.
29   If not set, <literal>cc</literal> or GNU C will be used.
30   The <literal>CFLAGS</literal> environment variable holds
31   options to be passed to the C compiler. If you're using a
32   Bourne-shell compatible shell you may pass something like this:
33   
34   <screen>
35   CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
36   </screen>
37   
38   The configure script takes a number of arguments, you can see
39   them all with
40   <screen>
41   ./configure --help
42   </screen>
43
44  </para>
45  
46  <para>
47   When configured build the software by typing:
48   
49   <screen>
50   make
51   </screen>
52  
53  </para>
54  
55  <para>
56   If successful, two executables have been created in the sub-directory
57   <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, type
81   <screen>
82     make install
83   </screen>
84   By default this will install the Zebra executables in 
85   <filename>/usr/local/bin</filename>,
86   and the standard configuration files in 
87   <filename>/usr/local/share/zebra</filename>
88   You can override this with the <literal>--prefix</literal> option
89   to configure.
90  </para>
91 </chapter>
92  <!-- Keep this comment at the end of the file
93  Local variables:
94  mode: sgml
95  sgml-omittag:t
96  sgml-shorttag:t
97  sgml-minimize-attributes:nil
98  sgml-always-quote-attributes:t
99  sgml-indent-step:1
100  sgml-indent-data:t
101  sgml-parent-document: "zebra.xml"
102  sgml-local-catalogs: nil
103  sgml-namecase-general:t
104  End:
105  -->