summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0101
1 files changed, 53 insertions, 48 deletions
diff --git a/sftp.0 b/sftp.0
index 488548a6e..40de1a0cd 100644
--- a/sftp.0
+++ b/sftp.0
@@ -15,20 +15,20 @@ SYNOPSIS
15DESCRIPTION 15DESCRIPTION
16 sftp is an interactive file transfer program, similar to ftp(1), which 16 sftp is an interactive file transfer program, similar to ftp(1), which
17 performs all operations over an encrypted ssh(1) transport. It may also 17 performs all operations over an encrypted ssh(1) transport. It may also
18 use many features of ssh, such as public key authentication and compres- 18 use many features of ssh, such as public key authentication and
19 sion. sftp connects and logs into the specified host, then enters an in- 19 compression. sftp connects and logs into the specified host, then enters
20 teractive command mode. 20 an interactive command mode.
21 21
22 The second usage format will retrieve files automatically if a non-inter- 22 The second usage format will retrieve files automatically if a non-
23 active authentication method is used; otherwise it will do so after suc- 23 interactive authentication method is used; otherwise it will do so after
24 cessful interactive authentication. 24 successful interactive authentication.
25 25
26 The third usage format allows sftp to start in a remote directory. 26 The third usage format allows sftp to start in a remote directory.
27 27
28 The final usage format allows for automated sessions using the -b option. 28 The final usage format allows for automated sessions using the -b option.
29 In such cases, it is necessary to configure non-interactive authentica- 29 In such cases, it is necessary to configure non-interactive
30 tion to obviate the need to enter a password at connection time (see 30 authentication to obviate the need to enter a password at connection time
31 sshd(8) and ssh-keygen(1) for details). The options are as follows: 31 (see sshd(8) and ssh-keygen(1) for details). The options are as follows:
32 32
33 -1 Specify the use of protocol version 1. 33 -1 Specify the use of protocol version 1.
34 34
@@ -44,8 +44,8 @@ DESCRIPTION
44 higher memory consumption. The default is 32768 bytes. 44 higher memory consumption. The default is 32768 bytes.
45 45
46 -b batchfile 46 -b batchfile
47 Batch mode reads a series of commands from an input batchfile in- 47 Batch mode reads a series of commands from an input batchfile
48 stead of stdin. Since it lacks user interaction it should be 48 instead of stdin. Since it lacks user interaction it should be
49 used in conjunction with non-interactive authentication. A 49 used in conjunction with non-interactive authentication. A
50 batchfile of `-' may be used to indicate standard input. sftp 50 batchfile of `-' may be used to indicate standard input. sftp
51 will abort if any of the following commands fail: get, put, 51 will abort if any of the following commands fail: get, put,
@@ -144,9 +144,9 @@ DESCRIPTION
144 Increasing this may slightly improve file transfer speed but will 144 Increasing this may slightly improve file transfer speed but will
145 increase memory usage. The default is 64 outstanding requests. 145 increase memory usage. The default is 64 outstanding requests.
146 146
147 -r Recursively copy entire directories when uploading and download- 147 -r Recursively copy entire directories when uploading and
148 ing. Note that sftp does not follow symbolic links encountered 148 downloading. Note that sftp does not follow symbolic links
149 in the tree traversal. 149 encountered in the tree traversal.
150 150
151 -S program 151 -S program
152 Name of the program to use for the encrypted connection. The 152 Name of the program to use for the encrypted connection. The
@@ -155,8 +155,8 @@ DESCRIPTION
155 -s subsystem | sftp_server 155 -s subsystem | sftp_server
156 Specifies the SSH2 subsystem or the path for an sftp server on 156 Specifies the SSH2 subsystem or the path for an sftp server on
157 the remote host. A path is useful for using sftp over protocol 157 the remote host. A path is useful for using sftp over protocol
158 version 1, or when the remote sshd(8) does not have an sftp sub- 158 version 1, or when the remote sshd(8) does not have an sftp
159 system configured. 159 subsystem configured.
160 160
161 -v Raise logging level. This option is also passed to ssh. 161 -v Raise logging level. This option is also passed to ssh.
162 162
@@ -173,16 +173,18 @@ INTERACTIVE COMMANDS
173 Change remote directory to path. 173 Change remote directory to path.
174 174
175 chgrp grp path 175 chgrp grp path
176 Change group of file path to grp. path may contain glob(3) char- 176 Change group of file path to grp. path may contain glob(3)
177 acters and may match multiple files. grp must be a numeric GID. 177 characters and may match multiple files. grp must be a numeric
178 GID.
178 179
179 chmod mode path 180 chmod mode path
180 Change permissions of file path to mode. path may contain 181 Change permissions of file path to mode. path may contain
181 glob(3) characters and may match multiple files. 182 glob(3) characters and may match multiple files.
182 183
183 chown own path 184 chown own path
184 Change owner of file path to own. path may contain glob(3) char- 185 Change owner of file path to own. path may contain glob(3)
185 acters and may match multiple files. own must be a numeric UID. 186 characters and may match multiple files. own must be a numeric
187 UID.
186 188
187 df [-hi] [path] 189 df [-hi] [path]
188 Display usage information for the filesystem holding the current 190 Display usage information for the filesystem holding the current
@@ -198,14 +200,15 @@ INTERACTIVE COMMANDS
198 Retrieve the remote-path and store it on the local machine. If 200 Retrieve the remote-path and store it on the local machine. If
199 the local path name is not specified, it is given the same name 201 the local path name is not specified, it is given the same name
200 it has on the remote machine. remote-path may contain glob(3) 202 it has on the remote machine. remote-path may contain glob(3)
201 characters and may match multiple files. If it does and local- 203 characters and may match multiple files. If it does and
202 path is specified, then local-path must specify a directory. 204 local-path is specified, then local-path must specify a
205 directory.
203 206
204 If either the -P or -p flag is specified, then full file permis- 207 If either the -P or -p flag is specified, then full file
205 sions and access times are copied too. 208 permissions and access times are copied too.
206 209
207 If the -r flag is specified then directories will be copied re- 210 If the -r flag is specified then directories will be copied
208 cursively. Note that sftp does not follow symbolic links when 211 recursively. Note that sftp does not follow symbolic links when
209 performing recursive transfers. 212 performing recursive transfers.
210 213
211 help Display help text. 214 help Display help text.
@@ -214,10 +217,10 @@ INTERACTIVE COMMANDS
214 Change local directory to path. 217 Change local directory to path.
215 218
216 lls [ls-options [path]] 219 lls [ls-options [path]]
217 Display local directory listing of either path or current direc- 220 Display local directory listing of either path or current
218 tory if path is not specified. ls-options may contain any flags 221 directory if path is not specified. ls-options may contain any
219 supported by the local system's ls(1) command. path may contain 222 flags supported by the local system's ls(1) command. path may
220 glob(3) characters and may match multiple files. 223 contain glob(3) characters and may match multiple files.
221 224
222 lmkdir path 225 lmkdir path
223 Create local directory specified by path. 226 Create local directory specified by path.
@@ -239,8 +242,8 @@ INTERACTIVE COMMANDS
239 242
240 -a List files beginning with a dot (`.'). 243 -a List files beginning with a dot (`.').
241 244
242 -f Do not sort the listing. The default sort order is lexi- 245 -f Do not sort the listing. The default sort order is
243 cographical. 246 lexicographical.
244 247
245 -h When used with a long format option, use unit suffixes: 248 -h When used with a long format option, use unit suffixes:
246 Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, 249 Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte,
@@ -248,8 +251,8 @@ INTERACTIVE COMMANDS
248 four or fewer using powers of 2 for sizes (K=1024, 251 four or fewer using powers of 2 for sizes (K=1024,
249 M=1048576, etc.). 252 M=1048576, etc.).
250 253
251 -l Display additional details including permissions and own- 254 -l Display additional details including permissions and
252 ership information. 255 ownership information.
253 256
254 -n Produce a long listing with user and group information 257 -n Produce a long listing with user and group information
255 presented numerically. 258 presented numerically.
@@ -270,17 +273,18 @@ INTERACTIVE COMMANDS
270 Toggle display of progress meter. 273 Toggle display of progress meter.
271 274
272 put [-Ppr] local-path [remote-path] 275 put [-Ppr] local-path [remote-path]
273 Upload local-path and store it on the remote machine. If the re- 276 Upload local-path and store it on the remote machine. If the
274 mote path name is not specified, it is given the same name it has 277 remote path name is not specified, it is given the same name it
275 on the local machine. local-path may contain glob(3) characters 278 has on the local machine. local-path may contain glob(3)
276 and may match multiple files. If it does and remote-path is 279 characters and may match multiple files. If it does and
277 specified, then remote-path must specify a directory. 280 remote-path is specified, then remote-path must specify a
278 281 directory.
279 If ether the -P or -p flag is specified, then full file permis- 282
280 sions and access times are copied too. 283 If ether the -P or -p flag is specified, then full file
281 284 permissions and access times are copied too.
282 If the -r flag is specified then directories will be copied re- 285
283 cursively. Note that sftp does not follow symbolic links when 286 If the -r flag is specified then directories will be copied
287 recursively. Note that sftp does not follow symbolic links when
284 performing recursive transfers. 288 performing recursive transfers.
285 289
286 pwd Display remote working directory. 290 pwd Display remote working directory.
@@ -313,7 +317,8 @@ SEE ALSO
313 ftp(1), ls(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3), 317 ftp(1), ls(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3),
314 ssh_config(5), sftp-server(8), sshd(8) 318 ssh_config(5), sftp-server(8), sshd(8)
315 319
316 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- 320 T. Ylonen, S. Lehtinen, SSH File Transfer Protocol,
317 filexfer-00.txt, January 2001, work in progress material. 321 draft-ietf-secsh-filexfer-00.txt, January 2001, work in progress
322 material.
318 323
319OpenBSD 4.7 February 8, 2010 5 324OpenBSD 4.8 February 8, 2010 OpenBSD 4.8