- markus@cvs.openbsd.org 2002/02/11 16:21:42

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index 6a365a41dc82d8124a22182528b6978f74b27078..059b46d1f0576f2fcec750f684accae0a0944558 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.22 2001/08/14 09:23:02 markus Exp $
+.\" $OpenBSD: sftp.1,v 1.29 2002/02/06 14:22:42 markus Exp $
 .\"
 .\" Copyright (c) 2001 Damien Miller.  All rights reserved.
 .\"
@@ -30,10 +30,15 @@
 .Nd Secure file transfer program
 .Sh SYNOPSIS
 .Nm sftp
-.Op Fl vC
+.Op Fl vC1
 .Op Fl b Ar batchfile
 .Op Fl o Ar ssh_option
-.Op Ar host
+.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 S Ar program
+.Ar host
 .Nm sftp
 .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
 .Nm sftp
@@ -73,15 +78,55 @@ commands fail:
 .Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
 and
 .Ic lmkdir .
+.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 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 o Ar ssh_option
-Specify an option to be directly passed to
+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 v
-Raise logging level. This option is also passed to ssh.
+.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 S Ar program
+Name of the
+.Ar program
+to use for the encrypted connection.
+The program must understand
+.Xr ssh 1
+options.
+.It Fl 1
+Specify the use of protocol version 1.
 .El
 .Sh INTERACTIVE COMMANDS
 Once in interactive mode,