sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.51 2004/01/13 12:17:33 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .Dd February 4, 2001
  26 .Dt SFTP 1
  27 .Os
  28 .Sh NAME
  29 .Nm sftp
  30 .Nd secure file transfer program
  31 .Sh SYNOPSIS
  32 .Nm sftp
  33 .Bk -words
  34 .Op Fl 1Cv
  35 .Op Fl B Ar buffer_size
  36 .Op Fl b Ar batchfile
  37 .Op Fl F Ar ssh_config
  38 .Op Fl o Ar ssh_option
  39 .Op Fl P Ar sftp_server_path
  40 .Op Fl R Ar num_requests
  41 .Op Fl S Ar program
  42 .Op Fl s Ar subsystem | sftp_server
  43 .Ar host
  44 .Ek
  45 .Nm sftp
  46 .Oo Oo Ar user Ns @ Oc Ns
  47 .Ar host Ns Oo : Ns Ar file Oo
  48 .Ar file Oc Oc Oc
  49 .Nm sftp
  50 .Oo Oo Ar user Ns @ Oc Ns
  51 .Ar host Ns Oo : Ns Ar dir Ns
  52 .Oo Ar / Oc Oc Oc
  53 .Nm sftp
  54 .Fl b Ar batchfile
  55 .Oo Ar user Ns @ Oc Ns Ar host
  56 .Sh DESCRIPTION
  57 .Nm
  58 is an interactive file transfer program, similar to
  59 .Xr ftp 1 ,
  60 which performs all operations over an encrypted
  61 .Xr ssh 1
  62 transport.
  63 It may also use many features of ssh, such as public key authentication and
  64 compression.
  65 .Nm
  66 connects and logs into the specified
  67 .Ar host ,
  68 then enters an interactive command mode.
  69 .Pp
  70 The second usage format will retrieve files automatically if a non-interactive
  71 authentication method is used; otherwise it will do so after
  72 successful interactive authentication.
  73 .Pp
  74 The third usage format allows the sftp client to start in a remote directory.
  75 .Pp
  76 The final usage format allows for automated sessions using the
  77 .Fl b
  78 option.
  79 In such cases, it is usually necessary to configure public key authentication
  80 to obviate the need to enter a password at connection time (see
  81 .Xr sshd 8
  82 and
  83 .Xr ssh-keygen 1
  84 for details).
  85 The options are as follows:
  86 .Bl -tag -width Ds
  87 .It Fl 1
  88 Specify the use of protocol version 1.
  89 .It Fl B Ar buffer_size
  90 Specify the size of the buffer that
  91 .Nm
  92 uses when transferring files.
  93 Larger buffers require fewer round trips at the cost of higher
  94 memory consumption.
  95 The default is 32768 bytes.
  96 .It Fl b Ar batchfile
  97 Batch mode reads a series of commands from an input
  98 .Ar batchfile
  99 instead of
 100 .Em stdin .
 101 Since it lacks user interaction it should be used in conjunction with
 102 non-interactive authentication.
 103 A
 104 .Ar batchfile
 105 of
 106 .Sq \-
 107 may be used to indicate standard input.
 108 .Nm
 109 will abort if any of the following
 110 commands fail:
 111 .Ic get , put , rename , ln ,
 112 .Ic rm , mkdir , chdir , ls ,
 113 .Ic lchdir , chmod , chown , chgrp , lpwd
 114 and
 115 .Ic lmkdir .
 116 Termination on error can be suppressed on a command by command basis by
 117 prefixing the command with a
 118 .Sq \-
 119 character (for example,
 120 .Ic -rm /tmp/blah* ) .
 121 .It Fl C
 122 Enables compression (via ssh's
 123 .Fl C
 124 flag).
 125 .It Fl F Ar ssh_config
 126 Specifies an alternative
 127 per-user configuration file for
 128 .Xr ssh 1 .
 129 This option is directly passed to
 130 .Xr ssh 1 .
 131 .It Fl o Ar ssh_option
 132 Can be used to pass options to
 133 .Nm ssh
 134 in the format used in
 135 .Xr ssh_config 5 .
 136 This is useful for specifying options
 137 for which there is no separate
 138 .Nm sftp
 139 command-line flag.
 140 For example, to specify an alternate port use:
 141 .Ic sftp -oPort=24 .
 142 For full details of the options listed below, and their possible values, see
 143 .Xr ssh_config 5 .
 144 .Pp
 145 .Bl -tag -width Ds -offset indent -compact
 146 .It AddressFamily
 147 .It BatchMode
 148 .It BindAddress
 149 .It ChallengeResponseAuthentication
 150 .It CheckHostIP
 151 .It Cipher
 152 .It Ciphers
 153 .It Compression
 154 .It CompressionLevel
 155 .It ConnectionAttempts
 156 .It ConnectionTimeout
 157 .It GlobalKnownHostsFile
 158 .It GSSAPIAuthentication
 159 .It GSSAPIDelegateCredentials
 160 .It Host
 161 .It HostbasedAuthentication
 162 .It HostKeyAlgorithms
 163 .It HostKeyAlias
 164 .It HostName
 165 .It IdentityFile
 166 .It LogLevel
 167 .It MACs
 168 .It NoHostAuthenticationForLocalhost
 169 .It NumberOfPasswordPrompts
 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
 189 Connect directly to a local sftp server
 190 (rather than via
 191 .Xr ssh 1 )
 192 This option may be useful in debugging the client and server.
 193 .It Fl R Ar num_requests
 194 Specify how many requests may be outstanding at any one time.
 195 Increasing this may slightly improve file transfer speed
 196 but will increase memory usage.
 197 The default is 16 outstanding requests.
 198 .It Fl S Ar program
 199 Name of the
 200 .Ar program
 201 to use for the encrypted connection.
 202 The program must understand
 203 .Xr ssh 1
 204 options.
 205 .It Fl s Ar subsystem | sftp_server
 206 Specifies the SSH2 subsystem or the path for an sftp server
 207 on the remote host.
 208 A path is useful for using
 209 .Nm
 210 over protocol version 1, or when the remote
 211 .Xr sshd 8
 212 does not have an sftp subsystem configured.
 213 .It Fl v
 214 Raise logging level.
 215 This option is also passed to ssh.
 216 .El
 217 .Sh INTERACTIVE COMMANDS
 218 Once in interactive mode,
 219 .Nm
 220 understands a set of commands similar to those of
 221 .Xr ftp 1 .
 222 Commands are case insensitive and pathnames may be enclosed in quotes if they
 223 contain spaces.
 224 .Bl -tag -width "lmdir path"
 225 .It Ic bye
 226 Quit
 227 .Nm sftp .
 228 .It Ic cd Ar path
 229 Change remote directory to
 230 .Ar path .
 231 .It Ic chgrp Ar grp Ar path
 232 Change group of file
 233 .Ar path
 234 to
 235 .Ar grp .
 236 .Ar grp
 237 must be a numeric GID.
 238 .It Ic chmod Ar mode Ar path
 239 Change permissions of file
 240 .Ar path
 241 to
 242 .Ar mode .
 243 .It Ic chown Ar own Ar path
 244 Change owner of file
 245 .Ar path
 246 to
 247 .Ar own .
 248 .Ar own
 249 must be a numeric UID.
 250 .It Ic exit
 251 Quit
 252 .Nm sftp .
 253 .It Xo Ic get
 254 .Op Ar flags
 255 .Ar remote-path
 256 .Op Ar local-path
 257 .Xc
 258 Retrieve the
 259 .Ar remote-path
 260 and store it on the local machine.
 261 If the local
 262 path name is not specified, it is given the same name it has on the
 263 remote machine.
 264 If the
 265 .Fl P
 266 flag is specified, then the file's full permission and access time are
 267 copied too.
 268 .It Ic help
 269 Display help text.
 270 .It Ic lcd Ar path
 271 Change local directory to
 272 .Ar path .
 273 .It Ic lls Op Ar ls-options Op Ar path
 274 Display local directory listing of either
 275 .Ar path
 276 or current directory if
 277 .Ar path
 278 is not specified.
 279 .It Ic lmkdir Ar path
 280 Create local directory specified by
 281 .Ar path .
 282 .It Ic ln Ar oldpath Ar newpath
 283 Create a symbolic link from
 284 .Ar oldpath
 285 to
 286 .Ar newpath .
 287 .It Ic lpwd
 288 Print local working directory.
 289 .It Xo Ic ls
 290 .Op Ar flags
 291 .Op Ar path
 292 .Xc
 293 Display remote directory listing of either
 294 .Ar path
 295 or current directory if
 296 .Ar path
 297 is not specified.
 298 If the
 299 .Fl l
 300 flag is specified, then display additional details including permissions
 301 and ownership information.
 302 .It Ic lumask Ar umask
 303 Set local umask to
 304 .Ar umask .
 305 .It Ic mkdir Ar path
 306 Create remote directory specified by
 307 .Ar path .
 308 .It Ic progress
 309 Toggle display of progress meter.
 310 .It Xo Ic put
 311 .Op Ar flags
 312 .Ar local-path
 313 .Op Ar remote-path
 314 .Xc
 315 Upload
 316 .Ar local-path
 317 and store it on the remote machine.
 318 If the remote path name is not specified, it is given the same name it has
 319 on the local machine.
 320 If the
 321 .Fl P
 322 flag is specified, then the file's full permission and access time are
 323 copied too.
 324 .It Ic pwd
 325 Display remote working directory.
 326 .It Ic quit
 327 Quit
 328 .Nm sftp .
 329 .It Ic rename Ar oldpath Ar newpath
 330 Rename remote file from
 331 .Ar oldpath
 332 to
 333 .Ar newpath .
 334 .It Ic rm Ar path
 335 Delete remote file specified by
 336 .Ar path .
 337 .It Ic rmdir Ar path
 338 Remove remote directory specified by
 339 .Ar path .
 340 .It Ic symlink Ar oldpath Ar newpath
 341 Create a symbolic link from
 342 .Ar oldpath
 343 to
 344 .Ar newpath .
 345 .It Ic version
 346 Display the
 347 .Nm
 348 protocol version.
 349 .It Ic \&! Ar command
 350 Execute
 351 .Ar command
 352 in local shell.
 353 .It Ic \&!
 354 Escape to local shell.
 355 .It Ic \&?
 356 Synonym for help.
 357 .El
 358 .Sh SEE ALSO
 359 .Xr ftp 1 ,
 360 .Xr scp 1 ,
 361 .Xr ssh 1 ,
 362 .Xr ssh-add 1 ,
 363 .Xr ssh-keygen 1 ,
 364 .Xr ssh_config 5 ,
 365 .Xr sftp-server 8 ,
 366 .Xr sshd 8
 367 .Rs
 368 .%A T. Ylonen
 369 .%A S. Lehtinen
 370 .%T "SSH File Transfer Protocol"
 371 .%N draft-ietf-secsh-filexfer-00.txt
 372 .%D January 2001
 373 .%O work in progress material
 374 .Re