summaryrefslogtreecommitdiff
path: root/sftp.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2004-03-01 01:21:46 +0000
committerColin Watson <cjwatson@debian.org>2004-03-01 01:21:46 +0000
commitf5bda272678ec6dccaa5f29379cf60cb855018e8 (patch)
treec225d6ba3d09bb5ece49c05fdbaeb02df3c94a28 /sftp.0
parent3342470472b45f000576e9f79f55bb30c7d517b8 (diff)
parent45431c9b4677608680cd071768cbf156b316a7e8 (diff)
Import OpenSSH 3.8p1.
Diffstat (limited to 'sftp.0')
-rw-r--r--sftp.0220
1 files changed, 220 insertions, 0 deletions
diff --git a/sftp.0 b/sftp.0
new file mode 100644
index 000000000..acb400dad
--- /dev/null
+++ b/sftp.0
@@ -0,0 +1,220 @@
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 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
108 Connect directly to a local sftp server (rather than via ssh(1))
109 This option may be useful in debugging the client and server.
110
111 -R num_requests
112 Specify how many requests may be outstanding at any one time.
113 Increasing this may slightly improve file transfer speed but will
114 increase memory usage. The default is 16 outstanding requests.
115
116 -S program
117 Name of the program to use for the encrypted connection. The
118 program must understand ssh(1) options.
119
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.
127
128INTERACTIVE COMMANDS
129 Once in interactive mode, sftp understands a set of commands similar to
130 those of ftp(1). Commands are case insensitive and pathnames may be en-
131 closed in quotes if they contain spaces.
132
133 bye Quit sftp.
134
135 cd path Change remote directory to path.
136
137 chgrp grp path
138 Change group of file path to grp. grp must be a numeric GID.
139
140 chmod mode path
141 Change permissions of file path to mode.
142
143 chown own path
144 Change owner of file path to own. own must be a numeric UID.
145
146 exit Quit sftp.
147
148 get [flags] remote-path [local-path]
149 Retrieve the remote-path and store it on the local machine.
150 If the local path name is not specified, it is given the same
151 name it has on the remote machine. If the -P flag is speci-
152 fied, then the file's full permission and access time are
153 copied too.
154
155 help Display help text.
156
157 lcd path Change local directory to path.
158
159 lls [ls-options [path]]
160 Display local directory listing of either path or current di-
161 rectory if path is not specified.
162
163 lmkdir path
164 Create local directory specified by path.
165
166 ln oldpath newpath
167 Create a symbolic link from oldpath to newpath.
168
169 lpwd Print local working directory.
170
171 ls [flags] [path]
172 Display remote directory listing of either path or current
173 directory if path is not specified. If the -l flag is speci-
174 fied, then display additional details including permissions
175 and ownership information.
176
177 lumask umask
178 Set local umask to umask.
179
180 mkdir path Create remote directory specified by path.
181
182 progress Toggle display of progress meter.
183
184 put [flags] local-path [remote-path]
185 Upload local-path and store it on the remote machine. If the
186 remote path name is not specified, it is given the same name
187 it has on the local machine. If the -P flag is specified,
188 then the file's full permission and access time are copied
189 too.
190
191 pwd Display remote working directory.
192
193 quit Quit sftp.
194
195 rename oldpath newpath
196 Rename remote file from oldpath to newpath.
197
198 rm path Delete remote file specified by path.
199
200 rmdir path Remove remote directory specified by path.
201
202 symlink oldpath newpath
203 Create a symbolic link from oldpath to newpath.
204
205 version Display the sftp protocol version.
206
207 ! command Execute command in local shell.
208
209 ! Escape to local shell.
210
211 ? Synonym for help.
212
213SEE ALSO
214 ftp(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), ssh_config(5),
215 sftp-server(8), sshd(8)
216
217 T. Ylonen, and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-
218 filexfer-00.txt, January 2001, work in progress material.
219
220OpenBSD 3.4 February 4, 2001 4