sftp.1

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