sftp - Secure file transfer program SYNOPSIS

sftp [-1Cv? [-b batchfile? [-F ssh_config? [-o ssh_option? [-s subsystem? [-S program? host

sftp [[[''user''@?host[''file''?]]

sftp [[[''user''@?host''dir''[[''/''?]] 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 compression. 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 last usage format allows the sftp client to start in a remote directory.

The options are as follows
  • 1 Specify the use of protocol version 1.
  • b batchfileBatch mode reads a series of commands from an inputbatchfile instead of stdin. Since it lacks userinteraction it should be used in conjunction withnon-interactive authentication. sftp will abort ifany of the following commands fail: get, put, rename,ln, rm, mkdir, chdir, lchdir and lmkdir.-CEnables compression (via ssh's -C flag).-F ssh_configSpecifies an alternative per-user configuration filefor ssh. This option is directly passed to ssh(1).
  • o ssh_option

Can be used to pass options to ssh in the format used in the ssh(1) configuration file. 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.

  • 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 sftp over protocol version 1, or when the remote sshd does not have an sftp subsystem config- ured.

  • S program

Name of the program to use for the encrypted connec- tion. The program must understand ssh(1) options.

  • v

Raise logging level. This option is also passed to ssh.


Once in interactive mode, sftp understands a set of commands similar to those of ftp(1). Commands are case insensitive and pathnames may be enclosed in quotes if they contain spaces.

bye Quit sftp.

cd pathChange remote directory to path.lcd pathChange local directory to path.chgrp grp pathChange group of file path to grp. grp must be anumeric GID.chmod mode pathChange permissions of file path to mode.chown own pathChange owner of file path to own. own must be anumeric UID.exitQuit sftp.get [flags? remote-path [local-path? Retrieve the remote-path and store it on the localmachine. If the local path name is not specified, itis given the same name it has on the remote machine.If the -P flag is specified, then the file's fullpermission and access time are copied too.helpDisplay help text.lls [ls-options [[path?]Display local directory listing of either path orcurrent directory if path is not specified.lmkdir pathCreate local directory specified by path.ln oldpath newpathCreate a symbolic link from oldpath to newpath.lpwdPrint local working [path?Display remote directory listing of either path orcurrent directory if path is not specified.lumask umaskSet local umask to umask.mkdir pathCreate remote directory specified by path.put [flags? local-path [local-path? Upload local-path and store it on the remote machine.If the remote path name is not specified, it is giventhe same name it has on the local machine. If the -Pflag is specified, then the file's full permissionand access time are copied too.pwdDisplay remote working directory.quitQuit sftp.rename oldpath newpathRename remote file from oldpath to newpath.rmdir pathRemove remote directory specified by path.rm pathDelete remote file specified by path.symlink oldpath newpathCreate a symbolic link from oldpath to newpath.! commandExecute command in local shell.!Escape to local shell.?Synonym for help.AUTHORS

Damien Miller SEE ALSO

scp(1), ssh(1), ssh-add(1), ssh-keygen(1), sftp-server(8), sshd(8)

T. Ylonen and S. Lehtinen, SSH File Transfer Protocol, draft-ietf-secsh-filexfer-00.txt, January 2001, workin progress material.BSD February 4, 2001 1

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.