sftp.1

   1 .\" $OpenBSD: sftp.1,v 1.76 2009/08/19 04:56:03 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 $Mdocdate: August 19 2009 $
  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 RSAAuthentication
 213 .It SendEnv
 214 .It ServerAliveInterval
 215 .It ServerAliveCountMax
 216 .It SmartcardDevice
 217 .It StrictHostKeyChecking
 218 .It TCPKeepAlive
 219 .It UsePrivilegedPort
 220 .It User
 221 .It UserKnownHostsFile
 222 .It VerifyHostKeyDNS
 223 .El
 224 .It Fl P Ar port
 225 Specifies the port to connect to on the remote host.
 226 .It Fl p
 227 Preserves modification times, access times, and modes from the
 228 original files transferred.
 229 .It Fl q
 230 Quiet mode: disables the progress meter as well as warning and
 231 diagnostic messages from
 232 .Xr ssh 1 .
 233 .It Fl R Ar num_requests
 234 Specify how many requests may be outstanding at any one time.
 235 Increasing this may slightly improve file transfer speed
 236 but will increase memory usage.
 237 The default is 64 outstanding requests.
 238 .It Fl r
 239 Recursively copy entire directories when uploading and downloading.
 240 Note that
 241 .Nm
 242 does not follow symbolic links encountered in the tree traversal.
 243 .It Fl S Ar program
 244 Name of the
 245 .Ar program
 246 to use for the encrypted connection.
 247 The program must understand
 248 .Xr ssh 1
 249 options.
 250 .It Fl s Ar subsystem | sftp_server
 251 Specifies the SSH2 subsystem or the path for an sftp server
 252 on the remote host.
 253 A path is useful for using
 254 .Nm
 255 over protocol version 1, or when the remote
 256 .Xr sshd 8
 257 does not have an sftp subsystem configured.
 258 .It Fl v
 259 Raise logging level.
 260 This option is also passed to ssh.
 261 .El
 262 .Sh INTERACTIVE COMMANDS
 263 Once in interactive mode,
 264 .Nm
 265 understands a set of commands similar to those of
 266 .Xr ftp 1 .
 267 Commands are case insensitive.
 268 Pathnames that contain spaces must be enclosed in quotes.
 269 Any special characters contained within pathnames that are recognized by
 270 .Xr glob 3
 271 must be escaped with backslashes
 272 .Pq Sq \e .
 273 .Bl -tag -width Ds
 274 .It Ic bye
 275 Quit
 276 .Nm sftp .
 277 .It Ic cd Ar path
 278 Change remote directory to
 279 .Ar path .
 280 .It Ic chgrp Ar grp Ar path
 281 Change group of file
 282 .Ar path
 283 to
 284 .Ar grp .
 285 .Ar path
 286 may contain
 287 .Xr glob 3
 288 characters and may match multiple files.
 289 .Ar grp
 290 must be a numeric GID.
 291 .It Ic chmod Ar mode Ar path
 292 Change permissions of file
 293 .Ar path
 294 to
 295 .Ar mode .
 296 .Ar path
 297 may contain
 298 .Xr glob 3
 299 characters and may match multiple files.
 300 .It Ic chown Ar own Ar path
 301 Change owner of file
 302 .Ar path
 303 to
 304 .Ar own .
 305 .Ar path
 306 may contain
 307 .Xr glob 3
 308 characters and may match multiple files.
 309 .Ar own
 310 must be a numeric UID.
 311 .It Xo Ic df
 312 .Op Fl hi
 313 .Op Ar path
 314 .Xc
 315 Display usage information for the filesystem holding the current directory
 316 (or
 317 .Ar path
 318 if specified).
 319 If the
 320 .Fl h
 321 flag is specified, the capacity information will be displayed using
 322 "human-readable" suffixes.
 323 The
 324 .Fl i
 325 flag requests display of inode information in addition to capacity information.
 326 This command is only supported on servers that implement the
 327 .Dq statvfs@openssh.com
 328 extension.
 329 .It Ic exit
 330 Quit
 331 .Nm sftp .
 332 .It Xo Ic get
 333 .Op Fl Ppr
 334 .Ar remote-path
 335 .Op Ar local-path
 336 .Xc
 337 Retrieve the
 338 .Ar remote-path
 339 and store it on the local machine.
 340 If the local
 341 path name is not specified, it is given the same name it has on the
 342 remote machine.
 343 .Ar remote-path
 344 may contain
 345 .Xr glob 3
 346 characters and may match multiple files.
 347 If it does and
 348 .Ar local-path
 349 is specified, then
 350 .Ar local-path
 351 must specify a directory.
 352 .Pp
 353 If either the
 354 .Fl P
 355 or
 356 .Fl p
 357 flag is specified, then full file permissions and access times are
 358 copied too.
 359 .Pp
 360 If the
 361 .Fl r
 362 flag is specified then directories will be copied recursively.
 363 Note that
 364 .Nm
 365 does not follow symbolic links when performing recursive transfers.
 366 .It Ic help
 367 Display help text.
 368 .It Ic lcd Ar path
 369 Change local directory to
 370 .Ar path .
 371 .It Ic lls Op Ar ls-options Op Ar path
 372 Display local directory listing of either
 373 .Ar path
 374 or current directory if
 375 .Ar path
 376 is not specified.
 377 .Ar ls-options
 378 may contain any flags supported by the local system's
 379 .Xr ls 1
 380 command.
 381 .Ar path
 382 may contain
 383 .Xr glob 3
 384 characters and may match multiple files.
 385 .It Ic lmkdir Ar path
 386 Create local directory specified by
 387 .Ar path .
 388 .It Ic ln Ar oldpath Ar newpath
 389 Create a symbolic link from
 390 .Ar oldpath
 391 to
 392 .Ar newpath .
 393 .It Ic lpwd
 394 Print local working directory.
 395 .It Xo Ic ls
 396 .Op Fl 1aflnrSt
 397 .Op Ar path
 398 .Xc
 399 Display a remote directory listing of either
 400 .Ar path
 401 or the current directory if
 402 .Ar path
 403 is not specified.
 404 .Ar path
 405 may contain
 406 .Xr glob 3
 407 characters and may match multiple files.
 408 .Pp
 409 The following flags are recognized and alter the behaviour of
 410 .Ic ls
 411 accordingly:
 412 .Bl -tag -width Ds
 413 .It Fl 1
 414 Produce single columnar output.
 415 .It Fl a
 416 List files beginning with a dot
 417 .Pq Sq \&. .
 418 .It Fl f
 419 Do not sort the listing.
 420 The default sort order is lexicographical.
 421 .It Fl l
 422 Display additional details including permissions
 423 and ownership information.
 424 .It Fl n
 425 Produce a long listing with user and group information presented
 426 numerically.
 427 .It Fl r
 428 Reverse the sort order of the listing.
 429 .It Fl S
 430 Sort the listing by file size.
 431 .It Fl t
 432 Sort the listing by last modification time.
 433 .El
 434 .It Ic lumask Ar umask
 435 Set local umask to
 436 .Ar umask .
 437 .It Ic mkdir Ar path
 438 Create remote directory specified by
 439 .Ar path .
 440 .It Ic progress
 441 Toggle display of progress meter.
 442 .It Xo Ic put
 443 .Op Fl Ppr
 444 .Ar local-path
 445 .Op Ar remote-path
 446 .Xc
 447 Upload
 448 .Ar local-path
 449 and store it on the remote machine.
 450 If the remote path name is not specified, it is given the same name it has
 451 on the local machine.
 452 .Ar local-path
 453 may contain
 454 .Xr glob 3
 455 characters and may match multiple files.
 456 If it does and
 457 .Ar remote-path
 458 is specified, then
 459 .Ar remote-path
 460 must specify a directory.
 461 .Pp
 462 If ether the
 463 .Fl P
 464 or
 465 .Fl p
 466 flag is specified, then full file permissions and access times are
 467 copied too.
 468 .Pp
 469 If the
 470 .Fl r
 471 flag is specified then directories will be copied recursively.
 472 Note that
 473 .Nm
 474 does not follow symbolic links when performing recursive transfers.
 475 .It Ic pwd
 476 Display remote working directory.
 477 .It Ic quit
 478 Quit
 479 .Nm sftp .
 480 .It Ic rename Ar oldpath Ar newpath
 481 Rename remote file from
 482 .Ar oldpath
 483 to
 484 .Ar newpath .
 485 .It Ic rm Ar path
 486 Delete remote file specified by
 487 .Ar path .
 488 .It Ic rmdir Ar path
 489 Remove remote directory specified by
 490 .Ar path .
 491 .It Ic symlink Ar oldpath Ar newpath
 492 Create a symbolic link from
 493 .Ar oldpath
 494 to
 495 .Ar newpath .
 496 .It Ic version
 497 Display the
 498 .Nm
 499 protocol version.
 500 .It Ic \&! Ns Ar command
 501 Execute
 502 .Ar command
 503 in local shell.
 504 .It Ic \&!
 505 Escape to local shell.
 506 .It Ic \&?
 507 Synonym for help.
 508 .El
 509 .Sh SEE ALSO
 510 .Xr ftp 1 ,
 511 .Xr ls 1 ,
 512 .Xr scp 1 ,
 513 .Xr ssh 1 ,
 514 .Xr ssh-add 1 ,
 515 .Xr ssh-keygen 1 ,
 516 .Xr glob 3 ,
 517 .Xr ssh_config 5 ,
 518 .Xr sftp-server 8 ,
 519 .Xr sshd 8
 520 .Rs
 521 .%A T. Ylonen
 522 .%A S. Lehtinen
 523 .%T "SSH File Transfer Protocol"
 524 .%N draft-ietf-secsh-filexfer-00.txt
 525 .%D January 2001
 526 .%O work in progress material
 527 .Re