1 .\" $OpenBSD: sftp.1,v 1.57 2004/06/21 22:41:31 djm 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.
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 Oo Ar user Ns @ Oc Ns
47 .Ar host Ns Oo : Ns Ar file Oo
50 .Oo Oo Ar user Ns @ Oc Ns
51 .Ar host Ns Oo : Ns Ar dir Ns
55 .Oo Ar user Ns @ Oc Ns Ar host
58 is an interactive file transfer program, similar to
60 which performs all operations over an encrypted
63 It may also use many features of ssh, such as public key authentication and
66 connects and logs into the specified
68 then enters an interactive command mode.
70 The second usage format will retrieve files automatically if a non-interactive
71 authentication method is used; otherwise it will do so after
72 successful interactive authentication.
74 The third usage format allows the sftp client to start in a remote directory.
76 The final usage format allows for automated sessions using the
79 In such cases, it is usually necessary to configure public key authentication
80 to obviate the need to enter a password at connection time (see
85 The options are as follows:
88 Specify the use of protocol version 1.
89 .It Fl B Ar buffer_size
90 Specify the size of the buffer that
92 uses when transferring files.
93 Larger buffers require fewer round trips at the cost of higher
95 The default is 32768 bytes.
97 Batch mode reads a series of commands from an input
101 Since it lacks user interaction it should be used in conjunction with
102 non-interactive authentication.
107 may be used to indicate standard input.
109 will abort if any of the following
111 .Ic get , put , rename , ln ,
112 .Ic rm , mkdir , chdir , ls ,
113 .Ic lchdir , chmod , chown , chgrp , lpwd
116 Termination on error can be suppressed on a command by command basis by
117 prefixing the command with a
119 character (for example,
120 .Ic -rm /tmp/blah* ) .
122 Enables compression (via ssh's
125 .It Fl F Ar ssh_config
126 Specifies an alternative
127 per-user configuration file for
129 This option is directly passed to
131 .It Fl o Ar ssh_option
132 Can be used to pass options to
134 in the format used in
136 This is useful for specifying options
137 for which there is no separate
140 For example, to specify an alternate port use:
142 For full details of the options listed below, and their possible values, see
145 .Bl -tag -width Ds -offset indent -compact
149 .It ChallengeResponseAuthentication
155 .It ConnectionAttempts
159 .It GlobalKnownHostsFile
160 .It GSSAPIAuthentication
161 .It GSSAPIDelegateCredentials
163 .It HostbasedAuthentication
164 .It HostKeyAlgorithms
171 .It NoHostAuthenticationForLocalhost
172 .It NumberOfPasswordPrompts
173 .It PasswordAuthentication
175 .It PreferredAuthentications
178 .It PubkeyAuthentication
179 .It RhostsRSAAuthentication
180 .It RSAAuthentication
182 .It ServerAliveInterval
183 .It ServerAliveCountMax
185 .It StrictHostKeyChecking
187 .It UsePrivilegedPort
189 .It UserKnownHostsFile
192 .It Fl P Ar sftp_server_path
193 Connect directly to a local sftp server
196 This option may be useful in debugging the client and server.
197 .It Fl R Ar num_requests
198 Specify how many requests may be outstanding at any one time.
199 Increasing this may slightly improve file transfer speed
200 but will increase memory usage.
201 The default is 16 outstanding requests.
205 to use for the encrypted connection.
206 The program must understand
209 .It Fl s Ar subsystem | sftp_server
210 Specifies the SSH2 subsystem or the path for an sftp server
212 A path is useful for using
214 over protocol version 1, or when the remote
216 does not have an sftp subsystem configured.
219 This option is also passed to ssh.
221 .Sh INTERACTIVE COMMANDS
222 Once in interactive mode,
224 understands a set of commands similar to those of
226 Commands are case insensitive and pathnames may be enclosed in quotes if they
228 .Bl -tag -width "lmdir path"
233 Change remote directory to
235 .It Ic chgrp Ar grp Ar path
241 must be a numeric GID.
242 .It Ic chmod Ar mode Ar path
243 Change permissions of file
247 .It Ic chown Ar own Ar path
253 must be a numeric UID.
264 and store it on the local machine.
266 path name is not specified, it is given the same name it has on the
270 flag is specified, then the file's full permission and access time are
275 Change local directory to
277 .It Ic lls Op Ar ls-options Op Ar path
278 Display local directory listing of either
280 or current directory if
283 .It Ic lmkdir Ar path
284 Create local directory specified by
286 .It Ic ln Ar oldpath Ar newpath
287 Create a symbolic link from
292 Print local working directory.
297 Display remote directory listing of either
299 or current directory if
304 flag is specified, then display additional details including permissions
305 and ownership information.
308 flag will produce a long listing with user and group information presented
313 listings are sorted in lexicographical order.
314 This may be changed by specifying the
318 (sort by last modification time), or
320 (don't sort at all) flags.
321 Additionally, the sort order may be reversed using the
324 .It Ic lumask Ar umask
328 Create remote directory specified by
331 Toggle display of progress meter.
339 and store it on the remote machine.
340 If the remote path name is not specified, it is given the same name it has
341 on the local machine.
344 flag is specified, then the file's full permission and access time are
347 Display remote working directory.
351 .It Ic rename Ar oldpath Ar newpath
352 Rename remote file from
357 Delete remote file specified by
360 Remove remote directory specified by
362 .It Ic symlink Ar oldpath Ar newpath
363 Create a symbolic link from
371 .It Ic \&! Ar command
376 Escape to local shell.
392 .%T "SSH File Transfer Protocol"
393 .%N draft-ietf-secsh-filexfer-00.txt
395 .%O work in progress material