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