- mouring@cvs.openbsd.org 2001/04/12 23:17:54

[openssh.git] / sftp.1

diff --git a/sftp.1 b/sftp.1
index e1c6960f898317e4b77715f70d5935941e33c59a..093ebb91c852d2b1faede43add6c9bca012cd11a 100644 (file)
--- a/sftp.1
+++ b/sftp.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sftp.1,v 1.10 2001/03/06 06:11:44 deraadt Exp $
+.\" $OpenBSD: sftp.1,v 1.15 2001/04/12 23:17:54 mouring 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
@@ -33,7 +33,11 @@
 .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
@@ -48,28 +52,36 @@ connects and logs into the specified
 .Ar hostname ,
 then enters an interactive command mode.
 .Pp
+The second usage format will fetch files automaticly if a non-interactive 
+authentication is used, else it do so after an interactive authenication 
+is used.
+.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 C
-Enables compression (via ssh's 
-.Fl C
-flag)
 .It Fl b Ar batchfile
 Batch mode reads a series of commands from an input
-.Fn batchfile
+.Ar batchfile
 instead of
-.Fn stdin .
-Since it lacks user interaction it should be used in conjuction with a 
-non-interactive authentication.  Sftp will abort if any of the following 
+.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: 
-.Pa get, put, rename, rm, mkdir, chdir, lchdir
+.Ic get , put , rename , ln , rm , mkdir , chdir , lchdir
 and
-.Pa lmkdir.
+.Ic lmkdir .
+.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
 .Xr ssh 1 .
+.It Fl v
+Raise logging level. This option is also passed to ssh.
 .El
 .Sh INTERACTIVE COMMANDS
 Once in interactive mode,
@@ -104,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
@@ -120,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
@@ -129,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
@@ -150,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
@@ -172,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
@@ -185,6 +207,7 @@ Synonym for help.
 Damien Miller <djm@mindrot.org>
 .Sh SEE ALSO
 .Xr ssh 1 ,
+.Xr sftp-server 8 ,
 .Xr ssh-add 1 ,
 .Xr ssh-keygen 1 ,
 .Xr sshd 8 ,