Man page 1 : sftp

sftp - secure file transfer program

sftp

k -words .Op Fl 1246Cpqrv [-B buffer_size ] [-b batchfile ] [-c cipher ] [-D sftp_server_path ] [-F ssh_config ] [-i identity_file ] [-o ssh_option ] [-P port ] [-R num_requests ] [-S program ] [-s subsystem | sftp_server ] host .Ek sftp .Oo Ar user Ns @ Oc Ns host Ns Op : Ns Ar sftp .Oo Ar user Ns @ Oc Ns host Ns Oo : Ns Ar dir Ns .Op Ar / Oc sftp - b Ar batchfile .Oo Ar user Ns @ Oc Ns Ar host

is an interactive file transfer program, similar to ftp(1) , which performs all operations over an encrypted ssh(1) transport. It may also use many features of ssh, such as public key authentication and compression. connects and logs into the specified host , then enters an interactive command mode.

The second usage format will retrieve files automatically if a non-interactive authentication method is used; otherwise it will do so after successful interactive authentication.

The third usage format allows to start in a remote directory.

The final usage format allows for automated sessions using the - b option. In such cases, it is necessary to configure non-interactive authentication to obviate the need to enter a password at connection time (see sshd(8) and ssh-keygen(1) for details). The options are as follows:

-tag -width Ds
-1 Specify the use of protocol version 1.
-2 Specify the use of protocol version 2.
-4 Forces to use IPv4 addresses only.
-6 Forces to use IPv6 addresses only.
-B buffer_size Specify the size of the buffer that uses when transferring files. Larger buffers require fewer round trips at the cost of higher memory consumption. The default is 32768 bytes.
-b batchfile Batch mode reads a series of commands from an input batchfile instead of .Em stdin . Since it lacks user interaction it should be used in conjunction with non-interactive authentication. A batchfile of .Sq - may be used to indicate standard input. will abort if any of the following commands fail: get , put , rename , ln , rm , mkdir , chdir , ls , lchdir , chmod , chown , chgrp , lpwd , df , and lmkdir . Termination on error can be suppressed on a command by command basis by prefixing the command with a .Sq - character (for example, -rm /tmp/blah* ) .
-C Enables compression (via ssh's - C flag).
-c cipher Selects the cipher to use for encrypting the data transfers. This option is directly passed to ssh(1) .
-D sftp_server_path Connect directly to a local sftp server (rather than via ssh(1) ) . This option may be useful in debugging the client and server.
-F ssh_config Specifies an alternative per-user configuration file for ssh(1) . This option is directly passed to ssh(1) .
-i identity_file Selects the file from which the identity (private key) for public key authentication is read. This option is directly passed to ssh(1) .
-o ssh_option Can be used to pass options to ssh in the format used in ssh_config(5) . This is useful for specifying options for which there is no separate sftp command-line flag. For example, to specify an alternate port use: sftp -oPort=24 . For full details of the options listed below, and their possible values, see ssh_config(5) .

-tag -width Ds -offset indent -compact
AddressFamily
BatchMode
BindAddress
ChallengeResponseAuthentication
CheckHostIP
Cipher
Ciphers
Compression
CompressionLevel
ConnectionAttempts
ConnectTimeout
ControlMaster
ControlPath
GlobalKnownHostsFile
GSSAPIAuthentication
GSSAPIDelegateCredentials
HashKnownHosts
Host
HostbasedAuthentication
HostKeyAlgorithms
HostKeyAlias
HostName
IdentityFile
IdentitiesOnly
KbdInteractiveDevices
LogLevel
MACs
NoHostAuthenticationForLocalhost
NumberOfPasswordPrompts
PasswordAuthentication
PKCS11Provider
Port
PreferredAuthentications
Protocol
ProxyCommand
PubkeyAuthentication
RekeyLimit
RhostsRSAAuthentication
RSAAuthentication
SendEnv
ServerAliveInterval
ServerAliveCountMax
StrictHostKeyChecking
TCPKeepAlive
UsePrivilegedPort
User
UserKnownHostsFile
VerifyHostKeyDNS
-P port Specifies the port to connect to on the remote host.
-p Preserves modification times, access times, and modes from the original files transferred.
-q Quiet mode: disables the progress meter as well as warning and diagnostic messages from ssh(1) .
-R num_requests Specify how many requests may be outstanding at any one time. Increasing this may slightly improve file transfer speed but will increase memory usage. The default is 64 outstanding requests.
-r Recursively copy entire directories when uploading and downloading. Note that does not follow symbolic links encountered in the tree traversal.
-S program Name of the program to use for the encrypted connection. The program must understand ssh(1) options.
-s subsystem | sftp_server Specifies the SSH2 subsystem or the path for an sftp server on the remote host. A path is useful for using over protocol version 1, or when the remote sshd(8) does not have an sftp subsystem configured.
-v Raise logging level. This option is also passed to ssh.

Once in interactive mode, understands a set of commands similar to those of ftp(1) . Commands are case insensitive. Pathnames that contain spaces must be enclosed in quotes. Any special characters contained within pathnames that are recognized by glob(3) must be escaped with backslashes .Pq Sq \ .

-tag -width Ds
Ic bye Quit sftp .
Ic cd path Change remote directory to path .
Ic chgrp grp path Change group of file path to grp . path may contain glob(3) characters and may match multiple files. grp must be a numeric GID.
Ic chmod mode path Change permissions of file path to mode . path may contain glob(3) characters and may match multiple files.
Ic chown own path Change owner of file path to own . path may contain glob(3) characters and may match multiple files. own must be a numeric UID.
df [-hi] [path] .Xc Display usage information for the filesystem holding the current directory (or path if specified). If the - h flag is specified, the capacity information will be displayed using "human-readable" suffixes. The - i flag requests display of inode information in addition to capacity information. This command is only supported on servers that implement the .Dq extension.
Ic exit Quit sftp .
get [-Ppr] remote-path .Op Ar local-path .Xc Retrieve the remote-path and store it on the local machine. If the local path name is not specified, it is given the same name it has on the remote machine. remote-path may contain glob(3) characters and may match multiple files. If it does and local-path is specified, then local-path must specify a directory.

If either the - P or - p flag is specified, then full file permissions and access times are copied too.

If the - r flag is specified then directories will be copied recursively. Note that does not follow symbolic links when performing recursive transfers.
Ic help Display help text.
Ic lcd path Change local directory to path .
Ic lls Op ls-options Op path Display local directory listing of either path or current directory if path is not specified. ls-options may contain any flags supported by the local system's ls(1) command. path may contain glob(3) characters and may match multiple files.
Ic lmkdir path Create local directory specified by path .
Ic ln oldpath newpath Create a symbolic link from oldpath to newpath .
Ic lpwd Print local working directory.
ls .Op Fl 1afhlnrSt [path] .Xc Display a remote directory listing of either path or the current directory if path is not specified. path may contain glob(3) characters and may match multiple files.

The following flags are recognized and alter the behaviour of ls accordingly:

-tag -width Ds
-1 Produce single columnar output.
-a List files beginning with a dot .Pq Sq . .
-f Do not sort the listing. The default sort order is lexicographical.
-h When used with a long format option, use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce the number of digits to four or fewer using powers of 2 for sizes (K=1024, M=1048576, etc.).
-l Display additional details including permissions and ownership information.
-n Produce a long listing with user and group information presented numerically.
-r Reverse the sort order of the listing.
-S Sort the listing by file size.
-t Sort the listing by last modification time.
Ic lumask umask Set local umask to umask .
Ic mkdir path Create remote directory specified by path .
Ic progress Toggle display of progress meter.
put [-Ppr] local-path .Op Ar remote-path .Xc Upload local-path and store it on the remote machine. If the remote path name is not specified, it is given the same name it has on the local machine. local-path may contain glob(3) characters and may match multiple files. If it does and remote-path is specified, then remote-path must specify a directory.

If ether the - P or - p flag is specified, then full file permissions and access times are copied too.

If the - r flag is specified then directories will be copied recursively. Note that does not follow symbolic links when performing recursive transfers.
Ic pwd Display remote working directory.
Ic quit Quit sftp .
Ic rename oldpath newpath Rename remote file from oldpath to newpath .
Ic rm path Delete remote file specified by path .
Ic rmdir path Remove remote directory specified by path .
Ic symlink oldpath newpath Create a symbolic link from oldpath to newpath .
Ic version Display the protocol version.
Ic ! Ns command Execute command in local shell.
Ic ! Escape to local shell.
Ic ? Synonym for help.

ftp(1) , ls(1) , scp(1) , ssh(1) , ssh-add(1) , ssh-keygen(1) , glob(3) , ssh_config(5) , sftp-server(8) , sshd(8) .Rs .%A T. Ylonen .%A S. Lehtinen .%T "SSH File Transfer Protocol" .%N draft-ietf-secsh-filexfer-00.txt .%D January 2001 .%O work in progress material