Annotation of src/usr.bin/ssh/sftp.1, Revision 1.96
1.96 ! jmc 1: .\" $OpenBSD: sftp.1,v 1.95 2013/10/17 00:30:13 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.96 ! jmc 25: .Dd $Mdocdate: October 17 2013 $
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.95 djm 34: .Op Fl 1246aCfpqrv
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.85 djm 41: .Op Fl l Ar limit
1.29 markus 42: .Op Fl o Ar ssh_option
1.72 djm 43: .Op Fl P Ar port
1.30 djm 44: .Op Fl R Ar num_requests
1.26 stevesk 45: .Op Fl S Ar program
1.46 jmc 46: .Op Fl s Ar subsystem | sftp_server
1.26 stevesk 47: .Ar host
1.41 jmc 48: .Ek
1.43 jmc 49: .Nm sftp
1.68 djm 50: .Oo Ar user Ns @ Oc Ns
51: .Ar host Ns Op : Ns Ar
1.43 jmc 52: .Nm sftp
1.84 jmc 53: .Oo
54: .Ar user Ns @ Oc Ns
1.41 jmc 55: .Ar host Ns Oo : Ns Ar dir Ns
1.84 jmc 56: .Op Ar /
57: .Oc
1.43 jmc 58: .Nm sftp
1.42 djm 59: .Fl b Ar batchfile
1.45 jmc 60: .Oo Ar user Ns @ Oc Ns Ar host
1.1 djm 61: .Sh DESCRIPTION
62: .Nm
63: is an interactive file transfer program, similar to
64: .Xr ftp 1 ,
65: which performs all operations over an encrypted
66: .Xr ssh 1
67: transport.
68: It may also use many features of ssh, such as public key authentication and
69: compression.
70: .Nm
71: connects and logs into the specified
1.18 stevesk 72: .Ar host ,
1.1 djm 73: then enters an interactive command mode.
1.15 mouring 74: .Pp
1.21 itojun 75: The second usage format will retrieve files automatically if a non-interactive
1.18 stevesk 76: authentication method is used; otherwise it will do so after
77: successful interactive authentication.
1.15 mouring 78: .Pp
1.60 jaredy 79: The third usage format allows
80: .Nm
81: to start in a remote directory.
1.1 djm 82: .Pp
1.44 jmc 83: The final usage format allows for automated sessions using the
1.42 djm 84: .Fl b
1.44 jmc 85: option.
1.62 jmc 86: In such cases, it is necessary to configure non-interactive authentication
1.44 jmc 87: to obviate the need to enter a password at connection time (see
1.42 djm 88: .Xr sshd 8
1.43 jmc 89: and
1.42 djm 90: .Xr ssh-keygen 1
1.44 jmc 91: for details).
1.89 djm 92: .Pp
93: Since some usage formats use colon characters to delimit host names from path
94: names, IPv6 addresses must be enclosed in square brackets to avoid ambiguity.
95: .Pp
1.1 djm 96: The options are as follows:
97: .Bl -tag -width Ds
1.46 jmc 98: .It Fl 1
99: Specify the use of protocol version 1.
1.70 djm 100: .It Fl 2
101: Specify the use of protocol version 2.
102: .It Fl 4
103: Forces
104: .Nm
105: to use IPv4 addresses only.
106: .It Fl 6
107: Forces
108: .Nm
109: to use IPv6 addresses only.
1.94 jmc 110: .It Fl a
111: Attempt to continue interrupted downloads rather than overwriting existing
112: partial or complete copies of files.
113: If the remote file contents differ from the partial local copy then the
114: resultant file is likely to be corrupt.
1.46 jmc 115: .It Fl B Ar buffer_size
116: Specify the size of the buffer that
117: .Nm
118: uses when transferring files.
119: Larger buffers require fewer round trips at the cost of higher
120: memory consumption.
121: The default is 32768 bytes.
1.10 deraadt 122: .It Fl b Ar batchfile
123: Batch mode reads a series of commands from an input
1.13 stevesk 124: .Ar batchfile
1.10 deraadt 125: instead of
1.13 stevesk 126: .Em stdin .
127: Since it lacks user interaction it should be used in conjunction with
1.51 jmc 128: non-interactive authentication.
1.50 djm 129: A
1.51 jmc 130: .Ar batchfile
131: of
132: .Sq \-
1.50 djm 133: may be used to indicate standard input.
1.13 stevesk 134: .Nm
1.21 itojun 135: will abort if any of the following
136: commands fail:
1.92 djm 137: .Ic get , put , reget , rename , ln ,
1.41 jmc 138: .Ic rm , mkdir , chdir , ls ,
1.66 jmc 139: .Ic lchdir , chmod , chown ,
1.88 djm 140: .Ic chgrp , lpwd , df , symlink ,
1.10 deraadt 141: and
1.13 stevesk 142: .Ic lmkdir .
1.41 jmc 143: Termination on error can be suppressed on a command by command basis by
144: prefixing the command with a
1.51 jmc 145: .Sq \-
1.44 jmc 146: character (for example,
147: .Ic -rm /tmp/blah* ) .
1.71 jmc 148: .It Fl C
149: Enables compression (via ssh's
150: .Fl C
151: flag).
1.70 djm 152: .It Fl c Ar cipher
153: Selects the cipher to use for encrypting the data transfers.
154: This option is directly passed to
155: .Xr ssh 1 .
1.72 djm 156: .It Fl D Ar sftp_server_path
157: Connect directly to a local sftp server
158: (rather than via
159: .Xr ssh 1 ) .
160: This option may be useful in debugging the client and server.
1.46 jmc 161: .It Fl F Ar ssh_config
162: Specifies an alternative
163: per-user configuration file for
164: .Xr ssh 1 .
165: This option is directly passed to
166: .Xr ssh 1 .
1.95 djm 167: .It Fl f
168: Requests that files be flushed to disk immediately after transfer.
169: When uploading files, this feature is only enabled if the server
170: implements the "fsync@openssh.com" extension.
1.70 djm 171: .It Fl i Ar identity_file
172: Selects the file from which the identity (private key) for public key
173: authentication is read.
174: This option is directly passed to
175: .Xr ssh 1 .
1.85 djm 176: .It Fl l Ar limit
177: Limits the used bandwidth, specified in Kbit/s.
1.1 djm 178: .It Fl o Ar ssh_option
1.23 stevesk 179: Can be used to pass options to
180: .Nm ssh
1.35 stevesk 181: in the format used in
182: .Xr ssh_config 5 .
183: This is useful for specifying options
1.23 stevesk 184: for which there is no separate
185: .Nm sftp
1.44 jmc 186: command-line flag.
187: For example, to specify an alternate port use:
1.26 stevesk 188: .Ic sftp -oPort=24 .
1.46 jmc 189: For full details of the options listed below, and their possible values, see
190: .Xr ssh_config 5 .
191: .Pp
192: .Bl -tag -width Ds -offset indent -compact
193: .It AddressFamily
194: .It BatchMode
195: .It BindAddress
196: .It ChallengeResponseAuthentication
197: .It CheckHostIP
198: .It Cipher
199: .It Ciphers
200: .It Compression
201: .It CompressionLevel
202: .It ConnectionAttempts
1.54 dtucker 203: .It ConnectTimeout
1.55 djm 204: .It ControlMaster
205: .It ControlPath
1.91 djm 206: .It ControlPersist
1.46 jmc 207: .It GlobalKnownHostsFile
208: .It GSSAPIAuthentication
209: .It GSSAPIDelegateCredentials
1.61 jmc 210: .It HashKnownHosts
1.46 jmc 211: .It Host
212: .It HostbasedAuthentication
213: .It HostKeyAlgorithms
214: .It HostKeyAlias
215: .It HostName
216: .It IdentityFile
1.52 markus 217: .It IdentitiesOnly
1.87 jmc 218: .It IPQoS
1.91 djm 219: .It KbdInteractiveAuthentication
1.58 djm 220: .It KbdInteractiveDevices
1.86 jmc 221: .It KexAlgorithms
1.46 jmc 222: .It LogLevel
223: .It MACs
224: .It NoHostAuthenticationForLocalhost
225: .It NumberOfPasswordPrompts
226: .It PasswordAuthentication
1.83 markus 227: .It PKCS11Provider
1.46 jmc 228: .It Port
229: .It PreferredAuthentications
230: .It Protocol
231: .It ProxyCommand
232: .It PubkeyAuthentication
1.63 dtucker 233: .It RekeyLimit
1.46 jmc 234: .It RhostsRSAAuthentication
235: .It RSAAuthentication
1.53 jmc 236: .It SendEnv
1.49 markus 237: .It ServerAliveInterval
238: .It ServerAliveCountMax
1.46 jmc 239: .It StrictHostKeyChecking
1.48 markus 240: .It TCPKeepAlive
1.46 jmc 241: .It UsePrivilegedPort
242: .It User
243: .It UserKnownHostsFile
244: .It VerifyHostKeyDNS
245: .El
1.72 djm 246: .It Fl P Ar port
247: Specifies the port to connect to on the remote host.
1.74 djm 248: .It Fl p
249: Preserves modification times, access times, and modes from the
250: original files transferred.
1.70 djm 251: .It Fl q
252: Quiet mode: disables the progress meter as well as warning and
253: diagnostic messages from
254: .Xr ssh 1 .
1.30 djm 255: .It Fl R Ar num_requests
1.44 jmc 256: Specify how many requests may be outstanding at any one time.
257: Increasing this may slightly improve file transfer speed
258: but will increase memory usage.
1.67 djm 259: The default is 64 outstanding requests.
1.74 djm 260: .It Fl r
261: Recursively copy entire directories when uploading and downloading.
262: Note that
263: .Nm
264: does not follow symbolic links encountered in the tree traversal.
1.26 stevesk 265: .It Fl S Ar program
266: Name of the
267: .Ar program
268: to use for the encrypted connection.
269: The program must understand
270: .Xr ssh 1
271: options.
1.46 jmc 272: .It Fl s Ar subsystem | sftp_server
273: Specifies the SSH2 subsystem or the path for an sftp server
274: on the remote host.
275: A path is useful for using
276: .Nm
277: over protocol version 1, or when the remote
278: .Xr sshd 8
279: does not have an sftp subsystem configured.
280: .It Fl v
281: Raise logging level.
282: This option is also passed to ssh.
1.1 djm 283: .El
284: .Sh INTERACTIVE COMMANDS
1.2 djm 285: Once in interactive mode,
286: .Nm
1.21 itojun 287: understands a set of commands similar to those of
1.1 djm 288: .Xr ftp 1 .
1.60 jaredy 289: Commands are case insensitive.
290: Pathnames that contain spaces must be enclosed in quotes.
291: Any special characters contained within pathnames that are recognized by
292: .Xr glob 3
293: must be escaped with backslashes
294: .Pq Sq \e .
295: .Bl -tag -width Ds
1.22 markus 296: .It Ic bye
1.44 jmc 297: Quit
298: .Nm sftp .
1.3 deraadt 299: .It Ic cd Ar path
1.21 itojun 300: Change remote directory to
1.3 deraadt 301: .Ar path .
302: .It Ic chgrp Ar grp Ar path
1.21 itojun 303: Change group of file
1.5 stevesk 304: .Ar path
305: to
1.1 djm 306: .Ar grp .
1.60 jaredy 307: .Ar path
308: may contain
309: .Xr glob 3
310: characters and may match multiple files.
1.1 djm 311: .Ar grp
1.5 stevesk 312: must be a numeric GID.
1.3 deraadt 313: .It Ic chmod Ar mode Ar path
1.21 itojun 314: Change permissions of file
1.5 stevesk 315: .Ar path
316: to
1.3 deraadt 317: .Ar mode .
1.60 jaredy 318: .Ar path
319: may contain
320: .Xr glob 3
321: characters and may match multiple files.
1.3 deraadt 322: .It Ic chown Ar own Ar path
1.21 itojun 323: Change owner of file
1.5 stevesk 324: .Ar path
325: to
1.1 djm 326: .Ar own .
1.60 jaredy 327: .Ar path
328: may contain
329: .Xr glob 3
330: characters and may match multiple files.
1.1 djm 331: .Ar own
332: must be a numeric UID.
1.65 djm 333: .It Xo Ic df
334: .Op Fl hi
335: .Op Ar path
336: .Xc
337: Display usage information for the filesystem holding the current directory
338: (or
339: .Ar path
340: if specified).
341: If the
342: .Fl h
343: flag is specified, the capacity information will be displayed using
344: "human-readable" suffixes.
345: The
346: .Fl i
347: flag requests display of inode information in addition to capacity information.
348: This command is only supported on servers that implement the
349: .Dq statvfs@openssh.com
350: extension.
1.11 deraadt 351: .It Ic exit
1.44 jmc 352: Quit
353: .Nm sftp .
1.7 djm 354: .It Xo Ic get
1.95 djm 355: .Op Fl afPpr
1.7 djm 356: .Ar remote-path
357: .Op Ar local-path
358: .Xc
1.1 djm 359: Retrieve the
1.5 stevesk 360: .Ar remote-path
1.1 djm 361: and store it on the local machine.
362: If the local
1.21 itojun 363: path name is not specified, it is given the same name it has on the
1.44 jmc 364: remote machine.
1.60 jaredy 365: .Ar remote-path
366: may contain
367: .Xr glob 3
368: characters and may match multiple files.
369: If it does and
370: .Ar local-path
371: is specified, then
372: .Ar local-path
373: must specify a directory.
1.74 djm 374: .Pp
1.92 djm 375: If the
376: .Fl a
377: flag is specified, then attempt to resume partial transfers of existing files.
378: Note that resumption assumes that any partial copy of the local file matches
379: the remote copy.
1.93 djm 380: If the remote file contents differ from the partial local copy then the
381: resultant file is likely to be corrupt.
1.92 djm 382: .Pp
1.95 djm 383: If the
384: .Fl f
385: flag is specified, then
386: .Xr fsync 2
1.96 ! jmc 387: will be called after the file transfer has completed to flush the file
1.95 djm 388: to disk.
389: .Pp
1.76 jmc 390: If either the
1.75 djm 391: .Fl P
1.74 djm 392: or
393: .Fl p
1.60 jaredy 394: flag is specified, then full file permissions and access times are
1.7 djm 395: copied too.
1.74 djm 396: .Pp
397: If the
398: .Fl r
399: flag is specified then directories will be copied recursively.
400: Note that
401: .Nm
402: does not follow symbolic links when performing recursive transfers.
1.11 deraadt 403: .It Ic help
404: Display help text.
1.46 jmc 405: .It Ic lcd Ar path
406: Change local directory to
407: .Ar path .
1.3 deraadt 408: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 409: Display local directory listing of either
1.1 djm 410: .Ar path
411: or current directory if
412: .Ar path
1.5 stevesk 413: is not specified.
1.60 jaredy 414: .Ar ls-options
415: may contain any flags supported by the local system's
416: .Xr ls 1
417: command.
418: .Ar path
419: may contain
420: .Xr glob 3
421: characters and may match multiple files.
1.3 deraadt 422: .It Ic lmkdir Ar path
1.1 djm 423: Create local directory specified by
1.3 deraadt 424: .Ar path .
1.88 djm 425: .It Xo Ic ln
426: .Op Fl s
427: .Ar oldpath
428: .Ar newpath
429: .Xc
430: Create a link from
1.12 djm 431: .Ar oldpath
432: to
433: .Ar newpath .
1.88 djm 434: If the
435: .Fl s
436: flag is specified the created link is a symbolic link, otherwise it is
437: a hard link.
1.3 deraadt 438: .It Ic lpwd
439: Print local working directory.
1.36 djm 440: .It Xo Ic ls
1.82 jmc 441: .Op Fl 1afhlnrSt
1.36 djm 442: .Op Ar path
443: .Xc
1.60 jaredy 444: Display a remote directory listing of either
1.1 djm 445: .Ar path
1.60 jaredy 446: or the current directory if
1.5 stevesk 447: .Ar path
1.44 jmc 448: is not specified.
1.60 jaredy 449: .Ar path
450: may contain
451: .Xr glob 3
452: characters and may match multiple files.
453: .Pp
454: The following flags are recognized and alter the behaviour of
455: .Ic ls
456: accordingly:
457: .Bl -tag -width Ds
458: .It Fl 1
459: Produce single columnar output.
460: .It Fl a
461: List files beginning with a dot
462: .Pq Sq \&. .
463: .It Fl f
464: Do not sort the listing.
465: The default sort order is lexicographical.
1.81 djm 466: .It Fl h
467: When used with a long format option, use unit suffixes: Byte, Kilobyte,
468: Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
469: the number of digits to four or fewer using powers of 2 for sizes (K=1024,
470: M=1048576, etc.).
1.82 jmc 471: .It Fl l
472: Display additional details including permissions
473: and ownership information.
1.60 jaredy 474: .It Fl n
475: Produce a long listing with user and group information presented
1.56 djm 476: numerically.
1.60 jaredy 477: .It Fl r
478: Reverse the sort order of the listing.
479: .It Fl S
480: Sort the listing by file size.
481: .It Fl t
482: Sort the listing by last modification time.
483: .El
1.3 deraadt 484: .It Ic lumask Ar umask
1.21 itojun 485: Set local umask to
1.3 deraadt 486: .Ar umask .
487: .It Ic mkdir Ar path
1.1 djm 488: Create remote directory specified by
1.3 deraadt 489: .Ar path .
1.40 fgsch 490: .It Ic progress
491: Toggle display of progress meter.
1.7 djm 492: .It Xo Ic put
1.95 djm 493: .Op Fl fPpr
1.7 djm 494: .Ar local-path
1.37 djm 495: .Op Ar remote-path
1.7 djm 496: .Xc
1.1 djm 497: Upload
1.5 stevesk 498: .Ar local-path
1.44 jmc 499: and store it on the remote machine.
500: If the remote path name is not specified, it is given the same name it has
501: on the local machine.
1.60 jaredy 502: .Ar local-path
503: may contain
504: .Xr glob 3
505: characters and may match multiple files.
506: If it does and
507: .Ar remote-path
508: is specified, then
509: .Ar remote-path
510: must specify a directory.
1.95 djm 511: .Pp
512: If the
513: .Fl f
514: flag is specified, then a request will be sent to the server to call
515: .Xr fsync 2
516: after the file has been transferred.
517: Note that this is only supported by servers that implement
518: the "fsync@openssh.com" extension.
1.74 djm 519: .Pp
1.90 dtucker 520: If either the
1.7 djm 521: .Fl P
1.74 djm 522: or
523: .Fl p
524: flag is specified, then full file permissions and access times are
1.7 djm 525: copied too.
1.74 djm 526: .Pp
527: If the
528: .Fl r
529: flag is specified then directories will be copied recursively.
530: Note that
531: .Nm
532: does not follow symbolic links when performing recursive transfers.
1.3 deraadt 533: .It Ic pwd
534: Display remote working directory.
535: .It Ic quit
1.44 jmc 536: Quit
537: .Nm sftp .
1.92 djm 538: .It Xo Ic reget
539: .Op Fl Ppr
540: .Ar remote-path
541: .Op Ar local-path
542: .Xc
543: Resume download of
544: .Ar remote-path .
545: Equivalent to
546: .Ic get
547: with the
548: .Fl a
549: flag set.
1.3 deraadt 550: .It Ic rename Ar oldpath Ar newpath
1.1 djm 551: Rename remote file from
552: .Ar oldpath
553: to
1.3 deraadt 554: .Ar newpath .
1.46 jmc 555: .It Ic rm Ar path
556: Delete remote file specified by
557: .Ar path .
1.3 deraadt 558: .It Ic rmdir Ar path
1.1 djm 559: Remove remote directory specified by
1.3 deraadt 560: .Ar path .
1.12 djm 561: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 562: Create a symbolic link from
1.12 djm 563: .Ar oldpath
564: to
565: .Ar newpath .
1.38 fgsch 566: .It Ic version
567: Display the
568: .Nm
569: protocol version.
1.69 sobrado 570: .It Ic \&! Ns Ar command
1.21 itojun 571: Execute
1.1 djm 572: .Ar command
1.3 deraadt 573: in local shell.
1.45 jmc 574: .It Ic \&!
1.3 deraadt 575: Escape to local shell.
1.45 jmc 576: .It Ic \&?
1.5 stevesk 577: Synonym for help.
1.4 itojun 578: .El
1.1 djm 579: .Sh SEE ALSO
1.46 jmc 580: .Xr ftp 1 ,
1.60 jaredy 581: .Xr ls 1 ,
1.17 markus 582: .Xr scp 1 ,
1.1 djm 583: .Xr ssh 1 ,
584: .Xr ssh-add 1 ,
585: .Xr ssh-keygen 1 ,
1.60 jaredy 586: .Xr glob 3 ,
1.35 stevesk 587: .Xr ssh_config 5 ,
1.17 markus 588: .Xr sftp-server 8 ,
589: .Xr sshd 8
590: .Rs
1.20 deraadt 591: .%A T. Ylonen
592: .%A S. Lehtinen
1.17 markus 593: .%T "SSH File Transfer Protocol"
594: .%N draft-ietf-secsh-filexfer-00.txt
595: .%D January 2001
596: .%O work in progress material
597: .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