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