version 1.36.2.2, 2003/04/03 23:27:12 |
version 1.36.2.3, 2003/09/16 21:20:27 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm sftp |
.Nm sftp |
.Nd Secure file transfer program |
.Nd secure file transfer program |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm sftp |
.Nm sftp |
.Bk -words |
.Bk -words |
|
|
.Ar host |
.Ar host |
.Ek |
.Ek |
.Nm sftp |
.Nm sftp |
.Oo Oo Ar user Ns No @ Oc Ns |
.Oo Oo Ar user Ns @ Oc Ns |
.Ar host Ns Oo : Ns Ar file Oo |
.Ar host Ns Oo : Ns Ar file Oo |
.Ar file Oc Oc Oc |
.Ar file Oc Oc Oc |
.Nm sftp |
.Nm sftp |
.Oo Oo Ar user Ns No @ Oc Ns |
.Oo Oo Ar user Ns @ Oc Ns |
.Ar host Ns Oo : Ns Ar dir Ns |
.Ar host Ns Oo : Ns Ar dir Ns |
.Oo Ar / Oc Oc Oc |
.Oo Ar / Oc Oc Oc |
|
.Nm sftp |
|
.Fl b Ar batchfile |
|
.Oo Ar user Ns @ Oc Ns Ar host |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm |
.Nm |
is an interactive file transfer program, similar to |
is an interactive file transfer program, similar to |
|
|
authentication method is used; otherwise it will do so after |
authentication method is used; otherwise it will do so after |
successful interactive authentication. |
successful interactive authentication. |
.Pp |
.Pp |
The last usage format allows the sftp client to start in a remote directory. |
The third usage format allows the sftp client to start in a remote directory. |
.Pp |
.Pp |
|
The final usage format allows for automated sessions using the |
|
.Fl b |
|
option. |
|
In such cases, it is usually necessary to configure public key authentication |
|
to obviate the need to enter a password at connection time (see |
|
.Xr sshd 8 |
|
and |
|
.Xr ssh-keygen 1 |
|
for details). |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl b Ar batchfile |
.It Fl b Ar batchfile |
|
|
.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 |
.Ic '-' |
.Sq Ic \- |
character (For example, |
character (for example, |
.Ic -rm /tmp/blah* |
.Ic -rm /tmp/blah* ) . |
). |
|
.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 |
|
|
This is useful for specifying options |
This is useful for specifying options |
for which there is no separate |
for which there is no separate |
.Nm sftp |
.Nm sftp |
command-line flag. For example, to specify an alternate |
command-line flag. |
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 |
.It Fl s Ar subsystem | sftp_server |
Specifies the SSH2 subsystem or the path for an 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 |
on the remote host. |
protocol version 1, or when the remote |
A path is useful for using |
.Nm sshd |
.Nm |
|
over protocol version 1, or when the remote |
|
.Xr sshd 8 |
does not have an sftp subsystem configured. |
does not have an sftp subsystem configured. |
.It Fl v |
.It Fl v |
Raise logging level. This option is also passed to ssh. |
Raise logging level. |
|
This option is also passed to ssh. |
.It Fl B Ar buffer_size |
.It Fl B Ar buffer_size |
Specify the size of the buffer that |
Specify the size of the buffer that |
.Nm |
.Nm |
uses when transferring files. Larger buffers require fewer round trips at |
uses when transferring files. |
the cost of higher memory consumption. The default is 32768 bytes. |
Larger buffers require fewer round trips at the cost of higher |
|
memory consumption. |
|
The default is 32768 bytes. |
.It Fl C |
.It Fl C |
Enables compression (via ssh's |
Enables compression (via ssh's |
.Fl C |
.Fl C |
|
|
.It Fl F Ar ssh_config |
.It Fl F Ar ssh_config |
Specifies an alternative |
Specifies an alternative |
per-user configuration file for |
per-user configuration file for |
.Nm ssh . |
.Xr ssh 1 . |
This option is directly passed to |
This option is directly passed to |
.Xr ssh 1 . |
.Xr ssh 1 . |
.It Fl P Ar sftp_server path |
.It Fl P Ar sftp_server path |
Connect directly to a local |
Connect directly to a local sftp server |
.Nm sftp-server |
|
(rather than via |
(rather than via |
.Nm ssh ) |
.Xr ssh 1 ) |
This option may be useful in debugging the client and server. |
This option may be useful in debugging the client and server. |
.It Fl R Ar num_requests |
.It Fl R Ar num_requests |
Specify how many requests may be outstanding at any one time. Increasing |
Specify how many requests may be outstanding at any one time. |
this may slightly improve file transfer speed but will increase memory |
Increasing this may slightly improve file transfer speed |
usage. The default is 16 outstanding requests. |
but will increase memory usage. |
|
The default is 16 outstanding requests. |
.It Fl S Ar program |
.It Fl S Ar program |
Name of the |
Name of the |
.Ar program |
.Ar program |
|
|
contain spaces. |
contain spaces. |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Ic bye |
.It Ic bye |
Quit sftp. |
Quit |
|
.Nm sftp . |
.It Ic cd Ar path |
.It Ic cd Ar path |
Change remote directory to |
Change remote directory to |
.Ar path . |
.Ar path . |
|
|
.Ar own |
.Ar own |
must be a numeric UID. |
must be a numeric UID. |
.It Ic exit |
.It Ic exit |
Quit sftp. |
Quit |
|
.Nm sftp . |
.It Xo Ic get |
.It Xo Ic get |
.Op Ar flags |
.Op Ar flags |
.Ar remote-path |
.Ar remote-path |
|
|
and store it on the local machine. |
and store it on the local machine. |
If the local |
If the local |
path name is not specified, it is given the same name it has on the |
path name is not specified, it is given the same name it has on the |
remote machine. If the |
remote machine. |
|
If the |
.Fl P |
.Fl P |
flag is specified, then the file's full permission and access time are |
flag is specified, then the file's full permission and access time are |
copied too. |
copied too. |
|
|
.Ar path |
.Ar path |
or current directory if |
or current directory if |
.Ar path |
.Ar path |
is not specified. If the |
is not specified. |
|
If the |
.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. |
|
|
.Xc |
.Xc |
Upload |
Upload |
.Ar local-path |
.Ar local-path |
and store it on the remote machine. If the remote path name is not |
and store it on the remote machine. |
specified, it is given the same name it has on the local machine. If the |
If the remote path name is not specified, it is given the same name it has |
|
on the local machine. |
|
If the |
.Fl P |
.Fl P |
flag is specified, then the file's full permission and access time are |
flag is specified, then the file's full permission and access time are |
copied too. |
copied too. |
.It Ic pwd |
.It Ic pwd |
Display remote working directory. |
Display remote working directory. |
.It Ic quit |
.It Ic quit |
Quit sftp. |
Quit |
|
.Nm sftp . |
.It Ic rename Ar oldpath Ar newpath |
.It Ic rename Ar oldpath Ar newpath |
Rename remote file from |
Rename remote file from |
.Ar oldpath |
.Ar oldpath |
|
|
Display the |
Display the |
.Nm |
.Nm |
protocol version. |
protocol version. |
.It Ic ! Ar command |
.It Ic \&! Ar command |
Execute |
Execute |
.Ar command |
.Ar command |
in local shell. |
in local shell. |
.It Ic ! |
.It Ic \&! |
Escape to local shell. |
Escape to local shell. |
.It Ic ? |
.It Ic \&? |
Synonym for help. |
Synonym for help. |
.El |
.El |
.Sh AUTHORS |
|
Damien Miller <djm@mindrot.org> |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr scp 1 , |
.Xr scp 1 , |
.Xr ssh 1 , |
.Xr ssh 1 , |