1 '\" te
   2 .\" Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FTPCONFIG 1M "May 1, 2003"
   7 .SH NAME
   8 ftpconfig \- set up anonymous FTP
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBftpconfig\fR [\fIftpdir\fR]
  13 .fi
  14 
  15 .LP
  16 .nf
  17 \fBftpconfig\fR \fB-d\fR \fIftpdir\fR
  18 .fi
  19 
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBftpconfig\fR script is executed by the super user to set up anonymous
  24 FTP. Anonymous FTP allows users to remotely log on to the FTP server by
  25 specifying the user name  \fBftp\fR or \fBanonymous\fR and the user's email
  26 address as password. The anonymous users are logged on to the FTP Server and
  27 given access to a restricted file area with its own file system root. See
  28 \fBchroot\fR(2). The FTP area has  its own minimal system files.
  29 .sp
  30 .LP
  31 This command will copy and set up all the components needed to operate an
  32 anonymous FTP server, including creating the \fIftp\fR user account, creating
  33 device nodes, copying \fB/usr/lib\fR files, and copying timezone data.  The
  34 \fBpasswd\fR and \fBgroup\fR files set up have been stripped down to prevent
  35 malicious users from finding login names on the server.  The anonymous file
  36 area will be placed under \fBftpdir\fR. If the \fIftp\fR user account already
  37 exists, then the current FTP area is used, and the system files in it are
  38 updated. All other files are left untouched. This command should be run to
  39 update the anonymous FTP area's configuration whenever a system patch is
  40 installed, or the system is upgraded.
  41 .SH OPTIONS
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-d\fR \fR
  46 .ad
  47 .RS 7n
  48 Create a new or update an existing \fIftpdir\fR without creating or updating
  49 the \fIftp\fR user account. Use this option when creating guest FTP user
  50 accounts.
  51 .RE
  52 
  53 .SH OPERANDS
  54 .sp
  55 .LP
  56 The following operands are supported:
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIftpdir\fR\fR
  61 .ad
  62 .RS 10n
  63 The absolute pathname of the directory under which the anonymous FTP area is
  64 set up.
  65 .RE
  66 
  67 .SH EXIT STATUS
  68 .sp
  69 .LP
  70 The following exit values are returned:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB0\fR \fR
  75 .ad
  76 .RS 6n
  77 Successful completion
  78 .RE
  79 
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB1\fR\fR
  84 .ad
  85 .RS 6n
  86 Improper usage of the command
  87 .RE
  88 
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB2\fR\fR
  93 .ad
  94 .RS 6n
  95 Command failed
  96 .RE
  97 
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5)  for descriptions of the following attributes:
 102 .sp
 103 
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Evolving
 112 .TE
 113 
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBftpaddhost\fR(1M), \fBin.ftpd\fR(1M), \fBuseradd\fR(1M), \fBchroot\fR(2),
 118 \fBattributes\fR(5)