summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.077
1 files changed, 61 insertions, 16 deletions
diff --git a/sftp.0 b/sftp.0
index 1b81391e5..cb1bb033e 100644
--- a/sftp.0
+++ b/sftp.0
@@ -4,8 +4,9 @@ NAME
4 sftp - secure file transfer program 4 sftp - secure file transfer program
5 5
6SYNOPSIS 6SYNOPSIS
7 sftp [-1Cv] [-B buffer_size] [-b batchfile] [-F ssh_config] 7 sftp [-1246Cpqrv] [-B buffer_size] [-b batchfile] [-c cipher]
8 [-o ssh_option] [-P sftp_server_path] [-R num_requests] [-S program] 8 [-D sftp_server_path] [-F ssh_config] [-i identity_file]
9 [-o ssh_option] [-P port] [-R num_requests] [-S program]
9 [-s subsystem | sftp_server] host 10 [-s subsystem | sftp_server] host
10 sftp [user@]host[:file ...] 11 sftp [user@]host[:file ...]
11 sftp [user@]host[:dir[/]] 12 sftp [user@]host[:dir[/]]
@@ -31,6 +32,12 @@ DESCRIPTION
31 32
32 -1 Specify the use of protocol version 1. 33 -1 Specify the use of protocol version 1.
33 34
35 -2 Specify the use of protocol version 2.
36
37 -4 Forces sftp to use IPv4 addresses only.
38
39 -6 Forces sftp to use IPv6 addresses only.
40
34 -B buffer_size 41 -B buffer_size
35 Specify the size of the buffer that sftp uses when transferring 42 Specify the size of the buffer that sftp uses when transferring
36 files. Larger buffers require fewer round trips at the cost of 43 files. Larger buffers require fewer round trips at the cost of
@@ -49,10 +56,23 @@ DESCRIPTION
49 56
50 -C Enables compression (via ssh's -C flag). 57 -C Enables compression (via ssh's -C flag).
51 58
59 -c cipher
60 Selects the cipher to use for encrypting the data transfers.
61 This option is directly passed to ssh(1).
62
63 -D sftp_server_path
64 Connect directly to a local sftp server (rather than via ssh(1)).
65 This option may be useful in debugging the client and server.
66
52 -F ssh_config 67 -F ssh_config
53 Specifies an alternative per-user configuration file for ssh(1). 68 Specifies an alternative per-user configuration file for ssh(1).
54 This option is directly passed to ssh(1). 69 This option is directly passed to ssh(1).
55 70
71 -i identity_file
72 Selects the file from which the identity (private key) for public
73 key authentication is read. This option is directly passed to
74 ssh(1).
75
56 -o ssh_option 76 -o ssh_option
57 Can be used to pass options to ssh in the format used in 77 Can be used to pass options to ssh in the format used in
58 ssh_config(5). This is useful for specifying options for which 78 ssh_config(5). This is useful for specifying options for which
@@ -91,6 +111,7 @@ DESCRIPTION
91 NoHostAuthenticationForLocalhost 111 NoHostAuthenticationForLocalhost
92 NumberOfPasswordPrompts 112 NumberOfPasswordPrompts
93 PasswordAuthentication 113 PasswordAuthentication
114 PKCS11Provider
94 Port 115 Port
95 PreferredAuthentications 116 PreferredAuthentications
96 Protocol 117 Protocol
@@ -102,7 +123,6 @@ DESCRIPTION
102 SendEnv 123 SendEnv
103 ServerAliveInterval 124 ServerAliveInterval
104 ServerAliveCountMax 125 ServerAliveCountMax
105 SmartcardDevice
106 StrictHostKeyChecking 126 StrictHostKeyChecking
107 TCPKeepAlive 127 TCPKeepAlive
108 UsePrivilegedPort 128 UsePrivilegedPort
@@ -110,15 +130,24 @@ DESCRIPTION
110 UserKnownHostsFile 130 UserKnownHostsFile
111 VerifyHostKeyDNS 131 VerifyHostKeyDNS
112 132
113 -P sftp_server_path 133 -P port
114 Connect directly to a local sftp server (rather than via ssh(1)). 134 Specifies the port to connect to on the remote host.
115 This option may be useful in debugging the client and server. 135
136 -p Preserves modification times, access times, and modes from the
137 original files transferred.
138
139 -q Quiet mode: disables the progress meter as well as warning and
140 diagnostic messages from ssh(1).
116 141
117 -R num_requests 142 -R num_requests
118 Specify how many requests may be outstanding at any one time. 143 Specify how many requests may be outstanding at any one time.
119 Increasing this may slightly improve file transfer speed but will 144 Increasing this may slightly improve file transfer speed but will
120 increase memory usage. The default is 64 outstanding requests. 145 increase memory usage. The default is 64 outstanding requests.
121 146
147 -r Recursively copy entire directories when uploading and download-
148 ing. Note that sftp does not follow symbolic links encountered
149 in the tree traversal.
150
122 -S program 151 -S program
123 Name of the program to use for the encrypted connection. The 152 Name of the program to use for the encrypted connection. The
124 program must understand ssh(1) options. 153 program must understand ssh(1) options.
@@ -165,14 +194,19 @@ INTERACTIVE COMMANDS
165 194
166 exit Quit sftp. 195 exit Quit sftp.
167 196
168 get [-P] remote-path [local-path] 197 get [-Ppr] remote-path [local-path]
169 Retrieve the remote-path and store it on the local machine. If 198 Retrieve the remote-path and store it on the local machine. If
170 the local path name is not specified, it is given the same name 199 the local path name is not specified, it is given the same name
171 it has on the remote machine. remote-path may contain glob(3) 200 it has on the remote machine. remote-path may contain glob(3)
172 characters and may match multiple files. If it does and local- 201 characters and may match multiple files. If it does and local-
173 path is specified, then local-path must specify a directory. If 202 path is specified, then local-path must specify a directory.
174 the -P flag is specified, then full file permissions and access 203
175 times are copied too. 204 If either the -P or -p flag is specified, then full file permis-
205 sions and access times are copied too.
206
207 If the -r flag is specified then directories will be copied re-
208 cursively. Note that sftp does not follow symbolic links when
209 performing recursive transfers.
176 210
177 help Display help text. 211 help Display help text.
178 212
@@ -193,7 +227,7 @@ INTERACTIVE COMMANDS
193 227
194 lpwd Print local working directory. 228 lpwd Print local working directory.
195 229
196 ls [-1aflnrSt] [path] 230 ls [-1afhlnrSt] [path]
197 Display a remote directory listing of either path or the current 231 Display a remote directory listing of either path or the current
198 directory if path is not specified. path may contain glob(3) 232 directory if path is not specified. path may contain glob(3)
199 characters and may match multiple files. 233 characters and may match multiple files.
@@ -208,6 +242,12 @@ INTERACTIVE COMMANDS
208 -f Do not sort the listing. The default sort order is lexi- 242 -f Do not sort the listing. The default sort order is lexi-
209 cographical. 243 cographical.
210 244
245 -h When used with a long format option, use unit suffixes:
246 Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte,
247 and Exabyte in order to reduce the number of digits to
248 four or fewer using powers of 2 for sizes (K=1024,
249 M=1048576, etc.).
250
211 -l Display additional details including permissions and own- 251 -l Display additional details including permissions and own-
212 ership information. 252 ership information.
213 253
@@ -229,14 +269,19 @@ INTERACTIVE COMMANDS
229 progress 269 progress
230 Toggle display of progress meter. 270 Toggle display of progress meter.
231 271
232 put [-P] local-path [remote-path] 272 put [-Ppr] local-path [remote-path]
233 Upload local-path and store it on the remote machine. If the re- 273 Upload local-path and store it on the remote machine. If the re-
234 mote path name is not specified, it is given the same name it has 274 mote path name is not specified, it is given the same name it has
235 on the local machine. local-path may contain glob(3) characters 275 on the local machine. local-path may contain glob(3) characters
236 and may match multiple files. If it does and remote-path is 276 and may match multiple files. If it does and remote-path is
237 specified, then remote-path must specify a directory. If the -P 277 specified, then remote-path must specify a directory.
238 flag is specified, then the file's full permission and access 278
239 time are copied too. 279 If ether the -P or -p flag is specified, then full file permis-
280 sions and access times are copied too.
281
282 If the -r flag is specified then directories will be copied re-
283 cursively. Note that sftp does not follow symbolic links when
284 performing recursive transfers.
240 285
241 pwd Display remote working directory. 286 pwd Display remote working directory.
242 287
@@ -271,4 +316,4 @@ SEE ALSO
271 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- 316 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
272 filexfer-00.txt, January 2001, work in progress material. 317 filexfer-00.txt, January 2001, work in progress material.
273 318
274OpenBSD 4.6 December 9, 2008 5 319OpenBSD 4.6 February 8, 2010 5