Annotation of src/usr.bin/ssh/sftp.1, Revision 1.77
1.76 jmc 1: .\" $OpenBSD: sftp.1,v 1.75 2009/08/18 21:15:59 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.77 ! reyk 25: .Dd $Mdocdate: August 19 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.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.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
1.77 ! reyk 212: .It RDomain
1.46 jmc 213: .It RSAAuthentication
1.53 jmc 214: .It SendEnv
1.49 markus 215: .It ServerAliveInterval
216: .It ServerAliveCountMax
1.46 jmc 217: .It SmartcardDevice
218: .It StrictHostKeyChecking
1.48 markus 219: .It TCPKeepAlive
1.46 jmc 220: .It UsePrivilegedPort
221: .It User
222: .It UserKnownHostsFile
223: .It VerifyHostKeyDNS
224: .El
1.72 djm 225: .It Fl P Ar port
226: Specifies the port to connect to on the remote host.
1.74 djm 227: .It Fl p
228: Preserves modification times, access times, and modes from the
229: original files transferred.
1.70 djm 230: .It Fl q
231: Quiet mode: disables the progress meter as well as warning and
232: diagnostic messages from
233: .Xr ssh 1 .
1.30 djm 234: .It Fl R Ar num_requests
1.44 jmc 235: Specify how many requests may be outstanding at any one time.
236: Increasing this may slightly improve file transfer speed
237: but will increase memory usage.
1.67 djm 238: The default is 64 outstanding requests.
1.74 djm 239: .It Fl r
240: Recursively copy entire directories when uploading and downloading.
241: Note that
242: .Nm
243: does not follow symbolic links encountered in the tree traversal.
1.26 stevesk 244: .It Fl S Ar program
245: Name of the
246: .Ar program
247: to use for the encrypted connection.
248: The program must understand
249: .Xr ssh 1
250: options.
1.46 jmc 251: .It Fl s Ar subsystem | sftp_server
252: Specifies the SSH2 subsystem or the path for an sftp server
253: on the remote host.
254: A path is useful for using
255: .Nm
256: over protocol version 1, or when the remote
257: .Xr sshd 8
258: does not have an sftp subsystem configured.
259: .It Fl v
260: Raise logging level.
261: This option is also passed to ssh.
1.1 djm 262: .El
263: .Sh INTERACTIVE COMMANDS
1.2 djm 264: Once in interactive mode,
265: .Nm
1.21 itojun 266: understands a set of commands similar to those of
1.1 djm 267: .Xr ftp 1 .
1.60 jaredy 268: Commands are case insensitive.
269: Pathnames that contain spaces must be enclosed in quotes.
270: Any special characters contained within pathnames that are recognized by
271: .Xr glob 3
272: must be escaped with backslashes
273: .Pq Sq \e .
274: .Bl -tag -width Ds
1.22 markus 275: .It Ic bye
1.44 jmc 276: Quit
277: .Nm sftp .
1.3 deraadt 278: .It Ic cd Ar path
1.21 itojun 279: Change remote directory to
1.3 deraadt 280: .Ar path .
281: .It Ic chgrp Ar grp Ar path
1.21 itojun 282: Change group of file
1.5 stevesk 283: .Ar path
284: to
1.1 djm 285: .Ar grp .
1.60 jaredy 286: .Ar path
287: may contain
288: .Xr glob 3
289: characters and may match multiple files.
1.1 djm 290: .Ar grp
1.5 stevesk 291: must be a numeric GID.
1.3 deraadt 292: .It Ic chmod Ar mode Ar path
1.21 itojun 293: Change permissions of file
1.5 stevesk 294: .Ar path
295: to
1.3 deraadt 296: .Ar mode .
1.60 jaredy 297: .Ar path
298: may contain
299: .Xr glob 3
300: characters and may match multiple files.
1.3 deraadt 301: .It Ic chown Ar own Ar path
1.21 itojun 302: Change owner of file
1.5 stevesk 303: .Ar path
304: to
1.1 djm 305: .Ar own .
1.60 jaredy 306: .Ar path
307: may contain
308: .Xr glob 3
309: characters and may match multiple files.
1.1 djm 310: .Ar own
311: must be a numeric UID.
1.65 djm 312: .It Xo Ic df
313: .Op Fl hi
314: .Op Ar path
315: .Xc
316: Display usage information for the filesystem holding the current directory
317: (or
318: .Ar path
319: if specified).
320: If the
321: .Fl h
322: flag is specified, the capacity information will be displayed using
323: "human-readable" suffixes.
324: The
325: .Fl i
326: flag requests display of inode information in addition to capacity information.
327: This command is only supported on servers that implement the
328: .Dq statvfs@openssh.com
329: extension.
1.11 deraadt 330: .It Ic exit
1.44 jmc 331: Quit
332: .Nm sftp .
1.7 djm 333: .It Xo Ic get
1.74 djm 334: .Op Fl Ppr
1.7 djm 335: .Ar remote-path
336: .Op Ar local-path
337: .Xc
1.1 djm 338: Retrieve the
1.5 stevesk 339: .Ar remote-path
1.1 djm 340: and store it on the local machine.
341: If the local
1.21 itojun 342: path name is not specified, it is given the same name it has on the
1.44 jmc 343: remote machine.
1.60 jaredy 344: .Ar remote-path
345: may contain
346: .Xr glob 3
347: characters and may match multiple files.
348: If it does and
349: .Ar local-path
350: is specified, then
351: .Ar local-path
352: must specify a directory.
1.74 djm 353: .Pp
1.76 jmc 354: If either the
1.75 djm 355: .Fl P
1.74 djm 356: or
357: .Fl p
1.60 jaredy 358: flag is specified, then full file permissions and access times are
1.7 djm 359: copied too.
1.74 djm 360: .Pp
361: If the
362: .Fl r
363: flag is specified then directories will be copied recursively.
364: Note that
365: .Nm
366: does not follow symbolic links when performing recursive transfers.
1.11 deraadt 367: .It Ic help
368: Display help text.
1.46 jmc 369: .It Ic lcd Ar path
370: Change local directory to
371: .Ar path .
1.3 deraadt 372: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 373: Display local directory listing of either
1.1 djm 374: .Ar path
375: or current directory if
376: .Ar path
1.5 stevesk 377: is not specified.
1.60 jaredy 378: .Ar ls-options
379: may contain any flags supported by the local system's
380: .Xr ls 1
381: command.
382: .Ar path
383: may contain
384: .Xr glob 3
385: characters and may match multiple files.
1.3 deraadt 386: .It Ic lmkdir Ar path
1.1 djm 387: Create local directory specified by
1.3 deraadt 388: .Ar path .
1.12 djm 389: .It Ic ln Ar oldpath Ar newpath
1.21 itojun 390: Create a symbolic link from
1.12 djm 391: .Ar oldpath
392: to
393: .Ar newpath .
1.3 deraadt 394: .It Ic lpwd
395: Print local working directory.
1.36 djm 396: .It Xo Ic ls
1.60 jaredy 397: .Op Fl 1aflnrSt
1.36 djm 398: .Op Ar path
399: .Xc
1.60 jaredy 400: Display a remote directory listing of either
1.1 djm 401: .Ar path
1.60 jaredy 402: or the current directory if
1.5 stevesk 403: .Ar path
1.44 jmc 404: is not specified.
1.60 jaredy 405: .Ar path
406: may contain
407: .Xr glob 3
408: characters and may match multiple files.
409: .Pp
410: The following flags are recognized and alter the behaviour of
411: .Ic ls
412: accordingly:
413: .Bl -tag -width Ds
414: .It Fl 1
415: Produce single columnar output.
416: .It Fl a
417: List files beginning with a dot
418: .Pq Sq \&. .
419: .It Fl f
420: Do not sort the listing.
421: The default sort order is lexicographical.
422: .It Fl l
423: Display additional details including permissions
1.36 djm 424: and ownership information.
1.60 jaredy 425: .It Fl n
426: Produce a long listing with user and group information presented
1.56 djm 427: numerically.
1.60 jaredy 428: .It Fl r
429: Reverse the sort order of the listing.
430: .It Fl S
431: Sort the listing by file size.
432: .It Fl t
433: Sort the listing by last modification time.
434: .El
1.3 deraadt 435: .It Ic lumask Ar umask
1.21 itojun 436: Set local umask to
1.3 deraadt 437: .Ar umask .
438: .It Ic mkdir Ar path
1.1 djm 439: Create remote directory specified by
1.3 deraadt 440: .Ar path .
1.40 fgsch 441: .It Ic progress
442: Toggle display of progress meter.
1.7 djm 443: .It Xo Ic put
1.75 djm 444: .Op Fl Ppr
1.7 djm 445: .Ar local-path
1.37 djm 446: .Op Ar remote-path
1.7 djm 447: .Xc
1.1 djm 448: Upload
1.5 stevesk 449: .Ar local-path
1.44 jmc 450: and store it on the remote machine.
451: If the remote path name is not specified, it is given the same name it has
452: on the local machine.
1.60 jaredy 453: .Ar local-path
454: may contain
455: .Xr glob 3
456: characters and may match multiple files.
457: If it does and
458: .Ar remote-path
459: is specified, then
460: .Ar remote-path
461: must specify a directory.
1.74 djm 462: .Pp
463: If ether the
1.7 djm 464: .Fl P
1.74 djm 465: or
466: .Fl p
467: flag is specified, then full file permissions and access times are
1.7 djm 468: copied too.
1.74 djm 469: .Pp
470: If the
471: .Fl r
472: flag is specified then directories will be copied recursively.
473: Note that
474: .Nm
475: does not follow symbolic links when performing recursive transfers.
1.3 deraadt 476: .It Ic pwd
477: Display remote working directory.
478: .It Ic quit
1.44 jmc 479: Quit
480: .Nm sftp .
1.3 deraadt 481: .It Ic rename Ar oldpath Ar newpath
1.1 djm 482: Rename remote file from
483: .Ar oldpath
484: to
1.3 deraadt 485: .Ar newpath .
1.46 jmc 486: .It Ic rm Ar path
487: Delete remote file specified by
488: .Ar path .
1.3 deraadt 489: .It Ic rmdir Ar path
1.1 djm 490: Remove remote directory specified by
1.3 deraadt 491: .Ar path .
1.12 djm 492: .It Ic symlink Ar oldpath Ar newpath
1.21 itojun 493: Create a symbolic link from
1.12 djm 494: .Ar oldpath
495: to
496: .Ar newpath .
1.38 fgsch 497: .It Ic version
498: Display the
499: .Nm
500: protocol version.
1.69 sobrado 501: .It Ic \&! Ns Ar command
1.21 itojun 502: Execute
1.1 djm 503: .Ar command
1.3 deraadt 504: in local shell.
1.45 jmc 505: .It Ic \&!
1.3 deraadt 506: Escape to local shell.
1.45 jmc 507: .It Ic \&?
1.5 stevesk 508: Synonym for help.
1.4 itojun 509: .El
1.1 djm 510: .Sh SEE ALSO
1.46 jmc 511: .Xr ftp 1 ,
1.60 jaredy 512: .Xr ls 1 ,
1.17 markus 513: .Xr scp 1 ,
1.1 djm 514: .Xr ssh 1 ,
515: .Xr ssh-add 1 ,
516: .Xr ssh-keygen 1 ,
1.60 jaredy 517: .Xr glob 3 ,
1.35 stevesk 518: .Xr ssh_config 5 ,
1.17 markus 519: .Xr sftp-server 8 ,
520: .Xr sshd 8
521: .Rs
1.20 deraadt 522: .%A T. Ylonen
523: .%A S. Lehtinen
1.17 markus 524: .%T "SSH File Transfer Protocol"
525: .%N draft-ietf-secsh-filexfer-00.txt
526: .%D January 2001
527: .%O work in progress material
528: .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