More Docbook doc updates
[idzebra-moved-to-github.git] / doc / installation.xml
1 <chapter id="installation">
2  <title>Installation</title>
3  <para>
4   An ANSI C compiler is required to compile the Zebra
5   server system &mdash; <literal>gcc</literal> works fine if your
6   own system doesn't provide an adequate compiler.
7  </para>
8  
9  <para>
10   Unpack the distribution archive. The <literal>configure</literal>
11   shell script attempts to guess correct values for various
12   system-dependent variables used during compilation.
13   It uses those values to create a 'Makefile' in each directory of Zebra.
14  </para>
15  
16  <para>
17   To run the configure script type:
18
19   <screen>
20   ./configure
21   </screen>
22
23  </para>
24  
25  <para>
26   The configure script attempts to use C compiler specified by
27   the <literal>CC</literal> environment variable.
28   If not set, <literal>cc</literal> or GNU C will be used.
29   The <literal>CFLAGS</literal> environment variable holds
30   options to be passed to the C compiler. If you're using a
31   Bourne-shell compatible shell you may pass something like this:
32   
33   <screen>
34   CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
35   </screen>
36
37  </para>
38  
39  <para>
40   When configured build the software by typing:
41   
42   <screen>
43   make
44   </screen>
45  
46  </para>
47  
48  <para>
49   If successful, two executables have been created in the sub-directory
50   <literal>index</literal>.
51   <variablelist>
52    
53    <varlistentry>
54     <term><literal>zebrasrv</literal></term>
55     <listitem>
56      <para>
57       The Z39.50 server and search engine.
58      </para>
59     </listitem>
60    </varlistentry>
61    <varlistentry>
62     <term><literal>zebraidx</literal></term>
63     <listitem>
64      <para>
65       The administrative indexing tool.
66      </para>
67     </listitem>
68    </varlistentry>
69   </variablelist>
70  </para>
71  
72 </chapter>
73  <!-- Keep this comment at the end of the file
74  Local variables:
75  mode: sgml
76  sgml-omittag:t
77  sgml-shorttag:t
78  sgml-minimize-attributes:nil
79  sgml-always-quote-attributes:t
80  sgml-indent-step:1
81  sgml-indent-data:t
82  sgml-parent-document: "zebra.xml"
83  sgml-local-catalogs: nil
84  sgml-namecase-general:t
85  End:
86  -->