More documentation cleanups
[idzebra-moved-to-github.git] / doc / installation.xml
1 <chapter id="installation">
2  <!-- $Id: installation.xml,v 1.3 2002-04-09 13:26:26 adam 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  </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   If successful, two executables have been created in the sub-directory
51   <literal>index</literal>.
52   <variablelist>
53    
54    <varlistentry>
55     <term><literal>zebrasrv</literal></term>
56     <listitem>
57      <para>
58       The Z39.50 server and search engine.
59      </para>
60     </listitem>
61    </varlistentry>
62    <varlistentry>
63     <term><literal>zebraidx</literal></term>
64     <listitem>
65      <para>
66       The administrative indexing tool.
67      </para>
68     </listitem>
69    </varlistentry>
70   </variablelist>
71  </para>
72  
73 </chapter>
74  <!-- Keep this comment at the end of the file
75  Local variables:
76  mode: sgml
77  sgml-omittag:t
78  sgml-shorttag:t
79  sgml-minimize-attributes:nil
80  sgml-always-quote-attributes:t
81  sgml-indent-step:1
82  sgml-indent-data:t
83  sgml-parent-document: "zebra.xml"
84  sgml-local-catalogs: nil
85  sgml-namecase-general:t
86  End:
87  -->