From 14c62eb2beb36b2898187b89e6c5058f8942a693 Mon Sep 17 00:00:00 2001 From: Ben Lindstrom Date: Wed, 15 Aug 2001 23:25:46 +0000 Subject: - stevesk@cvs.openbsd.org 2001/08/14 17:54:29 [scp.1 sftp.1 ssh.1] consistent documentation and example of ``-o ssh_option'' for sftp and scp; document keyword=argument for ssh. --- ChangeLog | 6 +++++- scp.1 | 22 +++++++++++++--------- sftp.1 | 14 +++++++++++--- ssh.1 | 20 ++++++++++++++++---- 4 files changed, 45 insertions(+), 17 deletions(-) diff --git a/ChangeLog b/ChangeLog index d2e59410f..110cbe3b6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -26,6 +26,10 @@ - markus@cvs.openbsd.org 2001/08/14 09:23:02 [sftp.1 sftp-int.c] "bye"; hk63a@netscape.net + - stevesk@cvs.openbsd.org 2001/08/14 17:54:29 + [scp.1 sftp.1 ssh.1] + consistent documentation and example of ``-o ssh_option'' for sftp and + scp; document keyword=argument for ssh. 20010814 - (stevesk) sshpty.c, cray.[ch]: whitespace, formatting and cleanup @@ -6315,4 +6319,4 @@ - Wrote replacements for strlcpy and mkdtemp - Released 1.0pre1 -$Id: ChangeLog,v 1.1482 2001/08/15 23:22:56 mouring Exp $ +$Id: ChangeLog,v 1.1483 2001/08/15 23:25:46 mouring Exp $ diff --git a/scp.1 b/scp.1 index 395ffdf88..10bd85cad 100644 --- a/scp.1 +++ b/scp.1 @@ -9,7 +9,7 @@ .\" .\" Created: Sun May 7 00:14:37 1995 ylo .\" -.\" $OpenBSD: scp.1,v 1.16 2001/08/08 07:16:58 deraadt Exp $ +.\" $OpenBSD: scp.1,v 1.17 2001/08/14 17:54:29 stevesk Exp $ .\" .Dd September 25, 1999 .Dt SCP 1 @@ -24,7 +24,7 @@ .Op Fl P Ar port .Op Fl c Ar cipher .Op Fl i Ar identity_file -.Op Fl o Ar option +.Op Fl o Ar ssh_option .Sm off .Oo .Op Ar user@ @@ -107,13 +107,17 @@ to use for the encrypted connection. The program must understand .Xr ssh 1 options. -.It Fl o Ar option -Can be used to give options in the format used in the config file. -These options are passed directly to -.Xr ssh 1 , -for instance -.Fl o "Protocol=1" -would force protocol 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 scp +command-line flag. For example, to force the use of protocol +version 1 you may specify +.Ic scp -oProtocol=1 . .It Fl 4 Forces .Nm diff --git a/sftp.1 b/sftp.1 index 6a365a41d..25a9b8a48 100644 --- a/sftp.1 +++ b/sftp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sftp.1,v 1.22 2001/08/14 09:23:02 markus Exp $ +.\" $OpenBSD: sftp.1,v 1.23 2001/08/14 17:54:29 stevesk Exp $ .\" .\" Copyright (c) 2001 Damien Miller. All rights reserved. .\" @@ -78,8 +78,16 @@ 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 . +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 force the use of protocol +version 1 you may specify +.Ic sftp -oProtocol=1 . .It Fl v Raise logging level. This option is also passed to ssh. .El diff --git a/ssh.1 b/ssh.1 index b6fe0550f..8166bddda 100644 --- a/ssh.1 +++ b/ssh.1 @@ -34,7 +34,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. .\" -.\" $OpenBSD: ssh.1,v 1.126 2001/08/01 22:16:45 markus Exp $ +.\" $OpenBSD: ssh.1,v 1.127 2001/08/14 17:54:29 stevesk Exp $ .Dd September 25, 1999 .Dt SSH 1 .Os @@ -492,10 +492,9 @@ Do not execute a remote command. This is useful if you just want to forward ports (protocol version 2 only). .It Fl o Ar option -Can be used to give options in the format used in the config file. +Can be used to give options in the format used in the configuration file. This is useful for specifying options for which there is no separate command-line flag. -The option has the same format as a line in the configuration file. .It Fl p Ar port Port to connect to on the remote host. This can be specified on a @@ -613,7 +612,8 @@ to use IPv6 addresses only. .El .Sh CONFIGURATION FILES .Nm -obtains configuration data from the following sources (in this order): +obtains configuration data from the following sources in +the following order: command line options, user's configuration file .Pq Pa $HOME/.ssh/config , and system-wide configuration file @@ -638,6 +638,18 @@ are comments. .Pp Otherwise a line is of the format .Dq keyword arguments . +Configuration options may be separated by whitespace or +optional whitespace and exactly one +.Ql = ; +the latter format is useful to avoid the need to quote whitespace +when specifying configuration options using the +.Nm ssh , +.Nm scp +and +.Nm sftp +.Fl o +option. +.Pp The possible keywords and their meanings are as follows (note that the configuration files are case-sensitive): -- cgit v1.2.3