Manual Pages for UNIX Darwin command on man sftp

SFTP(1) BSD General Commands Manual SFTP(1)

NAME

ssffttpp - secure file transfer program

SYNOPSIS

ssffttpp [-11CCvv] [-BB buffersize] [-bb batchfile] [-FF sshconfig]

[-oo sshoption] [-PP sftpserverpath] [-RR numrequests] [-SS program]

[-ss subsystem | sftpserver] host

ssffttpp [[user@]host[:file [file]]] ssffttpp [[user@]host[:dir[/]]]

ssffttpp -bb batchfile [user@]host

DESCRIPTION

ssffttpp 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 compres-

sion. ssffttpp connects and logs into the specified host, then enters an interactive command mode.

The second usage format will retrieve files automatically if a non-inter-

active authentication method is used; otherwise it will do so after suc-

cessful interactive authentication. The third usage format allows ssffttpp to start in a remote directory.

The final usage format allows for automated sessions using the -bb option.

In such cases, it is necessary to configure non-interactive authentica-

tion 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:

-11 Specify the use of protocol version 1.

-BB buffersize

Specify the size of the buffer that ssffttpp uses when transferring files. Larger buffers require fewer round trips at the cost of higher memory consumption. The default is 32768 bytes.

-bb batchfile

Batch mode reads a series of commands from an input batchfile instead of stdin. Since it lacks user interaction it should be

used in conjunction with non-interactive authentication. A

batchfile of `-' may be used to indicate standard input. ssffttpp

will abort if any of the following commands fail: ggeett, ppuutt, rreennaammee, llnn, rrmm, mmkkddiirr, cchhddiirr, llss, llcchhddiirr, cchhmmoodd, cchhoowwnn, cchhggrrpp, llppwwdd, ddff, and llmmkkddiirr. Termination on error can be suppressed on

a command by command basis by prefixing the command with a `-'

character (for example, -rrmm //ttmmpp//bbllaahh**).

-CC Enables compression (via ssh's -CC flag).

-FF sshconfig

Specifies an alternative per-user configuration file for ssh(1).

This option is directly passed to ssh(1).

-oo sshoption

Can be used to pass options to sssshh in the format used in sshconfig(5). This is useful for specifying options for which

there is no separate ssffttpp command-line flag. For example, to

specify an alternate port use: ssffttpp -ooPPoorrtt==2244. For full details

of the options listed below, and their possible values, see sshconfig(5). 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 Port PreferredAuthentications Protocol ProxyCommand PubkeyAuthentication RekeyLimit RhostsRSAAuthentication RSAAuthentication SendEnv ServerAliveInterval ServerAliveCountMax SmartcardDevice StrictHostKeyChecking TCPKeepAlive UsePrivilegedPort User UserKnownHostsFile VerifyHostKeyDNS

-PP sftpserverpath

Connect directly to a local sftp server (rather than via ssh(1)).

This option may be useful in debugging the client and server.

-RR numrequests

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.

-SS program

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

-ss subsystem | sftpserver

Specifies the SSH2 subsystem or the path for an sftp server on

the remote host. A path is useful for using ssffttpp over protocol

version 1, or when the remote sshd(8) does not have an sftp sub-

system configured.

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

IINNTTEERRAACCTTIIVVEE CCOOMMMMAANNDDSS Once in interactive mode, ssffttpp 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 (`\'). bbyyee Quit ssffttpp. ccdd path Change remote directory to path. cchhggrrpp grp path

Change group of file path to grp. path may contain glob(3) char-

acters and may match multiple files. grp must be a numeric GID. cchhmmoodd mode path Change permissions of file path to mode. path may contain glob(3) characters and may match multiple files. cchhoowwnn own path

Change owner of file path to own. path may contain glob(3) char-

acters and may match multiple files. own must be a numeric UID.

ddff [-hhii] [path]

Display usage information for the filesystem holding the current

directory (or path if specified). If the -hh flag is specified,

the capacity information will be displayed using "human-readable"

suffixes. The -ii 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. eexxiitt Quit ssffttpp.

ggeett [-PP] remote-path [local-path]

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 direc-

tory. If the -PP flag is specified, then full file permissions

and access times are copied too. hheellpp Display help text. llccdd path Change local directory to path.

llllss [ls-options [path]]

Display local directory listing of either path or current direc-

tory 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. llmmkkddiirr path Create local directory specified by path. llnn oldpath newpath Create a symbolic link from oldpath to newpath. llppwwdd Print local working directory.

llss [-11aaffllnnrrSStt] [path]

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 llss accordingly:

-11 Produce single columnar output.

-aa List files beginning with a dot (`.').

-ff Do not sort the listing. The default sort order is lexi-

cographical.

-ll Display additional details including permissions and own-

ership information.

-nn Produce a long listing with user and group information

presented numerically.

-rr Reverse the sort order of the listing.

-SS Sort the listing by file size.

-tt Sort the listing by last modification time.

lluummaasskk umask Set local umask to umask. mmkkddiirr path Create remote directory specified by path. pprrooggrreessss Toggle display of progress meter.

ppuutt [-PP] local-path [remote-path]

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) charac-

ters and may match multiple files. If it does and remote-path is

specified, then remote-path must specify a directory. If the -PP

flag is specified, then the file's full permission and access time are copied too. ppwwdd Display remote working directory. qquuiitt Quit ssffttpp. rreennaammee oldpath newpath Rename remote file from oldpath to newpath. rrmm path Delete remote file specified by path. rrmmddiirr path Remove remote directory specified by path. ssyymmlliinnkk oldpath newpath Create a symbolic link from oldpath to newpath. vveerrssiioonn Display the ssffttpp protocol version. !! command Execute command in local shell. !! Escape to local shell. ?? Synonym for help.

sshconfig(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.

BSD December 21, 2019 BSD