=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/ssh/sftp.1,v retrieving revision 1.36.2.3 retrieving revision 1.37 diff -u -r1.36.2.3 -r1.37 --- src/usr.bin/ssh/sftp.1 2003/09/16 21:20:27 1.36.2.3 +++ src/usr.bin/ssh/sftp.1 2002/12/06 05:20:02 1.37 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sftp.1,v 1.36.2.3 2003/09/16 21:20:27 brad Exp $ +.\" $OpenBSD: sftp.1,v 1.37 2002/12/06 05:20:02 djm Exp $ .\" .\" Copyright (c) 2001 Damien Miller. All rights reserved. .\" @@ -27,10 +27,9 @@ .Os .Sh NAME .Nm sftp -.Nd secure file transfer program +.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 @@ -41,18 +40,10 @@ .Op Fl R Ar num_requests .Op Fl S Ar program .Ar host -.Ek .Nm sftp -.Oo Oo Ar user Ns @ Oc Ns -.Ar host Ns Oo : Ns Ar file Oo -.Ar file Oc Oc Oc +.Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] .Nm sftp -.Oo Oo Ar user Ns @ Oc Ns -.Ar host Ns Oo : Ns Ar dir Ns -.Oo Ar / Oc Oc Oc -.Nm sftp -.Fl b Ar batchfile -.Oo Ar user Ns @ Oc Ns Ar host +.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] .Sh DESCRIPTION .Nm is an interactive file transfer program, similar to @@ -71,17 +62,8 @@ authentication method is used; otherwise it will do so after successful interactive authentication. .Pp -The third usage format allows the sftp client to start in a remote directory. +The last usage format allows the sftp client to start in a remote directory. .Pp -The final usage format allows for automated sessions using the -.Fl b -option. -In such cases, it is usually necessary to configure public key authentication -to obviate the need to enter a password at connection time (see -.Xr sshd 8 -and -.Xr ssh-keygen 1 -for details). The options are as follows: .Bl -tag -width Ds .It Fl b Ar batchfile @@ -95,15 +77,9 @@ will abort if any of the following commands fail: .Ic get , put , rename , ln , -.Ic rm , mkdir , chdir , ls , -.Ic lchdir , chmod , chown , chgrp , lpwd +.Ic rm , mkdir , chdir , lchdir and .Ic lmkdir . -Termination on error can be suppressed on a command by command basis by -prefixing the command with a -.Sq Ic \- -character (for example, -.Ic -rm /tmp/blah* ) . .It Fl o Ar ssh_option Can be used to pass options to .Nm ssh @@ -112,27 +88,22 @@ 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: +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 -.Nm -over protocol version 1, or when the remote -.Xr sshd 8 +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. +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. +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 @@ -140,19 +111,19 @@ .It Fl F Ar ssh_config Specifies an alternative per-user configuration file for -.Xr ssh 1 . +.Nm ssh . This option is directly passed to .Xr ssh 1 . .It Fl P Ar sftp_server path -Connect directly to a local sftp server +Connect directly to a local +.Nm sftp-server (rather than via -.Xr ssh 1 ) +.Nm ssh ) This option may be useful in debugging the client and server. .It Fl R Ar num_requests -Specify how many requests may be outstanding at any one time. -Increasing this may slightly improve file transfer speed -but will increase memory usage. -The default is 16 outstanding requests. +Specify how many requests may be outstanding at any one time. Increasing +this may slightly improve file transfer speed but will increase memory +usage. The default is 16 outstanding requests. .It Fl S Ar program Name of the .Ar program @@ -172,8 +143,7 @@ contain spaces. .Bl -tag -width Ds .It Ic bye -Quit -.Nm sftp . +Quit sftp. .It Ic cd Ar path Change remote directory to .Ar path . @@ -200,8 +170,7 @@ .Ar own must be a numeric UID. .It Ic exit -Quit -.Nm sftp . +Quit sftp. .It Xo Ic get .Op Ar flags .Ar remote-path @@ -212,8 +181,7 @@ and store it on the local machine. If the local path name is not specified, it is given the same name it has on the -remote machine. -If the +remote machine. If the .Fl P flag is specified, then the file's full permission and access time are copied too. @@ -243,8 +211,7 @@ .Ar path or current directory if .Ar path -is not specified. -If the +is not specified. If the .Fl l flag is specified, then display additional details including permissions and ownership information. @@ -254,8 +221,6 @@ .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 @@ -263,18 +228,15 @@ .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 quit -Quit -.Nm sftp . +Quit sftp. .It Ic rename Ar oldpath Ar newpath Rename remote file from .Ar oldpath @@ -291,19 +253,17 @@ .Ar oldpath to .Ar newpath . -.It Ic version -Display the -.Nm -protocol version. -.It Ic \&! Ar command +.It Ic ! Ar command Execute .Ar command in local shell. -.It Ic \&! +.It Ic ! Escape to local shell. -.It Ic \&? +.It Ic ? Synonym for help. .El +.Sh AUTHORS +Damien Miller .Sh SEE ALSO .Xr scp 1 , .Xr ssh 1 ,