summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.067
1 files changed, 34 insertions, 33 deletions
diff --git a/sftp.0 b/sftp.0
index 45b8faf55..7ad3e8d3f 100644
--- a/sftp.0
+++ b/sftp.0
@@ -7,32 +7,29 @@ SYNOPSIS
7 sftp [-46aCfpqrv] [-B buffer_size] [-b batchfile] [-c cipher] 7 sftp [-46aCfpqrv] [-B buffer_size] [-b batchfile] [-c cipher]
8 [-D sftp_server_path] [-F ssh_config] [-i identity_file] [-l limit] 8 [-D sftp_server_path] [-F ssh_config] [-i identity_file] [-l limit]
9 [-o ssh_option] [-P port] [-R num_requests] [-S program] 9 [-o ssh_option] [-P port] [-R num_requests] [-S program]
10 [-s subsystem | sftp_server] host 10 [-s subsystem | sftp_server] destination
11 sftp [user@]host[:file ...]
12 sftp [user@]host[:dir[/]]
13 sftp -b batchfile [user@]host
14 11
15DESCRIPTION 12DESCRIPTION
16 sftp is an interactive file transfer program, similar to ftp(1), which 13 sftp is a file transfer program, similar to ftp(1), which performs all
17 performs all operations over an encrypted ssh(1) transport. It may also 14 operations over an encrypted ssh(1) transport. It may also use many
18 use many features of ssh, such as public key authentication and 15 features of ssh, such as public key authentication and compression.
19 compression. sftp connects and logs into the specified host, then enters
20 an interactive command mode.
21 16
22 The second usage format will retrieve files automatically if a non- 17 The destination may be specified either as [user@]host[:path] or as a URI
23 interactive authentication method is used; otherwise it will do so after 18 in the form sftp://[user@]host[:port][/path].
24 successful interactive authentication.
25 19
26 The third usage format allows sftp to start in a remote directory. 20 If the destination includes a path and it is not a directory, sftp will
21 retrieve files automatically if a non-interactive authentication method
22 is used; otherwise it will do so after successful interactive
23 authentication.
27 24
28 The final usage format allows for automated sessions using the -b option. 25 If no path is specified, or if the path is a directory, sftp will log in
29 In such cases, it is necessary to configure non-interactive 26 to the specified host and enter interactive command mode, changing to the
30 authentication to obviate the need to enter a password at connection time 27 remote directory if one was specified. An optional trailing slash can be
31 (see sshd(8) and ssh-keygen(1) for details). 28 used to force the path to be interpreted as a directory.
32 29
33 Since some usage formats use colon characters to delimit host names from 30 Since the destination formats use colon characters to delimit host names
34 path names, IPv6 addresses must be enclosed in square brackets to avoid 31 from path names or port numbers, IPv6 addresses must be enclosed in
35 ambiguity. 32 square brackets to avoid ambiguity.
36 33
37 The options are as follows: 34 The options are as follows:
38 35
@@ -53,14 +50,15 @@ DESCRIPTION
53 -b batchfile 50 -b batchfile
54 Batch mode reads a series of commands from an input batchfile 51 Batch mode reads a series of commands from an input batchfile
55 instead of stdin. Since it lacks user interaction it should be 52 instead of stdin. Since it lacks user interaction it should be
56 used in conjunction with non-interactive authentication. A 53 used in conjunction with non-interactive authentication to
57 batchfile of M-bM-^@M-^X-M-bM-^@M-^Y may be used to indicate standard input. sftp 54 obviate the need to enter a password at connection time (see
58 will abort if any of the following commands fail: get, put, 55 sshd(8) and ssh-keygen(1) for details). A batchfile of M-bM-^@M-^X-M-bM-^@M-^Y may
59 reget, reput, rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, 56 be used to indicate standard input. sftp will abort if any of
60 chown, chgrp, lpwd, df, symlink, and lmkdir. Termination on 57 the following commands fail: get, put, reget, reput, rename, ln,
61 error can be suppressed on a command by command basis by 58 rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp, lpwd, df,
62 prefixing the command with a M-bM-^@M-^X-M-bM-^@M-^Y character (for example, -rm 59 symlink, and lmkdir. Termination on error can be suppressed on a
63 /tmp/blah*). 60 command by command basis by prefixing the command with a M-bM-^@M-^X-M-bM-^@M-^Y
61 character (for example, -rm /tmp/blah*).
64 62
65 -C Enables compression (via ssh's -C flag). 63 -C Enables compression (via ssh's -C flag).
66 64
@@ -99,6 +97,7 @@ DESCRIPTION
99 AddressFamily 97 AddressFamily
100 BatchMode 98 BatchMode
101 BindAddress 99 BindAddress
100 BindInterface
102 CanonicalDomains 101 CanonicalDomains
103 CanonicalizeFallbackLocal 102 CanonicalizeFallbackLocal
104 CanonicalizeHostname 103 CanonicalizeHostname
@@ -193,8 +192,9 @@ INTERACTIVE COMMANDS
193 192
194 bye Quit sftp. 193 bye Quit sftp.
195 194
196 cd path 195 cd [path]
197 Change remote directory to path. 196 Change remote directory to path. If path is not specified, then
197 change directory to the one the session started in.
198 198
199 chgrp grp path 199 chgrp grp path
200 Change group of file path to grp. path may contain glob(3) 200 Change group of file path to grp. path may contain glob(3)
@@ -246,8 +246,9 @@ INTERACTIVE COMMANDS
246 246
247 help Display help text. 247 help Display help text.
248 248
249 lcd path 249 lcd [path]
250 Change local directory to path. 250 Change local directory to path. If path is not specified, then
251 change directory to the local user's home directory.
251 252
252 lls [ls-options [path]] 253 lls [ls-options [path]]
253 Display local directory listing of either path or current 254 Display local directory listing of either path or current
@@ -374,4 +375,4 @@ SEE ALSO
374 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- 375 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
375 filexfer-00.txt, January 2001, work in progress material. 376 filexfer-00.txt, January 2001, work in progress material.
376 377
377OpenBSD 6.2 May 3, 2017 OpenBSD 6.2 378OpenBSD 6.2 February 23, 2018 OpenBSD 6.2