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