crypto/openssh-3.9p1/sftp.1

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