]>
Commit | Line | Data |
---|---|---|
e3c1c3e6 | 1 | .\" $OpenBSD: sftp.1,v 1.26 2001/09/17 20:38:09 stevesk 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 | |
e68225b2 | 30 | .Nd Secure file transfer program |
61e96248 | 31 | .Sh SYNOPSIS |
32 | .Nm sftp | |
e3c1c3e6 | 33 | .Op Fl 1Cv |
a5ec8a3d | 34 | .Op Fl b Ar batchfile |
f1278af7 | 35 | .Op Fl F Ar ssh_config |
61e96248 | 36 | .Op Fl o Ar ssh_option |
e3c1c3e6 | 37 | .Op Fl s Ar subsystem | sftp_server |
38 | .Op Fl S Ar program | |
39 | .Ar host | |
edeeab1e | 40 | .Nm sftp |
41 | .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] | |
42 | .Nm sftp | |
3730bb22 | 43 | .Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] |
61e96248 | 44 | .Sh DESCRIPTION |
45 | .Nm | |
46 | is an interactive file transfer program, similar to | |
47 | .Xr ftp 1 , | |
48 | which performs all operations over an encrypted | |
49 | .Xr ssh 1 | |
50 | transport. | |
51 | It may also use many features of ssh, such as public key authentication and | |
52 | compression. | |
53 | .Nm | |
54 | connects and logs into the specified | |
cf7ff074 | 55 | .Ar host , |
61e96248 | 56 | then enters an interactive command mode. |
57 | .Pp | |
3730bb22 | 58 | The second usage format will retrieve files automatically if a non-interactive |
cf7ff074 | 59 | authentication method is used; otherwise it will do so after |
60 | successful interactive authentication. | |
edeeab1e | 61 | .Pp |
62 | The last usage format allows the sftp client to start in a remote directory. | |
63 | .Pp | |
61e96248 | 64 | The options are as follows: |
65 | .Bl -tag -width Ds | |
e3c1c3e6 | 66 | .It Fl 1 |
67 | Specify the use of protocol version 1. | |
a5ec8a3d | 68 | .It Fl b Ar batchfile |
69 | Batch mode reads a series of commands from an input | |
acf06a60 | 70 | .Ar batchfile |
a5ec8a3d | 71 | instead of |
acf06a60 | 72 | .Em stdin . |
73 | Since it lacks user interaction it should be used in conjunction with | |
74 | non-interactive authentication. | |
75 | .Nm | |
3730bb22 | 76 | will abort if any of the following |
77 | commands fail: | |
acf06a60 | 78 | .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir |
a5ec8a3d | 79 | and |
acf06a60 | 80 | .Ic lmkdir . |
17910dce | 81 | .It Fl C |
3730bb22 | 82 | Enables compression (via ssh's |
17910dce | 83 | .Fl C |
e3c1c3e6 | 84 | flag). |
f1278af7 | 85 | .It Fl F Ar ssh_config |
86 | Specifies an alternative | |
87 | per-user configuration file for | |
88 | .Nm ssh . | |
89 | This option is directly passed to | |
90 | .Xr ssh 1 . | |
61e96248 | 91 | .It Fl o Ar ssh_option |
38539909 | 92 | Can be used to pass options to |
93 | .Nm ssh | |
94 | in the format used in the | |
95 | .Xr ssh 1 | |
96 | configuration file. This is useful for specifying options | |
97 | for which there is no separate | |
98 | .Nm sftp | |
e3c1c3e6 | 99 | command-line flag. For example, to specify an alternate |
100 | port use: | |
101 | .Ic sftp -oPort=24 . | |
102 | .It Fl s Ar subsystem | sftp_server | |
103 | Specifies the SSH2 subsystem or the path for an sftp server | |
104 | on the remote host. A path is useful for using sftp over | |
105 | protocol version 1, or when the remote | |
106 | .Nm sshd | |
107 | does not have an sftp subsystem configured. | |
108 | .It Fl S Ar program | |
109 | Name of the | |
110 | .Ar program | |
111 | to use for the encrypted connection. | |
112 | The program must understand | |
113 | .Xr ssh 1 | |
114 | options. | |
17910dce | 115 | .It Fl v |
116 | Raise logging level. This option is also passed to ssh. | |
61e96248 | 117 | .El |
118 | .Sh INTERACTIVE COMMANDS | |
0426a3b4 | 119 | Once in interactive mode, |
120 | .Nm | |
3730bb22 | 121 | understands a set of commands similar to those of |
61e96248 | 122 | .Xr ftp 1 . |
a0e6fead | 123 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
124 | contain spaces. | |
61e96248 | 125 | .Bl -tag -width Ds |
68874d2b | 126 | .It Ic bye |
127 | Quit sftp. | |
0426a3b4 | 128 | .It Ic cd Ar path |
3730bb22 | 129 | Change remote directory to |
0426a3b4 | 130 | .Ar path . |
131 | .It Ic lcd Ar path | |
3730bb22 | 132 | Change local directory to |
0426a3b4 | 133 | .Ar path . |
134 | .It Ic chgrp Ar grp Ar path | |
3730bb22 | 135 | Change group of file |
0426a3b4 | 136 | .Ar path |
137 | to | |
61e96248 | 138 | .Ar grp . |
139 | .Ar grp | |
0426a3b4 | 140 | must be a numeric GID. |
141 | .It Ic chmod Ar mode Ar path | |
3730bb22 | 142 | Change permissions of file |
0426a3b4 | 143 | .Ar path |
144 | to | |
145 | .Ar mode . | |
146 | .It Ic chown Ar own Ar path | |
3730bb22 | 147 | Change owner of file |
0426a3b4 | 148 | .Ar path |
149 | to | |
61e96248 | 150 | .Ar own . |
151 | .Ar own | |
152 | must be a numeric UID. | |
17910dce | 153 | .It Ic exit |
154 | Quit sftp. | |
58c54a79 | 155 | .It Xo Ic get |
156 | .Op Ar flags | |
157 | .Ar remote-path | |
158 | .Op Ar local-path | |
159 | .Xc | |
61e96248 | 160 | Retrieve the |
0426a3b4 | 161 | .Ar remote-path |
61e96248 | 162 | and store it on the local machine. |
163 | If the local | |
3730bb22 | 164 | path name is not specified, it is given the same name it has on the |
165 | remote machine. If the | |
58c54a79 | 166 | .Fl P |
167 | flag is specified, then the file's full permission and access time are | |
168 | copied too. | |
17910dce | 169 | .It Ic help |
170 | Display help text. | |
0426a3b4 | 171 | .It Ic lls Op Ar ls-options Op Ar path |
3730bb22 | 172 | Display local directory listing of either |
61e96248 | 173 | .Ar path |
174 | or current directory if | |
175 | .Ar path | |
0426a3b4 | 176 | is not specified. |
177 | .It Ic lmkdir Ar path | |
61e96248 | 178 | Create local directory specified by |
0426a3b4 | 179 | .Ar path . |
3a7fe5ba | 180 | .It Ic ln Ar oldpath Ar newpath |
3730bb22 | 181 | Create a symbolic link from |
3a7fe5ba | 182 | .Ar oldpath |
183 | to | |
184 | .Ar newpath . | |
0426a3b4 | 185 | .It Ic lpwd |
186 | Print local working directory. | |
187 | .It Ic ls Op Ar path | |
61e96248 | 188 | Display remote directory listing of either |
189 | .Ar path | |
0426a3b4 | 190 | or current directory if |
191 | .Ar path | |
192 | is not specified. | |
193 | .It Ic lumask Ar umask | |
3730bb22 | 194 | Set local umask to |
0426a3b4 | 195 | .Ar umask . |
196 | .It Ic mkdir Ar path | |
61e96248 | 197 | Create remote directory specified by |
0426a3b4 | 198 | .Ar path . |
58c54a79 | 199 | .It Xo Ic put |
200 | .Op Ar flags | |
201 | .Ar local-path | |
202 | .Op Ar local-path | |
203 | .Xc | |
61e96248 | 204 | Upload |
0426a3b4 | 205 | .Ar local-path |
3730bb22 | 206 | and store it on the remote machine. If the remote path name is not |
207 | specified, it is given the same name it has on the local machine. If the | |
58c54a79 | 208 | .Fl P |
209 | flag is specified, then the file's full permission and access time are | |
210 | copied too. | |
0426a3b4 | 211 | .It Ic pwd |
212 | Display remote working directory. | |
0426a3b4 | 213 | .It Ic quit |
214 | Quit sftp. | |
215 | .It Ic rename Ar oldpath Ar newpath | |
61e96248 | 216 | Rename remote file from |
217 | .Ar oldpath | |
218 | to | |
0426a3b4 | 219 | .Ar newpath . |
220 | .It Ic rmdir Ar path | |
61e96248 | 221 | Remove remote directory specified by |
0426a3b4 | 222 | .Ar path . |
223 | .It Ic rm Ar path | |
61e96248 | 224 | Delete remote file specified by |
0426a3b4 | 225 | .Ar path . |
3a7fe5ba | 226 | .It Ic symlink Ar oldpath Ar newpath |
3730bb22 | 227 | Create a symbolic link from |
3a7fe5ba | 228 | .Ar oldpath |
229 | to | |
230 | .Ar newpath . | |
61e96248 | 231 | .It Ic ! Ar command |
3730bb22 | 232 | Execute |
61e96248 | 233 | .Ar command |
0426a3b4 | 234 | in local shell. |
61e96248 | 235 | .It Ic ! |
0426a3b4 | 236 | Escape to local shell. |
237 | .It Ic ? | |
238 | Synonym for help. | |
239 | .El | |
61e96248 | 240 | .Sh AUTHORS |
241 | Damien Miller <djm@mindrot.org> | |
242 | .Sh SEE ALSO | |
2cad6cef | 243 | .Xr scp 1 , |
61e96248 | 244 | .Xr ssh 1 , |
245 | .Xr ssh-add 1 , | |
246 | .Xr ssh-keygen 1 , | |
2cad6cef | 247 | .Xr sftp-server 8 , |
248 | .Xr sshd 8 | |
249 | .Rs | |
7b518233 | 250 | .%A T. Ylonen |
251 | .%A S. Lehtinen | |
2cad6cef | 252 | .%T "SSH File Transfer Protocol" |
253 | .%N draft-ietf-secsh-filexfer-00.txt | |
254 | .%D January 2001 | |
255 | .%O work in progress material | |
256 | .Re |