]>
Commit | Line | Data |
---|---|---|
99be0775 | 1 | .\" $OpenBSD: sftp.1,v 1.52 2004/03/05 10:53:58 markus Exp $ |
3c0ef626 | 2 | .\" |
3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. | |
4 | .\" | |
5 | .\" Redistribution and use in source and binary forms, with or without | |
6 | .\" modification, are permitted provided that the following conditions | |
7 | .\" are met: | |
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. | |
13 | .\" | |
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. | |
24 | .\" | |
25 | .Dd February 4, 2001 | |
26 | .Dt SFTP 1 | |
27 | .Os | |
28 | .Sh NAME | |
29 | .Nm sftp | |
0fff78ff | 30 | .Nd secure file transfer program |
3c0ef626 | 31 | .Sh SYNOPSIS |
32 | .Nm sftp | |
6a9b3198 | 33 | .Bk -words |
cdd66111 | 34 | .Op Fl 1Cv |
9cb1827b | 35 | .Op Fl B Ar buffer_size |
cdd66111 | 36 | .Op Fl b Ar batchfile |
9cb1827b | 37 | .Op Fl F Ar ssh_config |
cdd66111 | 38 | .Op Fl o Ar ssh_option |
39 | .Op Fl P Ar sftp_server_path | |
e9a17296 | 40 | .Op Fl R Ar num_requests |
3c0ef626 | 41 | .Op Fl S Ar program |
cdd66111 | 42 | .Op Fl s Ar subsystem | sftp_server |
3c0ef626 | 43 | .Ar host |
6a9b3198 | 44 | .Ek |
3c0ef626 | 45 | .Nm sftp |
0fff78ff | 46 | .Oo Oo Ar user Ns @ Oc Ns |
6a9b3198 | 47 | .Ar host Ns Oo : Ns Ar file Oo |
48 | .Ar file Oc Oc Oc | |
3c0ef626 | 49 | .Nm sftp |
0fff78ff | 50 | .Oo Oo Ar user Ns @ Oc Ns |
6a9b3198 | 51 | .Ar host Ns Oo : Ns Ar dir Ns |
52 | .Oo Ar / Oc Oc Oc | |
0fff78ff | 53 | .Nm sftp |
54 | .Fl b Ar batchfile | |
55 | .Oo Ar user Ns @ Oc Ns Ar host | |
3c0ef626 | 56 | .Sh DESCRIPTION |
57 | .Nm | |
58 | is an interactive file transfer program, similar to | |
59 | .Xr ftp 1 , | |
60 | which performs all operations over an encrypted | |
61 | .Xr ssh 1 | |
62 | transport. | |
63 | It may also use many features of ssh, such as public key authentication and | |
64 | compression. | |
65 | .Nm | |
66 | connects and logs into the specified | |
67 | .Ar host , | |
68 | then enters an interactive command mode. | |
69 | .Pp | |
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. | |
73 | .Pp | |
0fff78ff | 74 | The third usage format allows the sftp client to start in a remote directory. |
3c0ef626 | 75 | .Pp |
0fff78ff | 76 | The final usage format allows for automated sessions using the |
77 | .Fl b | |
78 | option. | |
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 | |
81 | .Xr sshd 8 | |
82 | and | |
83 | .Xr ssh-keygen 1 | |
84 | for details). | |
3c0ef626 | 85 | The options are as follows: |
86 | .Bl -tag -width Ds | |
cdd66111 | 87 | .It Fl 1 |
88 | Specify the use of protocol version 1. | |
89 | .It Fl B Ar buffer_size | |
90 | Specify the size of the buffer that | |
91 | .Nm | |
92 | uses when transferring files. | |
93 | Larger buffers require fewer round trips at the cost of higher | |
94 | memory consumption. | |
95 | The default is 32768 bytes. | |
3c0ef626 | 96 | .It Fl b Ar batchfile |
97 | Batch mode reads a series of commands from an input | |
98 | .Ar batchfile | |
99 | instead of | |
100 | .Em stdin . | |
101 | Since it lacks user interaction it should be used in conjunction with | |
102 | non-interactive authentication. | |
cdd66111 | 103 | A |
104 | .Ar batchfile | |
105 | of | |
106 | .Sq \- | |
107 | may be used to indicate standard input. | |
3c0ef626 | 108 | .Nm |
109 | will abort if any of the following | |
110 | commands fail: | |
e9a17296 | 111 | .Ic get , put , rename , ln , |
6a9b3198 | 112 | .Ic rm , mkdir , chdir , ls , |
113 | .Ic lchdir , chmod , chown , chgrp , lpwd | |
3c0ef626 | 114 | and |
115 | .Ic lmkdir . | |
6a9b3198 | 116 | Termination on error can be suppressed on a command by command basis by |
117 | prefixing the command with a | |
cdd66111 | 118 | .Sq \- |
0fff78ff | 119 | character (for example, |
120 | .Ic -rm /tmp/blah* ) . | |
cdd66111 | 121 | .It Fl C |
122 | Enables compression (via ssh's | |
123 | .Fl C | |
124 | flag). | |
125 | .It Fl F Ar ssh_config | |
126 | Specifies an alternative | |
127 | per-user configuration file for | |
128 | .Xr ssh 1 . | |
129 | This option is directly passed to | |
130 | .Xr ssh 1 . | |
3c0ef626 | 131 | .It Fl o Ar ssh_option |
132 | Can be used to pass options to | |
133 | .Nm ssh | |
f5799ae1 | 134 | in the format used in |
135 | .Xr ssh_config 5 . | |
136 | This is useful for specifying options | |
3c0ef626 | 137 | for which there is no separate |
138 | .Nm sftp | |
0fff78ff | 139 | command-line flag. |
140 | For example, to specify an alternate port use: | |
3c0ef626 | 141 | .Ic sftp -oPort=24 . |
cdd66111 | 142 | For full details of the options listed below, and their possible values, see |
143 | .Xr ssh_config 5 . | |
144 | .Pp | |
145 | .Bl -tag -width Ds -offset indent -compact | |
146 | .It AddressFamily | |
147 | .It BatchMode | |
148 | .It BindAddress | |
149 | .It ChallengeResponseAuthentication | |
150 | .It CheckHostIP | |
151 | .It Cipher | |
152 | .It Ciphers | |
153 | .It Compression | |
154 | .It CompressionLevel | |
155 | .It ConnectionAttempts | |
156 | .It ConnectionTimeout | |
157 | .It GlobalKnownHostsFile | |
158 | .It GSSAPIAuthentication | |
159 | .It GSSAPIDelegateCredentials | |
160 | .It Host | |
161 | .It HostbasedAuthentication | |
162 | .It HostKeyAlgorithms | |
163 | .It HostKeyAlias | |
164 | .It HostName | |
165 | .It IdentityFile | |
99be0775 | 166 | .It IdentitiesOnly |
cdd66111 | 167 | .It LogLevel |
168 | .It MACs | |
169 | .It NoHostAuthenticationForLocalhost | |
170 | .It NumberOfPasswordPrompts | |
171 | .It PasswordAuthentication | |
172 | .It Port | |
173 | .It PreferredAuthentications | |
174 | .It Protocol | |
175 | .It ProxyCommand | |
176 | .It PubkeyAuthentication | |
177 | .It RhostsRSAAuthentication | |
178 | .It RSAAuthentication | |
179 | .It ServerAliveInterval | |
180 | .It ServerAliveCountMax | |
181 | .It SmartcardDevice | |
182 | .It StrictHostKeyChecking | |
183 | .It TCPKeepAlive | |
184 | .It UsePrivilegedPort | |
185 | .It User | |
186 | .It UserKnownHostsFile | |
187 | .It VerifyHostKeyDNS | |
188 | .El | |
189 | .It Fl P Ar sftp_server_path | |
0fff78ff | 190 | Connect directly to a local sftp server |
e9a17296 | 191 | (rather than via |
0fff78ff | 192 | .Xr ssh 1 ) |
e9a17296 | 193 | This option may be useful in debugging the client and server. |
194 | .It Fl R Ar num_requests | |
0fff78ff | 195 | Specify how many requests may be outstanding at any one time. |
196 | Increasing this may slightly improve file transfer speed | |
197 | but will increase memory usage. | |
198 | The default is 16 outstanding requests. | |
3c0ef626 | 199 | .It Fl S Ar program |
200 | Name of the | |
201 | .Ar program | |
202 | to use for the encrypted connection. | |
203 | The program must understand | |
204 | .Xr ssh 1 | |
205 | options. | |
cdd66111 | 206 | .It Fl s Ar subsystem | sftp_server |
207 | Specifies the SSH2 subsystem or the path for an sftp server | |
208 | on the remote host. | |
209 | A path is useful for using | |
210 | .Nm | |
211 | over protocol version 1, or when the remote | |
212 | .Xr sshd 8 | |
213 | does not have an sftp subsystem configured. | |
214 | .It Fl v | |
215 | Raise logging level. | |
216 | This option is also passed to ssh. | |
3c0ef626 | 217 | .El |
218 | .Sh INTERACTIVE COMMANDS | |
219 | Once in interactive mode, | |
220 | .Nm | |
221 | understands a set of commands similar to those of | |
222 | .Xr ftp 1 . | |
223 | Commands are case insensitive and pathnames may be enclosed in quotes if they | |
224 | contain spaces. | |
cdd66111 | 225 | .Bl -tag -width "lmdir path" |
3c0ef626 | 226 | .It Ic bye |
0fff78ff | 227 | Quit |
228 | .Nm sftp . | |
3c0ef626 | 229 | .It Ic cd Ar path |
230 | Change remote directory to | |
231 | .Ar path . | |
3c0ef626 | 232 | .It Ic chgrp Ar grp Ar path |
233 | Change group of file | |
234 | .Ar path | |
235 | to | |
236 | .Ar grp . | |
237 | .Ar grp | |
238 | must be a numeric GID. | |
239 | .It Ic chmod Ar mode Ar path | |
240 | Change permissions of file | |
241 | .Ar path | |
242 | to | |
243 | .Ar mode . | |
244 | .It Ic chown Ar own Ar path | |
245 | Change owner of file | |
246 | .Ar path | |
247 | to | |
248 | .Ar own . | |
249 | .Ar own | |
250 | must be a numeric UID. | |
251 | .It Ic exit | |
0fff78ff | 252 | Quit |
253 | .Nm sftp . | |
3c0ef626 | 254 | .It Xo Ic get |
255 | .Op Ar flags | |
256 | .Ar remote-path | |
257 | .Op Ar local-path | |
258 | .Xc | |
259 | Retrieve the | |
260 | .Ar remote-path | |
261 | and store it on the local machine. | |
262 | If the local | |
263 | path name is not specified, it is given the same name it has on the | |
0fff78ff | 264 | remote machine. |
265 | If the | |
3c0ef626 | 266 | .Fl P |
267 | flag is specified, then the file's full permission and access time are | |
268 | copied too. | |
269 | .It Ic help | |
270 | Display help text. | |
cdd66111 | 271 | .It Ic lcd Ar path |
272 | Change local directory to | |
273 | .Ar path . | |
3c0ef626 | 274 | .It Ic lls Op Ar ls-options Op Ar path |
275 | Display local directory listing of either | |
276 | .Ar path | |
277 | or current directory if | |
278 | .Ar path | |
279 | is not specified. | |
280 | .It Ic lmkdir Ar path | |
281 | Create local directory specified by | |
282 | .Ar path . | |
283 | .It Ic ln Ar oldpath Ar newpath | |
284 | Create a symbolic link from | |
285 | .Ar oldpath | |
286 | to | |
287 | .Ar newpath . | |
288 | .It Ic lpwd | |
289 | Print local working directory. | |
41b2f314 | 290 | .It Xo Ic ls |
291 | .Op Ar flags | |
292 | .Op Ar path | |
293 | .Xc | |
3c0ef626 | 294 | Display remote directory listing of either |
295 | .Ar path | |
296 | or current directory if | |
297 | .Ar path | |
0fff78ff | 298 | is not specified. |
299 | If the | |
41b2f314 | 300 | .Fl l |
301 | flag is specified, then display additional details including permissions | |
302 | and ownership information. | |
3c0ef626 | 303 | .It Ic lumask Ar umask |
304 | Set local umask to | |
305 | .Ar umask . | |
306 | .It Ic mkdir Ar path | |
307 | Create remote directory specified by | |
308 | .Ar path . | |
6a9b3198 | 309 | .It Ic progress |
310 | Toggle display of progress meter. | |
3c0ef626 | 311 | .It Xo Ic put |
312 | .Op Ar flags | |
313 | .Ar local-path | |
6a9b3198 | 314 | .Op Ar remote-path |
3c0ef626 | 315 | .Xc |
316 | Upload | |
317 | .Ar local-path | |
0fff78ff | 318 | and store it on the remote machine. |
319 | If the remote path name is not specified, it is given the same name it has | |
320 | on the local machine. | |
321 | If the | |
3c0ef626 | 322 | .Fl P |
323 | flag is specified, then the file's full permission and access time are | |
324 | copied too. | |
325 | .It Ic pwd | |
326 | Display remote working directory. | |
327 | .It Ic quit | |
0fff78ff | 328 | Quit |
329 | .Nm sftp . | |
3c0ef626 | 330 | .It Ic rename Ar oldpath Ar newpath |
331 | Rename remote file from | |
332 | .Ar oldpath | |
333 | to | |
334 | .Ar newpath . | |
9cb1827b | 335 | .It Ic rm Ar path |
336 | Delete remote file specified by | |
337 | .Ar path . | |
cdd66111 | 338 | .It Ic rmdir Ar path |
339 | Remove remote directory specified by | |
340 | .Ar path . | |
3c0ef626 | 341 | .It Ic symlink Ar oldpath Ar newpath |
342 | Create a symbolic link from | |
343 | .Ar oldpath | |
344 | to | |
345 | .Ar newpath . | |
6a9b3198 | 346 | .It Ic version |
347 | Display the | |
348 | .Nm | |
349 | protocol version. | |
0fff78ff | 350 | .It Ic \&! Ar command |
3c0ef626 | 351 | Execute |
352 | .Ar command | |
353 | in local shell. | |
0fff78ff | 354 | .It Ic \&! |
3c0ef626 | 355 | Escape to local shell. |
0fff78ff | 356 | .It Ic \&? |
3c0ef626 | 357 | Synonym for help. |
358 | .El | |
3c0ef626 | 359 | .Sh SEE ALSO |
cdd66111 | 360 | .Xr ftp 1 , |
3c0ef626 | 361 | .Xr scp 1 , |
362 | .Xr ssh 1 , | |
363 | .Xr ssh-add 1 , | |
364 | .Xr ssh-keygen 1 , | |
f5799ae1 | 365 | .Xr ssh_config 5 , |
3c0ef626 | 366 | .Xr sftp-server 8 , |
367 | .Xr sshd 8 | |
368 | .Rs | |
369 | .%A T. Ylonen | |
370 | .%A S. Lehtinen | |
371 | .%T "SSH File Transfer Protocol" | |
372 | .%N draft-ietf-secsh-filexfer-00.txt | |
373 | .%D January 2001 | |
374 | .%O work in progress material | |
375 | .Re |