sftp — secure file transfer program
SYNOPSIS
sftp [-46aCfpqrv] [-B buffer_size] [-b batchfile] [-c cipher] [-D sftp_server_path] [-F ssh_config]
[-s subsystem | sftp_server] host
sftp [user@]host[:file …]
sftp [user@]host[:dir[/]]
sftp -b batchfile [user@]host
DESCRIPTION
sftp 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 com‐
pression. sftp 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 sftp 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).
Since some usage formats use colon characters to delimit host names from path names, IPv6 addresses must be
enclosed in square brackets to avoid ambiguity.
The options are as follows:
-4 Forces sftp to use IPv4 addresses only.
-6 Forces sftp to use IPv6 addresses only.
-a Attempt to continue interrupted transfers rather than overwriting existing partial or complete copies
likely to be corrupt.
-B buffer_size
round trips at the cost of higher memory consumption. The default is 32768 bytes.
-b batchfile
interaction it should be used in conjunction with non-interactive authentication. A batchfile of ‘-’
may be used to indicate standard input. sftp will abort if any of the following commands fail: get,
put, reget, reput, rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp, lpwd, df, symlink,
and lmkdir. Termination on error can be suppressed on a command by command basis by prefixing the com‐
mand with a ‘-’ character (for example, -rm /tmp/blah*).
-C Enables compression (via ssh’s -C flag).
-c cipher
-D sftp_server_path
ging the client and server.
-F ssh_config
ssh(1).
-f Requests that files be flushed to disk immediately after transfer. When uploading files, this feature
-i identity_file
option is directly passed to ssh(1).
-l limit
-o ssh_option
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).
BatchMode
BindAddress
CanonicalDomains
CanonicalizeFallbackLocal
CanonicalizeHostname
CanonicalizeMaxDots
CanonicalizePermittedCNAMEs
CertificateFile
ChallengeResponseAuthentication
CheckHostIP
Ciphers
Compression
ConnectionAttempts
ConnectTimeout
ControlMaster
ControlPath
ControlPersist
GlobalKnownHostsFile
GSSAPIAuthentication
GSSAPIDelegateCredentials
HashKnownHosts
Host
HostbasedAuthentication
HostbasedKeyTypes
HostKeyAlgorithms
HostKeyAlias
HostName
IdentitiesOnly
IdentityAgent
IdentityFile
IPQoS
KbdInteractiveAuthentication
KbdInteractiveDevices
KexAlgorithms
LogLevel
MACs
NoHostAuthenticationForLocalhost
NumberOfPasswordPrompts
PasswordAuthentication
PKCS11Provider
Port
PreferredAuthentications
ProxyCommand
ProxyJump
PubkeyAcceptedKeyTypes
PubkeyAuthentication
RekeyLimit
SendEnv
ServerAliveInterval
ServerAliveCountMax
StrictHostKeyChecking
TCPKeepAlive
UpdateHostKeys
UsePrivilegedPort
User
UserKnownHostsFile
VerifyHostKeyDNS
-P port
-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
file transfer speed but will increase memory usage. The default is 64 outstanding requests.
-r
在上传或者下载时,递归复制整个目录。注意,在目录遍历的时候,sftp并不会跟随符号链接指向的地址。
如果在上传或者下载目录时未指定-r选项,会产生Cannot download non-regular file错误。
-S program
-s subsystem | sftp_server
the remote sshd(8) does not have an sftp subsystem configured.
-v Raise logging level. This option is also passed to ssh.
交互式命令(INTERACTIVE COMMANDS)
Once in interactive mode, sftp 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 (‘\’).
bye Quit sftp.
cd path
chgrp grp path
grp must be a numeric GID.
chmod mode path
files.
chown own path
own must be a numeric UID.
df [-hi] [path]
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 “statvfs@openssh.com” extension.
exit Quit sftp.
get [-afPpr] remote-path [local-path]
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.
resumption assumes that any partial copy of the local file matches the remote copy. If the remote file
contents differ from the partial local copy then the resultant file is likely to be corrupt.
flush the file to disk.
low symbolic links when performing recursive transfers.
help Display help text.
lcd path
lls [ls-options [path]]
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.
lmkdir path
ln [-s] oldpath newpath
link, otherwise it is a hard link.
lpwd Print local working directory.
ls [-1afhlnrSt] [path]
path may contain glob(3) characters and may match multiple files.
powers of 2 for sizes (K=1024, M=1048576, etc.).
lumask umask
mkdir path
progress
put [-afPpr] local-path [remote-path]
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 direc‐
tory.
resumption assumes that any partial copy of the remote file matches the local copy. If the local file
contents differ from the remote local copy then the resultant file is likely to be corrupt.
has been transferred. Note that this is only supported by servers that implement the
“fsync@openssh.com” extension.
low symbolic links when performing recursive transfers.
pwd Display remote working directory.
quit Quit sftp.
reget [-Ppr] remote-path [local-path]
reput [-Ppr] [local-path] remote-path
rename oldpath newpath
rm path
rmdir path
symlink oldpath newpath
version
!command
! Escape to local shell.
? Synonym for help.
SEE ALSO
ftp(1), ls(1), scp(1), ssh(1), ssh-add(1), ssh-keygen(1), glob(3), ssh_config(5), sftp-server(8), sshd(8)
T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-filexfer-00.txt, January 2001, work in
progress material.
参考文献
- man 1 sftp, version OpenSSH 7.6p1-2