1 .\" $OpenBSD: sftp.1,v 1.69 2008/12/09 15:35:00 sobrado 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: December 9 2008 $
30 .Nd secure file transfer program
35 .Op Fl B Ar buffer_size
37 .Op Fl F Ar ssh_config
38 .Op Fl o Ar ssh_option
39 .Op Fl P Ar sftp_server_path
40 .Op Fl R Ar num_requests
42 .Op Fl s Ar subsystem | sftp_server
46 .Oo Ar user Ns @ Oc Ns
47 .Ar host Ns Op : Ns Ar
49 .Oo Ar user Ns @ Oc Ns
50 .Ar host Ns Oo : Ns Ar dir Ns
54 .Oo Ar user Ns @ Oc Ns Ar host
57 is an interactive file transfer program, similar to
59 which performs all operations over an encrypted
62 It may also use many features of ssh, such as public key authentication and
65 connects and logs into the specified
67 then enters an interactive command mode.
69 The second usage format will retrieve files automatically if a non-interactive
70 authentication method is used; otherwise it will do so after
71 successful interactive authentication.
73 The third usage format allows
75 to start in a remote directory.
77 The final usage format allows for automated sessions using the
80 In such cases, it is necessary to configure non-interactive authentication
81 to obviate the need to enter a password at connection time (see
86 The options are as follows:
89 Specify the use of protocol version 1.
90 .It Fl B Ar buffer_size
91 Specify the size of the buffer that
93 uses when transferring files.
94 Larger buffers require fewer round trips at the cost of higher
96 The default is 32768 bytes.
98 Batch mode reads a series of commands from an input
102 Since it lacks user interaction it should be used in conjunction with
103 non-interactive authentication.
108 may be used to indicate standard input.
110 will abort if any of the following
112 .Ic get , put , rename , ln ,
113 .Ic rm , mkdir , chdir , ls ,
114 .Ic lchdir , chmod , chown ,
115 .Ic chgrp , lpwd , df ,
118 Termination on error can be suppressed on a command by command basis by
119 prefixing the command with a
121 character (for example,
122 .Ic -rm /tmp/blah* ) .
124 Enables compression (via ssh's
127 .It Fl F Ar ssh_config
128 Specifies an alternative
129 per-user configuration file for
131 This option is directly passed to
133 .It Fl o Ar ssh_option
134 Can be used to pass options to
136 in the format used in
138 This is useful for specifying options
139 for which there is no separate
142 For example, to specify an alternate port use:
144 For full details of the options listed below, and their possible values, see
147 .Bl -tag -width Ds -offset indent -compact
151 .It ChallengeResponseAuthentication
157 .It ConnectionAttempts
161 .It GlobalKnownHostsFile
162 .It GSSAPIAuthentication
163 .It GSSAPIDelegateCredentials
166 .It HostbasedAuthentication
167 .It HostKeyAlgorithms
172 .It KbdInteractiveDevices
175 .It NoHostAuthenticationForLocalhost
176 .It NumberOfPasswordPrompts
177 .It PasswordAuthentication
179 .It PreferredAuthentications
182 .It PubkeyAuthentication
184 .It RhostsRSAAuthentication
185 .It RSAAuthentication
187 .It ServerAliveInterval
188 .It ServerAliveCountMax
190 .It StrictHostKeyChecking
192 .It UsePrivilegedPort
194 .It UserKnownHostsFile
197 .It Fl P Ar sftp_server_path
198 Connect directly to a local sftp server
201 This option may be useful in debugging the client and server.
202 .It Fl R Ar num_requests
203 Specify how many requests may be outstanding at any one time.
204 Increasing this may slightly improve file transfer speed
205 but will increase memory usage.
206 The default is 256 outstanding requests providing for 8MB
207 of outstanding data with a 32KB buffer.
211 to use for the encrypted connection.
212 The program must understand
215 .It Fl s Ar subsystem | sftp_server
216 Specifies the SSH2 subsystem or the path for an sftp server
218 A path is useful for using
220 over protocol version 1, or when the remote
222 does not have an sftp subsystem configured.
225 This option is also passed to ssh.
227 .Sh INTERACTIVE COMMANDS
228 Once in interactive mode,
230 understands a set of commands similar to those of
232 Commands are case insensitive.
233 Pathnames that contain spaces must be enclosed in quotes.
234 Any special characters contained within pathnames that are recognized by
236 must be escaped with backslashes
243 Change remote directory to
245 .It Ic chgrp Ar grp Ar path
253 characters and may match multiple files.
255 must be a numeric GID.
256 .It Ic chmod Ar mode Ar path
257 Change permissions of file
264 characters and may match multiple files.
265 .It Ic chown Ar own Ar path
273 characters and may match multiple files.
275 must be a numeric UID.
280 Display usage information for the filesystem holding the current directory
286 flag is specified, the capacity information will be displayed using
287 "human-readable" suffixes.
290 flag requests display of inode information in addition to capacity information.
291 This command is only supported on servers that implement the
292 .Dq statvfs@openssh.com
304 and store it on the local machine.
306 path name is not specified, it is given the same name it has on the
311 characters and may match multiple files.
316 must specify a directory.
319 flag is specified, then full file permissions and access times are
324 Change local directory to
326 .It Ic lls Op Ar ls-options Op Ar path
327 Display local directory listing of either
329 or current directory if
333 may contain any flags supported by the local system's
339 characters and may match multiple files.
340 .It Ic lmkdir Ar path
341 Create local directory specified by
343 .It Ic ln Ar oldpath Ar newpath
344 Create a symbolic link from
349 Print local working directory.
354 Display a remote directory listing of either
356 or the current directory if
362 characters and may match multiple files.
364 The following flags are recognized and alter the behaviour of
369 Produce single columnar output.
371 List files beginning with a dot
374 Do not sort the listing.
375 The default sort order is lexicographical.
377 Display additional details including permissions
378 and ownership information.
380 Produce a long listing with user and group information presented
383 Reverse the sort order of the listing.
385 Sort the listing by file size.
387 Sort the listing by last modification time.
389 .It Ic lumask Ar umask
393 Create remote directory specified by
396 Toggle display of progress meter.
404 and store it on the remote machine.
405 If the remote path name is not specified, it is given the same name it has
406 on the local machine.
410 characters and may match multiple files.
415 must specify a directory.
418 flag is specified, then the file's full permission and access time are
421 Display remote working directory.
425 .It Ic rename Ar oldpath Ar newpath
426 Rename remote file from
431 Delete remote file specified by
434 Remove remote directory specified by
436 .It Ic symlink Ar oldpath Ar newpath
437 Create a symbolic link from
445 .It Ic \&! Ns Ar command
450 Escape to local shell.
468 .%T "SSH File Transfer Protocol"
469 .%N draft-ietf-secsh-filexfer-00.txt
471 .%O work in progress material