1 .\" $OpenBSD: sftp.1,v 1.36 2002/09/11 22:41:50 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 o Ar ssh_option
36 .Op Fl s Ar subsystem | sftp_server
37 .Op Fl B Ar buffer_size
38 .Op Fl F Ar ssh_config
39 .Op Fl P Ar sftp_server path
40 .Op Fl R Ar num_requests
44 .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
46 .Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]]
49 is an interactive file transfer program, similar to
51 which performs all operations over an encrypted
54 It may also use many features of ssh, such as public key authentication and
57 connects and logs into the specified
59 then enters an interactive command mode.
61 The second usage format will retrieve files automatically if a non-interactive
62 authentication method is used; otherwise it will do so after
63 successful interactive authentication.
65 The last usage format allows the sftp client to start in a remote directory.
67 The options are as follows:
70 Batch mode reads a series of commands from an input
74 Since it lacks user interaction it should be used in conjunction with
75 non-interactive authentication.
77 will abort if any of the following
79 .Ic get , put , rename , ln ,
80 .Ic rm , mkdir , chdir , lchdir
83 .It Fl o Ar ssh_option
84 Can be used to pass options to
88 This is useful for specifying options
89 for which there is no separate
91 command-line flag. For example, to specify an alternate
94 .It Fl s Ar subsystem | sftp_server
95 Specifies the SSH2 subsystem or the path for an sftp server
96 on the remote host. A path is useful for using sftp over
97 protocol version 1, or when the remote
99 does not have an sftp subsystem configured.
101 Raise logging level. This option is also passed to ssh.
102 .It Fl B Ar buffer_size
103 Specify the size of the buffer that
105 uses when transferring files. Larger buffers require fewer round trips at
106 the cost of higher memory consumption. The default is 32768 bytes.
108 Enables compression (via ssh's
111 .It Fl F Ar ssh_config
112 Specifies an alternative
113 per-user configuration file for
115 This option is directly passed to
117 .It Fl P Ar sftp_server path
118 Connect directly to a local
122 This option may be useful in debugging the client and server.
123 .It Fl R Ar num_requests
124 Specify how many requests may be outstanding at any one time. Increasing
125 this may slightly improve file transfer speed but will increase memory
126 usage. The default is 16 outstanding requests.
130 to use for the encrypted connection.
131 The program must understand
135 Specify the use of protocol version 1.
137 .Sh INTERACTIVE COMMANDS
138 Once in interactive mode,
140 understands a set of commands similar to those of
142 Commands are case insensitive and pathnames may be enclosed in quotes if they
148 Change remote directory to
151 Change local directory to
153 .It Ic chgrp Ar grp Ar path
159 must be a numeric GID.
160 .It Ic chmod Ar mode Ar path
161 Change permissions of file
165 .It Ic chown Ar own Ar path
171 must be a numeric UID.
181 and store it on the local machine.
183 path name is not specified, it is given the same name it has on the
184 remote machine. If the
186 flag is specified, then the file's full permission and access time are
190 .It Ic lls Op Ar ls-options Op Ar path
191 Display local directory listing of either
193 or current directory if
196 .It Ic lmkdir Ar path
197 Create local directory specified by
199 .It Ic ln Ar oldpath Ar newpath
200 Create a symbolic link from
205 Print local working directory.
210 Display remote directory listing of either
212 or current directory if
214 is not specified. If the
216 flag is specified, then display additional details including permissions
217 and ownership information.
218 .It Ic lumask Ar umask
222 Create remote directory specified by
231 and store it on the remote machine. If the remote path name is not
232 specified, it is given the same name it has on the local machine. If the
234 flag is specified, then the file's full permission and access time are
237 Display remote working directory.
240 .It Ic rename Ar oldpath Ar newpath
241 Rename remote file from
246 Remove remote directory specified by
249 Delete remote file specified by
251 .It Ic symlink Ar oldpath Ar newpath
252 Create a symbolic link from
261 Escape to local shell.
266 Damien Miller <djm@mindrot.org>
278 .%T "SSH File Transfer Protocol"
279 .%N draft-ietf-secsh-filexfer-00.txt
281 .%O work in progress material