Merge from vendor branch NCURSES:
[dragonfly.git] / crypto / heimdal-0.6.3 / doc / install.texi
1 @c $Id: install.texi,v 1.18 2002/09/04 03:18:48 assar Exp $
2
3 @node Building and Installing, Setting up a realm, What is Kerberos?, Top
4 @comment  node-name,  next,  previous,  up
5 @chapter Building and Installing
6
7 Heimdal uses GNU Autoconf to configure for specific hosts, and GNU
8 Automake to manage makefiles. If this is new to you, the short
9 instruction is to run the @code{configure} script in the top level
10 directory, and when that finishes @code{make}.
11
12 If you want to build the distribution in a different directory from the
13 source directory, you will need a make that implements VPATH correctly,
14 such as GNU make.
15
16 You will need to build the distribution:
17
18 @itemize @bullet
19 @item
20 A compiler that supports a ``loose'' ANSI C mode, such as @code{gcc}.
21 @item
22 lex or flex
23 @item
24 awk
25 @item
26 yacc or bison
27 @item
28 a socket library
29 @item
30 NDBM or Berkeley DB for building the server side.
31 @end itemize
32
33 When everything is built, you can install by doing @kbd{make
34 install}. The default location for installation is @file{/usr/heimdal},
35 but this can be changed by running @code{configure} with
36 @samp{--prefix=/some/other/place}.
37
38 If you need to change the default behavior, configure understands the
39 following options:
40
41 @table @asis
42 @item @kbd{--without-berkeley-db}
43 DB is preferred before NDBM, but if you for some reason want to use NDBM
44 instead, you can use this option.
45
46 @item @kbd{--with-krb4=@file{dir}}
47 Gives the location of Kerberos 4 libraries and headers. This enables
48 Kerberos 4 support in the applications (telnet, rsh, popper, etc) and
49 the KDC. It is automatically check for in @file{/usr/athena}. If you
50 keep libraries and headers in different places, you can instead give the
51 path to each with the @kbd{--with-krb4-lib=@file{dir}}, and
52 @kbd{--with-krb4-include=@file{dir}} options.
53
54 You will need a fairly recent version of our Kerberos 4 distribution for
55 @code{rshd} and @code{popper} to support version 4 clients.
56
57 @item @kbd{--enable-dce}
58 Enables support for getting DCE credentials and tokens.  See the README
59 files in @file{appl/dceutils} for more information.
60
61 @item @kbd{--disable-otp}
62 By default some of the application programs will build with support for
63 one-time passwords (OTP).  Use this option to disable that support.
64
65 @item @kbd{--enable-osfc2}
66 Enable some C2 support for OSF/Digital Unix/Tru64.  Use this option if
67 you are running your OSF operating system in C2 mode.
68
69 @item @kbd{--with-readline=@file{dir}}
70 Gives the path for the GNU Readline library, which will be used in some
71 programs. If no readline library is found, the (simpler) editline
72 library will be used instead.
73
74 @item @kbd{--with-hesiod=@file{dir}}
75 Enables hesiod support in push.
76
77 @item @kbd{--enable-netinfo}
78 Add support for using netinfo to lookup configuration information.
79 Probably only useful (and working) on NextStep/Mac OS X.
80
81 @item @kbd{--without-ipv6}
82 Disable the IPv6 support.
83
84 @item @kbd{--with-openldap}
85 Compile Heimdal with support for storing the database in LDAP.  Requires
86 OpenLDAP @url{http://www.openldap.org}.  See
87 @url{http://www.padl.com/~lukeh/heimdal/} for more information.
88
89 @item @kbd{--enable-bigendian}
90 @item @kbd{--enable-littleendian}
91 Normally, the build process will figure out by itself if the machine is
92 big or little endian.  It might fail in some cases when
93 cross-compiling.  If it does fail to figure it out, use the relevant of
94 these two options.
95
96 @item @kbd{--with-mips-abi=@var{abi}}
97 On Irix there are three different ABIs that can be used (@samp{32},
98 @samp{n32}, or @samp{64}).  This option allows you to override the
99 automatic selection.
100
101 @item @kbd{--disable-mmap}
102 Do not use the mmap system call.  Normally, configure detects if there
103 is a working mmap and it is only used if there is one.  Only try this
104 option if it fails to work anyhow.
105
106 @end table