- djm@cvs.openbsd.org 2010/01/30 02:54:53

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index 00253037de60e9309d1d001181c1356f830c209e..dab73f6b3b5a1454419729e4f8236ef8137c0e42 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.47 2003/10/13 08:22:25 markus Exp $
+.\" $OpenBSD: sftp.1,v 1.82 2010/01/13 12:48:34 jmc Exp $

 .\"
 .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
 .\"
 .\"
 .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
 .\"


@@ -22,7 +22,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.Dd February 4, 2001
+.Dd $Mdocdate$

 .Dt SFTP 1
 .Os
 .Sh NAME
 .Dt SFTP 1
 .Os
 .Sh NAME


@@ -31,25 +31,27 @@
 .Sh SYNOPSIS
 .Nm sftp
 .Bk -words
 .Sh SYNOPSIS
 .Nm sftp
 .Bk -words

-.Op Fl 1Cv
+.Op Fl 1246Cpqrv

 .Op Fl B Ar buffer_size
 .Op Fl b Ar batchfile
 .Op Fl B Ar buffer_size
 .Op Fl b Ar batchfile

+.Op Fl c Ar cipher
+.Op Fl D Ar sftp_server_path

 .Op Fl F Ar ssh_config
 .Op Fl F Ar ssh_config

+.Op Fl i Ar identity_file

 .Op Fl o Ar ssh_option
 .Op Fl o Ar ssh_option

-.Op Fl P Ar sftp_server_path
+.Op Fl P Ar port

 .Op Fl R Ar num_requests
 .Op Fl S Ar program
 .Op Fl s Ar subsystem | sftp_server
 .Ar host
 .Ek
 .Nm sftp
 .Op Fl R Ar num_requests
 .Op Fl S Ar program
 .Op Fl s Ar subsystem | sftp_server
 .Ar host
 .Ek
 .Nm sftp

-.Oo Oo Ar user Ns @ Oc Ns
-.Ar host Ns Oo : Ns Ar file Oo
-.Ar file Oc Oc Oc
+.Oo Ar user Ns @ Oc Ns
+.Ar host Ns Op : Ns Ar

 .Nm sftp
 .Nm sftp

-.Oo Oo Ar user Ns @ Oc Ns
+.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
+.Op Ar / Oc

 .Nm sftp
 .Fl b Ar batchfile
 .Oo Ar user Ns @ Oc Ns Ar host
 .Nm sftp
 .Fl b Ar batchfile
 .Oo Ar user Ns @ Oc Ns Ar host


@@ -71,12 +73,14 @@ The second usage format will retrieve files automatically if a non-interactive
 authentication method is used; otherwise it will do so after
 successful interactive authentication.
 .Pp
 authentication method is used; otherwise it will do so after
 successful interactive authentication.
 .Pp

-The third usage format allows the sftp client to start in a remote directory.
+The third usage format allows
+.Nm
+to start in a remote directory.

 .Pp
 The final usage format allows for automated sessions using the
 .Fl b
 option.
 .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
+In such cases, it is necessary to configure non-interactive authentication

 to obviate the need to enter a password at connection time (see
 .Xr sshd 8
 and
 to obviate the need to enter a password at connection time (see
 .Xr sshd 8
 and


@@ -86,6 +90,16 @@ The options are as follows:
 .Bl -tag -width Ds
 .It Fl 1
 Specify the use of protocol version 1.
 .Bl -tag -width Ds
 .It Fl 1
 Specify the use of protocol version 1.

+.It Fl 2
+Specify the use of protocol version 2.
+.It Fl 4
+Forces
+.Nm
+to use IPv4 addresses only.
+.It Fl 6
+Forces
+.Nm
+to use IPv6 addresses only.

 .It Fl B Ar buffer_size
 Specify the size of the buffer that
 .Nm
 .It Fl B Ar buffer_size
 Specify the size of the buffer that
 .Nm


@@ -100,29 +114,49 @@ instead of
 .Em stdin .
 Since it lacks user interaction it should be used in conjunction with
 non-interactive authentication.
 .Em stdin .
 Since it lacks user interaction it should be used in conjunction with
 non-interactive authentication.

+A
+.Ar batchfile
+of
+.Sq \-
+may be used to indicate standard input.

 .Nm
 will abort if any of the following
 commands fail:
 .Ic get , put , rename , ln ,
 .Ic rm , mkdir , chdir , ls ,
 .Nm
 will abort if any of the following
 commands fail:
 .Ic get , put , rename , ln ,
 .Ic rm , mkdir , chdir , ls ,

-.Ic lchdir , chmod , chown , chgrp , lpwd
+.Ic lchdir , chmod , chown ,
+.Ic chgrp , lpwd , df ,

 and
 .Ic lmkdir .
 Termination on error can be suppressed on a command by command basis by
 prefixing the command with a
 and
 .Ic lmkdir .
 Termination on error can be suppressed on a command by command basis by
 prefixing the command with a

-.Sq Ic \-
+.Sq \-

 character (for example,
 .Ic -rm /tmp/blah* ) .
 .It Fl C
 Enables compression (via ssh's
 .Fl C
 flag).
 character (for example,
 .Ic -rm /tmp/blah* ) .
 .It Fl C
 Enables compression (via ssh's
 .Fl C
 flag).

+.It Fl c Ar cipher
+Selects the cipher to use for encrypting the data transfers.
+This option is directly passed to
+.Xr ssh 1 .
+.It Fl D Ar sftp_server_path
+Connect directly to a local sftp server
+(rather than via
+.Xr ssh 1 ) .
+This option may be useful in debugging the client and server.

 .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 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 i Ar identity_file
+Selects the file from which the identity (private key) for public key
+authentication is read.
+This option is directly passed to
+.Xr ssh 1 .

 .It Fl o Ar ssh_option
 Can be used to pass options to
 .Nm ssh
 .It Fl o Ar ssh_option
 Can be used to pass options to
 .Nm ssh


@@ -148,17 +182,21 @@ For full details of the options listed below, and their possible values, see
 .It Compression
 .It CompressionLevel
 .It ConnectionAttempts
 .It Compression
 .It CompressionLevel
 .It ConnectionAttempts

-.It ConnectionTimeout
+.It ConnectTimeout
+.It ControlMaster
+.It ControlPath

 .It GlobalKnownHostsFile
 .It GSSAPIAuthentication
 .It GSSAPIDelegateCredentials
 .It GlobalKnownHostsFile
 .It GSSAPIAuthentication
 .It GSSAPIDelegateCredentials

+.It HashKnownHosts

 .It Host
 .It HostbasedAuthentication
 .It HostKeyAlgorithms
 .It HostKeyAlias
 .It HostName
 .It IdentityFile
 .It Host
 .It HostbasedAuthentication
 .It HostKeyAlgorithms
 .It HostKeyAlias
 .It HostName
 .It IdentityFile

-.It KeepAlive
+.It IdentitiesOnly
+.It KbdInteractiveDevices

 .It LogLevel
 .It MACs
 .It NoHostAuthenticationForLocalhost
 .It LogLevel
 .It MACs
 .It NoHostAuthenticationForLocalhost


@@ -169,25 +207,39 @@ For full details of the options listed below, and their possible values, see
 .It Protocol
 .It ProxyCommand
 .It PubkeyAuthentication
 .It Protocol
 .It ProxyCommand
 .It PubkeyAuthentication

+.It RekeyLimit

 .It RhostsRSAAuthentication
 .It RSAAuthentication
 .It RhostsRSAAuthentication
 .It RSAAuthentication

+.It SendEnv
+.It ServerAliveInterval
+.It ServerAliveCountMax

 .It SmartcardDevice
 .It StrictHostKeyChecking
 .It SmartcardDevice
 .It StrictHostKeyChecking

+.It TCPKeepAlive

 .It UsePrivilegedPort
 .It User
 .It UserKnownHostsFile
 .It VerifyHostKeyDNS
 .El
 .It UsePrivilegedPort
 .It User
 .It UserKnownHostsFile
 .It VerifyHostKeyDNS
 .El

-.It Fl P Ar sftp_server_path
-Connect directly to a local sftp server
-(rather than via
-.Xr ssh 1 )
-This option may be useful in debugging the client and server.
+.It Fl P Ar port
+Specifies the port to connect to on the remote host.
+.It Fl p
+Preserves modification times, access times, and modes from the
+original files transferred.
+.It Fl q
+Quiet mode: disables the progress meter as well as warning and
+diagnostic messages from
+.Xr ssh 1 .

 .It Fl R Ar num_requests
 Specify how many requests may be outstanding at any one time.
 Increasing this may slightly improve file transfer speed
 but will increase memory usage.
 .It Fl R Ar num_requests
 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 16 outstanding requests.
+The default is 64 outstanding requests.
+.It Fl r
+Recursively copy entire directories when uploading and downloading.
+Note that
+.Nm
+does not follow symbolic links encountered in the tree traversal.

 .It Fl S Ar program
 Name of the
 .Ar program
 .It Fl S Ar program
 Name of the
 .Ar program


@@ -212,9 +264,13 @@ Once in interactive mode,
 .Nm
 understands a set of commands similar to those of
 .Xr ftp 1 .
 .Nm
 understands a set of commands similar to those of
 .Xr ftp 1 .

-Commands are case insensitive and pathnames may be enclosed in quotes if they
-contain spaces.
-.Bl -tag -width "lmdir path"
+Commands are case insensitive.
+Pathnames that contain spaces must be enclosed in quotes.
+Any special characters contained within pathnames that are recognized by
+.Xr glob 3
+must be escaped with backslashes
+.Pq Sq \e .
+.Bl -tag -width Ds

 .It Ic bye
 Quit
 .Nm sftp .
 .It Ic bye
 Quit
 .Nm sftp .


@@ -226,6 +282,10 @@ Change group of file
 .Ar path
 to
 .Ar grp .
 .Ar path
 to
 .Ar grp .

+.Ar path
+may contain
+.Xr glob 3
+characters and may match multiple files.

 .Ar grp
 must be a numeric GID.
 .It Ic chmod Ar mode Ar path
 .Ar grp
 must be a numeric GID.
 .It Ic chmod Ar mode Ar path


@@ -233,18 +293,44 @@ Change permissions of file
 .Ar path
 to
 .Ar mode .
 .Ar path
 to
 .Ar mode .

+.Ar path
+may contain
+.Xr glob 3
+characters and may match multiple files.

 .It Ic chown Ar own Ar path
 Change owner of file
 .Ar path
 to
 .Ar own .
 .It Ic chown Ar own Ar path
 Change owner of file
 .Ar path
 to
 .Ar own .

+.Ar path
+may contain
+.Xr glob 3
+characters and may match multiple files.

 .Ar own
 must be a numeric UID.
 .Ar own
 must be a numeric UID.

+.It Xo Ic df
+.Op Fl hi
+.Op Ar path
+.Xc
+Display usage information for the filesystem holding the current directory
+(or
+.Ar path
+if specified).
+If the
+.Fl h
+flag is specified, the capacity information will be displayed using
+"human-readable" suffixes.
+The
+.Fl i
+flag requests display of inode information in addition to capacity information.
+This command is only supported on servers that implement the
+.Dq statvfs@openssh.com
+extension.

 .It Ic exit
 Quit
 .Nm sftp .
 .It Xo Ic get
 .It Ic exit
 Quit
 .Nm sftp .
 .It Xo Ic get

-.Op Ar flags
+.Op Fl Ppr

 .Ar remote-path
 .Op Ar local-path
 .Xc
 .Ar remote-path
 .Op Ar local-path
 .Xc


@@ -254,10 +340,29 @@ 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 local
 path name is not specified, it is given the same name it has on the
 remote machine.

-If the
+.Ar remote-path
+may contain
+.Xr glob 3
+characters and may match multiple files.
+If it does and
+.Ar local-path
+is specified, then
+.Ar local-path
+must specify a directory.
+.Pp
+If either the

 .Fl P
 .Fl P

-flag is specified, then the file's full permission and access time are
+or
+.Fl p
+flag is specified, then full file permissions and access times are

 copied too.
 copied too.

+.Pp
+If the
+.Fl r
+flag is specified then directories will be copied recursively.
+Note that
+.Nm
+does not follow symbolic links when performing recursive transfers.

 .It Ic help
 Display help text.
 .It Ic lcd Ar path
 .It Ic help
 Display help text.
 .It Ic lcd Ar path


@@ -269,6 +374,14 @@ Display local directory listing of either
 or current directory if
 .Ar path
 is not specified.
 or current directory if
 .Ar path
 is not specified.

+.Ar ls-options
+may contain any flags supported by the local system's
+.Xr ls 1
+command.
+.Ar path
+may contain
+.Xr glob 3
+characters and may match multiple files.

 .It Ic lmkdir Ar path
 Create local directory specified by
 .Ar path .
 .It Ic lmkdir Ar path
 Create local directory specified by
 .Ar path .


@@ -280,18 +393,49 @@ to
 .It Ic lpwd
 Print local working directory.
 .It Xo Ic ls
 .It Ic lpwd
 Print local working directory.
 .It Xo Ic ls

-.Op Ar flags
+.Op Fl 1afhlnrSt

 .Op Ar path
 .Xc
 .Op Ar path
 .Xc

-Display remote directory listing of either
+Display a remote directory listing of either

 .Ar path
 .Ar path

-or current directory if
+or the current directory if

 .Ar path
 is not specified.
 .Ar path
 is not specified.

-If the
-.Fl l
-flag is specified, then display additional details including permissions
+.Ar path
+may contain
+.Xr glob 3
+characters and may match multiple files.
+.Pp
+The following flags are recognized and alter the behaviour of
+.Ic ls
+accordingly:
+.Bl -tag -width Ds
+.It Fl 1
+Produce single columnar output.
+.It Fl a
+List files beginning with a dot
+.Pq Sq \&. .
+.It Fl f
+Do not sort the listing.
+The default sort order is lexicographical.
+.It Fl h
+When used with a long format option, use unit suffixes: Byte, Kilobyte,
+Megabyte, Gigabyte, Terabyte, Petabyte, and Exabyte in order to reduce
+the number of digits to four or fewer using powers of 2 for sizes (K=1024,
+M=1048576, etc.).
+.It Fl l
+Display additional details including permissions

 and ownership information.
 and ownership information.

+.It Fl n
+Produce a long listing with user and group information presented
+numerically.
+.It Fl r
+Reverse the sort order of the listing.
+.It Fl S
+Sort the listing by file size.
+.It Fl t
+Sort the listing by last modification time.
+.El

 .It Ic lumask Ar umask
 Set local umask to
 .Ar umask .
 .It Ic lumask Ar umask
 Set local umask to
 .Ar umask .


@@ -301,7 +445,7 @@ Create remote directory specified by
 .It Ic progress
 Toggle display of progress meter.
 .It Xo Ic put
 .It Ic progress
 Toggle display of progress meter.
 .It Xo Ic put

-.Op Ar flags
+.Op Fl Ppr

 .Ar local-path
 .Op Ar remote-path
 .Xc
 .Ar local-path
 .Op Ar remote-path
 .Xc


@@ -310,10 +454,29 @@ Upload
 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.
 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
+.Ar local-path
+may contain
+.Xr glob 3
+characters and may match multiple files.
+If it does and
+.Ar remote-path
+is specified, then
+.Ar remote-path
+must specify a directory.
+.Pp
+If ether the

 .Fl P
 .Fl P

-flag is specified, then the file's full permission and access time are
+or
+.Fl p
+flag is specified, then full file permissions and access times are

 copied too.
 copied too.

+.Pp
+If the
+.Fl r
+flag is specified then directories will be copied recursively.
+Note that
+.Nm
+does not follow symbolic links when performing recursive transfers.

 .It Ic pwd
 Display remote working directory.
 .It Ic quit
 .It Ic pwd
 Display remote working directory.
 .It Ic quit


@@ -339,7 +502,7 @@ to
 Display the
 .Nm
 protocol version.
 Display the
 .Nm
 protocol version.

-.It Ic \&! Ar command
+.It Ic \&! Ns Ar command

 Execute
 .Ar command
 in local shell.
 Execute
 .Ar command
 in local shell.


@@ -350,10 +513,12 @@ Synonym for help.
 .El
 .Sh SEE ALSO
 .Xr ftp 1 ,
 .El
 .Sh SEE ALSO
 .Xr ftp 1 ,

+.Xr ls 1 ,

 .Xr scp 1 ,
 .Xr ssh 1 ,
 .Xr ssh-add 1 ,
 .Xr ssh-keygen 1 ,
 .Xr scp 1 ,
 .Xr ssh 1 ,
 .Xr ssh-add 1 ,
 .Xr ssh-keygen 1 ,

+.Xr glob 3 ,

 .Xr ssh_config 5 ,
 .Xr sftp-server 8 ,
 .Xr sshd 8
 .Xr ssh_config 5 ,
 .Xr sftp-server 8 ,
 .Xr sshd 8