Annotation of src/usr.bin/ssh/sftp.1, Revision 1.139
1.139 ! djm 1: .\" $OpenBSD: sftp.1,v 1.138 2021/07/02 05:11:21 dtucker 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.139 ! djm 25: .Dd $Mdocdate: July 2 2021 $
1.1 djm 26: .Dt SFTP 1
27: .Os
28: .Sh NAME
29: .Nm sftp
1.128 jmc 30: .Nd OpenSSH secure file transfer
1.1 djm 31: .Sh SYNOPSIS
1.43 jmc 32: .Nm sftp
1.132 djm 33: .Op Fl 46AaCfNpqrv
1.46 jmc 34: .Op Fl B Ar buffer_size
1.29 markus 35: .Op Fl b Ar batchfile
1.70 djm 36: .Op Fl c Ar cipher
1.72 djm 37: .Op Fl D Ar sftp_server_path
1.46 jmc 38: .Op Fl F Ar ssh_config
1.73 jmc 39: .Op Fl i Ar identity_file
1.124 tb 40: .Op Fl J Ar destination
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.111 millert 47: .Ar destination
1.1 djm 48: .Sh DESCRIPTION
49: .Nm
1.111 millert 50: is a file transfer program, similar to
1.1 djm 51: .Xr ftp 1 ,
52: which performs all operations over an encrypted
53: .Xr ssh 1
54: transport.
55: It may also use many features of ssh, such as public key authentication and
56: compression.
1.111 millert 57: .Pp
58: The
59: .Ar destination
60: may be specified either as
1.112 jmc 61: .Sm off
62: .Oo user @ Oc host Op : path
63: .Sm on
64: or as a URI in the form
65: .Sm off
66: .No sftp:// Oo user @ Oc host Oo : port Oc Op / path .
67: .Sm on
1.111 millert 68: .Pp
69: If the
70: .Ar destination
71: includes a
72: .Ar path
73: and it is not a directory,
1.1 djm 74: .Nm
1.111 millert 75: 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.111 millert 79: If no
80: .Ar path
81: is specified, or if the
82: .Ar path
83: is a directory,
1.60 jaredy 84: .Nm
1.111 millert 85: will log in to the specified
86: .Ar host
87: and enter interactive command mode, changing to the remote directory
88: if one was specified.
89: An optional trailing slash can be used to force the
90: .Ar path
91: to be interpreted as a directory.
1.1 djm 92: .Pp
1.111 millert 93: Since the destination formats use colon characters to delimit host
94: names from path names or port numbers, IPv6 addresses must be
95: enclosed in square brackets to avoid ambiguity.
1.89 djm 96: .Pp
1.1 djm 97: The options are as follows:
98: .Bl -tag -width Ds
1.70 djm 99: .It Fl 4
100: Forces
101: .Nm
102: to use IPv4 addresses only.
103: .It Fl 6
104: Forces
105: .Nm
106: to use IPv6 addresses only.
1.132 djm 107: .It Fl A
108: Allows forwarding of
109: .Xr ssh-agent 1
110: to the remote system.
111: The default is not to forward an authentication agent.
1.94 jmc 112: .It Fl a
1.99 jmc 113: Attempt to continue interrupted transfers rather than overwriting
1.98 logan 114: existing partial or complete copies of files.
1.99 jmc 115: If the partial contents differ from those being transferred,
1.98 logan 116: then the resultant file is likely to be corrupt.
1.46 jmc 117: .It Fl B Ar buffer_size
118: Specify the size of the buffer that
119: .Nm
120: uses when transferring files.
121: Larger buffers require fewer round trips at the cost of higher
122: memory consumption.
123: The default is 32768 bytes.
1.10 deraadt 124: .It Fl b Ar batchfile
125: Batch mode reads a series of commands from an input
1.13 stevesk 126: .Ar batchfile
1.10 deraadt 127: instead of
1.13 stevesk 128: .Em stdin .
129: Since it lacks user interaction it should be used in conjunction with
1.111 millert 130: non-interactive authentication to obviate the need to enter a password
131: at connection time (see
132: .Xr sshd 8
133: and
134: .Xr ssh-keygen 1
135: for details).
1.122 djm 136: .Pp
1.50 djm 137: A
1.51 jmc 138: .Ar batchfile
139: of
140: .Sq \-
1.50 djm 141: may be used to indicate standard input.
1.13 stevesk 142: .Nm
1.21 itojun 143: will abort if any of the following
144: commands fail:
1.121 schwarze 145: .Ic get , put , reget , reput , rename , ln ,
1.41 jmc 146: .Ic rm , mkdir , chdir , ls ,
1.139 ! djm 147: .Ic lchdir , copy , cp , chmod , chown ,
1.88 djm 148: .Ic chgrp , lpwd , df , symlink ,
1.10 deraadt 149: and
1.13 stevesk 150: .Ic lmkdir .
1.122 djm 151: .Pp
1.41 jmc 152: Termination on error can be suppressed on a command by command basis by
153: prefixing the command with a
1.51 jmc 154: .Sq \-
1.44 jmc 155: character (for example,
156: .Ic -rm /tmp/blah* ) .
1.122 djm 157: Echo of the command may be suppressed by prefixing the command with a
158: .Sq @
159: character.
160: These two prefixes may be combined in any order, for example
161: .Ic -@ls /bsd .
1.71 jmc 162: .It Fl C
163: Enables compression (via ssh's
164: .Fl C
165: flag).
1.70 djm 166: .It Fl c Ar cipher
167: Selects the cipher to use for encrypting the data transfers.
168: This option is directly passed to
169: .Xr ssh 1 .
1.72 djm 170: .It Fl D Ar sftp_server_path
171: Connect directly to a local sftp server
172: (rather than via
173: .Xr ssh 1 ) .
174: This option may be useful in debugging the client and server.
1.46 jmc 175: .It Fl F Ar ssh_config
176: Specifies an alternative
177: per-user configuration file for
178: .Xr ssh 1 .
179: This option is directly passed to
180: .Xr ssh 1 .
1.95 djm 181: .It Fl f
182: Requests that files be flushed to disk immediately after transfer.
183: When uploading files, this feature is only enabled if the server
184: implements the "fsync@openssh.com" extension.
1.70 djm 185: .It Fl i Ar identity_file
186: Selects the file from which the identity (private key) for public key
187: authentication is read.
1.124 tb 188: This option is directly passed to
189: .Xr ssh 1 .
190: .It Fl J Ar destination
1.125 jmc 191: Connect to the target host by first making an
1.124 tb 192: .Nm
193: connection to the jump host described by
194: .Ar destination
195: and then establishing a TCP forwarding to the ultimate destination from
196: there.
197: Multiple jump hops may be specified separated by comma characters.
198: This is a shortcut to specify a
199: .Cm ProxyJump
200: configuration directive.
1.70 djm 201: This option is directly passed to
202: .Xr ssh 1 .
1.85 djm 203: .It Fl l Ar limit
204: Limits the used bandwidth, specified in Kbit/s.
1.130 jmc 205: .It Fl N
206: Disables quiet mode, e.g. to override the implicit quiet mode set by the
207: .Fl b
208: flag.
1.1 djm 209: .It Fl o Ar ssh_option
1.23 stevesk 210: Can be used to pass options to
211: .Nm ssh
1.35 stevesk 212: in the format used in
213: .Xr ssh_config 5 .
214: This is useful for specifying options
1.23 stevesk 215: for which there is no separate
216: .Nm sftp
1.44 jmc 217: command-line flag.
218: For example, to specify an alternate port use:
1.26 stevesk 219: .Ic sftp -oPort=24 .
1.46 jmc 220: For full details of the options listed below, and their possible values, see
221: .Xr ssh_config 5 .
222: .Pp
223: .Bl -tag -width Ds -offset indent -compact
224: .It AddressFamily
225: .It BatchMode
226: .It BindAddress
1.114 jmc 227: .It BindInterface
1.97 djm 228: .It CanonicalDomains
229: .It CanonicalizeFallbackLocal
230: .It CanonicalizeHostname
231: .It CanonicalizeMaxDots
232: .It CanonicalizePermittedCNAMEs
1.120 jmc 233: .It CASignatureAlgorithms
1.102 jmc 234: .It CertificateFile
1.46 jmc 235: .It CheckHostIP
236: .It Ciphers
237: .It Compression
1.110 naddy 238: .It ConnectionAttempts
1.54 dtucker 239: .It ConnectTimeout
1.55 djm 240: .It ControlMaster
241: .It ControlPath
1.91 djm 242: .It ControlPersist
1.46 jmc 243: .It GlobalKnownHostsFile
244: .It GSSAPIAuthentication
245: .It GSSAPIDelegateCredentials
1.61 jmc 246: .It HashKnownHosts
1.46 jmc 247: .It Host
1.136 naddy 248: .It HostbasedAcceptedAlgorithms
1.46 jmc 249: .It HostbasedAuthentication
250: .It HostKeyAlgorithms
251: .It HostKeyAlias
1.126 jmc 252: .It Hostname
1.104 jmc 253: .It IdentitiesOnly
1.103 markus 254: .It IdentityAgent
1.46 jmc 255: .It IdentityFile
1.87 jmc 256: .It IPQoS
1.91 djm 257: .It KbdInteractiveAuthentication
1.58 djm 258: .It KbdInteractiveDevices
1.86 jmc 259: .It KexAlgorithms
1.133 jmc 260: .It KnownHostsCommand
1.46 jmc 261: .It LogLevel
262: .It MACs
263: .It NoHostAuthenticationForLocalhost
264: .It NumberOfPasswordPrompts
265: .It PasswordAuthentication
1.83 markus 266: .It PKCS11Provider
1.46 jmc 267: .It Port
268: .It PreferredAuthentications
269: .It ProxyCommand
1.105 jmc 270: .It ProxyJump
1.134 dtucker 271: .It PubkeyAcceptedAlgorithms
1.46 jmc 272: .It PubkeyAuthentication
1.63 dtucker 273: .It RekeyLimit
1.53 jmc 274: .It SendEnv
1.49 markus 275: .It ServerAliveInterval
276: .It ServerAliveCountMax
1.116 jmc 277: .It SetEnv
1.46 jmc 278: .It StrictHostKeyChecking
1.48 markus 279: .It TCPKeepAlive
1.100 djm 280: .It UpdateHostKeys
1.46 jmc 281: .It User
282: .It UserKnownHostsFile
283: .It VerifyHostKeyDNS
284: .El
1.72 djm 285: .It Fl P Ar port
286: Specifies the port to connect to on the remote host.
1.74 djm 287: .It Fl p
288: Preserves modification times, access times, and modes from the
289: original files transferred.
1.70 djm 290: .It Fl q
291: Quiet mode: disables the progress meter as well as warning and
292: diagnostic messages from
293: .Xr ssh 1 .
1.30 djm 294: .It Fl R Ar num_requests
1.44 jmc 295: Specify how many requests may be outstanding at any one time.
296: Increasing this may slightly improve file transfer speed
297: but will increase memory usage.
1.67 djm 298: The default is 64 outstanding requests.
1.74 djm 299: .It Fl r
300: Recursively copy entire directories when uploading and downloading.
301: Note that
302: .Nm
303: does not follow symbolic links encountered in the tree traversal.
1.26 stevesk 304: .It Fl S Ar program
305: Name of the
306: .Ar program
307: to use for the encrypted connection.
308: The program must understand
309: .Xr ssh 1
310: options.
1.46 jmc 311: .It Fl s Ar subsystem | sftp_server
312: Specifies the SSH2 subsystem or the path for an sftp server
313: on the remote host.
1.109 jmc 314: A path is useful when the remote
1.46 jmc 315: .Xr sshd 8
316: does not have an sftp subsystem configured.
317: .It Fl v
318: Raise logging level.
319: This option is also passed to ssh.
1.1 djm 320: .El
321: .Sh INTERACTIVE COMMANDS
1.2 djm 322: Once in interactive mode,
323: .Nm
1.21 itojun 324: understands a set of commands similar to those of
1.1 djm 325: .Xr ftp 1 .
1.60 jaredy 326: Commands are case insensitive.
327: Pathnames that contain spaces must be enclosed in quotes.
328: Any special characters contained within pathnames that are recognized by
329: .Xr glob 3
330: must be escaped with backslashes
331: .Pq Sq \e .
332: .Bl -tag -width Ds
1.22 markus 333: .It Ic bye
1.44 jmc 334: Quit
335: .Nm sftp .
1.113 djm 336: .It Ic cd Op Ar path
1.21 itojun 337: Change remote directory to
1.3 deraadt 338: .Ar path .
1.113 djm 339: If
340: .Ar path
341: is not specified, then change directory to the one the session started in.
1.123 djm 342: .It Xo Ic chgrp
343: .Op Fl h
344: .Ar grp
345: .Ar path
346: .Xc
1.21 itojun 347: Change group of file
1.5 stevesk 348: .Ar path
349: to
1.1 djm 350: .Ar grp .
1.60 jaredy 351: .Ar path
352: may contain
1.118 kn 353: .Xr glob 7
1.60 jaredy 354: characters and may match multiple files.
1.1 djm 355: .Ar grp
1.5 stevesk 356: must be a numeric GID.
1.137 djm 357: .Pp
358: If the
359: .Fl h
360: flag is specified, then symlinks will not be followed.
361: Note that this is only supported by servers that implement
362: the "lsetstat@openssh.com" extension.
1.123 djm 363: .It Xo Ic chmod
364: .Op Fl h
365: .Ar mode
366: .Ar path
367: .Xc
1.21 itojun 368: Change permissions of file
1.5 stevesk 369: .Ar path
370: to
1.3 deraadt 371: .Ar mode .
1.60 jaredy 372: .Ar path
373: may contain
1.118 kn 374: .Xr glob 7
1.60 jaredy 375: characters and may match multiple files.
1.137 djm 376: .Pp
377: If the
378: .Fl h
379: flag is specified, then symlinks will not be followed.
380: Note that this is only supported by servers that implement
381: the "lsetstat@openssh.com" extension.
1.123 djm 382: .It Xo Ic chown
383: .Op Fl h
384: .Ar own
385: .Ar path
386: .Xc
1.21 itojun 387: Change owner of file
1.5 stevesk 388: .Ar path
389: to
1.1 djm 390: .Ar own .
1.60 jaredy 391: .Ar path
392: may contain
1.118 kn 393: .Xr glob 7
1.60 jaredy 394: characters and may match multiple files.
1.1 djm 395: .Ar own
396: must be a numeric UID.
1.137 djm 397: .Pp
398: If the
399: .Fl h
400: flag is specified, then symlinks will not be followed.
401: Note that this is only supported by servers that implement
402: the "lsetstat@openssh.com" extension.
1.139 ! djm 403: .It Ic copy Ar oldpath Ar newpath
! 404: Copy remote file from
! 405: .Ar oldpath
! 406: to
! 407: .Ar newpath .
! 408: .Pp
! 409: Note that this is only supported by servers that implement the "copy-data"
! 410: extension.
! 411: .It Ic cp Ar oldpath Ar newpath
! 412: Alias to
! 413: .Ic copy
! 414: command.
1.65 djm 415: .It Xo Ic df
416: .Op Fl hi
417: .Op Ar path
418: .Xc
419: Display usage information for the filesystem holding the current directory
420: (or
421: .Ar path
422: if specified).
423: If the
424: .Fl h
425: flag is specified, the capacity information will be displayed using
426: "human-readable" suffixes.
427: The
428: .Fl i
429: flag requests display of inode information in addition to capacity information.
430: This command is only supported on servers that implement the
431: .Dq statvfs@openssh.com
432: extension.
1.11 deraadt 433: .It Ic exit
1.44 jmc 434: Quit
435: .Nm sftp .
1.7 djm 436: .It Xo Ic get
1.127 jmc 437: .Op Fl afpR
1.7 djm 438: .Ar remote-path
439: .Op Ar local-path
440: .Xc
1.1 djm 441: Retrieve the
1.5 stevesk 442: .Ar remote-path
1.1 djm 443: and store it on the local machine.
444: If the local
1.21 itojun 445: path name is not specified, it is given the same name it has on the
1.44 jmc 446: remote machine.
1.60 jaredy 447: .Ar remote-path
448: may contain
1.118 kn 449: .Xr glob 7
1.60 jaredy 450: characters and may match multiple files.
451: If it does and
452: .Ar local-path
453: is specified, then
454: .Ar local-path
455: must specify a directory.
1.74 djm 456: .Pp
1.92 djm 457: If the
458: .Fl a
459: flag is specified, then attempt to resume partial transfers of existing files.
460: Note that resumption assumes that any partial copy of the local file matches
461: the remote copy.
1.93 djm 462: If the remote file contents differ from the partial local copy then the
463: resultant file is likely to be corrupt.
1.92 djm 464: .Pp
1.95 djm 465: If the
466: .Fl f
467: flag is specified, then
468: .Xr fsync 2
1.96 jmc 469: will be called after the file transfer has completed to flush the file
1.95 djm 470: to disk.
471: .Pp
1.127 jmc 472: If the
1.74 djm 473: .Fl p
1.127 jmc 474: .\" undocumented redundant alias
475: .\" or
476: .\" .Fl P
1.60 jaredy 477: flag is specified, then full file permissions and access times are
1.7 djm 478: copied too.
1.74 djm 479: .Pp
480: If the
1.127 jmc 481: .Fl R
482: .\" undocumented redundant alias
483: .\" or
484: .\" .Fl r
1.74 djm 485: flag is specified then directories will be copied recursively.
486: Note that
487: .Nm
488: does not follow symbolic links when performing recursive transfers.
1.11 deraadt 489: .It Ic help
490: Display help text.
1.113 djm 491: .It Ic lcd Op Ar path
1.46 jmc 492: Change local directory to
493: .Ar path .
1.113 djm 494: If
495: .Ar path
496: is not specified, then change directory to the local user's home directory.
1.3 deraadt 497: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 498: Display local directory listing of either
1.1 djm 499: .Ar path
500: or current directory if
501: .Ar path
1.5 stevesk 502: is not specified.
1.60 jaredy 503: .Ar ls-options
504: may contain any flags supported by the local system's
505: .Xr ls 1
506: command.
507: .Ar path
508: may contain
1.118 kn 509: .Xr glob 7
1.60 jaredy 510: characters and may match multiple files.
1.3 deraadt 511: .It Ic lmkdir Ar path
1.1 djm 512: Create local directory specified by
1.3 deraadt 513: .Ar path .
1.88 djm 514: .It Xo Ic ln
515: .Op Fl s
516: .Ar oldpath
517: .Ar newpath
518: .Xc
519: Create a link from
1.12 djm 520: .Ar oldpath
521: to
522: .Ar newpath .
1.88 djm 523: If the
524: .Fl s
525: flag is specified the created link is a symbolic link, otherwise it is
526: a hard link.
1.3 deraadt 527: .It Ic lpwd
528: Print local working directory.
1.36 djm 529: .It Xo Ic ls
1.82 jmc 530: .Op Fl 1afhlnrSt
1.36 djm 531: .Op Ar path
532: .Xc
1.60 jaredy 533: Display a remote directory listing of either
1.1 djm 534: .Ar path
1.60 jaredy 535: or the current directory if
1.5 stevesk 536: .Ar path
1.44 jmc 537: is not specified.
1.60 jaredy 538: .Ar path
539: may contain
1.118 kn 540: .Xr glob 7
1.60 jaredy 541: characters and may match multiple files.
542: .Pp
543: The following flags are recognized and alter the behaviour of
544: .Ic ls
545: accordingly:
546: .Bl -tag -width Ds
547: .It Fl 1
548: Produce single columnar output.
549: .It Fl a
550: List files beginning with a dot
551: .Pq Sq \&. .
552: .It Fl f
553: Do not sort the listing.
554: The default sort order is lexicographical.
1.81 djm 555: .It Fl h
556: When used with a long format option, use unit suffixes: Byte, Kilobyte,
557: Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
558: the number of digits to four or fewer using powers of 2 for sizes (K=1024,
559: M=1048576, etc.).
1.82 jmc 560: .It Fl l
561: Display additional details including permissions
562: and ownership information.
1.60 jaredy 563: .It Fl n
564: Produce a long listing with user and group information presented
1.56 djm 565: numerically.
1.60 jaredy 566: .It Fl r
567: Reverse the sort order of the listing.
568: .It Fl S
569: Sort the listing by file size.
570: .It Fl t
571: Sort the listing by last modification time.
572: .El
1.3 deraadt 573: .It Ic lumask Ar umask
1.21 itojun 574: Set local umask to
1.3 deraadt 575: .Ar umask .
576: .It Ic mkdir Ar path
1.1 djm 577: Create remote directory specified by
1.3 deraadt 578: .Ar path .
1.40 fgsch 579: .It Ic progress
580: Toggle display of progress meter.
1.7 djm 581: .It Xo Ic put
1.127 jmc 582: .Op Fl afpR
1.7 djm 583: .Ar local-path
1.37 djm 584: .Op Ar remote-path
1.7 djm 585: .Xc
1.1 djm 586: Upload
1.5 stevesk 587: .Ar local-path
1.44 jmc 588: and store it on the remote machine.
589: If the remote path name is not specified, it is given the same name it has
590: on the local machine.
1.60 jaredy 591: .Ar local-path
592: may contain
1.118 kn 593: .Xr glob 7
1.60 jaredy 594: characters and may match multiple files.
595: If it does and
596: .Ar remote-path
597: is specified, then
598: .Ar remote-path
599: must specify a directory.
1.95 djm 600: .Pp
601: If the
1.99 jmc 602: .Fl a
1.98 logan 603: flag is specified, then attempt to resume partial
604: transfers of existing files.
1.99 jmc 605: Note that resumption assumes that any partial copy of the remote file
1.98 logan 606: matches the local copy.
607: If the local file contents differ from the remote local copy then
608: the resultant file is likely to be corrupt.
609: .Pp
610: If the
1.95 djm 611: .Fl f
612: flag is specified, then a request will be sent to the server to call
613: .Xr fsync 2
614: after the file has been transferred.
615: Note that this is only supported by servers that implement
616: the "fsync@openssh.com" extension.
1.74 djm 617: .Pp
1.127 jmc 618: If the
1.74 djm 619: .Fl p
1.127 jmc 620: .\" undocumented redundant alias
621: .\" or
622: .\" .Fl P
1.74 djm 623: flag is specified, then full file permissions and access times are
1.7 djm 624: copied too.
1.74 djm 625: .Pp
626: If the
1.127 jmc 627: .Fl R
628: .\" undocumented redundant alias
629: .\" or
630: .\" .Fl r
1.74 djm 631: flag is specified then directories will be copied recursively.
632: Note that
633: .Nm
634: does not follow symbolic links when performing recursive transfers.
1.3 deraadt 635: .It Ic pwd
636: Display remote working directory.
637: .It Ic quit
1.44 jmc 638: Quit
639: .Nm sftp .
1.92 djm 640: .It Xo Ic reget
1.127 jmc 641: .Op Fl fpR
1.92 djm 642: .Ar remote-path
643: .Op Ar local-path
644: .Xc
645: Resume download of
646: .Ar remote-path .
647: Equivalent to
648: .Ic get
649: with the
1.98 logan 650: .Fl a
651: flag set.
652: .It Xo Ic reput
1.127 jmc 653: .Op Fl fpR
654: .Ar local-path
655: .Op Ar remote-path
1.98 logan 656: .Xc
657: Resume upload of
1.127 jmc 658: .Ar local-path .
1.98 logan 659: Equivalent to
660: .Ic put
1.99 jmc 661: with the
1.92 djm 662: .Fl a
663: flag set.
1.131 jmc 664: .It Ic rename Ar oldpath newpath
1.1 djm 665: Rename remote file from
666: .Ar oldpath
667: to
1.3 deraadt 668: .Ar newpath .
1.46 jmc 669: .It Ic rm Ar path
670: Delete remote file specified by
671: .Ar path .
1.3 deraadt 672: .It Ic rmdir Ar path
1.1 djm 673: Remove remote directory specified by
1.3 deraadt 674: .Ar path .
1.131 jmc 675: .It Ic symlink Ar oldpath newpath
1.21 itojun 676: Create a symbolic link from
1.12 djm 677: .Ar oldpath
678: to
679: .Ar newpath .
1.38 fgsch 680: .It Ic version
681: Display the
682: .Nm
683: protocol version.
1.69 sobrado 684: .It Ic \&! Ns Ar command
1.21 itojun 685: Execute
1.1 djm 686: .Ar command
1.3 deraadt 687: in local shell.
1.45 jmc 688: .It Ic \&!
1.3 deraadt 689: Escape to local shell.
1.45 jmc 690: .It Ic \&?
1.5 stevesk 691: Synonym for help.
1.4 itojun 692: .El
1.1 djm 693: .Sh SEE ALSO
1.46 jmc 694: .Xr ftp 1 ,
1.60 jaredy 695: .Xr ls 1 ,
1.17 markus 696: .Xr scp 1 ,
1.1 djm 697: .Xr ssh 1 ,
698: .Xr ssh-add 1 ,
699: .Xr ssh-keygen 1 ,
1.119 jmc 700: .Xr ssh_config 5 ,
1.118 kn 701: .Xr glob 7 ,
1.17 markus 702: .Xr sftp-server 8 ,
703: .Xr sshd 8
704: .Rs
1.20 deraadt 705: .%A T. Ylonen
706: .%A S. Lehtinen
1.17 markus 707: .%T "SSH File Transfer Protocol"
708: .%N draft-ietf-secsh-filexfer-00.txt
709: .%D January 2001
710: .%O work in progress material
711: .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