]>
Commit | Line | Data |
---|---|---|
fd573618 | 1 | .\" $OpenBSD: sftp.1,v 1.48 2003/12/09 21:53:37 markus 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 | |
102 | non-interactive authentication. | |
103 | .Nm | |
3730bb22 | 104 | will abort if any of the following |
105 | commands fail: | |
7e35f994 | 106 | .Ic get , put , rename , ln , |
a4e5acef | 107 | .Ic rm , mkdir , chdir , ls , |
9a36208d | 108 | .Ic lchdir , chmod , chown , chgrp , lpwd |
a5ec8a3d | 109 | and |
acf06a60 | 110 | .Ic lmkdir . |
a4e5acef | 111 | Termination on error can be suppressed on a command by command basis by |
112 | prefixing the command with a | |
bd47824b | 113 | .Sq Ic \- |
114 | character (for example, | |
115 | .Ic -rm /tmp/blah* ) . | |
433e60ac | 116 | .It Fl C |
117 | Enables compression (via ssh's | |
118 | .Fl C | |
119 | flag). | |
120 | .It Fl F Ar ssh_config | |
121 | Specifies an alternative | |
122 | per-user configuration file for | |
123 | .Xr ssh 1 . | |
124 | This option is directly passed to | |
125 | .Xr ssh 1 . | |
61e96248 | 126 | .It Fl o Ar ssh_option |
38539909 | 127 | Can be used to pass options to |
128 | .Nm ssh | |
c21a7c4a | 129 | in the format used in |
130 | .Xr ssh_config 5 . | |
131 | This is useful for specifying options | |
38539909 | 132 | for which there is no separate |
133 | .Nm sftp | |
bd47824b | 134 | command-line flag. |
135 | For example, to specify an alternate port use: | |
e3c1c3e6 | 136 | .Ic sftp -oPort=24 . |
433e60ac | 137 | For full details of the options listed below, and their possible values, see |
138 | .Xr ssh_config 5 . | |
139 | .Pp | |
140 | .Bl -tag -width Ds -offset indent -compact | |
141 | .It AddressFamily | |
142 | .It BatchMode | |
143 | .It BindAddress | |
144 | .It ChallengeResponseAuthentication | |
145 | .It CheckHostIP | |
146 | .It Cipher | |
147 | .It Ciphers | |
433e60ac | 148 | .It Compression |
149 | .It CompressionLevel | |
150 | .It ConnectionAttempts | |
151 | .It ConnectionTimeout | |
433e60ac | 152 | .It GlobalKnownHostsFile |
153 | .It GSSAPIAuthentication | |
154 | .It GSSAPIDelegateCredentials | |
155 | .It Host | |
156 | .It HostbasedAuthentication | |
157 | .It HostKeyAlgorithms | |
158 | .It HostKeyAlias | |
159 | .It HostName | |
160 | .It IdentityFile | |
433e60ac | 161 | .It LogLevel |
162 | .It MACs | |
163 | .It NoHostAuthenticationForLocalhost | |
164 | .It NumberOfPasswordPrompts | |
165 | .It PasswordAuthentication | |
166 | .It Port | |
167 | .It PreferredAuthentications | |
168 | .It Protocol | |
169 | .It ProxyCommand | |
170 | .It PubkeyAuthentication | |
433e60ac | 171 | .It RhostsRSAAuthentication |
172 | .It RSAAuthentication | |
173 | .It SmartcardDevice | |
174 | .It StrictHostKeyChecking | |
fd573618 | 175 | .It TCPKeepAlive |
433e60ac | 176 | .It UsePrivilegedPort |
177 | .It User | |
178 | .It UserKnownHostsFile | |
179 | .It VerifyHostKeyDNS | |
433e60ac | 180 | .El |
181 | .It Fl P Ar sftp_server_path | |
bd47824b | 182 | Connect directly to a local sftp server |
7d5e8c46 | 183 | (rather than via |
bd47824b | 184 | .Xr ssh 1 ) |
7d5e8c46 | 185 | This option may be useful in debugging the client and server. |
c25d3df7 | 186 | .It Fl R Ar num_requests |
bd47824b | 187 | Specify how many requests may be outstanding at any one time. |
188 | Increasing this may slightly improve file transfer speed | |
189 | but will increase memory usage. | |
190 | The default is 16 outstanding requests. | |
e3c1c3e6 | 191 | .It Fl S Ar program |
192 | Name of the | |
193 | .Ar program | |
194 | to use for the encrypted connection. | |
195 | The program must understand | |
196 | .Xr ssh 1 | |
197 | options. | |
433e60ac | 198 | .It Fl s Ar subsystem | sftp_server |
199 | Specifies the SSH2 subsystem or the path for an sftp server | |
200 | on the remote host. | |
201 | A path is useful for using | |
202 | .Nm | |
203 | over protocol version 1, or when the remote | |
204 | .Xr sshd 8 | |
205 | does not have an sftp subsystem configured. | |
206 | .It Fl v | |
207 | Raise logging level. | |
208 | This option is also passed to ssh. | |
61e96248 | 209 | .El |
210 | .Sh INTERACTIVE COMMANDS | |
0426a3b4 | 211 | Once in interactive mode, |
212 | .Nm | |
3730bb22 | 213 | understands a set of commands similar to those of |
61e96248 | 214 | .Xr ftp 1 . |
a0e6fead | 215 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
216 | contain spaces. | |
433e60ac | 217 | .Bl -tag -width "lmdir path" |
68874d2b | 218 | .It Ic bye |
bd47824b | 219 | Quit |
220 | .Nm sftp . | |
0426a3b4 | 221 | .It Ic cd Ar path |
3730bb22 | 222 | Change remote directory to |
0426a3b4 | 223 | .Ar path . |
0426a3b4 | 224 | .It Ic chgrp Ar grp Ar path |
3730bb22 | 225 | Change group of file |
0426a3b4 | 226 | .Ar path |
227 | to | |
61e96248 | 228 | .Ar grp . |
229 | .Ar grp | |
0426a3b4 | 230 | must be a numeric GID. |
231 | .It Ic chmod Ar mode Ar path | |
3730bb22 | 232 | Change permissions of file |
0426a3b4 | 233 | .Ar path |
234 | to | |
235 | .Ar mode . | |
236 | .It Ic chown Ar own Ar path | |
3730bb22 | 237 | Change owner of file |
0426a3b4 | 238 | .Ar path |
239 | to | |
61e96248 | 240 | .Ar own . |
241 | .Ar own | |
242 | must be a numeric UID. | |
17910dce | 243 | .It Ic exit |
bd47824b | 244 | Quit |
245 | .Nm sftp . | |
58c54a79 | 246 | .It Xo Ic get |
247 | .Op Ar flags | |
248 | .Ar remote-path | |
249 | .Op Ar local-path | |
250 | .Xc | |
61e96248 | 251 | Retrieve the |
0426a3b4 | 252 | .Ar remote-path |
61e96248 | 253 | and store it on the local machine. |
254 | If the local | |
3730bb22 | 255 | path name is not specified, it is given the same name it has on the |
bd47824b | 256 | remote machine. |
257 | If the | |
58c54a79 | 258 | .Fl P |
259 | flag is specified, then the file's full permission and access time are | |
260 | copied too. | |
17910dce | 261 | .It Ic help |
262 | Display help text. | |
433e60ac | 263 | .It Ic lcd Ar path |
264 | Change local directory to | |
265 | .Ar path . | |
0426a3b4 | 266 | .It Ic lls Op Ar ls-options Op Ar path |
3730bb22 | 267 | Display local directory listing of either |
61e96248 | 268 | .Ar path |
269 | or current directory if | |
270 | .Ar path | |
0426a3b4 | 271 | is not specified. |
272 | .It Ic lmkdir Ar path | |
61e96248 | 273 | Create local directory specified by |
0426a3b4 | 274 | .Ar path . |
3a7fe5ba | 275 | .It Ic ln Ar oldpath Ar newpath |
3730bb22 | 276 | Create a symbolic link from |
3a7fe5ba | 277 | .Ar oldpath |
278 | to | |
279 | .Ar newpath . | |
0426a3b4 | 280 | .It Ic lpwd |
281 | Print local working directory. | |
00b3ad3e | 282 | .It Xo Ic ls |
283 | .Op Ar flags | |
284 | .Op Ar path | |
285 | .Xc | |
61e96248 | 286 | Display remote directory listing of either |
287 | .Ar path | |
0426a3b4 | 288 | or current directory if |
289 | .Ar path | |
bd47824b | 290 | is not specified. |
291 | If the | |
00b3ad3e | 292 | .Fl l |
293 | flag is specified, then display additional details including permissions | |
294 | and ownership information. | |
0426a3b4 | 295 | .It Ic lumask Ar umask |
3730bb22 | 296 | Set local umask to |
0426a3b4 | 297 | .Ar umask . |
298 | .It Ic mkdir Ar path | |
61e96248 | 299 | Create remote directory specified by |
0426a3b4 | 300 | .Ar path . |
b65c3807 | 301 | .It Ic progress |
302 | Toggle display of progress meter. | |
58c54a79 | 303 | .It Xo Ic put |
304 | .Op Ar flags | |
305 | .Ar local-path | |
2ea16b0b | 306 | .Op Ar remote-path |
58c54a79 | 307 | .Xc |
61e96248 | 308 | Upload |
0426a3b4 | 309 | .Ar local-path |
bd47824b | 310 | and store it on the remote machine. |
311 | If the remote path name is not specified, it is given the same name it has | |
312 | on the local machine. | |
313 | If the | |
58c54a79 | 314 | .Fl P |
315 | flag is specified, then the file's full permission and access time are | |
316 | copied too. | |
0426a3b4 | 317 | .It Ic pwd |
318 | Display remote working directory. | |
0426a3b4 | 319 | .It Ic quit |
bd47824b | 320 | Quit |
321 | .Nm sftp . | |
0426a3b4 | 322 | .It Ic rename Ar oldpath Ar newpath |
61e96248 | 323 | Rename remote file from |
324 | .Ar oldpath | |
325 | to | |
0426a3b4 | 326 | .Ar newpath . |
0426a3b4 | 327 | .It Ic rm Ar path |
61e96248 | 328 | Delete remote file specified by |
0426a3b4 | 329 | .Ar path . |
433e60ac | 330 | .It Ic rmdir Ar path |
331 | Remove remote directory specified by | |
332 | .Ar path . | |
3a7fe5ba | 333 | .It Ic symlink Ar oldpath Ar newpath |
3730bb22 | 334 | Create a symbolic link from |
3a7fe5ba | 335 | .Ar oldpath |
336 | to | |
337 | .Ar newpath . | |
048ff12c | 338 | .It Ic version |
339 | Display the | |
340 | .Nm | |
341 | protocol version. | |
d0445371 | 342 | .It Ic \&! Ar command |
3730bb22 | 343 | Execute |
61e96248 | 344 | .Ar command |
0426a3b4 | 345 | in local shell. |
d0445371 | 346 | .It Ic \&! |
0426a3b4 | 347 | Escape to local shell. |
d0445371 | 348 | .It Ic \&? |
0426a3b4 | 349 | Synonym for help. |
350 | .El | |
61e96248 | 351 | .Sh SEE ALSO |
433e60ac | 352 | .Xr ftp 1 , |
2cad6cef | 353 | .Xr scp 1 , |
61e96248 | 354 | .Xr ssh 1 , |
355 | .Xr ssh-add 1 , | |
356 | .Xr ssh-keygen 1 , | |
c21a7c4a | 357 | .Xr ssh_config 5 , |
2cad6cef | 358 | .Xr sftp-server 8 , |
359 | .Xr sshd 8 | |
360 | .Rs | |
7b518233 | 361 | .%A T. Ylonen |
362 | .%A S. Lehtinen | |
2cad6cef | 363 | .%T "SSH File Transfer Protocol" |
364 | .%N draft-ietf-secsh-filexfer-00.txt | |
365 | .%D January 2001 | |
366 | .%O work in progress material | |
367 | .Re |