- markus@cvs.openbsd.org 2003/05/11 20:30:25

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index 60d46b1c2e3083f00f8f6237eebffb56e929ba89..02d2c274bb3611951f53283d3afb0e7c39e352fe 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.38 2003/01/07 23:42:54 fgsch Exp $
+.\" $OpenBSD: sftp.1,v 1.41 2003/03/28 10:11:43 jmc Exp $

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


@@ -30,6 +30,7 @@
 .Nd Secure file transfer program
 .Sh SYNOPSIS
 .Nm sftp
 .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
 .Op Fl vC1
 .Op Fl b Ar batchfile
 .Op Fl o Ar ssh_option


@@ -40,10 +41,15 @@
 .Op Fl R Ar num_requests
 .Op Fl S Ar program
 .Ar host
 .Op Fl R Ar num_requests
 .Op Fl S Ar program
 .Ar host

+.Ek

 .Nm sftp
 .Nm sftp

-.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
+.Oo Oo Ar user Ns No @ Oc Ns
+.Ar host Ns Oo : Ns Ar file Oo
+.Ar file Oc Oc Oc

 .Nm sftp
 .Nm sftp

-.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]]
+.Oo Oo Ar user Ns No @ Oc Ns
+.Ar host Ns Oo : Ns Ar dir Ns
+.Oo Ar / Oc Oc Oc

 .Sh DESCRIPTION
 .Nm
 is an interactive file transfer program, similar to
 .Sh DESCRIPTION
 .Nm
 is an interactive file transfer program, similar to


@@ -77,9 +83,16 @@ non-interactive authentication.
 will abort if any of the following
 commands fail:
 .Ic get , put , rename , ln ,
 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 .
 and
 .Ic lmkdir .

+Termination on error can be suppressed on a command by command basis by
+prefixing the command with a
+.Ic '-'
+character (For example,
+.Ic -rm /tmp/blah*
+).

 .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


@@ -88,19 +101,19 @@ in the format used in
 This is useful for specifying options
 for which there is no separate
 .Nm sftp
 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. 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
 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. 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
 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
+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.
 .Nm
 uses when transferring files. Larger buffers require fewer round trips at
 the cost of higher memory consumption. The default is 32768 bytes.


@@ -221,6 +234,8 @@ Set local umask to
 .It Ic mkdir Ar path
 Create remote directory specified by
 .Ar path .
 .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
 .It Xo Ic put
 .Op Ar flags
 .Ar local-path