Annotation of src/usr.bin/ssh/sftp.1, Revision 1.73
1.73 ! jmc 1: .\" $OpenBSD: sftp.1,v 1.72 2009/08/13 01:11:19 djm Exp $
1.1 djm 2: .\"
1.9 deraadt 3: .\" Copyright (c) 2001 Damien Miller. All rights reserved.
1.1 djm 4: .\"
5: .\" Redistribution and use in source and binary forms, with or without
6: .\" modification, are permitted provided that the following conditions
7: .\" are met:
8: .\" 1. Redistributions of source code must retain the above copyright
9: .\" notice, this list of conditions and the following disclaimer.
10: .\" 2. Redistributions in binary form must reproduce the above copyright
11: .\" notice, this list of conditions and the following disclaimer in the
12: .\" documentation and/or other materials provided with the distribution.
13: .\"
14: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24: .\"
1.73 ! jmc 25: .Dd $Mdocdate: August 13 2009 $
1.1 djm 26: .Dt SFTP 1
27: .Os
28: .Sh NAME
29: .Nm sftp
1.44 jmc 30: .Nd secure file transfer program
1.1 djm 31: .Sh SYNOPSIS
1.43 jmc 32: .Nm sftp
1.41 jmc 33: .Bk -words
1.70 djm 34: .Op Fl 1246Cqv
1.46 jmc 35: .Op Fl B Ar buffer_size
1.29 markus 36: .Op Fl b Ar batchfile
1.70 djm 37: .Op Fl c Ar cipher
1.72 djm 38: .Op Fl D Ar sftp_server_path
1.46 jmc 39: .Op Fl F Ar ssh_config
1.73 ! jmc 40: .Op Fl i Ar identity_file
1.29 markus 41: .Op Fl o Ar ssh_option
1.72 djm 42: .Op Fl P Ar port
1.30 djm 43: .Op Fl R Ar num_requests
1.26 stevesk 44: .Op Fl S Ar program
1.46 jmc 45: .Op Fl s Ar subsystem | sftp_server
1.26 stevesk 46: .Ar host
1.41 jmc 47: .Ek
1.43 jmc 48: .Nm sftp
1.68 djm 49: .Oo Ar user Ns @ Oc Ns
50: .Ar host Ns Op : Ns Ar
1.43 jmc 51: .Nm sftp
1.68 djm 52: .Oo Ar user Ns @ Oc Ns
1.41 jmc 53: .Ar host Ns Oo : Ns Ar dir Ns
1.69 sobrado 54: .Op Ar / Oc
1.43 jmc 55: .Nm sftp
1.42 djm 56: .Fl b Ar batchfile
1.45 jmc 57: .Oo Ar user Ns @ Oc Ns Ar host
1.1 djm 58: .Sh DESCRIPTION
59: .Nm
60: is an interactive file transfer program, similar to
61: .Xr ftp 1 ,
62: which performs all operations over an encrypted
63: .Xr ssh 1
64: transport.
65: It may also use many features of ssh, such as public key authentication and
66: compression.
67: .Nm
68: connects and logs into the specified
1.18 stevesk 69: .Ar host ,
1.1 djm 70: then enters an interactive command mode.
1.15 mouring 71: .Pp
1.21 itojun 72: The second usage format will retrieve files automatically if a non-interactive
1.18 stevesk 73: authentication method is used; otherwise it will do so after
74: successful interactive authentication.
1.15 mouring 75: .Pp
1.60 jaredy 76: The third usage format allows
77: .Nm
78: to start in a remote directory.
1.1 djm 79: .Pp
1.44 jmc 80: The final usage format allows for automated sessions using the
1.42 djm 81: .Fl b
1.44 jmc 82: option.
1.62 jmc 83: In such cases, it is necessary to configure non-interactive authentication
1.44 jmc 84: to obviate the need to enter a password at connection time (see
1.42 djm 85: .Xr sshd 8
1.43 jmc 86: and
1.42 djm 87: .Xr ssh-keygen 1
1.44 jmc 88: for details).
1.1 djm 89: The options are as follows:
90: .Bl -tag -width Ds
1.46 jmc 91: .It Fl 1
92: Specify the use of protocol version 1.
1.70 djm 93: .It Fl 2
94: Specify the use of protocol version 2.
95: .It Fl 4
96: Forces
97: .Nm
98: to use IPv4 addresses only.
99: .It Fl 6
100: Forces
101: .Nm
102: to use IPv6 addresses only.
1.46 jmc 103: .It Fl B Ar buffer_size
104: Specify the size of the buffer that
105: .Nm
106: uses when transferring files.
107: Larger buffers require fewer round trips at the cost of higher
108: memory consumption.
109: The default is 32768 bytes.
1.10 deraadt 110: .It Fl b Ar batchfile
111: Batch mode reads a series of commands from an input
1.13 stevesk 112: .Ar batchfile
1.10 deraadt 113: instead of
1.13 stevesk 114: .Em stdin .
115: Since it lacks user interaction it should be used in conjunction with
1.51 jmc 116: non-interactive authentication.
1.50 djm 117: A
1.51 jmc 118: .Ar batchfile
119: of
120: .Sq \-
1.50 djm 121: may be used to indicate standard input.
1.13 stevesk 122: .Nm
1.21 itojun 123: will abort if any of the following
124: commands fail:
1.33 deraadt 125: .Ic get , put , rename , ln ,
1.41 jmc 126: .Ic rm , mkdir , chdir , ls ,
1.66 jmc 127: .Ic lchdir , chmod , chown ,
128: .Ic chgrp , lpwd , df ,
1.10 deraadt 129: and
1.13 stevesk 130: .Ic lmkdir .
1.41 jmc 131: Termination on error can be suppressed on a command by command basis by
132: prefixing the command with a
1.51 jmc 133: .Sq \-
1.44 jmc 134: character (for example,
135: .Ic -rm /tmp/blah* ) .
1.71 jmc 136: .It Fl C
137: Enables compression (via ssh's
138: .Fl C
139: flag).
1.70 djm 140: .It Fl c Ar cipher
141: Selects the cipher to use for encrypting the data transfers.
142: This option is directly passed to
143: .Xr ssh 1 .
1.72 djm 144: .It Fl D Ar sftp_server_path
145: Connect directly to a local sftp server
146: (rather than via
147: .Xr ssh 1 ) .
148: This option may be useful in debugging the client and server.
1.46 jmc 149: .It Fl F Ar ssh_config
150: Specifies an alternative
151: per-user configuration file for
152: .Xr ssh 1 .
153: This option is directly passed to
154: .Xr ssh 1 .
1.70 djm 155: .It Fl i Ar identity_file
156: Selects the file from which the identity (private key) for public key
157: authentication is read.
158: This option is directly passed to
159: .Xr ssh 1 .
1.1 djm 160: .It Fl o Ar ssh_option
1.23 stevesk 161: Can be used to pass options to
162: .Nm ssh
1.35 stevesk 163: in the format used in
164: .Xr ssh_config 5 .
165: This is useful for specifying options
1.23 stevesk 166: for which there is no separate
167: .Nm sftp
1.44 jmc 168: command-line flag.
169: For example, to specify an alternate port use:
1.26 stevesk 170: .Ic sftp -oPort=24 .
1.46 jmc 171: For full details of the options listed below, and their possible values, see
172: .Xr ssh_config 5 .
173: .Pp
174: .Bl -tag -width Ds -offset indent -compact
175: .It AddressFamily
176: .It BatchMode
177: .It BindAddress
178: .It ChallengeResponseAuthentication
179: .It CheckHostIP
180: .It Cipher
181: .It Ciphers
182: .It Compression
183: .It CompressionLevel
184: .It ConnectionAttempts
1.54 dtucker 185: .It ConnectTimeout
1.55 djm 186: .It ControlMaster
187: .It ControlPath
1.46 jmc 188: .It GlobalKnownHostsFile
189: .It GSSAPIAuthentication
190: .It GSSAPIDelegateCredentials
1.61 jmc 191: .It HashKnownHosts
1.46 jmc 192: .It Host
193: .It HostbasedAuthentication
194: .It HostKeyAlgorithms
195: .It HostKeyAlias
196: .It HostName
197: .It IdentityFile
1.52 markus 198: .It IdentitiesOnly
1.58 djm 199: .It KbdInteractiveDevices
1.46 jmc 200: .It LogLevel
201: .It MACs
202: .It NoHostAuthenticationForLocalhost
203: .It NumberOfPasswordPrompts
204: .It PasswordAuthentication
205: .It Port
206: .It PreferredAuthentications
207: .It Protocol
208: .It ProxyCommand
209: .It PubkeyAuthentication
1.63 dtucker 210: .It RekeyLimit
1.46 jmc 211: .It RhostsRSAAuthentication
212: .It RSAAuthentication
1.53 jmc 213: .It SendEnv
1.49 markus 214: .It ServerAliveInterval
215: .It ServerAliveCountMax
1.46 jmc 216: .It SmartcardDevice
217: .It StrictHostKeyChecking
1.48 markus 218: .It TCPKeepAlive
1.46 jmc 219: .It UsePrivilegedPort
220: .It User
221: .It UserKnownHostsFile
222: .It VerifyHostKeyDNS
223: .El
1.72 djm 224: .It Fl P Ar port
225: Specifies the port to connect to on the remote host.
1.70 djm 226: .It Fl q
227: Quiet mode: disables the progress meter as well as warning and
228: diagnostic messages from
229: .Xr ssh 1 .
1.30 djm 230: .It Fl R Ar num_requests
1.44 jmc 231: Specify how many requests may be outstanding at any one time.
232: Increasing this may slightly improve file transfer speed
233: but will increase memory usage.
1.67 djm 234: The default is 64 outstanding requests.
1.26 stevesk 235: .It Fl S Ar program
236: Name of the
237: .Ar program
238: to use for the encrypted connection.
239: The program must understand
240: .Xr ssh 1
241: options.
1.46 jmc 242: .It Fl s Ar subsystem | sftp_server
243: Specifies the SSH2 subsystem or the path for an sftp server
244: on the remote host.
245: A path is useful for using
246: .Nm
247: over protocol version 1, or when the remote
248: .Xr sshd 8
249: does not have an sftp subsystem configured.
250: .It Fl v
251: Raise logging level.
252: This option is also passed to ssh.
1.1 djm 253: .El
254: .Sh INTERACTIVE COMMANDS
1.2 djm 255: Once in interactive mode,
256: .Nm
1.21 itojun 257: understands a set of commands similar to those of
1.1 djm 258: .Xr ftp 1 .
1.60 jaredy 259: Commands are case insensitive.
260: Pathnames that contain spaces must be enclosed in quotes.
261: Any special characters contained within pathnames that are recognized by
262: .Xr glob 3
263: must be escaped with backslashes
264: .Pq Sq \e .
265: .Bl -tag -width Ds
1.22 markus 266: .It Ic bye
1.44 jmc 267: Quit
268: .Nm sftp .
1.3 deraadt 269: .It Ic cd Ar path
1.21 itojun 270: Change remote directory to
1.3 deraadt 271: .Ar path .
272: .It Ic chgrp Ar grp Ar path
1.21 itojun 273: Change group of file
1.5 stevesk 274: .Ar path
275: to
1.1 djm 276: .Ar grp .
1.60 jaredy 277: .Ar path
278: may contain
279: .Xr glob 3
280: characters and may match multiple files.
1.1 djm 281: .Ar grp
1.5 stevesk 282: must be a numeric GID.
1.3 deraadt 283: .It Ic chmod Ar mode Ar path
1.21 itojun 284: Change permissions of file
1.5 stevesk 285: .Ar path
286: to
1.3 deraadt 287: .Ar mode .
1.60 jaredy 288: .Ar path
289: may contain
290: .Xr glob 3
291: characters and may match multiple files.
1.3 deraadt 292: .It Ic chown Ar own Ar path
1.21 itojun 293: Change owner of file
1.5 stevesk 294: .Ar path
295: to
1.1 djm 296: .Ar own .
1.60 jaredy 297: .Ar path
298: may contain
299: .Xr glob 3
300: characters and may match multiple files.
1.1 djm 301: .Ar own
302: must be a numeric UID.
1.65 djm 303: .It Xo Ic df
304: .Op Fl hi
305: .Op Ar path
306: .Xc
307: Display usage information for the filesystem holding the current directory
308: (or
309: .Ar path
310: if specified).
311: If the
312: .Fl h
313: flag is specified, the capacity information will be displayed using
314: "human-readable" suffixes.
315: The
316: .Fl i
317: flag requests display of inode information in addition to capacity information.
318: This command is only supported on servers that implement the
319: .Dq statvfs@openssh.com
320: extension.
1.11 deraadt 321: .It Ic exit
1.44 jmc 322: Quit
323: .Nm sftp .
1.7 djm 324: .It Xo Ic get
1.60 jaredy 325: .Op Fl P
1.7 djm 326: .Ar remote-path
327: .Op Ar local-path
328: .Xc
1.1 djm 329: Retrieve the
1.5 stevesk 330: .Ar remote-path
1.1 djm 331: and store it on the local machine.
332: If the local
1.21 itojun 333: path name is not specified, it is given the same name it has on the
1.44 jmc 334: remote machine.
1.60 jaredy 335: .Ar remote-path
336: may contain
337: .Xr glob 3
338: characters and may match multiple files.
339: If it does and
340: .Ar local-path
341: is specified, then
342: .Ar local-path
343: must specify a directory.
1.44 jmc 344: If the
1.7 djm 345: .Fl P
1.60 jaredy 346: flag is specified, then full file permissions and access times are
1.7 djm 347: copied too.
1.11 deraadt 348: .It Ic help
349: Display help text.
1.46 jmc 350: .It Ic lcd Ar path
351: Change local directory to
352: .Ar path .
1.3 deraadt 353: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 354: Display local directory listing of either
1.1 djm 355: .Ar path
356: or current directory if
357: .Ar path
1.5 stevesk 358: is not specified.
1.60 jaredy 359: .Ar ls-options
360: may contain any flags supported by the local system's
361: .Xr ls 1
362: command.
363: .Ar path
364: may contain
365: .Xr glob 3
366: characters and may match multiple files.
1.3 deraadt 367: .It Ic lmkdir Ar path
1.1 djm 368: Create local directory specified by
1.3 deraadt 369: .Ar path .
1.12 djm 370: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 371: Create a symbolic link from
1.12 djm 372: .Ar oldpath
373: to
374: .Ar newpath .
1.3 deraadt 375: .It Ic lpwd
376: Print local working directory.
1.36 djm 377: .It Xo Ic ls
1.60 jaredy 378: .Op Fl 1aflnrSt
1.36 djm 379: .Op Ar path
380: .Xc
1.60 jaredy 381: Display a remote directory listing of either
1.1 djm 382: .Ar path
1.60 jaredy 383: or the current directory if
1.5 stevesk 384: .Ar path
1.44 jmc 385: is not specified.
1.60 jaredy 386: .Ar path
387: may contain
388: .Xr glob 3
389: characters and may match multiple files.
390: .Pp
391: The following flags are recognized and alter the behaviour of
392: .Ic ls
393: accordingly:
394: .Bl -tag -width Ds
395: .It Fl 1
396: Produce single columnar output.
397: .It Fl a
398: List files beginning with a dot
399: .Pq Sq \&. .
400: .It Fl f
401: Do not sort the listing.
402: The default sort order is lexicographical.
403: .It Fl l
404: Display additional details including permissions
1.36 djm 405: and ownership information.
1.60 jaredy 406: .It Fl n
407: Produce a long listing with user and group information presented
1.56 djm 408: numerically.
1.60 jaredy 409: .It Fl r
410: Reverse the sort order of the listing.
411: .It Fl S
412: Sort the listing by file size.
413: .It Fl t
414: Sort the listing by last modification time.
415: .El
1.3 deraadt 416: .It Ic lumask Ar umask
1.21 itojun 417: Set local umask to
1.3 deraadt 418: .Ar umask .
419: .It Ic mkdir Ar path
1.1 djm 420: Create remote directory specified by
1.3 deraadt 421: .Ar path .
1.40 fgsch 422: .It Ic progress
423: Toggle display of progress meter.
1.7 djm 424: .It Xo Ic put
1.60 jaredy 425: .Op Fl P
1.7 djm 426: .Ar local-path
1.37 djm 427: .Op Ar remote-path
1.7 djm 428: .Xc
1.1 djm 429: Upload
1.5 stevesk 430: .Ar local-path
1.44 jmc 431: and store it on the remote machine.
432: If the remote path name is not specified, it is given the same name it has
433: on the local machine.
1.60 jaredy 434: .Ar local-path
435: may contain
436: .Xr glob 3
437: characters and may match multiple files.
438: If it does and
439: .Ar remote-path
440: is specified, then
441: .Ar remote-path
442: must specify a directory.
1.44 jmc 443: If the
1.7 djm 444: .Fl P
445: flag is specified, then the file's full permission and access time are
446: copied too.
1.3 deraadt 447: .It Ic pwd
448: Display remote working directory.
449: .It Ic quit
1.44 jmc 450: Quit
451: .Nm sftp .
1.3 deraadt 452: .It Ic rename Ar oldpath Ar newpath
1.1 djm 453: Rename remote file from
454: .Ar oldpath
455: to
1.3 deraadt 456: .Ar newpath .
1.46 jmc 457: .It Ic rm Ar path
458: Delete remote file specified by
459: .Ar path .
1.3 deraadt 460: .It Ic rmdir Ar path
1.1 djm 461: Remove remote directory specified by
1.3 deraadt 462: .Ar path .
1.12 djm 463: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 464: Create a symbolic link from
1.12 djm 465: .Ar oldpath
466: to
467: .Ar newpath .
1.38 fgsch 468: .It Ic version
469: Display the
470: .Nm
471: protocol version.
1.69 sobrado 472: .It Ic \&! Ns Ar command
1.21 itojun 473: Execute
1.1 djm 474: .Ar command
1.3 deraadt 475: in local shell.
1.45 jmc 476: .It Ic \&!
1.3 deraadt 477: Escape to local shell.
1.45 jmc 478: .It Ic \&?
1.5 stevesk 479: Synonym for help.
1.4 itojun 480: .El
1.1 djm 481: .Sh SEE ALSO
1.46 jmc 482: .Xr ftp 1 ,
1.60 jaredy 483: .Xr ls 1 ,
1.17 markus 484: .Xr scp 1 ,
1.1 djm 485: .Xr ssh 1 ,
486: .Xr ssh-add 1 ,
487: .Xr ssh-keygen 1 ,
1.60 jaredy 488: .Xr glob 3 ,
1.35 stevesk 489: .Xr ssh_config 5 ,
1.17 markus 490: .Xr sftp-server 8 ,
491: .Xr sshd 8
492: .Rs
1.20 deraadt 493: .%A T. Ylonen
494: .%A S. Lehtinen
1.17 markus 495: .%T "SSH File Transfer Protocol"
496: .%N draft-ietf-secsh-filexfer-00.txt
497: .%D January 2001
498: .%O work in progress material
499: .Re
![[BACK]](/icons/back.gif){kind=icon}
Return to sftp.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh