[sftp.1]
     Document sftp upload resume.
     OK from djm@, with feedback from okan@.
This commit is contained in:
Damien Miller 2014-05-15 13:47:15 +10:00
parent b15cd7bb09
commit d875ff78d2
2 changed files with 33 additions and 8 deletions

View File

@ -15,6 +15,10 @@
[sftp.c] [sftp.c]
Sort the sftp command list. Sort the sftp command list.
OK from djm@ OK from djm@
- logan@cvs.openbsd.org 2014/04/22 12:42:04
[sftp.1]
Document sftp upload resume.
OK from djm@, with feedback from okan@.
20140430 20140430
- (dtucker) [defines.h] Define __GNUC_PREREQ__ macro if we don't already - (dtucker) [defines.h] Define __GNUC_PREREQ__ macro if we don't already

37
sftp.1
View File

@ -1,4 +1,4 @@
.\" $OpenBSD: sftp.1,v 1.97 2013/10/20 09:51:26 djm Exp $ .\" $OpenBSD: sftp.1,v 1.98 2014/04/22 12:42:04 logan 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 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\" .\"
.Dd $Mdocdate: October 20 2013 $ .Dd $Mdocdate: April 22 2014 $
.Dt SFTP 1 .Dt SFTP 1
.Os .Os
.Sh NAME .Sh NAME
@ -108,10 +108,10 @@ Forces
.Nm .Nm
to use IPv6 addresses only. to use IPv6 addresses only.
.It Fl a .It Fl a
Attempt to continue interrupted downloads rather than overwriting existing Attempt to continue interrupted transfers rather than overwriting
partial or complete copies of files. existing partial or complete copies of files.
If the remote file contents differ from the partial local copy then the If the partial contents differ from those being transferred,
resultant file is likely to be corrupt. then the resultant file is likely to be corrupt.
.It Fl B Ar buffer_size .It Fl B Ar buffer_size
Specify the size of the buffer that Specify the size of the buffer that
.Nm .Nm
@ -134,7 +134,7 @@ may be used to indicate standard input.
.Nm .Nm
will abort if any of the following will abort if any of the following
commands fail: commands fail:
.Ic get , put , reget , rename , ln , .Ic get , put , reget , reput, rename , ln ,
.Ic rm , mkdir , chdir , ls , .Ic rm , mkdir , chdir , ls ,
.Ic lchdir , chmod , chown , .Ic lchdir , chmod , chown ,
.Ic chgrp , lpwd , df , symlink , .Ic chgrp , lpwd , df , symlink ,
@ -495,7 +495,7 @@ Create remote directory specified by
.It Ic progress .It Ic progress
Toggle display of progress meter. Toggle display of progress meter.
.It Xo Ic put .It Xo Ic put
.Op Fl fPpr .Op Fl afPpr
.Ar local-path .Ar local-path
.Op Ar remote-path .Op Ar remote-path
.Xc .Xc
@ -515,6 +515,15 @@ is specified, then
must specify a directory. must specify a directory.
.Pp .Pp
If the If the
.Fl a
flag is specified, then attempt to resume partial
transfers of existing files.
Note that resumption assumes that any partial copy of the remote file
matches the local copy.
If the local file contents differ from the remote local copy then
the resultant file is likely to be corrupt.
.Pp
If the
.Fl f .Fl f
flag is specified, then a request will be sent to the server to call flag is specified, then a request will be sent to the server to call
.Xr fsync 2 .Xr fsync 2
@ -552,6 +561,18 @@ Equivalent to
with the with the
.Fl a .Fl a
flag set. flag set.
.It Xo Ic reput
.Op Fl Ppr
.Op Ar local-path
.Ar remote-path
.Xc
Resume upload of
.Op Ar local-path .
Equivalent to
.Ic put
with the
.Fl a
flag set.
.It Ic rename Ar oldpath Ar newpath .It Ic rename Ar oldpath Ar newpath
Rename remote file from Rename remote file from
.Ar oldpath .Ar oldpath