1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH FTP 1 "Jun 6, 2006"
8 .SH NAME
9 ftp \- file transfer program
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBftp\fR [\fB-adfginpstvx\fR] [\fB-m\fR \fIGSS Mech\fR] [\fB-T\fR \fItimeout\fR]
14 [\fIhostname\fR [\fIport\fR]]
15 .fi
16
17 .SH DESCRIPTION
18 .sp
19 .LP
20 The \fBftp\fR command is the user interface to the \fBInternet\fR standard File
21 Transfer Protocol (\fBFTP\fR). \fBftp\fR transfers files to and from a remote
22 network site.
23 .sp
24 .LP
25 The host and optional port with which \fBftp\fR is to communicate can be
26 specified on the command line. If this is done, \fBftp\fR immediately attempts
27 to establish a connection to an \fBFTP\fR server on that host. Otherwise,
28 \fBftp\fR enters its command interpreter and awaits instructions from the user.
29 When \fBftp\fR is awaiting commands from the user, it displays the prompt
30 \fBftp>\fR.
31 .SH OPTIONS
32 .sp
33 .LP
34 The following options can be specified at the command line, or to the command
35 interpreter:
36 .sp
37 .ne 2
38 .na
39 \fB\fB-a\fR\fR
40 .ad
41 .RS 14n
42 Uses \fBGSSAPI\fR authentication \fBonly\fR. If the authentication fails, this
43 option closes the connection.
44 .RE
45
46 .sp
47 .ne 2
48 .na
49 \fB\fB-d\fR\fR
50 .ad
51 .RS 14n
52 Enables debugging.
1098
1099 .sp
1100 .ne 2
1101 .na
1102 \fB\fB?\fR [ \fIcommand\fR ]\fR
1103 .ad
1104 .sp .6
1105 .RS 4n
1106 A synonym for \fBhelp\fR.
1107 .RE
1108
1109 .sp
1110 .LP
1111 Command arguments which have embedded spaces can be quoted with quote (\fB"\fR)
1112 marks.
1113 .sp
1114 .LP
1115 If any command argument which is not indicated as being optional is not
1116 specified, \fBftp\fR prompts for that argument.
1117 .SH ABORTING A FILE TRANSFER
1118 .sp
1119 .LP
1120 To abort a file transfer, use the terminal interrupt key. Sending transfers is
1121 immediately halted. Receiving transfers are halted by sending an \fBFTP\fR
1122 protocol \fBABOR\fR command to the remote server, and discarding any further
1123 data received. The speed at which this is accomplished depends upon the remote
1124 server's support for \fBABOR\fR processing. If the remote server does not
1125 support the \fBABOR\fR command, an \fBftp>\fR prompt does not appear until the
1126 remote server has completed sending the requested file.
1127 .sp
1128 .LP
1129 The terminal interrupt key sequence is ignored when \fBftp\fR has completed any
1130 local processing and is awaiting a reply from the remote server. A long delay
1131 in this mode can result from the \fBABOR\fR processing described above, or from
1132 unexpected behavior by the remote server, including violations of the ftp
1133 protocol. If the delay results from unexpected remote server behavior, the
1134 local \fBftp\fR program must be killed by hand.
1135 .SH FILE NAMING CONVENTIONS
1136 .sp
1137 .LP
1138 Local files specified as arguments to \fBftp\fR commands are processed
1139 according to the following rules.
1140 .sp
1141 .ne 2
1142 .na
1143 \fB1)\fR
1144 .ad
1145 .RS 6n
1146 If the file name \fB\(mi\fR is specified, the standard input (for reading) or
1147 standard output (for writing) is used.
1148 .RE
1149
1150 .sp
1151 .ne 2
1152 .na
1153 \fB2)\fR
1154 .ad
1155 .RS 6n
1156 If the first character of the file name is \fB|\fR, the remainder of the
1182 .RS 6n
1183 For \fBmget\fR commands and \fBget\fR commands with unspecified local file
1184 names, the local filename is the remote filename, which can be altered by a
1185 \fBcase\fR, \fBntrans\fR, or \fBnmap\fR setting. The resulting filename can
1186 then be altered if \fBrunique\fR is on.
1187 .RE
1188
1189 .sp
1190 .ne 2
1191 .na
1192 \fB5)\fR
1193 .ad
1194 .RS 6n
1195 For \fBmput\fR commands and \fBput\fR commands with unspecified remote file
1196 names, the remote filename is the local filename, which can be altered by a
1197 \fBntrans\fR or \fBnmap\fR setting. The resulting filename can then be altered
1198 by the remote server if \fBsunique\fR is on.
1199 .RE
1200
1201 .SH FILE TRANSFER PARAMETERS
1202 .sp
1203 .LP
1204 The \fBFTP\fR specification specifies many parameters which can affect a file
1205 transfer.
1206 .sp
1207 .LP
1208 The "representation type" can be one of "network \fBASCII\fR", "\fBEBCDIC\fR",
1209 "image", or "local byte size" with a specified byte size (for PDP-10's and
1210 PDP-20's mostly). The "network \fBASCII\fR" and "\fBEBCDIC\fR" types have a
1211 further subtype which specifies whether vertical format control (\fBNEWLINE\fR
1212 characters, form feeds, and so on) are to be passed through ("non-print"),
1213 provided in \fBTELNET\fR format ("\fBTELNET\fR format controls"), or provided
1214 in \fBASA\fR (\fBFORTRAN\fR) ("carriage control (\fBASA\fR)") format. \fBftp\fR
1215 supports the "network \fBASCII\fR" (subtype "non-print" only) and "image"
1216 types, plus "local byte size" with a byte size of 8 for communicating with
1217 \fBTENEX\fR machines.
1218 .sp
1219 .LP
1220 The "file structure" can be one of \fBfile\fR (no record structure),
1221 \fBrecord\fR, or \fBpage\fR. \fBftp\fR supports only the default value, which
1222 is \fBfile\fR.
1223 .sp
1224 .LP
1225 The "transfer mode" can be one of \fBstream\fR, \fBblock\fR, or
1226 \fBcompressed\fR. \fBftp\fR supports only the default value, which is
1227 \fBstream\fR.
1228 .SH USAGE
1229 .sp
1230 .LP
1231 See \fBlargefile\fR(5) for the description of the behavior of \fBftp\fR when
1232 encountering files greater than or equal to 2 Gbyte (2^31 bytes).
1233 .sp
1234 .LP
1235 The \fBftp\fR command is IPv6-enabled. See \fBip6\fR(7P).
1236 .SH FILES
1237 .sp
1238 .LP
1239 \fB~/.netrc\fR
1240 .SH ATTRIBUTES
1241 .sp
1242 .LP
1243 See \fBattributes\fR(5) for descriptions of the following attributes:
1244 .sp
1245
1246 .sp
1247 .TS
1248 box;
1249 c | c
1250 l | l .
1251 ATTRIBUTE TYPE ATTRIBUTE VALUE
1252 _
1253 CSI enabled
1254 .TE
1255
1256 .SH SEE ALSO
1257 .sp
1258 .LP
1259 \fBls\fR(1), \fBrcp\fR(1), \fBsh\fR(1), \fBtar\fR(1), \fBin.ftpd\fR(1M),
1260 \fBpopen\fR(3C), \fBftp\fR(4), \fBftpusers\fR(4), \fBmech\fR(4),
1261 \fBnetrc\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5), \fBip6\fR(7P)
1262 .sp
1263 .LP
1264 Allman, M., Ostermann, S., and Metz, C. \fIRFC 2428, FTP Extensions for IPv6
1265 and NATs\fR. The Internet Society. September 1998.
1266 .sp
1267 .LP
1268 Lunt, S. J. \fIRFC 2228, FTP Security Extensions\fR. Internet Draft. November
1269 1993.
1270 .sp
1271 .LP
1272 Postel, Jon, and Joyce Reynolds. \fIRFC 959, File Transfer Protocol (FTP )\fR.
1273 Network Information Center. October 1985.
1274 .sp
1275 .LP
1276 Piscitello, D. \fIRFC 1639, FTP Operation Over Big Address Records (FOOBAR)\fR.
1277 Network Working Group. June 1994.
1278 .SH NOTES
1279 .sp
1280 .LP
1281 Failure to log in can arise from an explicit denial by the remote \fBFTP\fR
1282 server because the account is listed in \fB/etc/ftpusers\fR. See
1283 \fBin.ftpd\fR(1M) and \fBftpusers\fR(4).
1284 .sp
1285 .LP
1286 Correct execution of many commands depends upon proper behavior by the remote
1287 server.
1288 .sp
1289 .LP
1290 An error in the treatment of carriage returns in the 4.2 \fBBSD\fR code
1291 handling transfers with a "representation type" of "network \fBASCII\fR" has
1292 been corrected. This correction can result in incorrect transfers of binary
1293 files to and from 4.2 \fBBSD\fR servers using a "representation type" of
1294 "network \fBASCII\fR". Avoid this problem by using the "image" type.
|
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved
4 .\" 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.
5 .\" 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.
6 .\" 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]
7 .TH FTP 1 "Jun 6, 2006"
8 .SH NAME
9 ftp \- file transfer program
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBftp\fR [\fB-adfginpstvx\fR] [\fB-m\fR \fIGSS Mech\fR] [\fB-T\fR \fItimeout\fR]
14 [\fIhostname\fR [\fIport\fR]]
15 .fi
16
17 .SH DESCRIPTION
18 .LP
19 The \fBftp\fR command is the user interface to the \fBInternet\fR standard File
20 Transfer Protocol (\fBFTP\fR). \fBftp\fR transfers files to and from a remote
21 network site.
22 .sp
23 .LP
24 The host and optional port with which \fBftp\fR is to communicate can be
25 specified on the command line. If this is done, \fBftp\fR immediately attempts
26 to establish a connection to an \fBFTP\fR server on that host. Otherwise,
27 \fBftp\fR enters its command interpreter and awaits instructions from the user.
28 When \fBftp\fR is awaiting commands from the user, it displays the prompt
29 \fBftp>\fR.
30 .SH OPTIONS
31 .LP
32 The following options can be specified at the command line, or to the command
33 interpreter:
34 .sp
35 .ne 2
36 .na
37 \fB\fB-a\fR\fR
38 .ad
39 .RS 14n
40 Uses \fBGSSAPI\fR authentication \fBonly\fR. If the authentication fails, this
41 option closes the connection.
42 .RE
43
44 .sp
45 .ne 2
46 .na
47 \fB\fB-d\fR\fR
48 .ad
49 .RS 14n
50 Enables debugging.
1096
1097 .sp
1098 .ne 2
1099 .na
1100 \fB\fB?\fR [ \fIcommand\fR ]\fR
1101 .ad
1102 .sp .6
1103 .RS 4n
1104 A synonym for \fBhelp\fR.
1105 .RE
1106
1107 .sp
1108 .LP
1109 Command arguments which have embedded spaces can be quoted with quote (\fB"\fR)
1110 marks.
1111 .sp
1112 .LP
1113 If any command argument which is not indicated as being optional is not
1114 specified, \fBftp\fR prompts for that argument.
1115 .SH ABORTING A FILE TRANSFER
1116 .LP
1117 To abort a file transfer, use the terminal interrupt key. Sending transfers is
1118 immediately halted. Receiving transfers are halted by sending an \fBFTP\fR
1119 protocol \fBABOR\fR command to the remote server, and discarding any further
1120 data received. The speed at which this is accomplished depends upon the remote
1121 server's support for \fBABOR\fR processing. If the remote server does not
1122 support the \fBABOR\fR command, an \fBftp>\fR prompt does not appear until the
1123 remote server has completed sending the requested file.
1124 .sp
1125 .LP
1126 The terminal interrupt key sequence is ignored when \fBftp\fR has completed any
1127 local processing and is awaiting a reply from the remote server. A long delay
1128 in this mode can result from the \fBABOR\fR processing described above, or from
1129 unexpected behavior by the remote server, including violations of the ftp
1130 protocol. If the delay results from unexpected remote server behavior, the
1131 local \fBftp\fR program must be killed by hand.
1132 .SH FILE NAMING CONVENTIONS
1133 .LP
1134 Local files specified as arguments to \fBftp\fR commands are processed
1135 according to the following rules.
1136 .sp
1137 .ne 2
1138 .na
1139 \fB1)\fR
1140 .ad
1141 .RS 6n
1142 If the file name \fB\(mi\fR is specified, the standard input (for reading) or
1143 standard output (for writing) is used.
1144 .RE
1145
1146 .sp
1147 .ne 2
1148 .na
1149 \fB2)\fR
1150 .ad
1151 .RS 6n
1152 If the first character of the file name is \fB|\fR, the remainder of the
1178 .RS 6n
1179 For \fBmget\fR commands and \fBget\fR commands with unspecified local file
1180 names, the local filename is the remote filename, which can be altered by a
1181 \fBcase\fR, \fBntrans\fR, or \fBnmap\fR setting. The resulting filename can
1182 then be altered if \fBrunique\fR is on.
1183 .RE
1184
1185 .sp
1186 .ne 2
1187 .na
1188 \fB5)\fR
1189 .ad
1190 .RS 6n
1191 For \fBmput\fR commands and \fBput\fR commands with unspecified remote file
1192 names, the remote filename is the local filename, which can be altered by a
1193 \fBntrans\fR or \fBnmap\fR setting. The resulting filename can then be altered
1194 by the remote server if \fBsunique\fR is on.
1195 .RE
1196
1197 .SH FILE TRANSFER PARAMETERS
1198 .LP
1199 The \fBFTP\fR specification specifies many parameters which can affect a file
1200 transfer.
1201 .sp
1202 .LP
1203 The "representation type" can be one of "network \fBASCII\fR", "\fBEBCDIC\fR",
1204 "image", or "local byte size" with a specified byte size (for PDP-10's and
1205 PDP-20's mostly). The "network \fBASCII\fR" and "\fBEBCDIC\fR" types have a
1206 further subtype which specifies whether vertical format control (\fBNEWLINE\fR
1207 characters, form feeds, and so on) are to be passed through ("non-print"),
1208 provided in \fBTELNET\fR format ("\fBTELNET\fR format controls"), or provided
1209 in \fBASA\fR (\fBFORTRAN\fR) ("carriage control (\fBASA\fR)") format. \fBftp\fR
1210 supports the "network \fBASCII\fR" (subtype "non-print" only) and "image"
1211 types, plus "local byte size" with a byte size of 8 for communicating with
1212 \fBTENEX\fR machines.
1213 .sp
1214 .LP
1215 The "file structure" can be one of \fBfile\fR (no record structure),
1216 \fBrecord\fR, or \fBpage\fR. \fBftp\fR supports only the default value, which
1217 is \fBfile\fR.
1218 .sp
1219 .LP
1220 The "transfer mode" can be one of \fBstream\fR, \fBblock\fR, or
1221 \fBcompressed\fR. \fBftp\fR supports only the default value, which is
1222 \fBstream\fR.
1223 .SH USAGE
1224 .LP
1225 See \fBlargefile\fR(5) for the description of the behavior of \fBftp\fR when
1226 encountering files greater than or equal to 2 Gbyte (2^31 bytes).
1227 .sp
1228 .LP
1229 The \fBftp\fR command is IPv6-enabled. See \fBip6\fR(7P).
1230 .SH FILES
1231 .LP
1232 \fB~/.netrc\fR
1233 .SH ATTRIBUTES
1234 .LP
1235 See \fBattributes\fR(5) for descriptions of the following attributes:
1236 .sp
1237
1238 .sp
1239 .TS
1240 box;
1241 c | c
1242 l | l .
1243 ATTRIBUTE TYPE ATTRIBUTE VALUE
1244 _
1245 CSI enabled
1246 .TE
1247
1248 .SH SEE ALSO
1249 .LP
1250 \fBls\fR(1), \fBrcp\fR(1), \fBsh\fR(1), \fBtar\fR(1),
1251 \fBpopen\fR(3C), \fBftp\fR(4), \fBftpusers\fR(4), \fBmech\fR(4),
1252 \fBnetrc\fR(4), \fBattributes\fR(5), \fBlargefile\fR(5), \fBip6\fR(7P)
1253 .sp
1254 .LP
1255 Allman, M., Ostermann, S., and Metz, C. \fIRFC 2428, FTP Extensions for IPv6
1256 and NATs\fR. The Internet Society. September 1998.
1257 .sp
1258 .LP
1259 Lunt, S. J. \fIRFC 2228, FTP Security Extensions\fR. Internet Draft. November
1260 1993.
1261 .sp
1262 .LP
1263 Postel, Jon, and Joyce Reynolds. \fIRFC 959, File Transfer Protocol (FTP )\fR.
1264 Network Information Center. October 1985.
1265 .sp
1266 .LP
1267 Piscitello, D. \fIRFC 1639, FTP Operation Over Big Address Records (FOOBAR)\fR.
1268 Network Working Group. June 1994.
1269 .SH NOTES
1270 .LP
1271 Failure to log in can arise from an explicit denial by the remote \fBFTP\fR
1272 server because the account is listed in \fB/etc/ftpusers\fR. See
1273 \fBftpusers\fR(4).
1274 .sp
1275 .LP
1276 Correct execution of many commands depends upon proper behavior by the remote
1277 server.
1278 .sp
1279 .LP
1280 An error in the treatment of carriage returns in the 4.2 \fBBSD\fR code
1281 handling transfers with a "representation type" of "network \fBASCII\fR" has
1282 been corrected. This correction can result in incorrect transfers of binary
1283 files to and from 4.2 \fBBSD\fR servers using a "representation type" of
1284 "network \fBASCII\fR". Avoid this problem by using the "image" type.
|