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