Merge from vendor branch HEIMDAL:
[dragonfly.git] / contrib / lukemftpd / INSTALL
1 INSTALLATION INTRODUCTION
2 -------------------------
3
4 This file describes how to compile and install lukemftpd on your
5 system.
6
7         ============================================
8         =                                          =
9         =  NOTE: You will need an ANSI C compiler. =
10         =                                          =
11         ============================================
12
13
14 For most systems, execute the following to compile and install
15 lukemftpd:
16         ./configure
17         make
18         make install
19
20 Preformatted manual pages for ftpd(8), ftpd.conf(5), and ftpusers(5) are
21 also installed.  If you wish to install the sources, ensure that your system
22 has up-to-date mandoc macros. groff ships with this macro suite,
23 but it has bugs. Try:
24     ftp://ftp.netbsd.org/pub/NetBSD/NetBSD-current/src/share/tmac/
25 for a more recent version.
26
27
28 CONFIGURATION OPTIONS
29 ---------------------
30
31 lukemftpd is configured using an `autoconf' generated `configure'
32 script.  `configure' supports the following options:
33
34 * The standard `autoconf configure' options, including:
35   --prefix=PREFIX         install architecture-independent files in PREFIX
36                           [/usr/local]
37   --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
38                           [same as prefix]
39   --srcdir=DIR            find the sources in DIR [configure dir or ..]
40                           BSD or GNU make may be required for this to work.
41
42 * Specific options:
43
44   --enable-ipv6           Enable IPv6 support (if your OS supports it).
45   --disable-ipv6          Disable IPv6 support (even if your OS supports it).
46                           [default: enabled]
47   --enable-builtinls      Enable built-in /bin/ls.  [default: enabled]
48   --disable-builtinls     Disable built-in /bin/ls.
49   --with-socks            Compile with SOCKS firewall traversal support.
50   --with-socks5[=PATH]    Compile with SOCKS5 firewall traversal support.
51   --with-socks4[=PATH]    Compile with SOCKS4 firewall traversal support.
52   --with-skey             Compile with S/Key authentication support.
53
54 The following environment variables can be set to override various
55 compiler related settings.
56   CC=compiler           specify name of the C compiler (default: gcc or cc)
57   CFLAGS=flags          specify flags to C compiler (default: -O -g or just -O)
58   LDFLAGS=flags         specify flags to linker (default: none)
59
60 This can be achieved with:
61         env CC="compiler" CFLAGS="flags" LDFLAGS="flags" ./configure
62
63
64         ============================================
65         =                                          =
66         =  NOTE: You will need an ANSI C compiler. =
67         =                                          =
68         ============================================
69
70
71 PLATFORM SPECIFIC NOTES
72 -----------------------
73
74 The following platforms & compilers have been tested:
75
76 - Irix 6.5
77         - Compiler: /usr/local/bin/gcc
78            version: egcs-1.1.2
79
80           Configure with:
81                 ./configure --disable-builtinls
82           as the in-built ls code doesn't appear to work due to
83           problems in the fts routines.
84
85 - Linux 2.4 kernel with glibc prior to 2.2
86         Configure with:
87                 ./configure --disable-ipv6
88         as glibc before 2.2 doesn't correctly support sin6_scope_id.
89
90 - NetBSD 1.5 (i386)
91         - Compiler: /usr/bin/cc
92            version: egcs-1.1.2
93
94 - Solaris 2.6 (sparc)
95         - Compiler: /opt/SUNWspro/bin/cc
96            version: WorkShop Compilers 5.0
97
98 - Tru64 5.0
99         - Compiler: /bin/cc
100            version: Compaq C V6.1-011 on Digital UNIX V5.0 (Rev. 910)
101