usr/src/man/man1m/ftpaddhost.1m

   1 '\" te
   2 .\" Copyright (C) 2003, 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 FTPADDHOST 1M "May 1, 2003"
   7 .SH NAME
   8 ftpaddhost \- set up a virtual FTP host
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBftpaddhost\fR \fB-c\fR | \fB-l\fR [\fB-b\fR] [\fB-x\fR \fIxferlog\fR] \fIhostname\fR \fIroot_dir\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBftpaddhost\fR script is executed by the super user to set up virtual FTP
  19 hosts. The \fBftpaddhost\fR command configures the virtual host \fIhostname\fR
  20 under directory \fIroot_dir\fR. The value of \fIhostname\fR can be an IP
  21 address or the name of a host.
  22 .SH OPTIONS
  23 .sp
  24 .LP
  25 The \fBftpaddhost\fR script supports the following options:
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fB-b\fR\fR
  30 .ad
  31 .RS 14n
  32 Create a banner for the virtual host. This option is useful to confirm that the
  33 virtual host is working.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fB-c\fR\fR
  40 .ad
  41 .RS 14n
  42 Configure complete virtual hosting. This option allows each virtual host to
  43 have its own version of the \fBftpaccess\fR, \fBftpconversions\fR,
  44 \fB\fR\fBftpgroups\fR, \fBftphosts\fR, and \fBftpusers\fR files. The master
  45 version of each of these configuration files is copied from the \fB/etc/ftpd\fR
  46 directory and placed in  the \fB/etc/ftpd/virtual-ftpd/\fIhostname\fR\fR
  47 directory. If the \fB/etc/ftpusers\fR file exists it is appended to the virtual
  48 \fBftpusers\fR file. If a virtual host lacks its own version of a configuration
  49 file, the master version is used.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB-l\fR\fR
  56 .ad
  57 .RS 14n
  58 Configure limited virtual hosting. This  option allows a small number of
  59 parameters to be configured differently for a  virtual host. See the
  60 \fBvirtual\fR keyword on the \fBftpaccess\fR(4) manual page.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fB-x\fR \fIxferlog\fR\fR
  67 .ad
  68 .RS 14n
  69 Create a logfile entry such that the transfer logs for the virtual host are
  70 written to the specified file. An absolute path must be specified for the
  71 \fIxferlog\fR file.
  72 .RE
  73
  74 .SH OPERANDS
  75 .sp
  76 .LP
  77 The following operands are supported:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIhostname\fR\fR
  82 .ad
  83 .RS 12n
  84 The host name or IP address of the virtual server.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fIroot_dir\fR\fR
  91 .ad
  92 .RS 12n
  93 The absolute pathname of the directory under which the virtual server is set
  94 up.
  95 .RE
  96
  97 .SH EXIT STATUS
  98 .sp
  99 .LP
 100 The following exit values are returned:
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB0\fR \fR
 105 .ad
 106 .RS 6n
 107 Successful completion
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fB1\fR\fR
 114 .ad
 115 .RS 6n
 116 Improper usage of the command
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fB2\fR\fR
 123 .ad
 124 .RS 6n
 125 Command failed
 126 .RE
 127
 128 .SH FILES
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB/etc/ftpd/virtual-ftpd/\fIhostname\fR\fR\fR
 133 .ad
 134 .sp .6
 135 .RS 4n
 136 The configuration files directory for the virtual host \fIhostname\fR.
 137 .RE
 138
 139 .SH ATTRIBUTES
 140 .sp
 141 .LP
 142 See \fBattributes\fR(5)  for descriptions of the following attributes:
 143 .sp
 144
 145 .sp
 146 .TS
 147 box;
 148 c | c
 149 l | l .
 150 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 151 _
 152 Interface Stability     Evolving
 153 .TE
 154
 155 .SH SEE ALSO
 156 .sp
 157 .LP
 158 \fBftpconfig\fR(1M), \fBin.ftpd\fR(1M), \fBftpaccess\fR(4),
 159 \fBftpconversions\fR(4), \fBftpgroups\fR(4), \fBftphosts\fR(4),
 160 \fBftpusers\fR(4), \fBxferlog\fR(4), \fBattributes\fR(5)