sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.79 2009/12/29 16:38:41 stevesk 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 $Mdocdate$
  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 1246Cpqrv
  35 .Op Fl B Ar buffer_size
  36 .Op Fl b Ar batchfile
  37 .Op Fl c Ar cipher
  38 .Op Fl D Ar sftp_server_path
  39 .Op Fl F Ar ssh_config
  40 .Op Fl i Ar identity_file
  41 .Op Fl o Ar ssh_option
  42 .Op Fl P Ar port
  43 .Op Fl R Ar num_requests
  44 .Op Fl S Ar program
  45 .Op Fl s Ar subsystem | sftp_server
  46 .Ar host
  47 .Ek
  48 .Nm sftp
  49 .Oo Ar user Ns @ Oc Ns
  50 .Ar host Ns Op : Ns Ar
  51 .Nm sftp
  52 .Oo Ar user Ns @ Oc Ns
  53 .Ar host Ns Oo : Ns Ar dir Ns
  54 .Op Ar / Oc
  55 .Nm sftp
  56 .Fl b Ar batchfile
  57 .Oo Ar user Ns @ Oc Ns Ar host
  58 .Sh DESCRIPTION
  59 .Nm
  60 is an interactive file transfer program, similar to
  61 .Xr ftp 1 ,
  62 which performs all operations over an encrypted
  63 .Xr ssh 1
  64 transport.
  65 It may also use many features of ssh, such as public key authentication and
  66 compression.
  67 .Nm
  68 connects and logs into the specified
  69 .Ar host ,
  70 then enters an interactive command mode.
  71 .Pp
  72 The second usage format will retrieve files automatically if a non-interactive
  73 authentication method is used; otherwise it will do so after
  74 successful interactive authentication.
  75 .Pp
  76 The third usage format allows
  77 .Nm
  78 to start in a remote directory.
  79 .Pp
  80 The final usage format allows for automated sessions using the
  81 .Fl b
  82 option.
  83 In such cases, it is necessary to configure non-interactive authentication
  84 to obviate the need to enter a password at connection time (see
  85 .Xr sshd 8
  86 and
  87 .Xr ssh-keygen 1
  88 for details).
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Fl 1
  92 Specify the use of protocol version 1.
  93 .It Fl 2
  94 Specify the use of protocol version 2.
  95 .It Fl 4
  96 Forces
  97 .Nm
  98 to use IPv4 addresses only.
  99 .It Fl 6
 100 Forces
 101 .Nm
 102 to use IPv6 addresses only.
 103 .It Fl B Ar buffer_size
 104 Specify the size of the buffer that
 105 .Nm
 106 uses when transferring files.
 107 Larger buffers require fewer round trips at the cost of higher
 108 memory consumption.
 109 The default is 32768 bytes.
 110 .It Fl b Ar batchfile
 111 Batch mode reads a series of commands from an input
 112 .Ar batchfile
 113 instead of
 114 .Em stdin .
 115 Since it lacks user interaction it should be used in conjunction with
 116 non-interactive authentication.
 117 A
 118 .Ar batchfile
 119 of
 120 .Sq \-
 121 may be used to indicate standard input.
 122 .Nm
 123 will abort if any of the following
 124 commands fail:
 125 .Ic get , put , rename , ln ,
 126 .Ic rm , mkdir , chdir , ls ,
 127 .Ic lchdir , chmod , chown ,
 128 .Ic chgrp , lpwd , df ,
 129 and
 130 .Ic lmkdir .
 131 Termination on error can be suppressed on a command by command basis by
 132 prefixing the command with a
 133 .Sq \-
 134 character (for example,
 135 .Ic -rm /tmp/blah* ) .
 136 .It Fl C
 137 Enables compression (via ssh's
 138 .Fl C
 139 flag).
 140 .It Fl c Ar cipher
 141 Selects the cipher to use for encrypting the data transfers.
 142 This option is directly passed to
 143 .Xr ssh 1 .
 144 .It Fl D Ar sftp_server_path
 145 Connect directly to a local sftp server
 146 (rather than via
 147 .Xr ssh 1 ) .
 148 This option may be useful in debugging the client and server.
 149 .It Fl F Ar ssh_config
 150 Specifies an alternative
 151 per-user configuration file for
 152 .Xr ssh 1 .
 153 This option is directly passed to
 154 .Xr ssh 1 .
 155 .It Fl i Ar identity_file
 156 Selects the file from which the identity (private key) for public key
 157 authentication is read.
 158 This option is directly passed to
 159 .Xr ssh 1 .
 160 .It Fl o Ar ssh_option
 161 Can be used to pass options to
 162 .Nm ssh
 163 in the format used in
 164 .Xr ssh_config 5 .
 165 This is useful for specifying options
 166 for which there is no separate
 167 .Nm sftp
 168 command-line flag.
 169 For example, to specify an alternate port use:
 170 .Ic sftp -oPort=24 .
 171 For full details of the options listed below, and their possible values, see
 172 .Xr ssh_config 5 .
 173 .Pp
 174 .Bl -tag -width Ds -offset indent -compact
 175 .It AddressFamily
 176 .It BatchMode
 177 .It BindAddress
 178 .It ChallengeResponseAuthentication
 179 .It CheckHostIP
 180 .It Cipher
 181 .It Ciphers
 182 .It Compression
 183 .It CompressionLevel
 184 .It ConnectionAttempts
 185 .It ConnectTimeout
 186 .It ControlMaster
 187 .It ControlPath
 188 .It GlobalKnownHostsFile
 189 .It GSSAPIAuthentication
 190 .It GSSAPIDelegateCredentials
 191 .It HashKnownHosts
 192 .It Host
 193 .It HostbasedAuthentication
 194 .It HostKeyAlgorithms
 195 .It HostKeyAlias
 196 .It HostName
 197 .It IdentityFile
 198 .It IdentitiesOnly
 199 .It KbdInteractiveDevices
 200 .It LogLevel
 201 .It MACs
 202 .It NoHostAuthenticationForLocalhost
 203 .It NumberOfPasswordPrompts
 204 .It PasswordAuthentication
 205 .It Port
 206 .It PreferredAuthentications
 207 .It Protocol
 208 .It ProxyCommand
 209 .It PubkeyAuthentication
 210 .It RekeyLimit
 211 .It RhostsRSAAuthentication
 212 .It RoutingDomain
 213 .It RSAAuthentication
 214 .It SendEnv
 215 .It ServerAliveInterval
 216 .It ServerAliveCountMax
 217 .It SmartcardDevice
 218 .It StrictHostKeyChecking
 219 .It TCPKeepAlive
 220 .It UsePrivilegedPort
 221 .It User
 222 .It UserKnownHostsFile
 223 .It VerifyHostKeyDNS
 224 .El
 225 .It Fl P Ar port
 226 Specifies the port to connect to on the remote host.
 227 .It Fl p
 228 Preserves modification times, access times, and modes from the
 229 original files transferred.
 230 .It Fl q
 231 Quiet mode: disables the progress meter as well as warning and
 232 diagnostic messages from
 233 .Xr ssh 1 .
 234 .It Fl R Ar num_requests
 235 Specify how many requests may be outstanding at any one time.
 236 Increasing this may slightly improve file transfer speed
 237 but will increase memory usage.
 238 The default is 64 outstanding requests.
 239 .It Fl r
 240 Recursively copy entire directories when uploading and downloading.
 241 Note that
 242 .Nm
 243 does not follow symbolic links encountered in the tree traversal.
 244 .It Fl S Ar program
 245 Name of the
 246 .Ar program
 247 to use for the encrypted connection.
 248 The program must understand
 249 .Xr ssh 1
 250 options.
 251 .It Fl s Ar subsystem | sftp_server
 252 Specifies the SSH2 subsystem or the path for an sftp server
 253 on the remote host.
 254 A path is useful for using
 255 .Nm
 256 over protocol version 1, or when the remote
 257 .Xr sshd 8
 258 does not have an sftp subsystem configured.
 259 .It Fl v
 260 Raise logging level.
 261 This option is also passed to ssh.
 262 .El
 263 .Sh INTERACTIVE COMMANDS
 264 Once in interactive mode,
 265 .Nm
 266 understands a set of commands similar to those of
 267 .Xr ftp 1 .
 268 Commands are case insensitive.
 269 Pathnames that contain spaces must be enclosed in quotes.
 270 Any special characters contained within pathnames that are recognized by
 271 .Xr glob 3
 272 must be escaped with backslashes
 273 .Pq Sq \e .
 274 .Bl -tag -width Ds
 275 .It Ic bye
 276 Quit
 277 .Nm sftp .
 278 .It Ic cd Ar path
 279 Change remote directory to
 280 .Ar path .
 281 .It Ic chgrp Ar grp Ar path
 282 Change group of file
 283 .Ar path
 284 to
 285 .Ar grp .
 286 .Ar path
 287 may contain
 288 .Xr glob 3
 289 characters and may match multiple files.
 290 .Ar grp
 291 must be a numeric GID.
 292 .It Ic chmod Ar mode Ar path
 293 Change permissions of file
 294 .Ar path
 295 to
 296 .Ar mode .
 297 .Ar path
 298 may contain
 299 .Xr glob 3
 300 characters and may match multiple files.
 301 .It Ic chown Ar own Ar path
 302 Change owner of file
 303 .Ar path
 304 to
 305 .Ar own .
 306 .Ar path
 307 may contain
 308 .Xr glob 3
 309 characters and may match multiple files.
 310 .Ar own
 311 must be a numeric UID.
 312 .It Xo Ic df
 313 .Op Fl hi
 314 .Op Ar path
 315 .Xc
 316 Display usage information for the filesystem holding the current directory
 317 (or
 318 .Ar path
 319 if specified).
 320 If the
 321 .Fl h
 322 flag is specified, the capacity information will be displayed using
 323 "human-readable" suffixes.
 324 The
 325 .Fl i
 326 flag requests display of inode information in addition to capacity information.
 327 This command is only supported on servers that implement the
 328 .Dq statvfs@openssh.com
 329 extension.
 330 .It Ic exit
 331 Quit
 332 .Nm sftp .
 333 .It Xo Ic get
 334 .Op Fl Ppr
 335 .Ar remote-path
 336 .Op Ar local-path
 337 .Xc
 338 Retrieve the
 339 .Ar remote-path
 340 and store it on the local machine.
 341 If the local
 342 path name is not specified, it is given the same name it has on the
 343 remote machine.
 344 .Ar remote-path
 345 may contain
 346 .Xr glob 3
 347 characters and may match multiple files.
 348 If it does and
 349 .Ar local-path
 350 is specified, then
 351 .Ar local-path
 352 must specify a directory.
 353 .Pp
 354 If either the
 355 .Fl P
 356 or
 357 .Fl p
 358 flag is specified, then full file permissions and access times are
 359 copied too.
 360 .Pp
 361 If the
 362 .Fl r
 363 flag is specified then directories will be copied recursively.
 364 Note that
 365 .Nm
 366 does not follow symbolic links when performing recursive transfers.
 367 .It Ic help
 368 Display help text.
 369 .It Ic lcd Ar path
 370 Change local directory to
 371 .Ar path .
 372 .It Ic lls Op Ar ls-options Op Ar path
 373 Display local directory listing of either
 374 .Ar path
 375 or current directory if
 376 .Ar path
 377 is not specified.
 378 .Ar ls-options
 379 may contain any flags supported by the local system's
 380 .Xr ls 1
 381 command.
 382 .Ar path
 383 may contain
 384 .Xr glob 3
 385 characters and may match multiple files.
 386 .It Ic lmkdir Ar path
 387 Create local directory specified by
 388 .Ar path .
 389 .It Ic ln Ar oldpath Ar newpath
 390 Create a symbolic link from
 391 .Ar oldpath
 392 to
 393 .Ar newpath .
 394 .It Ic lpwd
 395 Print local working directory.
 396 .It Xo Ic ls
 397 .Op Fl 1aflnrSt
 398 .Op Ar path
 399 .Xc
 400 Display a remote directory listing of either
 401 .Ar path
 402 or the current directory if
 403 .Ar path
 404 is not specified.
 405 .Ar path
 406 may contain
 407 .Xr glob 3
 408 characters and may match multiple files.
 409 .Pp
 410 The following flags are recognized and alter the behaviour of
 411 .Ic ls
 412 accordingly:
 413 .Bl -tag -width Ds
 414 .It Fl 1
 415 Produce single columnar output.
 416 .It Fl a
 417 List files beginning with a dot
 418 .Pq Sq \&. .
 419 .It Fl f
 420 Do not sort the listing.
 421 The default sort order is lexicographical.
 422 .It Fl l
 423 Display additional details including permissions
 424 and ownership information.
 425 .It Fl n
 426 Produce a long listing with user and group information presented
 427 numerically.
 428 .It Fl r
 429 Reverse the sort order of the listing.
 430 .It Fl S
 431 Sort the listing by file size.
 432 .It Fl t
 433 Sort the listing by last modification time.
 434 .El
 435 .It Ic lumask Ar umask
 436 Set local umask to
 437 .Ar umask .
 438 .It Ic mkdir Ar path
 439 Create remote directory specified by
 440 .Ar path .
 441 .It Ic progress
 442 Toggle display of progress meter.
 443 .It Xo Ic put
 444 .Op Fl Ppr
 445 .Ar local-path
 446 .Op Ar remote-path
 447 .Xc
 448 Upload
 449 .Ar local-path
 450 and store it on the remote machine.
 451 If the remote path name is not specified, it is given the same name it has
 452 on the local machine.
 453 .Ar local-path
 454 may contain
 455 .Xr glob 3
 456 characters and may match multiple files.
 457 If it does and
 458 .Ar remote-path
 459 is specified, then
 460 .Ar remote-path
 461 must specify a directory.
 462 .Pp
 463 If ether the
 464 .Fl P
 465 or
 466 .Fl p
 467 flag is specified, then full file permissions and access times are
 468 copied too.
 469 .Pp
 470 If the
 471 .Fl r
 472 flag is specified then directories will be copied recursively.
 473 Note that
 474 .Nm
 475 does not follow symbolic links when performing recursive transfers.
 476 .It Ic pwd
 477 Display remote working directory.
 478 .It Ic quit
 479 Quit
 480 .Nm sftp .
 481 .It Ic rename Ar oldpath Ar newpath
 482 Rename remote file from
 483 .Ar oldpath
 484 to
 485 .Ar newpath .
 486 .It Ic rm Ar path
 487 Delete remote file specified by
 488 .Ar path .
 489 .It Ic rmdir Ar path
 490 Remove remote directory specified by
 491 .Ar path .
 492 .It Ic symlink Ar oldpath Ar newpath
 493 Create a symbolic link from
 494 .Ar oldpath
 495 to
 496 .Ar newpath .
 497 .It Ic version
 498 Display the
 499 .Nm
 500 protocol version.
 501 .It Ic \&! Ns Ar command
 502 Execute
 503 .Ar command
 504 in local shell.
 505 .It Ic \&!
 506 Escape to local shell.
 507 .It Ic \&?
 508 Synonym for help.
 509 .El
 510 .Sh SEE ALSO
 511 .Xr ftp 1 ,
 512 .Xr ls 1 ,
 513 .Xr scp 1 ,
 514 .Xr ssh 1 ,
 515 .Xr ssh-add 1 ,
 516 .Xr ssh-keygen 1 ,
 517 .Xr glob 3 ,
 518 .Xr ssh_config 5 ,
 519 .Xr sftp-server 8 ,
 520 .Xr sshd 8
 521 .Rs
 522 .%A T. Ylonen
 523 .%A S. Lehtinen
 524 .%T "SSH File Transfer Protocol"
 525 .%N draft-ietf-secsh-filexfer-00.txt
 526 .%D January 2001
 527 .%O work in progress material
 528 .Re