- deraadt@cvs.openbsd.org 2001/06/23 05:57:09

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index 22915133b1640bc2af34c01ed474dd9e1bbd0fdc..6d896308724af107df9fe80efaeab35f237348a6 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.9 2001/03/02 18:54:31 deraadt Exp $
+.\" $OpenBSD: sftp.1,v 1.20 2001/06/23 05:57:08 deraadt Exp $
 .\"
 .\" 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
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd Febuary 4, 2001
+.Dd February 4, 2001
 .Dt SFTP 1
 .Os
 .Sh NAME
@@ -31,8 +31,13 @@
 .Sh SYNOPSIS
 .Nm sftp
 .Op Fl vC
+.Op Fl b Ar batchfile
 .Op Fl o Ar ssh_option
-.Op Ar hostname | user@hostname
+.Op Ar host
+.Nm sftp
+.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]]
+.Nm sftp
+.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] 
 .Sh DESCRIPTION
 .Nm
 is an interactive file transfer program, similar to
@@ -44,13 +49,30 @@ It may also use many features of ssh, such as public key authentication and
 compression.
 .Nm
 connects and logs into the specified
-.Ar hostname ,
+.Ar host ,
 then enters an interactive command mode.
 .Pp
+The second usage format will retrieve files automatically if a non-interactive 
+authentication method is used; otherwise it will do so after
+successful interactive authentication.
+.Pp
+The last usage format allows the sftp client to start in a remote directory.
+.Pp
 The options are as follows:
 .Bl -tag -width Ds
-.It Fl v
-Raise logging level. This option is also passed to ssh.
+.It Fl b Ar batchfile
+Batch mode reads a series of commands from an input
+.Ar batchfile
+instead of
+.Em stdin .
+Since it lacks user interaction it should be used in conjunction with
+non-interactive authentication.
+.Nm
+will abort if any of the following 
+commands fail: 
+.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
+and
+.Ic lmkdir .
 .It Fl C
 Enables compression (via ssh's 
 .Fl C
@@ -58,6 +80,8 @@ flag)
 .It Fl o Ar ssh_option
 Specify an option to be directly passed to
 .Xr ssh 1 .
+.It Fl v
+Raise logging level. This option is also passed to ssh.
 .El
 .Sh INTERACTIVE COMMANDS
 Once in interactive mode,
@@ -92,8 +116,8 @@ to
 .Ar own .
 .Ar own
 must be a numeric UID.
-.It Ic help
-Display help text.
+.It Ic exit
+Quit sftp.
 .It Xo Ic get
 .Op Ar flags
 .Ar remote-path
@@ -108,6 +132,8 @@ remote machine. If the
 .Fl P
 flag is specified, then the file's full permission and access time are
 copied too.
+.It Ic help
+Display help text.
 .It Ic lls Op Ar ls-options Op Ar path
 Display local directory listing of either 
 .Ar path
@@ -117,6 +143,11 @@ is not specified.
 .It Ic lmkdir Ar path
 Create local directory specified by
 .Ar path .
+.It Ic ln Ar oldpath Ar newpath
+Create a symbolic link from 
+.Ar oldpath
+to
+.Ar newpath .
 .It Ic lpwd
 Print local working directory.
 .It Ic ls Op Ar path
@@ -138,15 +169,13 @@ Create remote directory specified by
 .Xc
 Upload
 .Ar local-path
-and store it on the remote machine. If the remote path name is not specified, 
-it is given the same name it has on the local machine. If the 
+and store it on the remote machine. If the remote path name is not 
+specified, it is given the same name it has on the local machine. If the 
 .Fl P
 flag is specified, then the file's full permission and access time are
 copied too.
 .It Ic pwd
 Display remote working directory.
-.It Ic exit
-Quit sftp.
 .It Ic quit
 Quit sftp.
 .It Ic rename Ar oldpath Ar newpath
@@ -160,6 +189,11 @@ Remove remote directory specified by
 .It Ic rm Ar path
 Delete remote file specified by
 .Ar path .
+.It Ic symlink Ar oldpath Ar newpath
+Create a symbolic link from 
+.Ar oldpath
+to
+.Ar newpath .
 .It Ic ! Ar command
 Execute 
 .Ar command
@@ -172,9 +206,17 @@ Synonym for help.
 .Sh AUTHORS
 Damien Miller <djm@mindrot.org>
 .Sh SEE ALSO
+.Xr scp 1 ,
 .Xr ssh 1 ,
 .Xr ssh-add 1 ,
 .Xr ssh-keygen 1 ,
-.Xr sshd 8 ,
-.Xr scp 1
-
+.Xr sftp-server 8 ,
+.Xr sshd 8
+.Rs
+.%A T. Ylonen
+.%A S. Lehtinen
+.%T "SSH File Transfer Protocol"
+.%N draft-ietf-secsh-filexfer-00.txt
+.%D January 2001
+.%O work in progress material
+.Re