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

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index 244a9b25680a1602e5b8e04706739b9575b8712b..dab73f6b3b5a1454419729e4f8236ef8137c0e42 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.70 2009/08/12 00:13:00 djm 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.
 .\"


@@ -31,14 +31,15 @@
 .Sh SYNOPSIS
 .Nm sftp
 .Bk -words
 .Sh SYNOPSIS
 .Nm sftp
 .Bk -words

-.Op Fl 1246Cqv
+.Op Fl 1246Cpqrv

 .Op Fl B Ar buffer_size
 .Op Fl b Ar batchfile
 .Op Fl c Ar cipher
 .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_path
+.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
 .Op Fl R Ar num_requests
 .Op Fl S Ar program
 .Op Fl s Ar subsystem | sftp_server


@@ -132,14 +133,19 @@ prefixing the command with a
 .Sq \-
 character (for example,
 .Ic -rm /tmp/blah* ) .
 .Sq \-
 character (for example,
 .Ic -rm /tmp/blah* ) .

-.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 C
 Enables compression (via ssh's
 .Fl C
 flag).
 .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
 .It Fl F Ar ssh_config
 Specifies an alternative
 per-user configuration file for


@@ -215,11 +221,11 @@ For full details of the options listed below, and their possible values, see
 .It UserKnownHostsFile
 .It VerifyHostKeyDNS
 .El
 .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
 .It Fl q
 Quiet mode: disables the progress meter as well as warning and
 diagnostic messages from


@@ -229,6 +235,11 @@ 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 64 outstanding requests.
 Increasing this may slightly improve file transfer speed
 but will increase memory usage.
 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


@@ -319,7 +330,7 @@ extension.
 Quit
 .Nm sftp .
 .It Xo Ic get
 Quit
 .Nm sftp .
 .It Xo Ic get

-.Op Fl P
+.Op Fl Ppr

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


@@ -338,10 +349,20 @@ If it does and
 is specified, then
 .Ar local-path
 must specify a directory.
 is specified, then
 .Ar local-path
 must specify a directory.

-If the
+.Pp
+If either the

 .Fl P
 .Fl P

+or
+.Fl p

 flag is specified, then full file permissions and access times are
 copied too.
 flag is specified, then full file permissions and access times are
 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


@@ -372,7 +393,7 @@ to
 .It Ic lpwd
 Print local working directory.
 .It Xo Ic ls
 .It Ic lpwd
 Print local working directory.
 .It Xo Ic ls

-.Op Fl 1aflnrSt
+.Op Fl 1afhlnrSt

 .Op Ar path
 .Xc
 Display a remote directory listing of either
 .Op Ar path
 .Xc
 Display a remote directory listing of either


@@ -397,6 +418,11 @@ List files beginning with a dot
 .It Fl f
 Do not sort the listing.
 The default sort order is lexicographical.
 .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.
 .It Fl l
 Display additional details including permissions
 and ownership information.


@@ -419,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 Fl P
+.Op Fl Ppr

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


@@ -437,10 +463,20 @@ If it does and
 is specified, then
 .Ar remote-path
 must specify a directory.
 is specified, then
 .Ar remote-path
 must specify a directory.

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