sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.54 2004/05/02 23:02:17 dtucker 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 ConnectTimeout
 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 IdentitiesOnly
 167 .It LogLevel
 168 .It MACs
 169 .It NoHostAuthenticationForLocalhost
 170 .It NumberOfPasswordPrompts
 171 .It PasswordAuthentication
 172 .It Port
 173 .It PreferredAuthentications
 174 .It Protocol
 175 .It ProxyCommand
 176 .It PubkeyAuthentication
 177 .It RhostsRSAAuthentication
 178 .It RSAAuthentication
 179 .It SendEnv
 180 .It ServerAliveInterval
 181 .It ServerAliveCountMax
 182 .It SmartcardDevice
 183 .It StrictHostKeyChecking
 184 .It TCPKeepAlive
 185 .It UsePrivilegedPort
 186 .It User
 187 .It UserKnownHostsFile
 188 .It VerifyHostKeyDNS
 189 .El
 190 .It Fl P Ar sftp_server_path
 191 Connect directly to a local sftp server
 192 (rather than via
 193 .Xr ssh 1 )
 194 This option may be useful in debugging the client and server.
 195 .It Fl R Ar num_requests
 196 Specify how many requests may be outstanding at any one time.
 197 Increasing this may slightly improve file transfer speed
 198 but will increase memory usage.
 199 The default is 16 outstanding requests.
 200 .It Fl S Ar program
 201 Name of the
 202 .Ar program
 203 to use for the encrypted connection.
 204 The program must understand
 205 .Xr ssh 1
 206 options.
 207 .It Fl s Ar subsystem | sftp_server
 208 Specifies the SSH2 subsystem or the path for an sftp server
 209 on the remote host.
 210 A path is useful for using
 211 .Nm
 212 over protocol version 1, or when the remote
 213 .Xr sshd 8
 214 does not have an sftp subsystem configured.
 215 .It Fl v
 216 Raise logging level.
 217 This option is also passed to ssh.
 218 .El
 219 .Sh INTERACTIVE COMMANDS
 220 Once in interactive mode,
 221 .Nm
 222 understands a set of commands similar to those of
 223 .Xr ftp 1 .
 224 Commands are case insensitive and pathnames may be enclosed in quotes if they
 225 contain spaces.
 226 .Bl -tag -width "lmdir path"
 227 .It Ic bye
 228 Quit
 229 .Nm sftp .
 230 .It Ic cd Ar path
 231 Change remote directory to
 232 .Ar path .
 233 .It Ic chgrp Ar grp Ar path
 234 Change group of file
 235 .Ar path
 236 to
 237 .Ar grp .
 238 .Ar grp
 239 must be a numeric GID.
 240 .It Ic chmod Ar mode Ar path
 241 Change permissions of file
 242 .Ar path
 243 to
 244 .Ar mode .
 245 .It Ic chown Ar own Ar path
 246 Change owner of file
 247 .Ar path
 248 to
 249 .Ar own .
 250 .Ar own
 251 must be a numeric UID.
 252 .It Ic exit
 253 Quit
 254 .Nm sftp .
 255 .It Xo Ic get
 256 .Op Ar flags
 257 .Ar remote-path
 258 .Op Ar local-path
 259 .Xc
 260 Retrieve the
 261 .Ar remote-path
 262 and store it on the local machine.
 263 If the local
 264 path name is not specified, it is given the same name it has on the
 265 remote machine.
 266 If the
 267 .Fl P
 268 flag is specified, then the file's full permission and access time are
 269 copied too.
 270 .It Ic help
 271 Display help text.
 272 .It Ic lcd Ar path
 273 Change local directory to
 274 .Ar path .
 275 .It Ic lls Op Ar ls-options Op Ar path
 276 Display local directory listing of either
 277 .Ar path
 278 or current directory if
 279 .Ar path
 280 is not specified.
 281 .It Ic lmkdir Ar path
 282 Create local directory specified by
 283 .Ar path .
 284 .It Ic ln Ar oldpath Ar newpath
 285 Create a symbolic link from
 286 .Ar oldpath
 287 to
 288 .Ar newpath .
 289 .It Ic lpwd
 290 Print local working directory.
 291 .It Xo Ic ls
 292 .Op Ar flags
 293 .Op Ar path
 294 .Xc
 295 Display remote directory listing of either
 296 .Ar path
 297 or current directory if
 298 .Ar path
 299 is not specified.
 300 If the
 301 .Fl l
 302 flag is specified, then display additional details including permissions
 303 and ownership information.
 304 .It Ic lumask Ar umask
 305 Set local umask to
 306 .Ar umask .
 307 .It Ic mkdir Ar path
 308 Create remote directory specified by
 309 .Ar path .
 310 .It Ic progress
 311 Toggle display of progress meter.
 312 .It Xo Ic put
 313 .Op Ar flags
 314 .Ar local-path
 315 .Op Ar remote-path
 316 .Xc
 317 Upload
 318 .Ar local-path
 319 and store it on the remote machine.
 320 If the remote path name is not specified, it is given the same name it has
 321 on the local machine.
 322 If the
 323 .Fl P
 324 flag is specified, then the file's full permission and access time are
 325 copied too.
 326 .It Ic pwd
 327 Display remote working directory.
 328 .It Ic quit
 329 Quit
 330 .Nm sftp .
 331 .It Ic rename Ar oldpath Ar newpath
 332 Rename remote file from
 333 .Ar oldpath
 334 to
 335 .Ar newpath .
 336 .It Ic rm Ar path
 337 Delete remote file specified by
 338 .Ar path .
 339 .It Ic rmdir Ar path
 340 Remove remote directory specified by
 341 .Ar path .
 342 .It Ic symlink Ar oldpath Ar newpath
 343 Create a symbolic link from
 344 .Ar oldpath
 345 to
 346 .Ar newpath .
 347 .It Ic version
 348 Display the
 349 .Nm
 350 protocol version.
 351 .It Ic \&! Ar command
 352 Execute
 353 .Ar command
 354 in local shell.
 355 .It Ic \&!
 356 Escape to local shell.
 357 .It Ic \&?
 358 Synonym for help.
 359 .El
 360 .Sh SEE ALSO
 361 .Xr ftp 1 ,
 362 .Xr scp 1 ,
 363 .Xr ssh 1 ,
 364 .Xr ssh-add 1 ,
 365 .Xr ssh-keygen 1 ,
 366 .Xr ssh_config 5 ,
 367 .Xr sftp-server 8 ,
 368 .Xr sshd 8
 369 .Rs
 370 .%A T. Ylonen
 371 .%A S. Lehtinen
 372 .%T "SSH File Transfer Protocol"
 373 .%N draft-ietf-secsh-filexfer-00.txt
 374 .%D January 2001
 375 .%O work in progress material
 376 .Re