1 .\" $OpenBSD: sftp.1,v 1.88 2010/12/04 00:18:01 djm Exp $
4 .\" Copyright (c) 2001 Damien Miller. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 .Nd secure file transfer program
36 .Op Fl B Ar buffer_size
39 .Op Fl D Ar sftp_server_path
40 .Op Fl F Ar ssh_config
41 .Op Fl i Ar identity_file
43 .Op Fl o Ar ssh_option
45 .Op Fl R Ar num_requests
47 .Op Fl s Ar subsystem | sftp_server
51 .Oo Ar user Ns @ Oc Ns
52 .Ar host Ns Op : Ns Ar
56 .Ar host Ns Oo : Ns Ar dir Ns
61 .Oo Ar user Ns @ Oc Ns Ar host
64 is an interactive file transfer program, similar to
66 which performs all operations over an encrypted
69 It may also use many features of ssh, such as public key authentication and
72 connects and logs into the specified
74 then enters an interactive command mode.
76 The second usage format will retrieve files automatically if a non-interactive
77 authentication method is used; otherwise it will do so after
78 successful interactive authentication.
80 The third usage format allows
82 to start in a remote directory.
84 The final usage format allows for automated sessions using the
87 In such cases, it is necessary to configure non-interactive authentication
88 to obviate the need to enter a password at connection time (see
93 The options are as follows:
96 Specify the use of protocol version 1.
98 Specify the use of protocol version 2.
102 to use IPv4 addresses only.
106 to use IPv6 addresses only.
107 .It Fl B Ar buffer_size
108 Specify the size of the buffer that
110 uses when transferring files.
111 Larger buffers require fewer round trips at the cost of higher
113 The default is 32768 bytes.
114 .It Fl b Ar batchfile
115 Batch mode reads a series of commands from an input
119 Since it lacks user interaction it should be used in conjunction with
120 non-interactive authentication.
125 may be used to indicate standard input.
127 will abort if any of the following
129 .Ic get , put , rename , ln ,
130 .Ic rm , mkdir , chdir , ls ,
131 .Ic lchdir , chmod , chown ,
132 .Ic chgrp , lpwd , df , symlink ,
135 Termination on error can be suppressed on a command by command basis by
136 prefixing the command with a
138 character (for example,
139 .Ic -rm /tmp/blah* ) .
141 Enables compression (via ssh's
145 Selects the cipher to use for encrypting the data transfers.
146 This option is directly passed to
148 .It Fl D Ar sftp_server_path
149 Connect directly to a local sftp server
152 This option may be useful in debugging the client and server.
153 .It Fl F Ar ssh_config
154 Specifies an alternative
155 per-user configuration file for
157 This option is directly passed to
159 .It Fl i Ar identity_file
160 Selects the file from which the identity (private key) for public key
161 authentication is read.
162 This option is directly passed to
165 Limits the used bandwidth, specified in Kbit/s.
166 .It Fl o Ar ssh_option
167 Can be used to pass options to
169 in the format used in
171 This is useful for specifying options
172 for which there is no separate
175 For example, to specify an alternate port use:
177 For full details of the options listed below, and their possible values, see
180 .Bl -tag -width Ds -offset indent -compact
184 .It ChallengeResponseAuthentication
190 .It ConnectionAttempts
194 .It GlobalKnownHostsFile
195 .It GSSAPIAuthentication
196 .It GSSAPIDelegateCredentials
199 .It HostbasedAuthentication
200 .It HostKeyAlgorithms
206 .It KbdInteractiveDevices
210 .It NoHostAuthenticationForLocalhost
211 .It NumberOfPasswordPrompts
212 .It PasswordAuthentication
215 .It PreferredAuthentications
218 .It PubkeyAuthentication
220 .It RhostsRSAAuthentication
221 .It RSAAuthentication
223 .It ServerAliveInterval
224 .It ServerAliveCountMax
225 .It StrictHostKeyChecking
227 .It UsePrivilegedPort
229 .It UserKnownHostsFile
233 Specifies the port to connect to on the remote host.
235 Preserves modification times, access times, and modes from the
236 original files transferred.
238 Quiet mode: disables the progress meter as well as warning and
239 diagnostic messages from
241 .It Fl R Ar num_requests
242 Specify how many requests may be outstanding at any one time.
243 Increasing this may slightly improve file transfer speed
244 but will increase memory usage.
245 The default is 256 outstanding requests providing for 8MB
246 of outstanding data with a 32KB buffer.
248 Recursively copy entire directories when uploading and downloading.
251 does not follow symbolic links encountered in the tree traversal.
255 to use for the encrypted connection.
256 The program must understand
259 .It Fl s Ar subsystem | sftp_server
260 Specifies the SSH2 subsystem or the path for an sftp server
262 A path is useful for using
264 over protocol version 1, or when the remote
266 does not have an sftp subsystem configured.
269 This option is also passed to ssh.
271 .Sh INTERACTIVE COMMANDS
272 Once in interactive mode,
274 understands a set of commands similar to those of
276 Commands are case insensitive.
277 Pathnames that contain spaces must be enclosed in quotes.
278 Any special characters contained within pathnames that are recognized by
280 must be escaped with backslashes
287 Change remote directory to
289 .It Ic chgrp Ar grp Ar path
297 characters and may match multiple files.
299 must be a numeric GID.
300 .It Ic chmod Ar mode Ar path
301 Change permissions of file
308 characters and may match multiple files.
309 .It Ic chown Ar own Ar path
317 characters and may match multiple files.
319 must be a numeric UID.
324 Display usage information for the filesystem holding the current directory
330 flag is specified, the capacity information will be displayed using
331 "human-readable" suffixes.
334 flag requests display of inode information in addition to capacity information.
335 This command is only supported on servers that implement the
336 .Dq statvfs@openssh.com
348 and store it on the local machine.
350 path name is not specified, it is given the same name it has on the
355 characters and may match multiple files.
360 must specify a directory.
366 flag is specified, then full file permissions and access times are
371 flag is specified then directories will be copied recursively.
374 does not follow symbolic links when performing recursive transfers.
378 Change local directory to
380 .It Ic lls Op Ar ls-options Op Ar path
381 Display local directory listing of either
383 or current directory if
387 may contain any flags supported by the local system's
393 characters and may match multiple files.
394 .It Ic lmkdir Ar path
395 Create local directory specified by
408 flag is specified the created link is a symbolic link, otherwise it is
411 Print local working directory.
416 Display a remote directory listing of either
418 or the current directory if
424 characters and may match multiple files.
426 The following flags are recognized and alter the behaviour of
431 Produce single columnar output.
433 List files beginning with a dot
436 Do not sort the listing.
437 The default sort order is lexicographical.
439 When used with a long format option, use unit suffixes: Byte, Kilobyte,
440 Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
441 the number of digits to four or fewer using powers of 2 for sizes (K=1024,
444 Display additional details including permissions
445 and ownership information.
447 Produce a long listing with user and group information presented
450 Reverse the sort order of the listing.
452 Sort the listing by file size.
454 Sort the listing by last modification time.
456 .It Ic lumask Ar umask
460 Create remote directory specified by
463 Toggle display of progress meter.
471 and store it on the remote machine.
472 If the remote path name is not specified, it is given the same name it has
473 on the local machine.
477 characters and may match multiple files.
482 must specify a directory.
488 flag is specified, then full file permissions and access times are
493 flag is specified then directories will be copied recursively.
496 does not follow symbolic links when performing recursive transfers.
498 Display remote working directory.
502 .It Ic rename Ar oldpath Ar newpath
503 Rename remote file from
508 Delete remote file specified by
511 Remove remote directory specified by
513 .It Ic symlink Ar oldpath Ar newpath
514 Create a symbolic link from
522 .It Ic \&! Ns Ar command
527 Escape to local shell.
545 .%T "SSH File Transfer Protocol"
546 .%N draft-ietf-secsh-filexfer-00.txt
548 .%O work in progress material