8f852f362f3e9faebdf12c678734e3f2e8f8f7a3
[krb5.git] / doc / rst_source / krb_build / index.rst
1 .. _build_V5:
2
3 Building Kerberos V5
4 ====================
5
6 .. note:: This document was copied from **Kerberos V5 Installation
7           Guide** with minor changes.  Currently it is under
8           review.  Please, send your feedback, corrections and
9           additions to krb5-bugs@mit.edu.  Your contribution is
10           greatly appreciated.
11
12
13 Build Requirements
14 ------------------
15
16 In order to build Kerberos V5, you will need approximately 60-70
17 megabytes of disk space.  The exact amount will vary depending on the
18 platform and whether the distribution is compiled with debugging
19 symbol tables or not.
20
21 Your C compiler must conform to ANSI C (ISO/IEC 9899:1990, "c89").
22 Some operating systems do not have an ANSI C compiler, or their
23 default compiler requires extra command-line options to enable ANSI C
24 conformance.
25
26 If you wish to keep a separate build tree, which contains the compiled
27 \*.o file and executables, separate from your source tree, you will
28 need a make program which supports **VPATH**, or you will need to use
29 a tool such as lndir to produce a symbolic link tree for your build
30 tree.
31
32 The first step in each of these build procedures is to unpack the
33 source distribution.  The Kerberos V5 distribution comes in a tar
34 file, generally named krb5-1.9.tar (for version 1.9. We will assume
35 that version is 1.9. Please, adjust this number accordingly), which
36 contains a compressed tar file consisting of the sources for all of
37 Kerberos (generally krb5-1.9.tar.gz) and a PGP signature for this
38 source tree (generally krb5-1.9.tar.gz.asc).  MIT highly recommends
39 that you verify the integrity of the source code using this signature.
40
41 Unpack the compressed tar file in some directory, such as
42 ``/u1/krb5-1.9``.  (In the rest of this document, we will assume that
43 you have chosen to unpack the Kerberos V5 source distribution in this
44 directory.  Note that the tarfiles will by default all unpack into the
45 ``./krb5-1.9`` directory, so that if your current directory is ``/u1``
46 when you unpack the tarfiles, you will get ``/u1/krb5-1.9/src``, etc.)
47
48
49 Contents
50 --------
51
52 .. toctree::
53    :maxdepth: 1
54
55    directory_org.rst
56    doing_build.rst
57    options2configure.rst
58    osconf.rst
59    test_cov.rst