version 1.45, 2003/09/02 18:50:06 |
version 1.45.2.2, 2004/08/19 22:37:32 |
|
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm sftp |
.Nm sftp |
.Bk -words |
.Bk -words |
.Op Fl vC1 |
.Op Fl 1Cv |
.Op Fl b Ar batchfile |
|
.Op Fl o Ar ssh_option |
|
.Op Fl s Ar subsystem | sftp_server |
|
.Op Fl B Ar buffer_size |
.Op Fl B Ar buffer_size |
|
.Op Fl b Ar batchfile |
.Op Fl F Ar ssh_config |
.Op Fl F Ar ssh_config |
.Op Fl P Ar sftp_server path |
.Op Fl o Ar ssh_option |
|
.Op Fl P Ar sftp_server_path |
.Op Fl R Ar num_requests |
.Op Fl R Ar num_requests |
.Op Fl S Ar program |
.Op Fl S Ar program |
|
.Op Fl s Ar subsystem | sftp_server |
.Ar host |
.Ar host |
.Ek |
.Ek |
.Nm sftp |
.Nm sftp |
|
|
for details). |
for details). |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
|
.It Fl 1 |
|
Specify the use of protocol version 1. |
|
.It Fl B Ar buffer_size |
|
Specify the size of the buffer that |
|
.Nm |
|
uses when transferring files. |
|
Larger buffers require fewer round trips at the cost of higher |
|
memory consumption. |
|
The default is 32768 bytes. |
.It Fl b Ar batchfile |
.It Fl b Ar batchfile |
Batch mode reads a series of commands from an input |
Batch mode reads a series of commands from an input |
.Ar batchfile |
.Ar batchfile |
|
|
.Em stdin . |
.Em stdin . |
Since it lacks user interaction it should be used in conjunction with |
Since it lacks user interaction it should be used in conjunction with |
non-interactive authentication. |
non-interactive authentication. |
|
A |
|
.Ar batchfile |
|
of |
|
.Sq \- |
|
may be used to indicate standard input. |
.Nm |
.Nm |
will abort if any of the following |
will abort if any of the following |
commands fail: |
commands fail: |
|
|
.Ic lmkdir . |
.Ic lmkdir . |
Termination on error can be suppressed on a command by command basis by |
Termination on error can be suppressed on a command by command basis by |
prefixing the command with a |
prefixing the command with a |
.Sq Ic \- |
.Sq \- |
character (for example, |
character (for example, |
.Ic -rm /tmp/blah* ) . |
.Ic -rm /tmp/blah* ) . |
|
.It Fl C |
|
Enables compression (via ssh's |
|
.Fl C |
|
flag). |
|
.It Fl F Ar ssh_config |
|
Specifies an alternative |
|
per-user configuration file for |
|
.Xr ssh 1 . |
|
This option is directly passed to |
|
.Xr ssh 1 . |
.It Fl o Ar ssh_option |
.It Fl o Ar ssh_option |
Can be used to pass options to |
Can be used to pass options to |
.Nm ssh |
.Nm ssh |
|
|
command-line flag. |
command-line flag. |
For example, to specify an alternate port use: |
For example, to specify an alternate port use: |
.Ic sftp -oPort=24 . |
.Ic sftp -oPort=24 . |
.It Fl s Ar subsystem | sftp_server |
For full details of the options listed below, and their possible values, see |
Specifies the SSH2 subsystem or the path for an sftp server |
.Xr ssh_config 5 . |
on the remote host. |
.Pp |
A path is useful for using |
.Bl -tag -width Ds -offset indent -compact |
.Nm |
.It AddressFamily |
over protocol version 1, or when the remote |
.It BatchMode |
.Xr sshd 8 |
.It BindAddress |
does not have an sftp subsystem configured. |
.It ChallengeResponseAuthentication |
.It Fl v |
.It CheckHostIP |
Raise logging level. |
.It Cipher |
This option is also passed to ssh. |
.It Ciphers |
.It Fl B Ar buffer_size |
.It Compression |
Specify the size of the buffer that |
.It CompressionLevel |
.Nm |
.It ConnectionAttempts |
uses when transferring files. |
.It ConnectTimeout |
Larger buffers require fewer round trips at the cost of higher |
.It ControlMaster |
memory consumption. |
.It ControlPath |
The default is 32768 bytes. |
.It GlobalKnownHostsFile |
.It Fl C |
.It GSSAPIAuthentication |
Enables compression (via ssh's |
.It GSSAPIDelegateCredentials |
.Fl C |
.It Host |
flag). |
.It HostbasedAuthentication |
.It Fl F Ar ssh_config |
.It HostKeyAlgorithms |
Specifies an alternative |
.It HostKeyAlias |
per-user configuration file for |
.It HostName |
.Xr ssh 1 . |
.It IdentityFile |
This option is directly passed to |
.It IdentitiesOnly |
.Xr ssh 1 . |
.It LogLevel |
.It Fl P Ar sftp_server path |
.It MACs |
|
.It NoHostAuthenticationForLocalhost |
|
.It NumberOfPasswordPrompts |
|
.It PasswordAuthentication |
|
.It Port |
|
.It PreferredAuthentications |
|
.It Protocol |
|
.It ProxyCommand |
|
.It PubkeyAuthentication |
|
.It RhostsRSAAuthentication |
|
.It RSAAuthentication |
|
.It SendEnv |
|
.It ServerAliveInterval |
|
.It ServerAliveCountMax |
|
.It SmartcardDevice |
|
.It StrictHostKeyChecking |
|
.It TCPKeepAlive |
|
.It UsePrivilegedPort |
|
.It User |
|
.It UserKnownHostsFile |
|
.It VerifyHostKeyDNS |
|
.El |
|
.It Fl P Ar sftp_server_path |
Connect directly to a local sftp server |
Connect directly to a local sftp server |
(rather than via |
(rather than via |
.Xr ssh 1 ) |
.Xr ssh 1 ) |
|
|
The program must understand |
The program must understand |
.Xr ssh 1 |
.Xr ssh 1 |
options. |
options. |
.It Fl 1 |
.It Fl s Ar subsystem | sftp_server |
Specify the use of protocol version 1. |
Specifies the SSH2 subsystem or the path for an sftp server |
|
on the remote host. |
|
A path is useful for using |
|
.Nm |
|
over protocol version 1, or when the remote |
|
.Xr sshd 8 |
|
does not have an sftp subsystem configured. |
|
.It Fl v |
|
Raise logging level. |
|
This option is also passed to ssh. |
.El |
.El |
.Sh INTERACTIVE COMMANDS |
.Sh INTERACTIVE COMMANDS |
Once in interactive mode, |
Once in interactive mode, |
|
|
.Xr ftp 1 . |
.Xr ftp 1 . |
Commands are case insensitive and pathnames may be enclosed in quotes if they |
Commands are case insensitive and pathnames may be enclosed in quotes if they |
contain spaces. |
contain spaces. |
.Bl -tag -width Ds |
.Bl -tag -width "lmdir path" |
.It Ic bye |
.It Ic bye |
Quit |
Quit |
.Nm sftp . |
.Nm sftp . |
.It Ic cd Ar path |
.It Ic cd Ar path |
Change remote directory to |
Change remote directory to |
.Ar path . |
.Ar path . |
.It Ic lcd Ar path |
|
Change local directory to |
|
.Ar path . |
|
.It Ic chgrp Ar grp Ar path |
.It Ic chgrp Ar grp Ar path |
Change group of file |
Change group of file |
.Ar path |
.Ar path |
|
|
copied too. |
copied too. |
.It Ic help |
.It Ic help |
Display help text. |
Display help text. |
|
.It Ic lcd Ar path |
|
Change local directory to |
|
.Ar path . |
.It Ic lls Op Ar ls-options Op Ar path |
.It Ic lls Op Ar ls-options Op Ar path |
Display local directory listing of either |
Display local directory listing of either |
.Ar path |
.Ar path |
|
|
.Fl l |
.Fl l |
flag is specified, then display additional details including permissions |
flag is specified, then display additional details including permissions |
and ownership information. |
and ownership information. |
|
The |
|
.Fl n |
|
flag will produce a long listing with user and group information presented |
|
numerically. |
|
.Pp |
|
By default, |
|
.Ic ls |
|
listings are sorted in lexicographical order. |
|
This may be changed by specifying the |
|
.Fl S |
|
(sort by file size), |
|
.Fl t |
|
(sort by last modification time), or |
|
.Fl f |
|
(don't sort at all) flags. |
|
Additionally, the sort order may be reversed using the |
|
.Fl r |
|
flag. |
.It Ic lumask Ar umask |
.It Ic lumask Ar umask |
Set local umask to |
Set local umask to |
.Ar umask . |
.Ar umask . |
|
|
.Ar oldpath |
.Ar oldpath |
to |
to |
.Ar newpath . |
.Ar newpath . |
.It Ic rmdir Ar path |
|
Remove remote directory specified by |
|
.Ar path . |
|
.It Ic rm Ar path |
.It Ic rm Ar path |
Delete remote file specified by |
Delete remote file specified by |
.Ar path . |
.Ar path . |
|
.It Ic rmdir Ar path |
|
Remove remote directory specified by |
|
.Ar path . |
.It Ic symlink Ar oldpath Ar newpath |
.It Ic symlink Ar oldpath Ar newpath |
Create a symbolic link from |
Create a symbolic link from |
.Ar oldpath |
.Ar oldpath |
|
|
Synonym for help. |
Synonym for help. |
.El |
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr ftp 1 , |
.Xr scp 1 , |
.Xr scp 1 , |
.Xr ssh 1 , |
.Xr ssh 1 , |
.Xr ssh-add 1 , |
.Xr ssh-add 1 , |