1 .\" $OpenBSD: sftp.1,v 1.125 2019/01/22 06:58:31 jmc Exp $
3 .\" Copyright (c) 2001 Damien Miller. All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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.
25 .Dd $Mdocdate: January 22 2019 $
30 .Nd secure file transfer program
34 .Op Fl B Ar buffer_size
37 .Op Fl D Ar sftp_server_path
38 .Op Fl F Ar ssh_config
39 .Op Fl i Ar identity_file
40 .Op Fl J Ar destination
42 .Op Fl o Ar ssh_option
44 .Op Fl R Ar num_requests
46 .Op Fl s Ar subsystem | sftp_server
50 is a file transfer program, similar to
52 which performs all operations over an encrypted
55 It may also use many features of ssh, such as public key authentication and
60 may be specified either as
62 .Oo user @ Oc host Op : path
64 or as a URI in the form
66 .No sftp:// Oo user @ Oc host Oo : port Oc Op / path .
73 and it is not a directory,
75 will retrieve files automatically if a non-interactive
76 authentication method is used; otherwise it will do so after
77 successful interactive authentication.
81 is specified, or if the
85 will log in to the specified
87 and enter interactive command mode, changing to the remote directory
89 An optional trailing slash can be used to force the
91 to be interpreted as a directory.
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.
97 The options are as follows:
102 to use IPv4 addresses only.
106 to use IPv6 addresses only.
108 Attempt to continue interrupted transfers rather than overwriting
109 existing partial or complete copies of files.
110 If the partial contents differ from those being transferred,
111 then the resultant file is likely to be corrupt.
112 .It Fl B Ar buffer_size
113 Specify the size of the buffer that
115 uses when transferring files.
116 Larger buffers require fewer round trips at the cost of higher
118 The default is 32768 bytes.
119 .It Fl b Ar batchfile
120 Batch mode reads a series of commands from an input
124 Since it lacks user interaction it should be used in conjunction with
125 non-interactive authentication to obviate the need to enter a password
126 at connection time (see
136 may be used to indicate standard input.
138 will abort if any of the following
140 .Ic get , put , reget , reput , rename , ln ,
141 .Ic rm , mkdir , chdir , ls ,
142 .Ic lchdir , chmod , chown ,
143 .Ic chgrp , lpwd , df , symlink ,
147 Termination on error can be suppressed on a command by command basis by
148 prefixing the command with a
150 character (for example,
151 .Ic -rm /tmp/blah* ) .
152 Echo of the command may be suppressed by prefixing the command with a
155 These two prefixes may be combined in any order, for example
158 Enables compression (via ssh's
162 Selects the cipher to use for encrypting the data transfers.
163 This option is directly passed to
165 .It Fl D Ar sftp_server_path
166 Connect directly to a local sftp server
169 This option may be useful in debugging the client and server.
170 .It Fl F Ar ssh_config
171 Specifies an alternative
172 per-user configuration file for
174 This option is directly passed to
177 Requests that files be flushed to disk immediately after transfer.
178 When uploading files, this feature is only enabled if the server
179 implements the "fsync@openssh.com" extension.
180 .It Fl i Ar identity_file
181 Selects the file from which the identity (private key) for public key
182 authentication is read.
183 This option is directly passed to
185 .It Fl J Ar destination
186 Connect to the target host by first making an
188 connection to the jump host described by
190 and then establishing a TCP forwarding to the ultimate destination from
192 Multiple jump hops may be specified separated by comma characters.
193 This is a shortcut to specify a
195 configuration directive.
196 This option is directly passed to
199 Limits the used bandwidth, specified in Kbit/s.
200 .It Fl o Ar ssh_option
201 Can be used to pass options to
203 in the format used in
205 This is useful for specifying options
206 for which there is no separate
209 For example, to specify an alternate port use:
211 For full details of the options listed below, and their possible values, see
214 .Bl -tag -width Ds -offset indent -compact
220 .It CanonicalizeFallbackLocal
221 .It CanonicalizeHostname
222 .It CanonicalizeMaxDots
223 .It CanonicalizePermittedCNAMEs
224 .It CASignatureAlgorithms
226 .It ChallengeResponseAuthentication
230 .It ConnectionAttempts
235 .It GlobalKnownHostsFile
236 .It GSSAPIAuthentication
237 .It GSSAPIDelegateCredentials
240 .It HostbasedAuthentication
241 .It HostbasedKeyTypes
242 .It HostKeyAlgorithms
249 .It KbdInteractiveAuthentication
250 .It KbdInteractiveDevices
254 .It NoHostAuthenticationForLocalhost
255 .It NumberOfPasswordPrompts
256 .It PasswordAuthentication
259 .It PreferredAuthentications
262 .It PubkeyAcceptedKeyTypes
263 .It PubkeyAuthentication
266 .It ServerAliveInterval
267 .It ServerAliveCountMax
269 .It StrictHostKeyChecking
273 .It UserKnownHostsFile
277 Specifies the port to connect to on the remote host.
279 Preserves modification times, access times, and modes from the
280 original files transferred.
282 Quiet mode: disables the progress meter as well as warning and
283 diagnostic messages from
285 .It Fl R Ar num_requests
286 Specify how many requests may be outstanding at any one time.
287 Increasing this may slightly improve file transfer speed
288 but will increase memory usage.
289 The default is 64 outstanding requests.
291 Recursively copy entire directories when uploading and downloading.
294 does not follow symbolic links encountered in the tree traversal.
298 to use for the encrypted connection.
299 The program must understand
302 .It Fl s Ar subsystem | sftp_server
303 Specifies the SSH2 subsystem or the path for an sftp server
305 A path is useful when the remote
307 does not have an sftp subsystem configured.
310 This option is also passed to ssh.
312 .Sh INTERACTIVE COMMANDS
313 Once in interactive mode,
315 understands a set of commands similar to those of
317 Commands are case insensitive.
318 Pathnames that contain spaces must be enclosed in quotes.
319 Any special characters contained within pathnames that are recognized by
321 must be escaped with backslashes
328 Change remote directory to
332 is not specified, then change directory to the one the session started in.
344 flag is specified, then symlinks will not be followed.
348 characters and may match multiple files.
350 must be a numeric GID.
356 Change permissions of file
362 flag is specified, then symlinks will not be followed.
366 characters and may match multiple files.
378 flag is specified, then symlinks will not be followed.
382 characters and may match multiple files.
384 must be a numeric UID.
389 Display usage information for the filesystem holding the current directory
395 flag is specified, the capacity information will be displayed using
396 "human-readable" suffixes.
399 flag requests display of inode information in addition to capacity information.
400 This command is only supported on servers that implement the
401 .Dq statvfs@openssh.com
413 and store it on the local machine.
415 path name is not specified, it is given the same name it has on the
420 characters and may match multiple files.
425 must specify a directory.
429 flag is specified, then attempt to resume partial transfers of existing files.
430 Note that resumption assumes that any partial copy of the local file matches
432 If the remote file contents differ from the partial local copy then the
433 resultant file is likely to be corrupt.
437 flag is specified, then
439 will be called after the file transfer has completed to flush the file
446 flag is specified, then full file permissions and access times are
451 flag is specified then directories will be copied recursively.
454 does not follow symbolic links when performing recursive transfers.
457 .It Ic lcd Op Ar path
458 Change local directory to
462 is not specified, then change directory to the local user's home directory.
463 .It Ic lls Op Ar ls-options Op Ar path
464 Display local directory listing of either
466 or current directory if
470 may contain any flags supported by the local system's
476 characters and may match multiple files.
477 .It Ic lmkdir Ar path
478 Create local directory specified by
491 flag is specified the created link is a symbolic link, otherwise it is
494 Print local working directory.
499 Display a remote directory listing of either
501 or the current directory if
507 characters and may match multiple files.
509 The following flags are recognized and alter the behaviour of
514 Produce single columnar output.
516 List files beginning with a dot
519 Do not sort the listing.
520 The default sort order is lexicographical.
522 When used with a long format option, use unit suffixes: Byte, Kilobyte,
523 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
524 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
527 Display additional details including permissions
528 and ownership information.
530 Produce a long listing with user and group information presented
533 Reverse the sort order of the listing.
535 Sort the listing by file size.
537 Sort the listing by last modification time.
539 .It Ic lumask Ar umask
543 Create remote directory specified by
546 Toggle display of progress meter.
554 and store it on the remote machine.
555 If the remote path name is not specified, it is given the same name it has
556 on the local machine.
560 characters and may match multiple files.
565 must specify a directory.
569 flag is specified, then attempt to resume partial
570 transfers of existing files.
571 Note that resumption assumes that any partial copy of the remote file
572 matches the local copy.
573 If the local file contents differ from the remote local copy then
574 the resultant file is likely to be corrupt.
578 flag is specified, then a request will be sent to the server to call
580 after the file has been transferred.
581 Note that this is only supported by servers that implement
582 the "fsync@openssh.com" extension.
588 flag is specified, then full file permissions and access times are
593 flag is specified then directories will be copied recursively.
596 does not follow symbolic links when performing recursive transfers.
598 Display remote working directory.
626 .It Ic rename Ar oldpath Ar newpath
627 Rename remote file from
632 Delete remote file specified by
635 Remove remote directory specified by
637 .It Ic symlink Ar oldpath Ar newpath
638 Create a symbolic link from
646 .It Ic \&! Ns Ar command
651 Escape to local shell.
669 .%T "SSH File Transfer Protocol"
670 .%N draft-ietf-secsh-filexfer-00.txt
672 .%O work in progress material