Import of OpenSSH 3.1p1

[gssapi-openssh.git] / openssh / sftp.1

diff --git a/openssh/sftp.1 b/openssh/sftp.1
index 0cc4e2b63b22942a8d112b2aebfad48ab439ff6a..2faaff1341789ba93838ba2ba10b810878995d83 100644 (file)
--- a/openssh/sftp.1
+++ b/openssh/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.26 2001/09/17 20:38:09 stevesk Exp $
+.\" $OpenBSD: sftp.1,v 1.33 2002/02/26 19:06:43 deraadt Exp $

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


@@ -30,11 +30,14 @@
 .Nd Secure file transfer program
 .Sh SYNOPSIS
 .Nm sftp
 .Nd Secure file transfer program
 .Sh SYNOPSIS
 .Nm sftp

-.Op Fl 1Cv
+.Op Fl vC1

 .Op Fl b Ar batchfile
 .Op Fl b Ar batchfile

-.Op Fl F Ar ssh_config

 .Op Fl o Ar ssh_option
 .Op Fl s Ar subsystem | sftp_server
 .Op Fl o Ar ssh_option
 .Op Fl s Ar subsystem | sftp_server

+.Op Fl B Ar buffer_size
+.Op Fl F Ar ssh_config
+.Op Fl P Ar sftp_server path
+.Op Fl R Ar num_requests

 .Op Fl S Ar program
 .Ar host
 .Nm sftp
 .Op Fl S Ar program
 .Ar host
 .Nm sftp


@@ -63,8 +66,6 @@ The last usage format allows the sftp client to start in a remote directory.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds
 .Pp
 The options are as follows:
 .Bl -tag -width Ds

-.It Fl 1
-Specify the use of protocol version 1.

 .It Fl b Ar batchfile
 Batch mode reads a series of commands from an input
 .Ar batchfile
 .It Fl b Ar batchfile
 Batch mode reads a series of commands from an input
 .Ar batchfile


@@ -75,19 +76,10 @@ non-interactive authentication.
 .Nm
 will abort if any of the following
 commands fail:
 .Nm
 will abort if any of the following
 commands fail:

-.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
+.Ic get , put , rename , ln ,
+.Ic rm , mkdir , chdir , lchdir

 and
 .Ic lmkdir .
 and
 .Ic lmkdir .

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


@@ -105,6 +97,33 @@ 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.
 protocol version 1, or when the remote
 .Nm sshd
 does not have an sftp subsystem configured.

+.It Fl v
+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
+the cost of higher memory consumption. The default is 32768 bytes.
+.It Fl C
+Enables compression (via ssh's
+.Fl C
+flag).
+.It Fl F Ar ssh_config
+Specifies an alternative
+per-user configuration file for
+.Nm ssh .
+This option is directly passed to
+.Xr ssh 1 .
+.It Fl P Ar sftp_server path
+Connect directly to a local 
+.Nm sftp-server 
+(rather than via
+.Nm ssh )
+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 
+this may slightly improve file transfer speed but will increase memory
+usage. The default is 16 outstanding requests.

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


@@ -112,8 +131,8 @@ to use for the encrypted connection.
 The program must understand
 .Xr ssh 1
 options.
 The program must understand
 .Xr ssh 1
 options.

-.It Fl v
-Raise logging level. This option is also passed to ssh.
+.It Fl 1
+Specify the use of protocol version 1.

 .El
 .Sh INTERACTIVE COMMANDS
 Once in interactive mode,
 .El
 .Sh INTERACTIVE COMMANDS
 Once in interactive mode,