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