Bug 2807 - On man page state clearly -o "option value" not just -o option
Summary: On man page state clearly -o "option value" not just -o option
Status: CLOSED WONTFIX
Alias: None
Product: Portable OpenSSH
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 7.6p1
Hardware: Other Linux
: P5 enhancement
Assignee: Assigned to nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-12-05 12:27 AEDT by Dan Jacobson
Modified: 2021-04-23 15:02 AEST (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Dan Jacobson 2017-12-05 12:27:53 AEDT 
In ssh the man page SYNOPSIS and at

-o option

say instead

-o "option value"

else the user figuring this out depends on the user finding its single
occurance in the "Finally the client connects" example. Nor will the
ssh_config man page help him here.
Comment 1 Dan Jacobson 2017-12-06 14:57:10 AEDT 
Today through trial and error I found that one can also use "=" instead of space as a separator.

Please be sure this is documented clearly on the ssh(1) manpage.

It is a lifesaver when one needs to do e.g.,
command="ssh -o ExitOnForwardFailure=yes -f m.example.org -L 10143:m.example.org:143 -N"; $command
Comment 2 Damien Miller 2018-01-05 13:47:05 AEDT 
The description for -o says;

Can be used to give options in the format used in the configuration file

IMO this is sufficient, and synopsis isn't typically used for dissecting the format of arguments.
Comment 3 Damien Miller 2021-04-23 15:02:29 AEST 
closing resolved bugs as of 8.6p1 release