diff options
author | Darren Tucker <dtucker@zip.com.au> | 2003-10-15 15:50:42 +1000 |
---|---|---|
committer | Darren Tucker <dtucker@zip.com.au> | 2003-10-15 15:50:42 +1000 |
commit | 1f20394e92afa417c1201506f9ae8683170ac496 (patch) | |
tree | dc4552b853891fb2fba19f404da087062622bf97 /sftp.1 | |
parent | 439ce0daf95fef595ba2592d16b17401a8bee135 (diff) |
- jmc@cvs.openbsd.org 2003/10/08 08:27:36
[scp.1 scp.c sftp-server.8 sftp.1 sftp.c ssh.1 sshd.8]
scp and sftp: add options list and sort options. options list requested
by deraadt@
sshd: use same format as ssh
ssh: remove wrong option from list
sftp-server: Subsystem is documented in ssh_config(5), not sshd(8)
ok deraadt@ markus@
Diffstat (limited to 'sftp.1')
-rw-r--r-- | sftp.1 | 142 |
1 files changed, 98 insertions, 44 deletions
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: sftp.1,v 1.45 2003/09/02 18:50:06 jmc Exp $ | 1 | .\" $OpenBSD: sftp.1,v 1.46 2003/10/08 08:27:36 jmc Exp $ |
2 | .\" | 2 | .\" |
3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. | 3 | .\" Copyright (c) 2001 Damien Miller. All rights reserved. |
4 | .\" | 4 | .\" |
@@ -31,15 +31,15 @@ | |||
31 | .Sh SYNOPSIS | 31 | .Sh SYNOPSIS |
32 | .Nm sftp | 32 | .Nm sftp |
33 | .Bk -words | 33 | .Bk -words |
34 | .Op Fl vC1 | 34 | .Op Fl 1Cv |
35 | .Op Fl b Ar batchfile | ||
36 | .Op Fl o Ar ssh_option | ||
37 | .Op Fl s Ar subsystem | sftp_server | ||
38 | .Op Fl B Ar buffer_size | 35 | .Op Fl B Ar buffer_size |
36 | .Op Fl b Ar batchfile | ||
39 | .Op Fl F Ar ssh_config | 37 | .Op Fl F Ar ssh_config |
40 | .Op Fl P Ar sftp_server path | 38 | .Op Fl o Ar ssh_option |
39 | .Op Fl P Ar sftp_server_path | ||
41 | .Op Fl R Ar num_requests | 40 | .Op Fl R Ar num_requests |
42 | .Op Fl S Ar program | 41 | .Op Fl S Ar program |
42 | .Op Fl s Ar subsystem | sftp_server | ||
43 | .Ar host | 43 | .Ar host |
44 | .Ek | 44 | .Ek |
45 | .Nm sftp | 45 | .Nm sftp |
@@ -84,6 +84,15 @@ and | |||
84 | for details). | 84 | for details). |
85 | The options are as follows: | 85 | The options are as follows: |
86 | .Bl -tag -width Ds | 86 | .Bl -tag -width Ds |
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. | ||
87 | .It Fl b Ar batchfile | 96 | .It Fl b Ar batchfile |
88 | Batch mode reads a series of commands from an input | 97 | Batch mode reads a series of commands from an input |
89 | .Ar batchfile | 98 | .Ar batchfile |
@@ -104,6 +113,16 @@ prefixing the command with a | |||
104 | .Sq Ic \- | 113 | .Sq Ic \- |
105 | character (for example, | 114 | character (for example, |
106 | .Ic -rm /tmp/blah* ) . | 115 | .Ic -rm /tmp/blah* ) . |
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 . | ||
107 | .It Fl o Ar ssh_option | 126 | .It Fl o Ar ssh_option |
108 | Can be used to pass options to | 127 | Can be used to pass options to |
109 | .Nm ssh | 128 | .Nm ssh |
@@ -115,35 +134,60 @@ for which there is no separate | |||
115 | command-line flag. | 134 | command-line flag. |
116 | For example, to specify an alternate port use: | 135 | For example, to specify an alternate port use: |
117 | .Ic sftp -oPort=24 . | 136 | .Ic sftp -oPort=24 . |
118 | .It Fl s Ar subsystem | sftp_server | 137 | For full details of the options listed below, and their possible values, see |
119 | Specifies the SSH2 subsystem or the path for an sftp server | 138 | .Xr ssh_config 5 . |
120 | on the remote host. | 139 | .Pp |
121 | A path is useful for using | 140 | .Bl -tag -width Ds -offset indent -compact |
122 | .Nm | 141 | .It AddressFamily |
123 | over protocol version 1, or when the remote | 142 | .It BatchMode |
124 | .Xr sshd 8 | 143 | .It BindAddress |
125 | does not have an sftp subsystem configured. | 144 | .It ChallengeResponseAuthentication |
126 | .It Fl v | 145 | .It CheckHostIP |
127 | Raise logging level. | 146 | .It Cipher |
128 | This option is also passed to ssh. | 147 | .It Ciphers |
129 | .It Fl B Ar buffer_size | 148 | .It ClearAllForwardings |
130 | Specify the size of the buffer that | 149 | .It Compression |
131 | .Nm | 150 | .It CompressionLevel |
132 | uses when transferring files. | 151 | .It ConnectionAttempts |
133 | Larger buffers require fewer round trips at the cost of higher | 152 | .It ConnectionTimeout |
134 | memory consumption. | 153 | .It DynamicForward |
135 | The default is 32768 bytes. | 154 | .It EscapeChar |
136 | .It Fl C | 155 | .It ForwardAgent |
137 | Enables compression (via ssh's | 156 | .It ForwardX11 |
138 | .Fl C | 157 | .It GatewayPorts |
139 | flag). | 158 | .It GlobalKnownHostsFile |
140 | .It Fl F Ar ssh_config | 159 | .It GSSAPIAuthentication |
141 | Specifies an alternative | 160 | .It GSSAPIDelegateCredentials |
142 | per-user configuration file for | 161 | .It Host |
143 | .Xr ssh 1 . | 162 | .It HostbasedAuthentication |
144 | This option is directly passed to | 163 | .It HostKeyAlgorithms |
145 | .Xr ssh 1 . | 164 | .It HostKeyAlias |
146 | .It Fl P Ar sftp_server path | 165 | .It HostName |
166 | .It IdentityFile | ||
167 | .It KeepAlive | ||
168 | .It LocalForward | ||
169 | .It LogLevel | ||
170 | .It MACs | ||
171 | .It NoHostAuthenticationForLocalhost | ||
172 | .It NumberOfPasswordPrompts | ||
173 | .It PasswordAuthentication | ||
174 | .It Port | ||
175 | .It PreferredAuthentications | ||
176 | .It Protocol | ||
177 | .It ProxyCommand | ||
178 | .It PubkeyAuthentication | ||
179 | .It RemoteForward | ||
180 | .It RhostsRSAAuthentication | ||
181 | .It RSAAuthentication | ||
182 | .It SmartcardDevice | ||
183 | .It StrictHostKeyChecking | ||
184 | .It UsePrivilegedPort | ||
185 | .It User | ||
186 | .It UserKnownHostsFile | ||
187 | .It VerifyHostKeyDNS | ||
188 | .It XAuthLocation | ||
189 | .El | ||
190 | .It Fl P Ar sftp_server_path | ||
147 | Connect directly to a local sftp server | 191 | Connect directly to a local sftp server |
148 | (rather than via | 192 | (rather than via |
149 | .Xr ssh 1 ) | 193 | .Xr ssh 1 ) |
@@ -160,8 +204,17 @@ to use for the encrypted connection. | |||
160 | The program must understand | 204 | The program must understand |
161 | .Xr ssh 1 | 205 | .Xr ssh 1 |
162 | options. | 206 | options. |
163 | .It Fl 1 | 207 | .It Fl s Ar subsystem | sftp_server |
164 | Specify the use of protocol version 1. | 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. | ||
165 | .El | 218 | .El |
166 | .Sh INTERACTIVE COMMANDS | 219 | .Sh INTERACTIVE COMMANDS |
167 | Once in interactive mode, | 220 | Once in interactive mode, |
@@ -170,16 +223,13 @@ understands a set of commands similar to those of | |||
170 | .Xr ftp 1 . | 223 | .Xr ftp 1 . |
171 | Commands are case insensitive and pathnames may be enclosed in quotes if they | 224 | Commands are case insensitive and pathnames may be enclosed in quotes if they |
172 | contain spaces. | 225 | contain spaces. |
173 | .Bl -tag -width Ds | 226 | .Bl -tag -width "lmdir path" |
174 | .It Ic bye | 227 | .It Ic bye |
175 | Quit | 228 | Quit |
176 | .Nm sftp . | 229 | .Nm sftp . |
177 | .It Ic cd Ar path | 230 | .It Ic cd Ar path |
178 | Change remote directory to | 231 | Change remote directory to |
179 | .Ar path . | 232 | .Ar path . |
180 | .It Ic lcd Ar path | ||
181 | Change local directory to | ||
182 | .Ar path . | ||
183 | .It Ic chgrp Ar grp Ar path | 233 | .It Ic chgrp Ar grp Ar path |
184 | Change group of file | 234 | Change group of file |
185 | .Ar path | 235 | .Ar path |
@@ -219,6 +269,9 @@ flag is specified, then the file's full permission and access time are | |||
219 | copied too. | 269 | copied too. |
220 | .It Ic help | 270 | .It Ic help |
221 | Display help text. | 271 | Display help text. |
272 | .It Ic lcd Ar path | ||
273 | Change local directory to | ||
274 | .Ar path . | ||
222 | .It Ic lls Op Ar ls-options Op Ar path | 275 | .It Ic lls Op Ar ls-options Op Ar path |
223 | Display local directory listing of either | 276 | Display local directory listing of either |
224 | .Ar path | 277 | .Ar path |
@@ -280,12 +333,12 @@ Rename remote file from | |||
280 | .Ar oldpath | 333 | .Ar oldpath |
281 | to | 334 | to |
282 | .Ar newpath . | 335 | .Ar newpath . |
283 | .It Ic rmdir Ar path | ||
284 | Remove remote directory specified by | ||
285 | .Ar path . | ||
286 | .It Ic rm Ar path | 336 | .It Ic rm Ar path |
287 | Delete remote file specified by | 337 | Delete remote file specified by |
288 | .Ar path . | 338 | .Ar path . |
339 | .It Ic rmdir Ar path | ||
340 | Remove remote directory specified by | ||
341 | .Ar path . | ||
289 | .It Ic symlink Ar oldpath Ar newpath | 342 | .It Ic symlink Ar oldpath Ar newpath |
290 | Create a symbolic link from | 343 | Create a symbolic link from |
291 | .Ar oldpath | 344 | .Ar oldpath |
@@ -305,6 +358,7 @@ Escape to local shell. | |||
305 | Synonym for help. | 358 | Synonym for help. |
306 | .El | 359 | .El |
307 | .Sh SEE ALSO | 360 | .Sh SEE ALSO |
361 | .Xr ftp 1 , | ||
308 | .Xr scp 1 , | 362 | .Xr scp 1 , |
309 | .Xr ssh 1 , | 363 | .Xr ssh 1 , |
310 | .Xr ssh-add 1 , | 364 | .Xr ssh-add 1 , |