summaryrefslogtreecommitdiff
path: root/sftp.1
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.1
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.1')
-rw-r--r--sftp.1142
1 files changed, 97 insertions, 45 deletions
diff --git a/sftp.1 b/sftp.1
index 753a4f2b9..2a67a888e 100644
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: sftp.1,v 1.45 2003/09/02 18:50:06 jmc Exp $ 1.\" $OpenBSD: sftp.1,v 1.51 2004/01/13 12:17:33 jmc Exp $
2.\" 2.\"
3.\" Copyright (c) 2001 Damien Miller. All rights reserved. 3.\" Copyright (c) 2001 Damien Miller. All rights reserved.
4.\" 4.\"
@@ -31,15 +31,15 @@
31.Sh SYNOPSIS 31.Sh SYNOPSIS
32.Nm sftp 32.Nm sftp
33.Bk -words 33.Bk -words
34.Op Fl vC1 34.Op Fl 1Cv
35.Op Fl b Ar batchfile
36.Op Fl o Ar ssh_option
37.Op Fl s Ar subsystem | sftp_server
38.Op Fl B Ar buffer_size 35.Op Fl B Ar buffer_size
36.Op Fl b Ar batchfile
39.Op Fl F Ar ssh_config 37.Op Fl F Ar ssh_config
40.Op Fl P Ar sftp_server path 38.Op Fl o Ar ssh_option
39.Op Fl P Ar sftp_server_path
41.Op Fl R Ar num_requests 40.Op Fl R Ar num_requests
42.Op Fl S Ar program 41.Op Fl S Ar program
42.Op Fl s Ar subsystem | sftp_server
43.Ar host 43.Ar host
44.Ek 44.Ek
45.Nm sftp 45.Nm sftp
@@ -84,6 +84,15 @@ and
84for details). 84for details).
85The options are as follows: 85The options are as follows:
86.Bl -tag -width Ds 86.Bl -tag -width Ds
87.It Fl 1
88Specify the use of protocol version 1.
89.It Fl B Ar buffer_size
90Specify the size of the buffer that
91.Nm
92uses when transferring files.
93Larger buffers require fewer round trips at the cost of higher
94memory consumption.
95The default is 32768 bytes.
87.It Fl b Ar batchfile 96.It Fl b Ar batchfile
88Batch mode reads a series of commands from an input 97Batch mode reads a series of commands from an input
89.Ar batchfile 98.Ar batchfile
@@ -91,6 +100,11 @@ instead of
91.Em stdin . 100.Em stdin .
92Since it lacks user interaction it should be used in conjunction with 101Since it lacks user interaction it should be used in conjunction with
93non-interactive authentication. 102non-interactive authentication.
103A
104.Ar batchfile
105of
106.Sq \-
107may be used to indicate standard input.
94.Nm 108.Nm
95will abort if any of the following 109will abort if any of the following
96commands fail: 110commands fail:
@@ -101,9 +115,19 @@ and
101.Ic lmkdir . 115.Ic lmkdir .
102Termination on error can be suppressed on a command by command basis by 116Termination on error can be suppressed on a command by command basis by
103prefixing the command with a 117prefixing the command with a
104.Sq Ic \- 118.Sq \-
105character (for example, 119character (for example,
106.Ic -rm /tmp/blah* ) . 120.Ic -rm /tmp/blah* ) .
121.It Fl C
122Enables compression (via ssh's
123.Fl C
124flag).
125.It Fl F Ar ssh_config
126Specifies an alternative
127per-user configuration file for
128.Xr ssh 1 .
129This option is directly passed to
130.Xr ssh 1 .
107.It Fl o Ar ssh_option 131.It Fl o Ar ssh_option
108Can be used to pass options to 132Can be used to pass options to
109.Nm ssh 133.Nm ssh
@@ -115,35 +139,53 @@ for which there is no separate
115command-line flag. 139command-line flag.
116For example, to specify an alternate port use: 140For example, to specify an alternate port use:
117.Ic sftp -oPort=24 . 141.Ic sftp -oPort=24 .
118.It Fl s Ar subsystem | sftp_server 142For full details of the options listed below, and their possible values, see
119Specifies the SSH2 subsystem or the path for an sftp server 143.Xr ssh_config 5 .
120on the remote host. 144.Pp
121A path is useful for using 145.Bl -tag -width Ds -offset indent -compact
122.Nm 146.It AddressFamily
123over protocol version 1, or when the remote 147.It BatchMode
124.Xr sshd 8 148.It BindAddress
125does not have an sftp subsystem configured. 149.It ChallengeResponseAuthentication
126.It Fl v 150.It CheckHostIP
127Raise logging level. 151.It Cipher
128This option is also passed to ssh. 152.It Ciphers
129.It Fl B Ar buffer_size 153.It Compression
130Specify the size of the buffer that 154.It CompressionLevel
131.Nm 155.It ConnectionAttempts
132uses when transferring files. 156.It ConnectionTimeout
133Larger buffers require fewer round trips at the cost of higher 157.It GlobalKnownHostsFile
134memory consumption. 158.It GSSAPIAuthentication
135The default is 32768 bytes. 159.It GSSAPIDelegateCredentials
136.It Fl C 160.It Host
137Enables compression (via ssh's 161.It HostbasedAuthentication
138.Fl C 162.It HostKeyAlgorithms
139flag). 163.It HostKeyAlias
140.It Fl F Ar ssh_config 164.It HostName
141Specifies an alternative 165.It IdentityFile
142per-user configuration file for 166.It LogLevel
143.Xr ssh 1 . 167.It MACs
144This option is directly passed to 168.It NoHostAuthenticationForLocalhost
145.Xr ssh 1 . 169.It NumberOfPasswordPrompts
146.It Fl P Ar sftp_server path 170.It PasswordAuthentication
171.It Port
172.It PreferredAuthentications
173.It Protocol
174.It ProxyCommand
175.It PubkeyAuthentication
176.It RhostsRSAAuthentication
177.It RSAAuthentication
178.It ServerAliveInterval
179.It ServerAliveCountMax
180.It SmartcardDevice
181.It StrictHostKeyChecking
182.It TCPKeepAlive
183.It UsePrivilegedPort
184.It User
185.It UserKnownHostsFile
186.It VerifyHostKeyDNS
187.El
188.It Fl P Ar sftp_server_path
147Connect directly to a local sftp server 189Connect directly to a local sftp server
148(rather than via 190(rather than via
149.Xr ssh 1 ) 191.Xr ssh 1 )
@@ -160,8 +202,17 @@ to use for the encrypted connection.
160The program must understand 202The program must understand
161.Xr ssh 1 203.Xr ssh 1
162options. 204options.
163.It Fl 1 205.It Fl s Ar subsystem | sftp_server
164Specify the use of protocol version 1. 206Specifies the SSH2 subsystem or the path for an sftp server
207on the remote host.
208A path is useful for using
209.Nm
210over protocol version 1, or when the remote
211.Xr sshd 8
212does not have an sftp subsystem configured.
213.It Fl v
214Raise logging level.
215This option is also passed to ssh.
165.El 216.El
166.Sh INTERACTIVE COMMANDS 217.Sh INTERACTIVE COMMANDS
167Once in interactive mode, 218Once in interactive mode,
@@ -170,16 +221,13 @@ understands a set of commands similar to those of
170.Xr ftp 1 . 221.Xr ftp 1 .
171Commands are case insensitive and pathnames may be enclosed in quotes if they 222Commands are case insensitive and pathnames may be enclosed in quotes if they
172contain spaces. 223contain spaces.
173.Bl -tag -width Ds 224.Bl -tag -width "lmdir path"
174.It Ic bye 225.It Ic bye
175Quit 226Quit
176.Nm sftp . 227.Nm sftp .
177.It Ic cd Ar path 228.It Ic cd Ar path
178Change remote directory to 229Change remote directory to
179.Ar path . 230.Ar path .
180.It Ic lcd Ar path
181Change local directory to
182.Ar path .
183.It Ic chgrp Ar grp Ar path 231.It Ic chgrp Ar grp Ar path
184Change group of file 232Change group of file
185.Ar path 233.Ar path
@@ -219,6 +267,9 @@ flag is specified, then the file's full permission and access time are
219copied too. 267copied too.
220.It Ic help 268.It Ic help
221Display help text. 269Display help text.
270.It Ic lcd Ar path
271Change local directory to
272.Ar path .
222.It Ic lls Op Ar ls-options Op Ar path 273.It Ic lls Op Ar ls-options Op Ar path
223Display local directory listing of either 274Display local directory listing of either
224.Ar path 275.Ar path
@@ -280,12 +331,12 @@ Rename remote file from
280.Ar oldpath 331.Ar oldpath
281to 332to
282.Ar newpath . 333.Ar newpath .
283.It Ic rmdir Ar path
284Remove remote directory specified by
285.Ar path .
286.It Ic rm Ar path 334.It Ic rm Ar path
287Delete remote file specified by 335Delete remote file specified by
288.Ar path . 336.Ar path .
337.It Ic rmdir Ar path
338Remove remote directory specified by
339.Ar path .
289.It Ic symlink Ar oldpath Ar newpath 340.It Ic symlink Ar oldpath Ar newpath
290Create a symbolic link from 341Create a symbolic link from
291.Ar oldpath 342.Ar oldpath
@@ -305,6 +356,7 @@ Escape to local shell.
305Synonym for help. 356Synonym for help.
306.El 357.El
307.Sh SEE ALSO 358.Sh SEE ALSO
359.Xr ftp 1 ,
308.Xr scp 1 , 360.Xr scp 1 ,
309.Xr ssh 1 , 361.Xr ssh 1 ,
310.Xr ssh-add 1 , 362.Xr ssh-add 1 ,