summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.045
1 files changed, 23 insertions, 22 deletions
diff --git a/sftp.0 b/sftp.0
index 479751215..b72ea4700 100644
--- a/sftp.0
+++ b/sftp.0
@@ -1,7 +1,7 @@
1SFTP(1) BSD General Commands Manual SFTP(1) 1SFTP(1) BSD General Commands Manual SFTP(1)
2 2
3NAME 3NAME
4 sftp - Secure file transfer program 4 sftp - secure file transfer program
5 5
6SYNOPSIS 6SYNOPSIS
7 sftp [-vC1] [-b batchfile] [-o ssh_option] [-s subsystem | sftp_server] 7 sftp [-vC1] [-b batchfile] [-o ssh_option] [-s subsystem | sftp_server]
@@ -9,6 +9,7 @@ SYNOPSIS
9 [-R num_requests] [-S program] host 9 [-R num_requests] [-S program] host
10 sftp [[user@]host[:file [file]]] 10 sftp [[user@]host[:file [file]]]
11 sftp [[user@]host[:dir[/]]] 11 sftp [[user@]host[:dir[/]]]
12 sftp -b batchfile [user@]host
12 13
13DESCRIPTION 14DESCRIPTION
14 sftp is an interactive file transfer program, similar to ftp(1), which 15 sftp is an interactive file transfer program, similar to ftp(1), which
@@ -21,10 +22,13 @@ DESCRIPTION
21 active authentication method is used; otherwise it will do so after suc- 22 active authentication method is used; otherwise it will do so after suc-
22 cessful interactive authentication. 23 cessful interactive authentication.
23 24
24 The last usage format allows the sftp client to start in a remote direc- 25 The third usage format allows the sftp client to start in a remote direc-
25 tory. 26 tory.
26 27
27 The options are as follows: 28 The final usage format allows for automated sessions using the -b option.
29 In such cases, it is usually necessary to configure public key authenti-
30 cation to obviate the need to enter a password at connection time (see
31 sshd(8) and ssh-keygen(1) for details). The options are as follows:
28 32
29 -b batchfile 33 -b batchfile
30 Batch mode reads a series of commands from an input batchfile 34 Batch mode reads a series of commands from an input batchfile
@@ -33,42 +37,42 @@ DESCRIPTION
33 will abort if any of the following commands fail: get, put, 37 will abort if any of the following commands fail: get, put,
34 rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp, 38 rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp,
35 lpwd and lmkdir. Termination on error can be suppressed on a 39 lpwd and lmkdir. Termination on error can be suppressed on a
36 command by command basis by prefixing the command with a M-bM-^@M-^M-bM-^@M-^Y-M-bM-^@M-^M-bM-^@M-^Y 40 command by command basis by prefixing the command with a M-bM-^@M-^X-M-bM-^@M-^Y
37 character (For example, -rm /tmp/blah* ). 41 character (for example, -rm /tmp/blah*).
38 42
39 -o ssh_option 43 -o ssh_option
40 Can be used to pass options to ssh in the format used in 44 Can be used to pass options to ssh in the format used in
41 ssh_config(5). This is useful for specifying options for which 45 ssh_config(5). This is useful for specifying options for which
42 there is no separate sftp command-line flag. For example, to 46 there is no separate sftp command-line flag. For example, to
43 specify an alternate port use: sftp -oPort=24. 47 specify an alternate port use: sftp -oPort=24.
44 48
45 -s subsystem | sftp_server 49 -s subsystem | sftp_server
46 Specifies the SSH2 subsystem or the path for an sftp server on 50 Specifies the SSH2 subsystem or the path for an sftp server on
47 the remote host. A path is useful for using sftp over protocol 51 the remote host. A path is useful for using sftp over protocol
48 version 1, or when the remote sshd does not have an sftp subsys- 52 version 1, or when the remote sshd(8) does not have an sftp sub-
49 tem configured. 53 system configured.
50 54
51 -v Raise logging level. This option is also passed to ssh. 55 -v Raise logging level. This option is also passed to ssh.
52 56
53 -B buffer_size 57 -B buffer_size
54 Specify the size of the buffer that sftp uses when transferring 58 Specify the size of the buffer that sftp uses when transferring
55 files. Larger buffers require fewer round trips at the cost of 59 files. Larger buffers require fewer round trips at the cost of
56 higher memory consumption. The default is 32768 bytes. 60 higher memory consumption. The default is 32768 bytes.
57 61
58 -C Enables compression (via sshM-bM-^@M-^Ys -C flag). 62 -C Enables compression (via sshM-bM-^@M-^Ys -C flag).
59 63
60 -F ssh_config 64 -F ssh_config
61 Specifies an alternative per-user configuration file for ssh. 65 Specifies an alternative per-user configuration file for ssh(1).
62 This option is directly passed to ssh(1). 66 This option is directly passed to ssh(1).
63 67
64 -P sftp_server path 68 -P sftp_server path
65 Connect directly to a local sftp-server (rather than via ssh) 69 Connect directly to a local sftp server (rather than via ssh(1))
66 This option may be useful in debugging the client and server. 70 This option may be useful in debugging the client and server.
67 71
68 -R num_requests 72 -R num_requests
69 Specify how many requests may be outstanding at any one time. 73 Specify how many requests may be outstanding at any one time.
70 Increasing this may slightly improve file transfer speed but will 74 Increasing this may slightly improve file transfer speed but will
71 increase memory usage. The default is 16 outstanding requests. 75 increase memory usage. The default is 16 outstanding requests.
72 76
73 -S program 77 -S program
74 Name of the program to use for the encrypted connection. The 78 Name of the program to use for the encrypted connection. The
@@ -103,7 +107,7 @@ INTERACTIVE COMMANDS
103 get [flags] remote-path [local-path] 107 get [flags] remote-path [local-path]
104 Retrieve the remote-path and store it on the local machine. If 108 Retrieve the remote-path and store it on the local machine. If
105 the local path name is not specified, it is given the same name 109 the local path name is not specified, it is given the same name
106 it has on the remote machine. If the -P flag is specified, then 110 it has on the remote machine. If the -P flag is specified, then
107 the fileM-bM-^@M-^Ys full permission and access time are copied too. 111 the fileM-bM-^@M-^Ys full permission and access time are copied too.
108 112
109 help Display help text. 113 help Display help text.
@@ -122,7 +126,7 @@ INTERACTIVE COMMANDS
122 126
123 ls [flags] [path] 127 ls [flags] [path]
124 Display remote directory listing of either path or current direc- 128 Display remote directory listing of either path or current direc-
125 tory if path is not specified. If the -l flag is specified, then 129 tory if path is not specified. If the -l flag is specified, then
126 display additional details including permissions and ownership 130 display additional details including permissions and ownership
127 information. 131 information.
128 132
@@ -136,9 +140,9 @@ INTERACTIVE COMMANDS
136 Toggle display of progress meter. 140 Toggle display of progress meter.
137 141
138 put [flags] local-path [remote-path] 142 put [flags] local-path [remote-path]
139 Upload local-path and store it on the remote machine. If the 143 Upload local-path and store it on the remote machine. If the
140 remote path name is not specified, it is given the same name it 144 remote path name is not specified, it is given the same name it
141 has on the local machine. If the -P flag is specified, then the 145 has on the local machine. If the -P flag is specified, then the
142 fileM-bM-^@M-^Ys full permission and access time are copied too. 146 fileM-bM-^@M-^Ys full permission and access time are copied too.
143 147
144 pwd Display remote working directory. 148 pwd Display remote working directory.
@@ -167,9 +171,6 @@ INTERACTIVE COMMANDS
167 171
168 ? Synonym for help. 172 ? Synonym for help.
169 173
170AUTHORS
171 Damien Miller <djm@mindrot.org>
172
173SEE ALSO 174SEE ALSO
174 scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), sftp-server(8), 175 scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), sftp-server(8),
175 sshd(8) 176 sshd(8)