Annotation of src/usr.bin/ssh/sftp.1, Revision 1.137
1.137 ! djm 1: .\" $OpenBSD: sftp.1,v 1.136 2021/01/26 15:40:17 naddy 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.136 naddy 25: .Dd $Mdocdate: January 26 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.66 jmc 147: .Ic lchdir , 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 ChallengeResponseAuthentication
236: .It CheckHostIP
237: .It Ciphers
238: .It Compression
1.110 naddy 239: .It ConnectionAttempts
1.54 dtucker 240: .It ConnectTimeout
1.55 djm 241: .It ControlMaster
242: .It ControlPath
1.91 djm 243: .It ControlPersist
1.46 jmc 244: .It GlobalKnownHostsFile
245: .It GSSAPIAuthentication
246: .It GSSAPIDelegateCredentials
1.61 jmc 247: .It HashKnownHosts
1.46 jmc 248: .It Host
1.136 naddy 249: .It HostbasedAcceptedAlgorithms
1.46 jmc 250: .It HostbasedAuthentication
251: .It HostKeyAlgorithms
252: .It HostKeyAlias
1.126 jmc 253: .It Hostname
1.104 jmc 254: .It IdentitiesOnly
1.103 markus 255: .It IdentityAgent
1.46 jmc 256: .It IdentityFile
1.87 jmc 257: .It IPQoS
1.91 djm 258: .It KbdInteractiveAuthentication
1.58 djm 259: .It KbdInteractiveDevices
1.86 jmc 260: .It KexAlgorithms
1.133 jmc 261: .It KnownHostsCommand
1.46 jmc 262: .It LogLevel
263: .It MACs
264: .It NoHostAuthenticationForLocalhost
265: .It NumberOfPasswordPrompts
266: .It PasswordAuthentication
1.83 markus 267: .It PKCS11Provider
1.46 jmc 268: .It Port
269: .It PreferredAuthentications
270: .It ProxyCommand
1.105 jmc 271: .It ProxyJump
1.134 dtucker 272: .It PubkeyAcceptedAlgorithms
1.46 jmc 273: .It PubkeyAuthentication
1.63 dtucker 274: .It RekeyLimit
1.53 jmc 275: .It SendEnv
1.49 markus 276: .It ServerAliveInterval
277: .It ServerAliveCountMax
1.116 jmc 278: .It SetEnv
1.46 jmc 279: .It StrictHostKeyChecking
1.48 markus 280: .It TCPKeepAlive
1.100 djm 281: .It UpdateHostKeys
1.46 jmc 282: .It User
283: .It UserKnownHostsFile
284: .It VerifyHostKeyDNS
285: .El
1.72 djm 286: .It Fl P Ar port
287: Specifies the port to connect to on the remote host.
1.74 djm 288: .It Fl p
289: Preserves modification times, access times, and modes from the
290: original files transferred.
1.70 djm 291: .It Fl q
292: Quiet mode: disables the progress meter as well as warning and
293: diagnostic messages from
294: .Xr ssh 1 .
1.30 djm 295: .It Fl R Ar num_requests
1.44 jmc 296: Specify how many requests may be outstanding at any one time.
297: Increasing this may slightly improve file transfer speed
298: but will increase memory usage.
1.67 djm 299: The default is 64 outstanding requests.
1.74 djm 300: .It Fl r
301: Recursively copy entire directories when uploading and downloading.
302: Note that
303: .Nm
304: does not follow symbolic links encountered in the tree traversal.
1.26 stevesk 305: .It Fl S Ar program
306: Name of the
307: .Ar program
308: to use for the encrypted connection.
309: The program must understand
310: .Xr ssh 1
311: options.
1.46 jmc 312: .It Fl s Ar subsystem | sftp_server
313: Specifies the SSH2 subsystem or the path for an sftp server
314: on the remote host.
1.109 jmc 315: A path is useful when the remote
1.46 jmc 316: .Xr sshd 8
317: does not have an sftp subsystem configured.
318: .It Fl v
319: Raise logging level.
320: This option is also passed to ssh.
1.1 djm 321: .El
322: .Sh INTERACTIVE COMMANDS
1.2 djm 323: Once in interactive mode,
324: .Nm
1.21 itojun 325: understands a set of commands similar to those of
1.1 djm 326: .Xr ftp 1 .
1.60 jaredy 327: Commands are case insensitive.
328: Pathnames that contain spaces must be enclosed in quotes.
329: Any special characters contained within pathnames that are recognized by
330: .Xr glob 3
331: must be escaped with backslashes
332: .Pq Sq \e .
333: .Bl -tag -width Ds
1.22 markus 334: .It Ic bye
1.44 jmc 335: Quit
336: .Nm sftp .
1.113 djm 337: .It Ic cd Op Ar path
1.21 itojun 338: Change remote directory to
1.3 deraadt 339: .Ar path .
1.113 djm 340: If
341: .Ar path
342: is not specified, then change directory to the one the session started in.
1.123 djm 343: .It Xo Ic chgrp
344: .Op Fl h
345: .Ar grp
346: .Ar path
347: .Xc
1.21 itojun 348: Change group of file
1.5 stevesk 349: .Ar path
350: to
1.1 djm 351: .Ar grp .
1.60 jaredy 352: .Ar path
353: may contain
1.118 kn 354: .Xr glob 7
1.60 jaredy 355: characters and may match multiple files.
1.1 djm 356: .Ar grp
1.5 stevesk 357: must be a numeric GID.
1.137 ! djm 358: .Pp
! 359: If the
! 360: .Fl h
! 361: flag is specified, then symlinks will not be followed.
! 362: Note that this is only supported by servers that implement
! 363: the "lsetstat@openssh.com" extension.
1.123 djm 364: .It Xo Ic chmod
365: .Op Fl h
366: .Ar mode
367: .Ar path
368: .Xc
1.21 itojun 369: Change permissions of file
1.5 stevesk 370: .Ar path
371: to
1.3 deraadt 372: .Ar mode .
1.60 jaredy 373: .Ar path
374: may contain
1.118 kn 375: .Xr glob 7
1.60 jaredy 376: characters and may match multiple files.
1.137 ! djm 377: .Pp
! 378: If the
! 379: .Fl h
! 380: flag is specified, then symlinks will not be followed.
! 381: Note that this is only supported by servers that implement
! 382: the "lsetstat@openssh.com" extension.
1.123 djm 383: .It Xo Ic chown
384: .Op Fl h
385: .Ar own
386: .Ar path
387: .Xc
1.21 itojun 388: Change owner of file
1.5 stevesk 389: .Ar path
390: to
1.1 djm 391: .Ar own .
1.60 jaredy 392: .Ar path
393: may contain
1.118 kn 394: .Xr glob 7
1.60 jaredy 395: characters and may match multiple files.
1.1 djm 396: .Ar own
397: must be a numeric UID.
1.137 ! djm 398: .Pp
! 399: If the
! 400: .Fl h
! 401: flag is specified, then symlinks will not be followed.
! 402: Note that this is only supported by servers that implement
! 403: the "lsetstat@openssh.com" extension.
1.65 djm 404: .It Xo Ic df
405: .Op Fl hi
406: .Op Ar path
407: .Xc
408: Display usage information for the filesystem holding the current directory
409: (or
410: .Ar path
411: if specified).
412: If the
413: .Fl h
414: flag is specified, the capacity information will be displayed using
415: "human-readable" suffixes.
416: The
417: .Fl i
418: flag requests display of inode information in addition to capacity information.
419: This command is only supported on servers that implement the
420: .Dq statvfs@openssh.com
421: extension.
1.11 deraadt 422: .It Ic exit
1.44 jmc 423: Quit
424: .Nm sftp .
1.7 djm 425: .It Xo Ic get
1.127 jmc 426: .Op Fl afpR
1.7 djm 427: .Ar remote-path
428: .Op Ar local-path
429: .Xc
1.1 djm 430: Retrieve the
1.5 stevesk 431: .Ar remote-path
1.1 djm 432: and store it on the local machine.
433: If the local
1.21 itojun 434: path name is not specified, it is given the same name it has on the
1.44 jmc 435: remote machine.
1.60 jaredy 436: .Ar remote-path
437: may contain
1.118 kn 438: .Xr glob 7
1.60 jaredy 439: characters and may match multiple files.
440: If it does and
441: .Ar local-path
442: is specified, then
443: .Ar local-path
444: must specify a directory.
1.74 djm 445: .Pp
1.92 djm 446: If the
447: .Fl a
448: flag is specified, then attempt to resume partial transfers of existing files.
449: Note that resumption assumes that any partial copy of the local file matches
450: the remote copy.
1.93 djm 451: If the remote file contents differ from the partial local copy then the
452: resultant file is likely to be corrupt.
1.92 djm 453: .Pp
1.95 djm 454: If the
455: .Fl f
456: flag is specified, then
457: .Xr fsync 2
1.96 jmc 458: will be called after the file transfer has completed to flush the file
1.95 djm 459: to disk.
460: .Pp
1.127 jmc 461: If the
1.74 djm 462: .Fl p
1.127 jmc 463: .\" undocumented redundant alias
464: .\" or
465: .\" .Fl P
1.60 jaredy 466: flag is specified, then full file permissions and access times are
1.7 djm 467: copied too.
1.74 djm 468: .Pp
469: If the
1.127 jmc 470: .Fl R
471: .\" undocumented redundant alias
472: .\" or
473: .\" .Fl r
1.74 djm 474: flag is specified then directories will be copied recursively.
475: Note that
476: .Nm
477: does not follow symbolic links when performing recursive transfers.
1.11 deraadt 478: .It Ic help
479: Display help text.
1.113 djm 480: .It Ic lcd Op Ar path
1.46 jmc 481: Change local directory to
482: .Ar path .
1.113 djm 483: If
484: .Ar path
485: is not specified, then change directory to the local user's home directory.
1.3 deraadt 486: .It Ic lls Op Ar ls-options Op Ar path
1.21 itojun 487: Display local directory listing of either
1.1 djm 488: .Ar path
489: or current directory if
490: .Ar path
1.5 stevesk 491: is not specified.
1.60 jaredy 492: .Ar ls-options
493: may contain any flags supported by the local system's
494: .Xr ls 1
495: command.
496: .Ar path
497: may contain
1.118 kn 498: .Xr glob 7
1.60 jaredy 499: characters and may match multiple files.
1.3 deraadt 500: .It Ic lmkdir Ar path
1.1 djm 501: Create local directory specified by
1.3 deraadt 502: .Ar path .
1.88 djm 503: .It Xo Ic ln
504: .Op Fl s
505: .Ar oldpath
506: .Ar newpath
507: .Xc
508: Create a link from
1.12 djm 509: .Ar oldpath
510: to
511: .Ar newpath .
1.88 djm 512: If the
513: .Fl s
514: flag is specified the created link is a symbolic link, otherwise it is
515: a hard link.
1.3 deraadt 516: .It Ic lpwd
517: Print local working directory.
1.36 djm 518: .It Xo Ic ls
1.82 jmc 519: .Op Fl 1afhlnrSt
1.36 djm 520: .Op Ar path
521: .Xc
1.60 jaredy 522: Display a remote directory listing of either
1.1 djm 523: .Ar path
1.60 jaredy 524: or the current directory if
1.5 stevesk 525: .Ar path
1.44 jmc 526: is not specified.
1.60 jaredy 527: .Ar path
528: may contain
1.118 kn 529: .Xr glob 7
1.60 jaredy 530: characters and may match multiple files.
531: .Pp
532: The following flags are recognized and alter the behaviour of
533: .Ic ls
534: accordingly:
535: .Bl -tag -width Ds
536: .It Fl 1
537: Produce single columnar output.
538: .It Fl a
539: List files beginning with a dot
540: .Pq Sq \&. .
541: .It Fl f
542: Do not sort the listing.
543: The default sort order is lexicographical.
1.81 djm 544: .It Fl h
545: When used with a long format option, use unit suffixes: Byte, Kilobyte,
546: Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
547: the number of digits to four or fewer using powers of 2 for sizes (K=1024,
548: M=1048576, etc.).
1.82 jmc 549: .It Fl l
550: Display additional details including permissions
551: and ownership information.
1.60 jaredy 552: .It Fl n
553: Produce a long listing with user and group information presented
1.56 djm 554: numerically.
1.60 jaredy 555: .It Fl r
556: Reverse the sort order of the listing.
557: .It Fl S
558: Sort the listing by file size.
559: .It Fl t
560: Sort the listing by last modification time.
561: .El
1.3 deraadt 562: .It Ic lumask Ar umask
1.21 itojun 563: Set local umask to
1.3 deraadt 564: .Ar umask .
565: .It Ic mkdir Ar path
1.1 djm 566: Create remote directory specified by
1.3 deraadt 567: .Ar path .
1.40 fgsch 568: .It Ic progress
569: Toggle display of progress meter.
1.7 djm 570: .It Xo Ic put
1.127 jmc 571: .Op Fl afpR
1.7 djm 572: .Ar local-path
1.37 djm 573: .Op Ar remote-path
1.7 djm 574: .Xc
1.1 djm 575: Upload
1.5 stevesk 576: .Ar local-path
1.44 jmc 577: and store it on the remote machine.
578: If the remote path name is not specified, it is given the same name it has
579: on the local machine.
1.60 jaredy 580: .Ar local-path
581: may contain
1.118 kn 582: .Xr glob 7
1.60 jaredy 583: characters and may match multiple files.
584: If it does and
585: .Ar remote-path
586: is specified, then
587: .Ar remote-path
588: must specify a directory.
1.95 djm 589: .Pp
590: If the
1.99 jmc 591: .Fl a
1.98 logan 592: flag is specified, then attempt to resume partial
593: transfers of existing files.
1.99 jmc 594: Note that resumption assumes that any partial copy of the remote file
1.98 logan 595: matches the local copy.
596: If the local file contents differ from the remote local copy then
597: the resultant file is likely to be corrupt.
598: .Pp
599: If the
1.95 djm 600: .Fl f
601: flag is specified, then a request will be sent to the server to call
602: .Xr fsync 2
603: after the file has been transferred.
604: Note that this is only supported by servers that implement
605: the "fsync@openssh.com" extension.
1.74 djm 606: .Pp
1.127 jmc 607: If the
1.74 djm 608: .Fl p
1.127 jmc 609: .\" undocumented redundant alias
610: .\" or
611: .\" .Fl P
1.74 djm 612: flag is specified, then full file permissions and access times are
1.7 djm 613: copied too.
1.74 djm 614: .Pp
615: If the
1.127 jmc 616: .Fl R
617: .\" undocumented redundant alias
618: .\" or
619: .\" .Fl r
1.74 djm 620: flag is specified then directories will be copied recursively.
621: Note that
622: .Nm
623: does not follow symbolic links when performing recursive transfers.
1.3 deraadt 624: .It Ic pwd
625: Display remote working directory.
626: .It Ic quit
1.44 jmc 627: Quit
628: .Nm sftp .
1.92 djm 629: .It Xo Ic reget
1.127 jmc 630: .Op Fl fpR
1.92 djm 631: .Ar remote-path
632: .Op Ar local-path
633: .Xc
634: Resume download of
635: .Ar remote-path .
636: Equivalent to
637: .Ic get
638: with the
1.98 logan 639: .Fl a
640: flag set.
641: .It Xo Ic reput
1.127 jmc 642: .Op Fl fpR
643: .Ar local-path
644: .Op Ar remote-path
1.98 logan 645: .Xc
646: Resume upload of
1.127 jmc 647: .Ar local-path .
1.98 logan 648: Equivalent to
649: .Ic put
1.99 jmc 650: with the
1.92 djm 651: .Fl a
652: flag set.
1.131 jmc 653: .It Ic rename Ar oldpath newpath
1.1 djm 654: Rename remote file from
655: .Ar oldpath
656: to
1.3 deraadt 657: .Ar newpath .
1.46 jmc 658: .It Ic rm Ar path
659: Delete remote file specified by
660: .Ar path .
1.3 deraadt 661: .It Ic rmdir Ar path
1.1 djm 662: Remove remote directory specified by
1.3 deraadt 663: .Ar path .
1.131 jmc 664: .It Ic symlink Ar oldpath newpath
1.21 itojun 665: Create a symbolic link from
1.12 djm 666: .Ar oldpath
667: to
668: .Ar newpath .
1.38 fgsch 669: .It Ic version
670: Display the
671: .Nm
672: protocol version.
1.69 sobrado 673: .It Ic \&! Ns Ar command
1.21 itojun 674: Execute
1.1 djm 675: .Ar command
1.3 deraadt 676: in local shell.
1.45 jmc 677: .It Ic \&!
1.3 deraadt 678: Escape to local shell.
1.45 jmc 679: .It Ic \&?
1.5 stevesk 680: Synonym for help.
1.4 itojun 681: .El
1.1 djm 682: .Sh SEE ALSO
1.46 jmc 683: .Xr ftp 1 ,
1.60 jaredy 684: .Xr ls 1 ,
1.17 markus 685: .Xr scp 1 ,
1.1 djm 686: .Xr ssh 1 ,
687: .Xr ssh-add 1 ,
688: .Xr ssh-keygen 1 ,
1.119 jmc 689: .Xr ssh_config 5 ,
1.118 kn 690: .Xr glob 7 ,
1.17 markus 691: .Xr sftp-server 8 ,
692: .Xr sshd 8
693: .Rs
1.20 deraadt 694: .%A T. Ylonen
695: .%A S. Lehtinen
1.17 markus 696: .%T "SSH File Transfer Protocol"
697: .%N draft-ietf-secsh-filexfer-00.txt
698: .%D January 2001
699: .%O work in progress material
700: .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