Default kdump's data limit to 64 bytes and document how it can be disabled.
[dragonfly.git] / contrib / lukemftpd / README
1 WHAT IS LUKEMFTPD?
2 ------------------
3
4 `lukemftpd' is what many users affectionately call the enhanced ftp
5 server in NetBSD ( http://www.netbsd.org/ ).  The `lukem' comes from
6 the account name of the NetBSD developer who wrote most of the
7 enhancements: Luke Mewburn <lukem@netbsd.org>.
8
9 This package is a `port' of the NetBSD ftp server to other systems.
10
11 The enhancements over the standard ftp server in 4.4BSD (and derivatives)
12 include:
13         * command line options:
14                 + allow override of directory used by anonymous ftp (-a)
15                 + optional change of directory for configuration files (-c)
16                 + check whether a user would be granted access (-C)
17                 + specify email address for display messages (-e)
18                 + change hostname advertised as (-h, -H)
19                 + specify data port to listen on (-P)
20                 + keep track of the number of users logged in (-q, -Q)
21                 + permanently drop privileges (-r)
22                 + specify version advertised (-V)
23                 + log wu-ftpd style `xferlog' entries to syslog (-X)
24
25         * % escape sequences in files displayed to users (/etc/motd,
26           /etc/ftpwelcome, ...)
27
28         * IPv6 support (from the KAME project).
29
30         * ftpusers(5) control of who may log in, and optional
31           specification of a "class" to be associated with the
32           specified user or group.
33
34         * ftpd.conf(5) to control various configuration options on
35           a per-class basis.  The following options are supported:
36                 + address to advertise in PASV and LPSV responses
37                 + check the PORT command for validity
38                 + specify the directory to chroot(2) to
39                 + automatic in-line conversions (e.g, `.tar.gz'
40                   retrieval of directories)
41                 + deny logins after the username is provided (rather
42                   than after the password)
43                 + display a file the first time a directory is entered
44                 + specify the home directory of the session (for "cd ~")
45                 + limit the maximum number of concurrent sessions
46                 + limit the maximum size of an uploaded file
47                 + set the default timeout and restrict the maximum
48                   timeout that a user may request
49                 + deny user from running the CHMOD, DELE, MKD, RMD, RNFR
50                   and UMASK commands
51                 + specify the motd(5) file to display upon login
52                 + specify a glob(3) pattern of files to notify a user
53                   of the existance of once a directory is entered
54                 + enable/disable the use of PASV and EPSV connections
55                 + limit the ports that PORT and LPRT may bind to
56                 + limit the transfer rate of transfers
57                 + limit the characters that may be used in an uploaded
58                   filename
59                 + set the umask
60                 + deny user from running APPE, STOR and STOU as well
61                   as CHMOD, ...
62
63         * In-built copy of ls(1) to implement LIST (unless disabled
64           out with --disable-builtinls), so that /bin/ls does not need
65           to exist inside the ftp tree.
66
67         * Virtual servers can be supported with a combination of
68           ftpd(8) flags and support in the invoking inetd(8) program
69           (such as that in NetBSD).
70
71         * Optional S/Key authentication (if configued with --with-skey).
72
73
74 Features present in NetBSD's ftpd but not yet available in lukemftpd:
75         * logging active sessions to utmp(5) (-u, -U)
76         * logging completed sessions to wtmp(5) (-w, -W)
77
78
79 INSTALLATION
80 ------------
81
82 Refer to `INSTALL' for more information on how to compile and install
83 lukemftpd.
84
85
86 FEEDBACK / BUG REPORTS
87 ----------------------
88
89 Please email feedback back to the maintainer: <lukem@netbsd.org>.
90
91
92 COPYRIGHT
93 ---------
94
95 lukemftpd is covered by a BSD-style copyright notice. Please refer to
96 the file `COPYING' for more information.
97
98
99 AVAILABILITY
100 ------------
101
102 The primary ftp site for lukemftpd is:
103         ftp://ftp.netbsd.org/pub/NetBSD/misc/lukemftp/
104 (the same location as lukemftp)