3416817e74853cfc456bae6e376c1c7c65f96817
[platform/upstream/krb5.git] / doc / build / index.rst
1 .. _build_V5:
2
3 Building Kerberos V5
4 ====================
5
6 This section details how to build and install MIT Kerberos software
7 from the source.
8
9 Prerequisites
10 -------------
11
12 In order to build Kerberos V5, you will need approximately 60-70
13 megabytes of disk space.  The exact amount will vary depending on the
14 platform and whether the distribution is compiled with debugging
15 symbol tables or not.
16
17 Your C compiler must conform to ANSI C (ISO/IEC 9899:1990, "c89").
18 Some operating systems do not have an ANSI C compiler, or their
19 default compiler requires extra command-line options to enable ANSI C
20 conformance.
21
22 If you wish to keep a separate build tree, which contains the compiled
23 \*.o file and executables, separate from your source tree, you will
24 need a make program which supports **VPATH**, or you will need to use
25 a tool such as lndir to produce a symbolic link tree for your build
26 tree.
27
28 Obtaining the software
29 ----------------------
30
31 The source code can be obtained from MIT Kerberos Distribution page,
32 at http://web.mit.edu/kerberos/dist/index.html.
33 The MIT Kerberos distribution comes in an archive file, generally
34 named krb5-VERSION-signed.tar, where *VERSION* is a placeholder for
35 the major and minor versions of MIT Kerberos.  (For example, MIT
36 Kerberos 1.9 has major version "1" and minor version "9".)
37
38 The krb5-VERSION-signed.tar contains a compressed tar file consisting
39 of the sources for all of Kerberos (generally named
40 krb5-VERSION.tar.gz) and a PGP signature file for this source tree
41 (generally named krb5-VERSION.tar.gz.asc).  MIT highly recommends that
42 you verify the integrity of the source code using this signature,
43 e.g., by running::
44
45     tar xf krb5-VERSION-signed.tar
46     gpg --verify krb5-VERSION.tar.gz.asc
47
48 Unpack krb5-VERSION.tar.gz in some directory. In this section we will assume
49 that you have chosen the top directory of the distribution the directory
50 ``/u1/krb5-VERSION``.
51
52 Review the README file for the license, copyright and other sprecific to the
53 distribution information.
54
55 Contents
56 --------
57 .. toctree::
58    :maxdepth: 1
59
60    directory_org.rst
61    doing_build.rst
62    options2configure.rst
63    osconf.rst