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