1.\" $NetBSD: ftpd.8,v 1.76 2005/08/07 11:13:34 wiz Exp $ |
2.\" 3.\" Copyright (c) 1997-2003 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Luke Mewburn. 8.\" 9.\" Redistribution and use in source and binary forms, with or without --- 48 unchanged lines hidden (view full) --- 58.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 59.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 60.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 61.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 62.\" SUCH DAMAGE. 63.\" 64.\" @(#)ftpd.8 8.2 (Berkeley) 4/19/94 65.\" |
66.Dd August 4, 2005 |
67.Dt FTPD 8 68.Os 69.Sh NAME 70.Nm ftpd 71.Nd 72Internet File Transfer Protocol server 73.Sh SYNOPSIS 74.Nm |
75.Op Fl 46DdHlQqrsUuWwX |
76.Op Fl a Ar anondir |
77.Op Fl C Ar user |
78.Op Fl c Ar confdir |
79.Op Fl e Ar emailaddr 80.Op Fl h Ar hostname 81.Op Fl L Ar xferlogfile 82.Op Fl P Ar dataport 83.Op Fl V Ar version 84.Sh DESCRIPTION 85.Nm 86is the Internet File Transfer Protocol server process. 87The server uses the 88.Tn TCP 89protocol and listens at the port specified in the 90.Dq ftp 91service specification; see 92.Xr services 5 . 93.Pp 94Available options: 95.Bl -tag -width Ds |
96.It Fl 4 97When 98.Fl D 99is specified, bind to IPv4 addresses only. 100.It Fl 6 101When 102.Fl D 103is specified, bind to IPv6 addresses only. |
104.It Fl a Ar anondir 105Define 106.Ar anondir 107as the directory to 108.Xr chroot 2 109into for anonymous logins. 110Default is the home directory for the ftp user. 111This can also be specified with the 112.Xr ftpd.conf 5 113.Sy chroot 114directive. |
115.It Fl C Ar user 116Check whether 117.Ar user 118would be granted access under 119the restrictions given in 120.Xr ftpusers 5 121and exit without attempting a connection. 122.Nm 123exits with an exit code of 0 if access would be granted, or 1 otherwise. 124This can be useful for testing configurations. |
125.It Fl c Ar confdir 126Change the root directory of the configuration files from 127.Dq Pa /etc 128to 129.Ar confdir . 130This changes the directory for the following files: 131.Pa /etc/ftpchroot , 132.Pa /etc/ftpusers , 133.Pa /etc/ftpwelcome , 134.Pa /etc/motd , 135and the file specified by the 136.Xr ftpd.conf 5 137.Sy limit 138directive. |
139.It Fl D 140Run as daemon. |
141.Nm |
142will listen on the default FTP port for incoming connections 143and fork a child for each connection. 144This is lower overhead than starting 145.Nm 146from 147.Xr inetd 8 148and thus might be useful on busy servers to reduce load. |
149.It Fl d 150Debugging information is written to the syslog using a facility of 151.Dv LOG_FTP . 152.It Fl e Ar emailaddr 153Use 154.Ar emailaddr 155for the 156.Dq "\&%E" 157escape sequence (see 158.Sx Display file escape sequences ) |
159.It Fl H 160Equivalent to 161.Do 162-h 163`hostname` 164.Dc . |
165.It Fl h Ar hostname 166Explicitly set the hostname to advertise as to 167.Ar hostname . 168The default is the hostname associated with the IP address that 169.Nm 170is listening on. 171This ability (with or without 172.Fl h ) , 173in conjunction with 174.Fl c Ar confdir , 175is useful when configuring 176.Sq virtual 177.Tn FTP 178servers, each listening on separate addresses as separate names. 179Refer to 180.Xr inetd.conf 5 181for more information on starting services to listen on specific IP addresses. |
182.It Fl L Ar xferlogfile 183Log 184.Tn wu-ftpd 185style 186.Sq xferlog 187entries to 188.Ar xferlogfile . |
189.It Fl l 190Each successful and failed 191.Tn FTP 192session is logged using syslog with a facility of 193.Dv LOG_FTP . 194If this option is specified more than once, the retrieve (get), store (put), 195append, delete, make directory, remove directory and rename operations and 196their file name arguments are also logged. |
197.It Fl P Ar dataport 198Use 199.Ar dataport 200as the data port, overriding the default of using the port one less 201that the port 202.Nm 203is listening on. |
204.It Fl Q 205Disable the use of pid files for keeping track of the number of logged-in 206users per class. 207This may reduce the load on heavily loaded 208.Tn FTP 209servers. |
210.It Fl q 211Enable the use of pid files for keeping track of the number of logged-in 212users per class. 213This is the default. |
214.It Fl r 215Permanently drop root privileges once the user is logged in. 216The use of this option may result in the server using a port other 217than the (listening-port - 1) for 218.Sy PORT 219style commands, which is contrary to the 220.Cm RFC 959 221specification, but in practice very few clients rely upon this behaviour. 222See 223.Sx SECURITY CONSIDERATIONS 224below for more details. 225.It Fl s 226Require a secure authentication mechanism like Kerberos or S/Key to be used. |
227.It Fl U 228Don't log each concurrent 229.Tn FTP 230session to 231.Pa /var/run/utmp . 232This is the default. |
233.It Fl u 234Log each concurrent 235.Tn FTP 236session to 237.Pa /var/run/utmp , 238making them visible to commands such as 239.Xr who 1 . |
240.It Fl V Ar version 241Use 242.Ar version 243as the version to advertise in the login banner and in the output of 244.Sy STAT 245and 246.Sy SYST 247instead of the default version information. 248If 249.Ar version 250is empty or 251.Sq - 252then don't display any version information. |
253.It Fl W 254Don't log each 255.Tn FTP 256session to 257.Pa /var/log/wtmp . |
258.It Fl w 259Log each 260.Tn FTP 261session to 262.Pa /var/log/wtmp , 263making them visible to commands such as 264.Xr last 1 . 265This is the default. |
266.It Fl X 267Log 268.Tn wu-ftpd 269style 270.Sq xferlog 271entries to the syslog, prefixed with 272.Dq "xferlog:\ " , 273using a facility of --- 584 unchanged lines hidden --- |