summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2004-03-01 02:25:32 +0000
committerColin Watson <cjwatson@debian.org>2004-03-01 02:25:32 +0000
commitea8116a11e3de70036dbc665ccb0d486cf89cac9 (patch)
treed73ccdff78d8608e156465af42e6a1b3527fb2d6 /sftp.0
parente39b311381a5609cc05acf298c42fba196dc524b (diff)
parentf5bda272678ec6dccaa5f29379cf60cb855018e8 (diff)
Merge 3.8p1 to the trunk. This builds and runs, but I haven't tested it
extensively yet. ProtocolKeepAlives is now just a compatibility alias for ServerAliveInterval.
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0209
1 files changed, 124 insertions, 85 deletions
diff --git a/sftp.0 b/sftp.0
index b72ea4700..acb400dad 100644
--- a/sftp.0
+++ b/sftp.0
@@ -1,12 +1,12 @@
1SFTP(1) BSD General Commands Manual SFTP(1) 1SFTP(1) OpenBSD Reference 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 [-1Cv] [-B buffer_size] [-b batchfile] [-F ssh_config]
8 [-B buffer_size] [-F ssh_config] [-P sftp_server path] 8 [-o ssh_option] [-P sftp_server_path] [-R num_requests] [-S program]
9 [-R num_requests] [-S program] host 9 [-s subsystem | sftp_server] 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 sftp -b batchfile [user@]host
@@ -15,8 +15,8 @@ DESCRIPTION
15 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
16 performs all operations over an encrypted ssh(1) transport. It may also 16 performs all operations over an encrypted ssh(1) transport. It may also
17 use many features of ssh, such as public key authentication and compres- 17 use many features of ssh, such as public key authentication and compres-
18 sion. sftp connects and logs into the specified host, then enters an 18 sion. sftp connects and logs into the specified host, then enters an in-
19 interactive command mode. 19 teractive command mode.
20 20
21 The second usage format will retrieve files automatically if a non-inter- 21 The second usage format will retrieve files automatically if a non-inter-
22 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-
@@ -30,42 +30,81 @@ DESCRIPTION
30 cation to obviate the need to enter a password at connection time (see 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: 31 sshd(8) and ssh-keygen(1) for details). The options are as follows:
32 32
33 -b batchfile 33 -1 Specify the use of protocol version 1.
34 Batch mode reads a series of commands from an input batchfile
35 instead of stdin. Since it lacks user interaction it should be
36 used in conjunction with non-interactive authentication. sftp
37 will abort if any of the following commands fail: get, put,
38 rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp,
39 lpwd and lmkdir. Termination on error can be suppressed on a
40 command by command basis by prefixing the command with a M-bM-^@M-^X-M-bM-^@M-^Y
41 character (for example, -rm /tmp/blah*).
42
43 -o ssh_option
44 Can be used to pass options to ssh in the format used in
45 ssh_config(5). This is useful for specifying options for which
46 there is no separate sftp command-line flag. For example, to
47 specify an alternate port use: sftp -oPort=24.
48
49 -s subsystem | sftp_server
50 Specifies the SSH2 subsystem or the path for an sftp server on
51 the remote host. A path is useful for using sftp over protocol
52 version 1, or when the remote sshd(8) does not have an sftp sub-
53 system configured.
54
55 -v Raise logging level. This option is also passed to ssh.
56 34
57 -B buffer_size 35 -B buffer_size
58 Specify the size of the buffer that sftp uses when transferring 36 Specify the size of the buffer that sftp uses when transferring
59 files. Larger buffers require fewer round trips at the cost of 37 files. Larger buffers require fewer round trips at the cost of
60 higher memory consumption. The default is 32768 bytes. 38 higher memory consumption. The default is 32768 bytes.
61 39
62 -C Enables compression (via sshM-bM-^@M-^Ys -C flag). 40 -b batchfile
41 Batch mode reads a series of commands from an input batchfile in-
42 stead of stdin. Since it lacks user interaction it should be
43 used in conjunction with non-interactive authentication. A
44 batchfile of `-' may be used to indicate standard input. sftp
45 will abort if any of the following commands fail: get, put,
46 rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp,
47 lpwd and lmkdir. Termination on error can be suppressed on a
48 command by command basis by prefixing the command with a `-'
49 character (for example, -rm /tmp/blah*).
50
51 -C Enables compression (via ssh's -C flag).
63 52
64 -F ssh_config 53 -F ssh_config
65 Specifies an alternative per-user configuration file for ssh(1). 54 Specifies an alternative per-user configuration file for ssh(1).
66 This option is directly passed to ssh(1). 55 This option is directly passed to ssh(1).
67 56
68 -P sftp_server path 57 -o ssh_option
58 Can be used to pass options to ssh in the format used in
59 ssh_config(5). This is useful for specifying options for which
60 there is no separate sftp command-line flag. For example, to
61 specify an alternate port use: sftp -oPort=24. For full details
62 of the options listed below, and their possible values, see
63 ssh_config(5).
64
65 AddressFamily
66 BatchMode
67 BindAddress
68 ChallengeResponseAuthentication
69 CheckHostIP
70 Cipher
71 Ciphers
72 Compression
73 CompressionLevel
74 ConnectionAttempts
75 ConnectionTimeout
76 GlobalKnownHostsFile
77 GSSAPIAuthentication
78 GSSAPIDelegateCredentials
79 Host
80 HostbasedAuthentication
81 HostKeyAlgorithms
82 HostKeyAlias
83 HostName
84 IdentityFile
85 LogLevel
86 MACs
87 NoHostAuthenticationForLocalhost
88 NumberOfPasswordPrompts
89 PasswordAuthentication
90 Port
91 PreferredAuthentications
92 Protocol
93 ProxyCommand
94 PubkeyAuthentication
95 RhostsRSAAuthentication
96 RSAAuthentication
97 ServerAliveInterval
98 ServerAliveCountMax
99 SmartcardDevice
100 StrictHostKeyChecking
101 TCPKeepAlive
102 UsePrivilegedPort
103 User
104 UserKnownHostsFile
105 VerifyHostKeyDNS
106
107 -P sftp_server_path
69 Connect directly to a local sftp server (rather than via ssh(1)) 108 Connect directly to a local sftp server (rather than via ssh(1))
70 This option may be useful in debugging the client and server. 109 This option may be useful in debugging the client and server.
71 110
@@ -78,104 +117,104 @@ DESCRIPTION
78 Name of the program to use for the encrypted connection. The 117 Name of the program to use for the encrypted connection. The
79 program must understand ssh(1) options. 118 program must understand ssh(1) options.
80 119
81 -1 Specify the use of protocol version 1. 120 -s subsystem | sftp_server
121 Specifies the SSH2 subsystem or the path for an sftp server on
122 the remote host. A path is useful for using sftp over protocol
123 version 1, or when the remote sshd(8) does not have an sftp sub-
124 system configured.
125
126 -v Raise logging level. This option is also passed to ssh.
82 127
83INTERACTIVE COMMANDS 128INTERACTIVE COMMANDS
84 Once in interactive mode, sftp understands a set of commands similar to 129 Once in interactive mode, sftp understands a set of commands similar to
85 those of ftp(1). Commands are case insensitive and pathnames may be 130 those of ftp(1). Commands are case insensitive and pathnames may be en-
86 enclosed in quotes if they contain spaces. 131 closed in quotes if they contain spaces.
87 132
88 bye Quit sftp. 133 bye Quit sftp.
89 134
90 cd path 135 cd path Change remote directory to path.
91 Change remote directory to path.
92
93 lcd path
94 Change local directory to path.
95 136
96 chgrp grp path 137 chgrp grp path
97 Change group of file path to grp. grp must be a numeric GID. 138 Change group of file path to grp. grp must be a numeric GID.
98 139
99 chmod mode path 140 chmod mode path
100 Change permissions of file path to mode. 141 Change permissions of file path to mode.
101 142
102 chown own path 143 chown own path
103 Change owner of file path to own. own must be a numeric UID. 144 Change owner of file path to own. own must be a numeric UID.
104 145
105 exit Quit sftp. 146 exit Quit sftp.
106 147
107 get [flags] remote-path [local-path] 148 get [flags] remote-path [local-path]
108 Retrieve the remote-path and store it on the local machine. If 149 Retrieve the remote-path and store it on the local machine.
109 the local path name is not specified, it is given the same name 150 If the local path name is not specified, it is given the same
110 it has on the remote machine. If the -P flag is specified, then 151 name it has on the remote machine. If the -P flag is speci-
111 the fileM-bM-^@M-^Ys full permission and access time are copied too. 152 fied, then the file's full permission and access time are
153 copied too.
154
155 help Display help text.
112 156
113 help Display help text. 157 lcd path Change local directory to path.
114 158
115 lls [ls-options [path]] 159 lls [ls-options [path]]
116 Display local directory listing of either path or current direc- 160 Display local directory listing of either path or current di-
117 tory if path is not specified. 161 rectory if path is not specified.
118 162
119 lmkdir path 163 lmkdir path
120 Create local directory specified by path. 164 Create local directory specified by path.
121 165
122 ln oldpath newpath 166 ln oldpath newpath
123 Create a symbolic link from oldpath to newpath. 167 Create a symbolic link from oldpath to newpath.
124 168
125 lpwd Print local working directory. 169 lpwd Print local working directory.
126 170
127 ls [flags] [path] 171 ls [flags] [path]
128 Display remote directory listing of either path or current direc- 172 Display remote directory listing of either path or current
129 tory if path is not specified. If the -l flag is specified, then 173 directory if path is not specified. If the -l flag is speci-
130 display additional details including permissions and ownership 174 fied, then display additional details including permissions
131 information. 175 and ownership information.
132 176
133 lumask umask 177 lumask umask
134 Set local umask to umask. 178 Set local umask to umask.
135 179
136 mkdir path 180 mkdir path Create remote directory specified by path.
137 Create remote directory specified by path.
138 181
139 progress 182 progress Toggle display of progress meter.
140 Toggle display of progress meter.
141 183
142 put [flags] local-path [remote-path] 184 put [flags] local-path [remote-path]
143 Upload local-path and store it on the remote machine. If the 185 Upload local-path and store it on the remote machine. If the
144 remote path name is not specified, it is given the same name it 186 remote path name is not specified, it is given the same name
145 has on the local machine. If the -P flag is specified, then the 187 it has on the local machine. If the -P flag is specified,
146 fileM-bM-^@M-^Ys full permission and access time are copied too. 188 then the file's full permission and access time are copied
189 too.
147 190
148 pwd Display remote working directory. 191 pwd Display remote working directory.
149 192
150 quit Quit sftp. 193 quit Quit sftp.
151 194
152 rename oldpath newpath 195 rename oldpath newpath
153 Rename remote file from oldpath to newpath. 196 Rename remote file from oldpath to newpath.
154 197
155 rmdir path 198 rm path Delete remote file specified by path.
156 Remove remote directory specified by path.
157 199
158 rm path 200 rmdir path Remove remote directory specified by path.
159 Delete remote file specified by path.
160 201
161 symlink oldpath newpath 202 symlink oldpath newpath
162 Create a symbolic link from oldpath to newpath. 203 Create a symbolic link from oldpath to newpath.
163 204
164 version 205 version Display the sftp protocol version.
165 Display the sftp protocol version.
166 206
167 ! command 207 ! command Execute command in local shell.
168 Execute command in local shell.
169 208
170 ! Escape to local shell. 209 ! Escape to local shell.
171 210
172 ? Synonym for help. 211 ? Synonym for help.
173 212
174SEE ALSO 213SEE ALSO
175 scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), sftp-server(8), 214 ftp(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5),
176 sshd(8) 215 sftp-server(8), sshd(8)
177 216
178 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- 217 T. Ylonen, and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
179 filexfer-00.txt, January 2001, work in progress material. 218 filexfer-00.txt, January 2001, work in progress material.
180 219
181BSD February 4, 2001 BSD 220OpenBSD 3.4 February 4, 2001 4
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-14 17:13:38 +0000