=================================================================== RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/ssh/sftp.1,v retrieving revision 1.7.2.4 retrieving revision 1.7.2.5 diff -u -r1.7.2.4 -r1.7.2.5 --- src/usr.bin/ssh/sftp.1 2001/05/07 21:09:35 1.7.2.4 +++ src/usr.bin/ssh/sftp.1 2001/09/27 00:15:42 1.7.2.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sftp.1,v 1.7.2.4 2001/05/07 21:09:35 jason Exp $ +.\" $OpenBSD: sftp.1,v 1.7.2.5 2001/09/27 00:15:42 miod Exp $ .\" .\" Copyright (c) 2001 Damien Miller. All rights reserved. .\" @@ -30,14 +30,17 @@ .Nd Secure file transfer program .Sh SYNOPSIS .Nm sftp -.Op Fl vC +.Op Fl 1Cv .Op Fl b Ar batchfile +.Op Fl F Ar ssh_config .Op Fl o Ar ssh_option -.Op Ar host +.Op Fl s Ar subsystem | sftp_server +.Op Fl S Ar program +.Ar host .Nm sftp .Op [\fIuser\fR@]\fIhost\fR[:\fIfile\fR [\fIfile\fR]] .Nm sftp -.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] +.Op [\fIuser\fR@]\fIhost\fR[:\fIdir\fR[\fI/\fR]] .Sh DESCRIPTION .Nm is an interactive file transfer program, similar to @@ -49,17 +52,19 @@ compression. .Nm connects and logs into the specified -.Ar hostname , +.Ar host , 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 authentication -is used. +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 1 +Specify the use of protocol version 1. .It Fl b Ar batchfile Batch mode reads a series of commands from an input .Ar batchfile @@ -68,49 +73,78 @@ 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: +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 +Enables compression (via ssh's .Fl C -flag) -.It Fl o Ar ssh_option -Specify an option to be directly passed to +flag). +.It Fl F Ar ssh_config +Specifies an alternative +per-user configuration file for +.Nm ssh . +This option is directly passed to .Xr ssh 1 . +.It Fl o Ar ssh_option +Can be used to pass options to +.Nm ssh +in the format used in the +.Xr ssh 1 +configuration file. 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: +.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 +protocol version 1, or when the remote +.Nm sshd +does not have an sftp subsystem configured. +.It Fl S Ar program +Name of the +.Ar program +to use for the encrypted connection. +The program must understand +.Xr ssh 1 +options. .It Fl v Raise logging level. This option is also passed to ssh. .El .Sh INTERACTIVE COMMANDS Once in interactive mode, .Nm -understands a set of commands similar to those of +understands a set of commands similar to those of .Xr ftp 1 . Commands are case insensitive and pathnames may be enclosed in quotes if they contain spaces. .Bl -tag -width Ds +.It Ic bye +Quit sftp. .It Ic cd Ar path -Change remote directory to +Change remote directory to .Ar path . .It Ic lcd Ar path -Change local directory to +Change local directory to .Ar path . .It Ic chgrp Ar grp Ar path -Change group of file +Change group of file .Ar path to .Ar grp . .Ar grp must be a numeric GID. .It Ic chmod Ar mode Ar path -Change permissions of file +Change permissions of file .Ar path to .Ar mode . .It Ic chown Ar own Ar path -Change owner of file +Change owner of file .Ar path to .Ar own . @@ -127,15 +161,15 @@ .Ar remote-path 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 +path name is not specified, it is given the same name it has on the +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 +Display local directory listing of either .Ar path or current directory if .Ar path @@ -144,7 +178,7 @@ Create local directory specified by .Ar path . .It Ic ln Ar oldpath Ar newpath -Create a symbolic link from +Create a symbolic link from .Ar oldpath to .Ar newpath . @@ -157,7 +191,7 @@ .Ar path is not specified. .It Ic lumask Ar umask -Set local umask to +Set local umask to .Ar umask . .It Ic mkdir Ar path Create remote directory specified by @@ -169,8 +203,8 @@ .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. @@ -190,12 +224,12 @@ Delete remote file specified by .Ar path . .It Ic symlink Ar oldpath Ar newpath -Create a symbolic link from +Create a symbolic link from .Ar oldpath to .Ar newpath . .It Ic ! Ar command -Execute +Execute .Ar command in local shell. .It Ic !