summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2004-05-01 11:28:49 +0000
committerColin Watson <cjwatson@debian.org>2004-05-01 11:28:49 +0000
commit16f1d21ea191deaaeeba719d01c0ad82aa044653 (patch)
tree0e52caec9e5c0e1ad3494e62bd1bc1b776a738a0 /sftp.0
parentbd5f26f25dbbb93a9f9d3850c200a17a753ceee1 (diff)
parentf5bda272678ec6dccaa5f29379cf60cb855018e8 (diff)
Import OpenSSH 3.8.1p1.
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0221
1 files changed, 221 insertions, 0 deletions
diff --git a/sftp.0 b/sftp.0
new file mode 100644
index 000000000..0cb4ac35b
--- /dev/null
+++ b/sftp.0
@@ -0,0 +1,221 @@
1SFTP(1) OpenBSD Reference Manual SFTP(1)
2
3NAME
4 sftp - secure file transfer program
5
6SYNOPSIS
7 sftp [-1Cv] [-B buffer_size] [-b batchfile] [-F ssh_config]
8 [-o ssh_option] [-P sftp_server_path] [-R num_requests] [-S program]
9 [-s subsystem | sftp_server] host
10 sftp [[user@]host[:file [file]]]
11 sftp [[user@]host[:dir[/]]]
12 sftp -b batchfile [user@]host
13
14DESCRIPTION
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
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 in-
19 teractive command mode.
20
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-
23 cessful interactive authentication.
24
25 The third usage format allows the sftp client to start in a remote direc-
26 tory.
27
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:
32
33 -1 Specify the use of protocol version 1.
34
35 -B buffer_size
36 Specify the size of the buffer that sftp uses when transferring
37 files. Larger buffers require fewer round trips at the cost of
38 higher memory consumption. The default is 32768 bytes.
39
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).
52
53 -F ssh_config
54 Specifies an alternative per-user configuration file for ssh(1).
55 This option is directly passed to ssh(1).
56
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 IdentitiesOnly
86 LogLevel
87 MACs
88 NoHostAuthenticationForLocalhost
89 NumberOfPasswordPrompts
90 PasswordAuthentication
91 Port
92 PreferredAuthentications
93 Protocol
94 ProxyCommand
95 PubkeyAuthentication
96 RhostsRSAAuthentication
97 RSAAuthentication
98 ServerAliveInterval
99 ServerAliveCountMax
100 SmartcardDevice
101 StrictHostKeyChecking
102 TCPKeepAlive
103 UsePrivilegedPort
104 User
105 UserKnownHostsFile
106 VerifyHostKeyDNS
107
108 -P sftp_server_path
109 Connect directly to a local sftp server (rather than via ssh(1))
110 This option may be useful in debugging the client and server.
111
112 -R num_requests
113 Specify how many requests may be outstanding at any one time.
114 Increasing this may slightly improve file transfer speed but will
115 increase memory usage. The default is 16 outstanding requests.
116
117 -S program
118 Name of the program to use for the encrypted connection. The
119 program must understand ssh(1) options.
120
121 -s subsystem | sftp_server
122 Specifies the SSH2 subsystem or the path for an sftp server on
123 the remote host. A path is useful for using sftp over protocol
124 version 1, or when the remote sshd(8) does not have an sftp sub-
125 system configured.
126
127 -v Raise logging level. This option is also passed to ssh.
128
129INTERACTIVE COMMANDS
130 Once in interactive mode, sftp understands a set of commands similar to
131 those of ftp(1). Commands are case insensitive and pathnames may be en-
132 closed in quotes if they contain spaces.
133
134 bye Quit sftp.
135
136 cd path Change remote directory to path.
137
138 chgrp grp path
139 Change group of file path to grp. grp must be a numeric GID.
140
141 chmod mode path
142 Change permissions of file path to mode.
143
144 chown own path
145 Change owner of file path to own. own must be a numeric UID.
146
147 exit Quit sftp.
148
149 get [flags] remote-path [local-path]
150 Retrieve the remote-path and store it on the local machine.
151 If the local path name is not specified, it is given the same
152 name it has on the remote machine. If the -P flag is speci-
153 fied, then the file's full permission and access time are
154 copied too.
155
156 help Display help text.
157
158 lcd path Change local directory to path.
159
160 lls [ls-options [path]]
161 Display local directory listing of either path or current di-
162 rectory if path is not specified.
163
164 lmkdir path
165 Create local directory specified by path.
166
167 ln oldpath newpath
168 Create a symbolic link from oldpath to newpath.
169
170 lpwd Print local working directory.
171
172 ls [flags] [path]
173 Display remote directory listing of either path or current
174 directory if path is not specified. If the -l flag is speci-
175 fied, then display additional details including permissions
176 and ownership information.
177
178 lumask umask
179 Set local umask to umask.
180
181 mkdir path Create remote directory specified by path.
182
183 progress Toggle display of progress meter.
184
185 put [flags] local-path [remote-path]
186 Upload local-path and store it on the remote machine. If the
187 remote path name is not specified, it is given the same name
188 it has on the local machine. If the -P flag is specified,
189 then the file's full permission and access time are copied
190 too.
191
192 pwd Display remote working directory.
193
194 quit Quit sftp.
195
196 rename oldpath newpath
197 Rename remote file from oldpath to newpath.
198
199 rm path Delete remote file specified by path.
200
201 rmdir path Remove remote directory specified by path.
202
203 symlink oldpath newpath
204 Create a symbolic link from oldpath to newpath.
205
206 version Display the sftp protocol version.
207
208 ! command Execute command in local shell.
209
210 ! Escape to local shell.
211
212 ? Synonym for help.
213
214SEE ALSO
215 ftp(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5),
216 sftp-server(8), sshd(8)
217
218 T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
219 filexfer-00.txt, January 2001, work in progress material.
220
221OpenBSD 3.5 February 4, 2001 4