]>
Commit | Line | Data |
---|---|---|
bd47824b | 1 | .\" $OpenBSD: sftp.1,v 1.44 2003/05/20 12:03:35 jmc 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 |
7d5e8c46 | 34 | .Op Fl vC1 |
a5ec8a3d | 35 | .Op Fl b Ar batchfile |
61e96248 | 36 | .Op Fl o Ar ssh_option |
e3c1c3e6 | 37 | .Op Fl s Ar subsystem | sftp_server |
7d5e8c46 | 38 | .Op Fl B Ar buffer_size |
39 | .Op Fl F Ar ssh_config | |
40 | .Op Fl P Ar sftp_server path | |
c25d3df7 | 41 | .Op Fl R Ar num_requests |
e3c1c3e6 | 42 | .Op Fl S Ar program |
43 | .Ar host | |
a4e5acef | 44 | .Ek |
72c5fe79 | 45 | .Nm sftp |
a4e5acef | 46 | .Oo Oo Ar user Ns No @ Oc Ns |
47 | .Ar host Ns Oo : Ns Ar file Oo | |
48 | .Ar file Oc Oc Oc | |
72c5fe79 | 49 | .Nm sftp |
a4e5acef | 50 | .Oo Oo Ar user Ns No @ Oc Ns |
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 |
55 | .Oo Ar user Ns No @ Oc Ns Ar host Ns | |
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 | |
a5ec8a3d | 87 | .It Fl b Ar batchfile |
88 | Batch mode reads a series of commands from an input | |
acf06a60 | 89 | .Ar batchfile |
a5ec8a3d | 90 | instead of |
acf06a60 | 91 | .Em stdin . |
92 | Since it lacks user interaction it should be used in conjunction with | |
93 | non-interactive authentication. | |
94 | .Nm | |
3730bb22 | 95 | will abort if any of the following |
96 | commands fail: | |
7e35f994 | 97 | .Ic get , put , rename , ln , |
a4e5acef | 98 | .Ic rm , mkdir , chdir , ls , |
9a36208d | 99 | .Ic lchdir , chmod , chown , chgrp , lpwd |
a5ec8a3d | 100 | and |
acf06a60 | 101 | .Ic lmkdir . |
a4e5acef | 102 | Termination on error can be suppressed on a command by command basis by |
103 | prefixing the command with a | |
bd47824b | 104 | .Sq Ic \- |
105 | character (for example, | |
106 | .Ic -rm /tmp/blah* ) . | |
61e96248 | 107 | .It Fl o Ar ssh_option |
38539909 | 108 | Can be used to pass options to |
109 | .Nm ssh | |
c21a7c4a | 110 | in the format used in |
111 | .Xr ssh_config 5 . | |
112 | This is useful for specifying options | |
38539909 | 113 | for which there is no separate |
114 | .Nm sftp | |
bd47824b | 115 | command-line flag. |
116 | For example, to specify an alternate port use: | |
e3c1c3e6 | 117 | .Ic sftp -oPort=24 . |
118 | .It Fl s Ar subsystem | sftp_server | |
119 | Specifies the SSH2 subsystem or the path for an sftp server | |
bd47824b | 120 | on the remote host. |
121 | A path is useful for using | |
122 | .Nm | |
123 | over protocol version 1, or when the remote | |
124 | .Xr sshd 8 | |
e3c1c3e6 | 125 | does not have an sftp subsystem configured. |
7d5e8c46 | 126 | .It Fl v |
bd47824b | 127 | Raise logging level. |
128 | This option is also passed to ssh. | |
7d5e8c46 | 129 | .It Fl B Ar buffer_size |
a4e5acef | 130 | Specify the size of the buffer that |
7d5e8c46 | 131 | .Nm |
bd47824b | 132 | uses when transferring files. |
133 | Larger buffers require fewer round trips at the cost of higher | |
134 | memory consumption. | |
135 | The default is 32768 bytes. | |
7d5e8c46 | 136 | .It Fl C |
137 | Enables compression (via ssh's | |
138 | .Fl C | |
139 | flag). | |
140 | .It Fl F Ar ssh_config | |
141 | Specifies an alternative | |
142 | per-user configuration file for | |
bd47824b | 143 | .Xr ssh 1 . |
7d5e8c46 | 144 | This option is directly passed to |
145 | .Xr ssh 1 . | |
146 | .It Fl P Ar sftp_server path | |
bd47824b | 147 | Connect directly to a local sftp server |
7d5e8c46 | 148 | (rather than via |
bd47824b | 149 | .Xr ssh 1 ) |
7d5e8c46 | 150 | This option may be useful in debugging the client and server. |
c25d3df7 | 151 | .It Fl R Ar num_requests |
bd47824b | 152 | Specify how many requests may be outstanding at any one time. |
153 | Increasing this may slightly improve file transfer speed | |
154 | but will increase memory usage. | |
155 | The default is 16 outstanding requests. | |
e3c1c3e6 | 156 | .It Fl S Ar program |
157 | Name of the | |
158 | .Ar program | |
159 | to use for the encrypted connection. | |
160 | The program must understand | |
161 | .Xr ssh 1 | |
162 | options. | |
7d5e8c46 | 163 | .It Fl 1 |
164 | Specify the use of protocol version 1. | |
61e96248 | 165 | .El |
166 | .Sh INTERACTIVE COMMANDS | |
0426a3b4 | 167 | Once in interactive mode, |
168 | .Nm | |
3730bb22 | 169 | understands a set of commands similar to those of |
61e96248 | 170 | .Xr ftp 1 . |
a0e6fead | 171 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
172 | contain spaces. | |
61e96248 | 173 | .Bl -tag -width Ds |
68874d2b | 174 | .It Ic bye |
bd47824b | 175 | Quit |
176 | .Nm sftp . | |
0426a3b4 | 177 | .It Ic cd Ar path |
3730bb22 | 178 | Change remote directory to |
0426a3b4 | 179 | .Ar path . |
180 | .It Ic lcd Ar path | |
3730bb22 | 181 | Change local directory to |
0426a3b4 | 182 | .Ar path . |
183 | .It Ic chgrp Ar grp Ar path | |
3730bb22 | 184 | Change group of file |
0426a3b4 | 185 | .Ar path |
186 | to | |
61e96248 | 187 | .Ar grp . |
188 | .Ar grp | |
0426a3b4 | 189 | must be a numeric GID. |
190 | .It Ic chmod Ar mode Ar path | |
3730bb22 | 191 | Change permissions of file |
0426a3b4 | 192 | .Ar path |
193 | to | |
194 | .Ar mode . | |
195 | .It Ic chown Ar own Ar path | |
3730bb22 | 196 | Change owner of file |
0426a3b4 | 197 | .Ar path |
198 | to | |
61e96248 | 199 | .Ar own . |
200 | .Ar own | |
201 | must be a numeric UID. | |
17910dce | 202 | .It Ic exit |
bd47824b | 203 | Quit |
204 | .Nm sftp . | |
58c54a79 | 205 | .It Xo Ic get |
206 | .Op Ar flags | |
207 | .Ar remote-path | |
208 | .Op Ar local-path | |
209 | .Xc | |
61e96248 | 210 | Retrieve the |
0426a3b4 | 211 | .Ar remote-path |
61e96248 | 212 | and store it on the local machine. |
213 | If the local | |
3730bb22 | 214 | path name is not specified, it is given the same name it has on the |
bd47824b | 215 | remote machine. |
216 | If the | |
58c54a79 | 217 | .Fl P |
218 | flag is specified, then the file's full permission and access time are | |
219 | copied too. | |
17910dce | 220 | .It Ic help |
221 | Display help text. | |
0426a3b4 | 222 | .It Ic lls Op Ar ls-options Op Ar path |
3730bb22 | 223 | Display local directory listing of either |
61e96248 | 224 | .Ar path |
225 | or current directory if | |
226 | .Ar path | |
0426a3b4 | 227 | is not specified. |
228 | .It Ic lmkdir Ar path | |
61e96248 | 229 | Create local directory specified by |
0426a3b4 | 230 | .Ar path . |
3a7fe5ba | 231 | .It Ic ln Ar oldpath Ar newpath |
3730bb22 | 232 | Create a symbolic link from |
3a7fe5ba | 233 | .Ar oldpath |
234 | to | |
235 | .Ar newpath . | |
0426a3b4 | 236 | .It Ic lpwd |
237 | Print local working directory. | |
00b3ad3e | 238 | .It Xo Ic ls |
239 | .Op Ar flags | |
240 | .Op Ar path | |
241 | .Xc | |
61e96248 | 242 | Display remote directory listing of either |
243 | .Ar path | |
0426a3b4 | 244 | or current directory if |
245 | .Ar path | |
bd47824b | 246 | is not specified. |
247 | If the | |
00b3ad3e | 248 | .Fl l |
249 | flag is specified, then display additional details including permissions | |
250 | and ownership information. | |
0426a3b4 | 251 | .It Ic lumask Ar umask |
3730bb22 | 252 | Set local umask to |
0426a3b4 | 253 | .Ar umask . |
254 | .It Ic mkdir Ar path | |
61e96248 | 255 | Create remote directory specified by |
0426a3b4 | 256 | .Ar path . |
b65c3807 | 257 | .It Ic progress |
258 | Toggle display of progress meter. | |
58c54a79 | 259 | .It Xo Ic put |
260 | .Op Ar flags | |
261 | .Ar local-path | |
2ea16b0b | 262 | .Op Ar remote-path |
58c54a79 | 263 | .Xc |
61e96248 | 264 | Upload |
0426a3b4 | 265 | .Ar local-path |
bd47824b | 266 | and store it on the remote machine. |
267 | If the remote path name is not specified, it is given the same name it has | |
268 | on the local machine. | |
269 | If the | |
58c54a79 | 270 | .Fl P |
271 | flag is specified, then the file's full permission and access time are | |
272 | copied too. | |
0426a3b4 | 273 | .It Ic pwd |
274 | Display remote working directory. | |
0426a3b4 | 275 | .It Ic quit |
bd47824b | 276 | Quit |
277 | .Nm sftp . | |
0426a3b4 | 278 | .It Ic rename Ar oldpath Ar newpath |
61e96248 | 279 | Rename remote file from |
280 | .Ar oldpath | |
281 | to | |
0426a3b4 | 282 | .Ar newpath . |
283 | .It Ic rmdir Ar path | |
61e96248 | 284 | Remove remote directory specified by |
0426a3b4 | 285 | .Ar path . |
286 | .It Ic rm Ar path | |
61e96248 | 287 | Delete remote file specified by |
0426a3b4 | 288 | .Ar path . |
3a7fe5ba | 289 | .It Ic symlink Ar oldpath Ar newpath |
3730bb22 | 290 | Create a symbolic link from |
3a7fe5ba | 291 | .Ar oldpath |
292 | to | |
293 | .Ar newpath . | |
048ff12c | 294 | .It Ic version |
295 | Display the | |
296 | .Nm | |
297 | protocol version. | |
61e96248 | 298 | .It Ic ! Ar command |
3730bb22 | 299 | Execute |
61e96248 | 300 | .Ar command |
0426a3b4 | 301 | in local shell. |
61e96248 | 302 | .It Ic ! |
0426a3b4 | 303 | Escape to local shell. |
304 | .It Ic ? | |
305 | Synonym for help. | |
306 | .El | |
61e96248 | 307 | .Sh SEE ALSO |
2cad6cef | 308 | .Xr scp 1 , |
61e96248 | 309 | .Xr ssh 1 , |
310 | .Xr ssh-add 1 , | |
311 | .Xr ssh-keygen 1 , | |
c21a7c4a | 312 | .Xr ssh_config 5 , |
2cad6cef | 313 | .Xr sftp-server 8 , |
314 | .Xr sshd 8 | |
315 | .Rs | |
7b518233 | 316 | .%A T. Ylonen |
317 | .%A S. Lehtinen | |
2cad6cef | 318 | .%T "SSH File Transfer Protocol" |
319 | .%N draft-ietf-secsh-filexfer-00.txt | |
320 | .%D January 2001 | |
321 | .%O work in progress material | |
322 | .Re |