1 .\" $OpenBSD: sftp.1,v 1.105 2016/07/16 06:57:55 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: July 16 2016 $
30 .Nd secure file transfer program
35 .Op Fl B Ar buffer_size
38 .Op Fl D Ar sftp_server_path
39 .Op Fl F Ar ssh_config
40 .Op Fl i Ar identity_file
42 .Op Fl o Ar ssh_option
44 .Op Fl R Ar num_requests
46 .Op Fl s Ar subsystem | sftp_server
50 .Oo Ar user Ns @ Oc Ns
51 .Ar host Ns Op : Ns Ar
55 .Ar host Ns Oo : Ns Ar dir Ns
60 .Oo Ar user Ns @ Oc Ns Ar host
63 is an interactive file transfer program, similar to
65 which performs all operations over an encrypted
68 It may also use many features of ssh, such as public key authentication and
71 connects and logs into the specified
73 then enters an interactive command mode.
75 The second usage format will retrieve files automatically if a non-interactive
76 authentication method is used; otherwise it will do so after
77 successful interactive authentication.
79 The third usage format allows
81 to start in a remote directory.
83 The final usage format allows for automated sessions using the
86 In such cases, it is necessary to configure non-interactive authentication
87 to obviate the need to enter a password at connection time (see
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.
96 The options are as follows:
99 Specify the use of protocol version 1.
101 Specify the use of protocol version 2.
105 to use IPv4 addresses only.
109 to use IPv6 addresses only.
111 Attempt to continue interrupted transfers rather than overwriting
112 existing partial or complete copies of files.
113 If the partial contents differ from those being transferred,
114 then the resultant file is likely to be corrupt.
115 .It Fl B Ar buffer_size
116 Specify the size of the buffer that
118 uses when transferring files.
119 Larger buffers require fewer round trips at the cost of higher
121 The default is 32768 bytes.
122 .It Fl b Ar batchfile
123 Batch mode reads a series of commands from an input
127 Since it lacks user interaction it should be used in conjunction with
128 non-interactive authentication.
133 may be used to indicate standard input.
135 will abort if any of the following
137 .Ic get , put , reget , reput, rename , ln ,
138 .Ic rm , mkdir , chdir , ls ,
139 .Ic lchdir , chmod , chown ,
140 .Ic chgrp , lpwd , df , symlink ,
143 Termination on error can be suppressed on a command by command basis by
144 prefixing the command with a
146 character (for example,
147 .Ic -rm /tmp/blah* ) .
149 Enables compression (via ssh's
153 Selects the cipher to use for encrypting the data transfers.
154 This option is directly passed to
156 .It Fl D Ar sftp_server_path
157 Connect directly to a local sftp server
160 This option may be useful in debugging the client and server.
161 .It Fl F Ar ssh_config
162 Specifies an alternative
163 per-user configuration file for
165 This option is directly passed to
168 Requests that files be flushed to disk immediately after transfer.
169 When uploading files, this feature is only enabled if the server
170 implements the "fsync@openssh.com" extension.
171 .It Fl i Ar identity_file
172 Selects the file from which the identity (private key) for public key
173 authentication is read.
174 This option is directly passed to
177 Limits the used bandwidth, specified in Kbit/s.
178 .It Fl o Ar ssh_option
179 Can be used to pass options to
181 in the format used in
183 This is useful for specifying options
184 for which there is no separate
187 For example, to specify an alternate port use:
189 For full details of the options listed below, and their possible values, see
192 .Bl -tag -width Ds -offset indent -compact
197 .It CanonicalizeFallbackLocal
198 .It CanonicalizeHostname
199 .It CanonicalizeMaxDots
200 .It CanonicalizePermittedCNAMEs
202 .It ChallengeResponseAuthentication
208 .It ConnectionAttempts
213 .It GlobalKnownHostsFile
214 .It GSSAPIAuthentication
215 .It GSSAPIDelegateCredentials
218 .It HostbasedAuthentication
219 .It HostbasedKeyTypes
220 .It HostKeyAlgorithms
227 .It KbdInteractiveAuthentication
228 .It KbdInteractiveDevices
232 .It NoHostAuthenticationForLocalhost
233 .It NumberOfPasswordPrompts
234 .It PasswordAuthentication
237 .It PreferredAuthentications
241 .It PubkeyAuthentication
243 .It RhostsRSAAuthentication
244 .It RSAAuthentication
246 .It ServerAliveInterval
247 .It ServerAliveCountMax
248 .It StrictHostKeyChecking
251 .It UsePrivilegedPort
253 .It UserKnownHostsFile
257 Specifies the port to connect to on the remote host.
259 Preserves modification times, access times, and modes from the
260 original files transferred.
262 Quiet mode: disables the progress meter as well as warning and
263 diagnostic messages from
265 .It Fl R Ar num_requests
266 Specify how many requests may be outstanding at any one time.
267 Increasing this may slightly improve file transfer speed
268 but will increase memory usage.
269 The default is 64 outstanding requests.
271 Recursively copy entire directories when uploading and downloading.
274 does not follow symbolic links encountered in the tree traversal.
278 to use for the encrypted connection.
279 The program must understand
282 .It Fl s Ar subsystem | sftp_server
283 Specifies the SSH2 subsystem or the path for an sftp server
285 A path is useful for using
287 over protocol version 1, or when the remote
289 does not have an sftp subsystem configured.
292 This option is also passed to ssh.
294 .Sh INTERACTIVE COMMANDS
295 Once in interactive mode,
297 understands a set of commands similar to those of
299 Commands are case insensitive.
300 Pathnames that contain spaces must be enclosed in quotes.
301 Any special characters contained within pathnames that are recognized by
303 must be escaped with backslashes
310 Change remote directory to
312 .It Ic chgrp Ar grp Ar path
320 characters and may match multiple files.
322 must be a numeric GID.
323 .It Ic chmod Ar mode Ar path
324 Change permissions of file
331 characters and may match multiple files.
332 .It Ic chown Ar own Ar path
340 characters and may match multiple files.
342 must be a numeric UID.
347 Display usage information for the filesystem holding the current directory
353 flag is specified, the capacity information will be displayed using
354 "human-readable" suffixes.
357 flag requests display of inode information in addition to capacity information.
358 This command is only supported on servers that implement the
359 .Dq statvfs@openssh.com
371 and store it on the local machine.
373 path name is not specified, it is given the same name it has on the
378 characters and may match multiple files.
383 must specify a directory.
387 flag is specified, then attempt to resume partial transfers of existing files.
388 Note that resumption assumes that any partial copy of the local file matches
390 If the remote file contents differ from the partial local copy then the
391 resultant file is likely to be corrupt.
395 flag is specified, then
397 will be called after the file transfer has completed to flush the file
404 flag is specified, then full file permissions and access times are
409 flag is specified then directories will be copied recursively.
412 does not follow symbolic links when performing recursive transfers.
416 Change local directory to
418 .It Ic lls Op Ar ls-options Op Ar path
419 Display local directory listing of either
421 or current directory if
425 may contain any flags supported by the local system's
431 characters and may match multiple files.
432 .It Ic lmkdir Ar path
433 Create local directory specified by
446 flag is specified the created link is a symbolic link, otherwise it is
449 Print local working directory.
454 Display a remote directory listing of either
456 or the current directory if
462 characters and may match multiple files.
464 The following flags are recognized and alter the behaviour of
469 Produce single columnar output.
471 List files beginning with a dot
474 Do not sort the listing.
475 The default sort order is lexicographical.
477 When used with a long format option, use unit suffixes: Byte, Kilobyte,
478 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
479 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
482 Display additional details including permissions
483 and ownership information.
485 Produce a long listing with user and group information presented
488 Reverse the sort order of the listing.
490 Sort the listing by file size.
492 Sort the listing by last modification time.
494 .It Ic lumask Ar umask
498 Create remote directory specified by
501 Toggle display of progress meter.
509 and store it on the remote machine.
510 If the remote path name is not specified, it is given the same name it has
511 on the local machine.
515 characters and may match multiple files.
520 must specify a directory.
524 flag is specified, then attempt to resume partial
525 transfers of existing files.
526 Note that resumption assumes that any partial copy of the remote file
527 matches the local copy.
528 If the local file contents differ from the remote local copy then
529 the resultant file is likely to be corrupt.
533 flag is specified, then a request will be sent to the server to call
535 after the file has been transferred.
536 Note that this is only supported by servers that implement
537 the "fsync@openssh.com" extension.
543 flag is specified, then full file permissions and access times are
548 flag is specified then directories will be copied recursively.
551 does not follow symbolic links when performing recursive transfers.
553 Display remote working directory.
581 .It Ic rename Ar oldpath Ar newpath
582 Rename remote file from
587 Delete remote file specified by
590 Remove remote directory specified by
592 .It Ic symlink Ar oldpath Ar newpath
593 Create a symbolic link from
601 .It Ic \&! Ns Ar command
606 Escape to local shell.
624 .%T "SSH File Transfer Protocol"
625 .%N draft-ietf-secsh-filexfer-00.txt
627 .%O work in progress material