src/usr.bin/ssh/sftp.1 - diff

Return to sftp.1 CVS log

Up to [local] / src / usr.bin / ssh

Diff for /src/usr.bin/ssh/sftp.1 between version 1.36 and 1.36.2.3

version 1.36, 2002/09/11 22:41:50

version 1.36.2.3, 2003/09/16 21:20:27

Line 27

.Os

.Sh NAME

.Nm sftp

.Nd Secure file transfer program

.Nd secure file transfer program

.Sh SYNOPSIS

.Nm sftp

.Bk -words

.Op Fl vC1

.Op Fl b Ar batchfile

.Op Fl o Ar ssh_option

Line 40

Line 41

.Op Fl R Ar num_requests

.Op Fl S Ar program

.Ar host

.Ek

.Nm sftp

.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]

.Oo Oo Ar user Ns @ Oc Ns

.Ar host Ns Oo : Ns Ar file Oo

.Ar file Oc Oc Oc

.Nm sftp

.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]]

.Oo Oo Ar user Ns @ Oc Ns

.Ar host Ns Oo : Ns Ar dir Ns

.Oo Ar / Oc Oc Oc

.Nm sftp

.Fl b Ar batchfile

.Oo Ar user Ns @ Oc Ns Ar host

.Sh DESCRIPTION

.Nm

is an interactive file transfer program, similar to

Line 62

Line 71

authentication method is used; otherwise it will do so after

successful interactive authentication.

.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

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:

.Bl -tag -width Ds

.It Fl b Ar batchfile

Line 77

Line 95

will abort if any of the following

commands fail:

.Ic get , put , rename , ln ,

.Ic rm , mkdir , chdir , lchdir

.Ic rm , mkdir , chdir , ls ,

.Ic lchdir , chmod , chown , chgrp , lpwd

and

.Ic lmkdir .

Termination on error can be suppressed on a command by command basis by

prefixing the command with a

.Sq Ic \-

character (for example,

.Ic -rm /tmp/blah* ) .

.It Fl o Ar ssh_option

Can be used to pass options to

.Nm ssh

Line 88

Line 112

This is useful for specifying options

for which there is no separate

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

.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

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.

.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

Specify the size of the buffer that

.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

Enables compression (via ssh's

.Fl C

Line 111

Line 140

.It Fl F Ar ssh_config

Specifies an alternative

per-user configuration file for

.Nm ssh .

.Xr ssh 1 .

This option is directly passed to

.Xr ssh 1 .

.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

.Nm ssh )

.Xr ssh 1 )

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

.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

Name of the

.Ar program

Line 143

Line 172

contain spaces.

.Bl -tag -width Ds

.It Ic bye

Quit sftp.

Quit

.Nm sftp .

.It Ic cd Ar path

Change remote directory to

.Ar path .

Line 170

Line 200

.Ar own

must be a numeric UID.

.It Ic exit

Quit sftp.

Quit

.Nm sftp .

.It Xo Ic get

.Op Ar flags

.Ar remote-path

Line 181

Line 212

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. If the

remote machine.

If the

.Fl P

flag is specified, then the file's full permission and access time are

copied too.

Line 211

Line 243

.Ar path

or current directory if

.Ar path

is not specified. If the

is not specified.

If the

.Fl l

flag is specified, then display additional details including permissions

and ownership information.

Line 221

Line 254

.It Ic mkdir Ar path

Create remote directory specified by

.Ar path .

.It Ic progress

Toggle display of progress meter.

.It Xo Ic put

.Op Ar flags

.Ar local-path

.Op Ar local-path

.Op Ar remote-path

.Xc

Upload

.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

flag is specified, then the file's full permission and access time are

copied too.

.It Ic pwd

Display remote working directory.

.It Ic quit

Quit sftp.

Quit

.Nm sftp .

.It Ic rename Ar oldpath Ar newpath

Rename remote file from

.Ar oldpath

Line 253

Line 291

.Ar oldpath

.Ar newpath .

.It Ic ! Ar command

.It Ic version

Display the

.Nm

protocol version.

.It Ic \&! Ar command

Execute

.Ar command

in local shell.

.It Ic !

.It Ic \&!

Escape to local shell.

.It Ic ?

.It Ic \&?

Synonym for help.

.El

.Sh AUTHORS

Damien Miller <djm@mindrot.org>

.Sh SEE ALSO

.Xr scp 1 ,

.Xr ssh 1 ,