version 1.17, 2001/04/22 13:32:27 |
version 1.17.2.1, 2001/09/27 19:03:55 |
|
|
.Nd Secure file transfer program |
.Nd Secure file transfer program |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm sftp |
.Nm sftp |
.Op Fl vC |
.Op Fl 1Cv |
.Op Fl b Ar batchfile |
.Op Fl b Ar batchfile |
|
.Op Fl F Ar ssh_config |
.Op Fl o Ar ssh_option |
.Op Fl o Ar ssh_option |
.Op Ar host |
.Op Fl s Ar subsystem | sftp_server |
|
.Op Fl S Ar program |
|
.Ar host |
.Nm sftp |
.Nm sftp |
.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] |
.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] |
.Nm sftp |
.Nm sftp |
.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] |
.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm |
.Nm |
is an interactive file transfer program, similar to |
is an interactive file transfer program, similar to |
|
|
compression. |
compression. |
.Nm |
.Nm |
connects and logs into the specified |
connects and logs into the specified |
.Ar hostname , |
.Ar host , |
then enters an interactive command mode. |
then enters an interactive command mode. |
.Pp |
.Pp |
The second usage format will fetch files automaticly if a non-interactive |
The second usage format will retrieve files automatically if a non-interactive |
authentication is used, else it do so after an interactive authentication |
authentication method is used; otherwise it will do so after |
is used. |
successful interactive authentication. |
.Pp |
.Pp |
The last usage format allows the sftp client to start in a remote directory. |
The last usage format allows the sftp client to start in a remote directory. |
.Pp |
.Pp |
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 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 |
|
|
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. |
.Nm |
.Nm |
will abort if any of the following |
will abort if any of the following |
commands fail: |
commands fail: |
.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir |
.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir |
and |
and |
.Ic lmkdir . |
.Ic lmkdir . |
.It Fl C |
.It Fl C |
Enables compression (via ssh's |
Enables compression (via ssh's |
.Fl C |
.Fl C |
flag) |
flag). |
.It Fl o Ar ssh_option |
.It Fl F Ar ssh_config |
Specify an option to be directly passed to |
Specifies an alternative |
|
per-user configuration file for |
|
.Nm ssh . |
|
This option is directly passed to |
.Xr ssh 1 . |
.Xr ssh 1 . |
|
.It Fl o Ar ssh_option |
|
Can be used to pass options to |
|
.Nm ssh |
|
in the format used in the |
|
.Xr ssh 1 |
|
configuration file. This is useful for specifying options |
|
for which there is no separate |
|
.Nm sftp |
|
command-line flag. For example, to specify an alternate |
|
port use: |
|
.Ic sftp -oPort=24 . |
|
.It Fl s Ar 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 |
|
.Nm sshd |
|
does not have an sftp subsystem configured. |
|
.It Fl S Ar program |
|
Name of the |
|
.Ar program |
|
to use for the encrypted connection. |
|
The program must understand |
|
.Xr ssh 1 |
|
options. |
.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. |
.El |
.El |
.Sh INTERACTIVE COMMANDS |
.Sh INTERACTIVE COMMANDS |
Once in interactive mode, |
Once in interactive mode, |
.Nm |
.Nm |
understands a set of commands similar to those of |
understands a set of commands similar to those of |
.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 Ds |
|
.It Ic bye |
|
Quit 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 |
.It Ic lcd Ar path |
Change local directory to |
Change local directory to |
.Ar path . |
.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 |
to |
to |
.Ar grp . |
.Ar grp . |
.Ar grp |
.Ar grp |
must be a numeric GID. |
must be a numeric GID. |
.It Ic chmod Ar mode Ar path |
.It Ic chmod Ar mode Ar path |
Change permissions of file |
Change permissions of file |
.Ar path |
.Ar path |
to |
to |
.Ar mode . |
.Ar mode . |
.It Ic chown Ar own Ar path |
.It Ic chown Ar own Ar path |
Change owner of file |
Change owner of file |
.Ar path |
.Ar path |
to |
to |
.Ar own . |
.Ar own . |
|
|
.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. |
.It Ic help |
.It Ic help |
Display help text. |
Display help text. |
.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 |
or current directory if |
or current directory if |
.Ar path |
.Ar path |
|
|
Create local directory specified by |
Create local directory specified by |
.Ar path . |
.Ar path . |
.It Ic ln Ar oldpath Ar newpath |
.It Ic ln Ar oldpath Ar newpath |
Create a symbolic link from |
Create a symbolic link from |
.Ar oldpath |
.Ar oldpath |
to |
to |
.Ar newpath . |
.Ar newpath . |
|
|
.Ar path |
.Ar path |
is not specified. |
is not specified. |
.It Ic lumask Ar umask |
.It Ic lumask Ar umask |
Set local umask to |
Set local umask to |
.Ar umask . |
.Ar umask . |
.It Ic mkdir Ar path |
.It Ic mkdir Ar path |
Create remote directory specified by |
Create remote directory specified by |
|
|
.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. If the remote path name is not |
specified, it is given the same name it has on the local machine. If the |
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. |
|
|
Delete remote file specified by |
Delete remote file specified by |
.Ar path . |
.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 |
to |
to |
.Ar newpath . |
.Ar newpath . |
.It Ic ! Ar command |
.It Ic ! Ar command |
Execute |
Execute |
.Ar command |
.Ar command |
in local shell. |
in local shell. |
.It Ic ! |
.It Ic ! |