]>
Commit | Line | Data |
---|---|---|
927fcba2 | 1 | .\" $OpenBSD: sftp.1,v 1.54 2004/05/02 23:02:17 dtucker Exp $ |
61e96248 | 2 | .\" |
f3c7c613 | 3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
61e96248 | 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 | .\" | |
317611b5 | 25 | .Dd February 4, 2001 |
61e96248 | 26 | .Dt SFTP 1 |
27 | .Os | |
28 | .Sh NAME | |
29 | .Nm sftp | |
bd47824b | 30 | .Nd secure file transfer program |
61e96248 | 31 | .Sh SYNOPSIS |
72c5fe79 | 32 | .Nm sftp |
a4e5acef | 33 | .Bk -words |
433e60ac | 34 | .Op Fl 1Cv |
7d5e8c46 | 35 | .Op Fl B Ar buffer_size |
433e60ac | 36 | .Op Fl b Ar batchfile |
7d5e8c46 | 37 | .Op Fl F Ar ssh_config |
433e60ac | 38 | .Op Fl o Ar ssh_option |
39 | .Op Fl P Ar sftp_server_path | |
c25d3df7 | 40 | .Op Fl R Ar num_requests |
e3c1c3e6 | 41 | .Op Fl S Ar program |
433e60ac | 42 | .Op Fl s Ar subsystem | sftp_server |
e3c1c3e6 | 43 | .Ar host |
a4e5acef | 44 | .Ek |
72c5fe79 | 45 | .Nm sftp |
d0445371 | 46 | .Oo Oo Ar user Ns @ Oc Ns |
a4e5acef | 47 | .Ar host Ns Oo : Ns Ar file Oo |
48 | .Ar file Oc Oc Oc | |
72c5fe79 | 49 | .Nm sftp |
d0445371 | 50 | .Oo Oo Ar user Ns @ Oc Ns |
a4e5acef | 51 | .Ar host Ns Oo : Ns Ar dir Ns |
52 | .Oo Ar / Oc Oc Oc | |
72c5fe79 | 53 | .Nm sftp |
81466908 | 54 | .Fl b Ar batchfile |
d0445371 | 55 | .Oo Ar user Ns @ Oc Ns Ar host |
61e96248 | 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 | |
cf7ff074 | 67 | .Ar host , |
61e96248 | 68 | then enters an interactive command mode. |
69 | .Pp | |
3730bb22 | 70 | The second usage format will retrieve files automatically if a non-interactive |
cf7ff074 | 71 | authentication method is used; otherwise it will do so after |
72 | successful interactive authentication. | |
edeeab1e | 73 | .Pp |
81466908 | 74 | The third usage format allows the sftp client to start in a remote directory. |
edeeab1e | 75 | .Pp |
bd47824b | 76 | The final usage format allows for automated sessions using the |
81466908 | 77 | .Fl b |
bd47824b | 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 | |
81466908 | 81 | .Xr sshd 8 |
72c5fe79 | 82 | and |
81466908 | 83 | .Xr ssh-keygen 1 |
bd47824b | 84 | for details). |
61e96248 | 85 | The options are as follows: |
86 | .Bl -tag -width Ds | |
433e60ac | 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. | |
a5ec8a3d | 96 | .It Fl b Ar batchfile |
97 | Batch mode reads a series of commands from an input | |
acf06a60 | 98 | .Ar batchfile |
a5ec8a3d | 99 | instead of |
acf06a60 | 100 | .Em stdin . |
101 | Since it lacks user interaction it should be used in conjunction with | |
f74de0d7 | 102 | non-interactive authentication. |
a8b64bb8 | 103 | A |
f74de0d7 | 104 | .Ar batchfile |
105 | of | |
106 | .Sq \- | |
a8b64bb8 | 107 | may be used to indicate standard input. |
acf06a60 | 108 | .Nm |
3730bb22 | 109 | will abort if any of the following |
110 | commands fail: | |
7e35f994 | 111 | .Ic get , put , rename , ln , |
a4e5acef | 112 | .Ic rm , mkdir , chdir , ls , |
9a36208d | 113 | .Ic lchdir , chmod , chown , chgrp , lpwd |
a5ec8a3d | 114 | and |
acf06a60 | 115 | .Ic lmkdir . |
a4e5acef | 116 | Termination on error can be suppressed on a command by command basis by |
117 | prefixing the command with a | |
f74de0d7 | 118 | .Sq \- |
bd47824b | 119 | character (for example, |
120 | .Ic -rm /tmp/blah* ) . | |
433e60ac | 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 . | |
61e96248 | 131 | .It Fl o Ar ssh_option |
38539909 | 132 | Can be used to pass options to |
133 | .Nm ssh | |
c21a7c4a | 134 | in the format used in |
135 | .Xr ssh_config 5 . | |
136 | This is useful for specifying options | |
38539909 | 137 | for which there is no separate |
138 | .Nm sftp | |
bd47824b | 139 | command-line flag. |
140 | For example, to specify an alternate port use: | |
e3c1c3e6 | 141 | .Ic sftp -oPort=24 . |
433e60ac | 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 | |
433e60ac | 153 | .It Compression |
154 | .It CompressionLevel | |
155 | .It ConnectionAttempts | |
927fcba2 | 156 | .It ConnectTimeout |
433e60ac | 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 | |
3a065ed0 | 166 | .It IdentitiesOnly |
433e60ac | 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 | |
433e60ac | 177 | .It RhostsRSAAuthentication |
178 | .It RSAAuthentication | |
8e99a198 | 179 | .It SendEnv |
5d8d32a3 | 180 | .It ServerAliveInterval |
181 | .It ServerAliveCountMax | |
433e60ac | 182 | .It SmartcardDevice |
183 | .It StrictHostKeyChecking | |
fd573618 | 184 | .It TCPKeepAlive |
433e60ac | 185 | .It UsePrivilegedPort |
186 | .It User | |
187 | .It UserKnownHostsFile | |
188 | .It VerifyHostKeyDNS | |
433e60ac | 189 | .El |
190 | .It Fl P Ar sftp_server_path | |
bd47824b | 191 | Connect directly to a local sftp server |
7d5e8c46 | 192 | (rather than via |
bd47824b | 193 | .Xr ssh 1 ) |
7d5e8c46 | 194 | This option may be useful in debugging the client and server. |
c25d3df7 | 195 | .It Fl R Ar num_requests |
bd47824b | 196 | Specify how many requests may be outstanding at any one time. |
197 | Increasing this may slightly improve file transfer speed | |
198 | but will increase memory usage. | |
199 | The default is 16 outstanding requests. | |
e3c1c3e6 | 200 | .It Fl S Ar program |
201 | Name of the | |
202 | .Ar program | |
203 | to use for the encrypted connection. | |
204 | The program must understand | |
205 | .Xr ssh 1 | |
206 | options. | |
433e60ac | 207 | .It Fl s Ar subsystem | sftp_server |
208 | Specifies the SSH2 subsystem or the path for an sftp server | |
209 | on the remote host. | |
210 | A path is useful for using | |
211 | .Nm | |
212 | over protocol version 1, or when the remote | |
213 | .Xr sshd 8 | |
214 | does not have an sftp subsystem configured. | |
215 | .It Fl v | |
216 | Raise logging level. | |
217 | This option is also passed to ssh. | |
61e96248 | 218 | .El |
219 | .Sh INTERACTIVE COMMANDS | |
0426a3b4 | 220 | Once in interactive mode, |
221 | .Nm | |
3730bb22 | 222 | understands a set of commands similar to those of |
61e96248 | 223 | .Xr ftp 1 . |
a0e6fead | 224 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
225 | contain spaces. | |
433e60ac | 226 | .Bl -tag -width "lmdir path" |
68874d2b | 227 | .It Ic bye |
bd47824b | 228 | Quit |
229 | .Nm sftp . | |
0426a3b4 | 230 | .It Ic cd Ar path |
3730bb22 | 231 | Change remote directory to |
0426a3b4 | 232 | .Ar path . |
0426a3b4 | 233 | .It Ic chgrp Ar grp Ar path |
3730bb22 | 234 | Change group of file |
0426a3b4 | 235 | .Ar path |
236 | to | |
61e96248 | 237 | .Ar grp . |
238 | .Ar grp | |
0426a3b4 | 239 | must be a numeric GID. |
240 | .It Ic chmod Ar mode Ar path | |
3730bb22 | 241 | Change permissions of file |
0426a3b4 | 242 | .Ar path |
243 | to | |
244 | .Ar mode . | |
245 | .It Ic chown Ar own Ar path | |
3730bb22 | 246 | Change owner of file |
0426a3b4 | 247 | .Ar path |
248 | to | |
61e96248 | 249 | .Ar own . |
250 | .Ar own | |
251 | must be a numeric UID. | |
17910dce | 252 | .It Ic exit |
bd47824b | 253 | Quit |
254 | .Nm sftp . | |
58c54a79 | 255 | .It Xo Ic get |
256 | .Op Ar flags | |
257 | .Ar remote-path | |
258 | .Op Ar local-path | |
259 | .Xc | |
61e96248 | 260 | Retrieve the |
0426a3b4 | 261 | .Ar remote-path |
61e96248 | 262 | and store it on the local machine. |
263 | If the local | |
3730bb22 | 264 | path name is not specified, it is given the same name it has on the |
bd47824b | 265 | remote machine. |
266 | If the | |
58c54a79 | 267 | .Fl P |
268 | flag is specified, then the file's full permission and access time are | |
269 | copied too. | |
17910dce | 270 | .It Ic help |
271 | Display help text. | |
433e60ac | 272 | .It Ic lcd Ar path |
273 | Change local directory to | |
274 | .Ar path . | |
0426a3b4 | 275 | .It Ic lls Op Ar ls-options Op Ar path |
3730bb22 | 276 | Display local directory listing of either |
61e96248 | 277 | .Ar path |
278 | or current directory if | |
279 | .Ar path | |
0426a3b4 | 280 | is not specified. |
281 | .It Ic lmkdir Ar path | |
61e96248 | 282 | Create local directory specified by |
0426a3b4 | 283 | .Ar path . |
3a7fe5ba | 284 | .It Ic ln Ar oldpath Ar newpath |
3730bb22 | 285 | Create a symbolic link from |
3a7fe5ba | 286 | .Ar oldpath |
287 | to | |
288 | .Ar newpath . | |
0426a3b4 | 289 | .It Ic lpwd |
290 | Print local working directory. | |
00b3ad3e | 291 | .It Xo Ic ls |
292 | .Op Ar flags | |
293 | .Op Ar path | |
294 | .Xc | |
61e96248 | 295 | Display remote directory listing of either |
296 | .Ar path | |
0426a3b4 | 297 | or current directory if |
298 | .Ar path | |
bd47824b | 299 | is not specified. |
300 | If the | |
00b3ad3e | 301 | .Fl l |
302 | flag is specified, then display additional details including permissions | |
303 | and ownership information. | |
0426a3b4 | 304 | .It Ic lumask Ar umask |
3730bb22 | 305 | Set local umask to |
0426a3b4 | 306 | .Ar umask . |
307 | .It Ic mkdir Ar path | |
61e96248 | 308 | Create remote directory specified by |
0426a3b4 | 309 | .Ar path . |
b65c3807 | 310 | .It Ic progress |
311 | Toggle display of progress meter. | |
58c54a79 | 312 | .It Xo Ic put |
313 | .Op Ar flags | |
314 | .Ar local-path | |
2ea16b0b | 315 | .Op Ar remote-path |
58c54a79 | 316 | .Xc |
61e96248 | 317 | Upload |
0426a3b4 | 318 | .Ar local-path |
bd47824b | 319 | and store it on the remote machine. |
320 | If the remote path name is not specified, it is given the same name it has | |
321 | on the local machine. | |
322 | If the | |
58c54a79 | 323 | .Fl P |
324 | flag is specified, then the file's full permission and access time are | |
325 | copied too. | |
0426a3b4 | 326 | .It Ic pwd |
327 | Display remote working directory. | |
0426a3b4 | 328 | .It Ic quit |
bd47824b | 329 | Quit |
330 | .Nm sftp . | |
0426a3b4 | 331 | .It Ic rename Ar oldpath Ar newpath |
61e96248 | 332 | Rename remote file from |
333 | .Ar oldpath | |
334 | to | |
0426a3b4 | 335 | .Ar newpath . |
0426a3b4 | 336 | .It Ic rm Ar path |
61e96248 | 337 | Delete remote file specified by |
0426a3b4 | 338 | .Ar path . |
433e60ac | 339 | .It Ic rmdir Ar path |
340 | Remove remote directory specified by | |
341 | .Ar path . | |
3a7fe5ba | 342 | .It Ic symlink Ar oldpath Ar newpath |
3730bb22 | 343 | Create a symbolic link from |
3a7fe5ba | 344 | .Ar oldpath |
345 | to | |
346 | .Ar newpath . | |
048ff12c | 347 | .It Ic version |
348 | Display the | |
349 | .Nm | |
350 | protocol version. | |
d0445371 | 351 | .It Ic \&! Ar command |
3730bb22 | 352 | Execute |
61e96248 | 353 | .Ar command |
0426a3b4 | 354 | in local shell. |
d0445371 | 355 | .It Ic \&! |
0426a3b4 | 356 | Escape to local shell. |
d0445371 | 357 | .It Ic \&? |
0426a3b4 | 358 | Synonym for help. |
359 | .El | |
61e96248 | 360 | .Sh SEE ALSO |
433e60ac | 361 | .Xr ftp 1 , |
2cad6cef | 362 | .Xr scp 1 , |
61e96248 | 363 | .Xr ssh 1 , |
364 | .Xr ssh-add 1 , | |
365 | .Xr ssh-keygen 1 , | |
c21a7c4a | 366 | .Xr ssh_config 5 , |
2cad6cef | 367 | .Xr sftp-server 8 , |
368 | .Xr sshd 8 | |
369 | .Rs | |
7b518233 | 370 | .%A T. Ylonen |
371 | .%A S. Lehtinen | |
2cad6cef | 372 | .%T "SSH File Transfer Protocol" |
373 | .%N draft-ietf-secsh-filexfer-00.txt | |
374 | .%D January 2001 | |
375 | .%O work in progress material | |
376 | .Re |