summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0147
1 files changed, 90 insertions, 57 deletions
diff --git a/sftp.0 b/sftp.0
index 746a410f2..5b1a2fc69 100644
--- a/sftp.0
+++ b/sftp.0
@@ -22,8 +22,7 @@ DESCRIPTION
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-
23 cessful interactive authentication. 23 cessful interactive authentication.
24 24
25 The third usage format allows the sftp client to start in a remote direc- 25 The third usage format allows sftp to start in a remote directory.
26 tory.
27 26
28 The final usage format allows for automated sessions using the -b option. 27 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- 28 In such cases, it is usually necessary to configure public key authenti-
@@ -78,6 +77,7 @@ DESCRIPTION
78 GlobalKnownHostsFile 77 GlobalKnownHostsFile
79 GSSAPIAuthentication 78 GSSAPIAuthentication
80 GSSAPIDelegateCredentials 79 GSSAPIDelegateCredentials
80 HashKnownHosts
81 Host 81 Host
82 HostbasedAuthentication 82 HostbasedAuthentication
83 HostKeyAlgorithms 83 HostKeyAlgorithms
@@ -85,6 +85,7 @@ DESCRIPTION
85 HostName 85 HostName
86 IdentityFile 86 IdentityFile
87 IdentitiesOnly 87 IdentitiesOnly
88 KbdInteractiveDevices
88 LogLevel 89 LogLevel
89 MACs 90 MACs
90 NoHostAuthenticationForLocalhost 91 NoHostAuthenticationForLocalhost
@@ -109,7 +110,7 @@ DESCRIPTION
109 VerifyHostKeyDNS 110 VerifyHostKeyDNS
110 111
111 -P sftp_server_path 112 -P sftp_server_path
112 Connect directly to a local sftp server (rather than via ssh(1)) 113 Connect directly to a local sftp server (rather than via ssh(1)).
113 This option may be useful in debugging the client and server. 114 This option may be useful in debugging the client and server.
114 115
115 -R num_requests 116 -R num_requests
@@ -131,100 +132,132 @@ DESCRIPTION
131 132
132INTERACTIVE COMMANDS 133INTERACTIVE COMMANDS
133 Once in interactive mode, sftp understands a set of commands similar to 134 Once in interactive mode, sftp understands a set of commands similar to
134 those of ftp(1). Commands are case insensitive and pathnames may be en- 135 those of ftp(1). Commands are case insensitive. Pathnames that contain
135 closed in quotes if they contain spaces. 136 spaces must be enclosed in quotes. Any special characters contained
137 within pathnames that are recognized by glob(3) must be escaped with
138 backslashes (`\').
136 139
137 bye Quit sftp. 140 bye Quit sftp.
138 141
139 cd path Change remote directory to path. 142 cd path
143 Change remote directory to path.
140 144
141 chgrp grp path 145 chgrp grp path
142 Change group of file path to grp. grp must be a numeric GID. 146 Change group of file path to grp. path may contain glob(3) char-
147 acters and may match multiple files. grp must be a numeric GID.
143 148
144 chmod mode path 149 chmod mode path
145 Change permissions of file path to mode. 150 Change permissions of file path to mode. path may contain
151 glob(3) characters and may match multiple files.
146 152
147 chown own path 153 chown own path
148 Change owner of file path to own. own must be a numeric UID. 154 Change owner of file path to own. path may contain glob(3) char-
155 acters and may match multiple files. own must be a numeric UID.
149 156
150 exit Quit sftp. 157 exit Quit sftp.
151 158
152 get [flags] remote-path [local-path] 159 get [-P] remote-path [local-path]
153 Retrieve the remote-path and store it on the local machine. 160 Retrieve the remote-path and store it on the local machine. If
154 If the local path name is not specified, it is given the same 161 the local path name is not specified, it is given the same name
155 name it has on the remote machine. If the -P flag is speci- 162 it has on the remote machine. remote-path may contain glob(3)
156 fied, then the file's full permission and access time are 163 characters and may match multiple files. If it does and local-
157 copied too. 164 path is specified, then local-path must specify a directory. If
165 the -P flag is specified, then full file permissions and access
166 times are copied too.
158 167
159 help Display help text. 168 help Display help text.
160 169
161 lcd path Change local directory to path. 170 lcd path
171 Change local directory to path.
162 172
163 lls [ls-options [path]] 173 lls [ls-options [path]]
164 Display local directory listing of either path or current di- 174 Display local directory listing of either path or current direc-
165 rectory if path is not specified. 175 tory if path is not specified. ls-options may contain any flags
176 supported by the local system's ls(1) command. path may contain
177 glob(3) characters and may match multiple files.
166 178
167 lmkdir path 179 lmkdir path
168 Create local directory specified by path. 180 Create local directory specified by path.
169 181
170 ln oldpath newpath 182 ln oldpath newpath
171 Create a symbolic link from oldpath to newpath. 183 Create a symbolic link from oldpath to newpath.
172 184
173 lpwd Print local working directory. 185 lpwd Print local working directory.
174 186
175 ls [flags] [path] 187 ls [-1aflnrSt] [path]
176 Display remote directory listing of either path or current 188 Display a remote directory listing of either path or the current
177 directory if path is not specified. If the -l flag is speci- 189 directory if path is not specified. path may contain glob(3)
178 fied, then display additional details including permissions 190 characters and may match multiple files.
179 and ownership information. The -n flag will produce a long
180 listing with user and group information presented numerical-
181 ly.
182 191
183 By default, ls listings are sorted in lexicographical order. 192 The following flags are recognized and alter the behaviour of ls
184 This may be changed by specifying the -S (sort by file size), 193 accordingly:
185 -t (sort by last modification time), or -f (don't sort at 194
186 all) flags. Additionally, the sort order may be reversed us- 195 -1 Produce single columnar output.
187 ing the -r flag. 196
197 -a List files beginning with a dot (`.').
198
199 -f Do not sort the listing. The default sort order is lexi-
200 cographical.
201
202 -l Display additional details including permissions and own-
203 ership information.
204
205 -n Produce a long listing with user and group information
206 presented numerically.
207
208 -r Reverse the sort order of the listing.
209
210 -S Sort the listing by file size.
211
212 -t Sort the listing by last modification time.
188 213
189 lumask umask 214 lumask umask
190 Set local umask to umask. 215 Set local umask to umask.
191 216
192 mkdir path Create remote directory specified by path. 217 mkdir path
218 Create remote directory specified by path.
193 219
194 progress Toggle display of progress meter. 220 progress
221 Toggle display of progress meter.
195 222
196 put [flags] local-path [remote-path] 223 put [-P] local-path [remote-path]
197 Upload local-path and store it on the remote machine. If the 224 Upload local-path and store it on the remote machine. If the re-
198 remote path name is not specified, it is given the same name 225 mote path name is not specified, it is given the same name it has
199 it has on the local machine. If the -P flag is specified, 226 on the local machine. local-path may contain glob(3) characters
200 then the file's full permission and access time are copied 227 and may match multiple files. If it does and remote-path is
201 too. 228 specified, then remote-path must specify a directory. If the -P
229 flag is specified, then the file's full permission and access
230 time are copied too.
202 231
203 pwd Display remote working directory. 232 pwd Display remote working directory.
204 233
205 quit Quit sftp. 234 quit Quit sftp.
206 235
207 rename oldpath newpath 236 rename oldpath newpath
208 Rename remote file from oldpath to newpath. 237 Rename remote file from oldpath to newpath.
209 238
210 rm path Delete remote file specified by path. 239 rm path
240 Delete remote file specified by path.
211 241
212 rmdir path Remove remote directory specified by path. 242 rmdir path
243 Remove remote directory specified by path.
213 244
214 symlink oldpath newpath 245 symlink oldpath newpath
215 Create a symbolic link from oldpath to newpath. 246 Create a symbolic link from oldpath to newpath.
216 247
217 version Display the sftp protocol version. 248 version
249 Display the sftp protocol version.
218 250
219 ! command Execute command in local shell. 251 ! command
252 Execute command in local shell.
220 253
221 ! Escape to local shell. 254 ! Escape to local shell.
222 255
223 ? Synonym for help. 256 ? Synonym for help.
224 257
225SEE ALSO 258SEE ALSO
226 ftp(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5), 259 ftp(1), ls(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3),
227 sftp-server(8), sshd(8) 260 ssh_config(5), sftp-server(8), sshd(8)
228 261
229 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh- 262 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
230 filexfer-00.txt, January 2001, work in progress material. 263 filexfer-00.txt, January 2001, work in progress material.