[openssh-commits] [openssh] 02/02: upstream: Tighten up the introduction a little:

[git+noreply at mindrot.org]

This is an automated email from the git hooks/post-receive script.

dtucker pushed a commit to branch master
in repository openssh.

commit 55ffd11b88f073662cdf0c8c48fe0800b8a71fc4
Author: djm at openbsd.org <djm at openbsd.org>
AuthorDate: Wed Jul 1 00:52:31 2026 +0000

    upstream: Tighten up the introduction a little:
    
    Mention Match as a conditional directive (previously it only
    mentioned Host)
    
    Try to use consistent language in the introduction to refer to
    configuration directives (previously it used "parameters" and
    "keywords" interchangeably).
    
    Mention that comments may appear at the end of the line too, and that
    whitespace at the beginning/end of lines is not significant.
    
    OpenBSD-Commit-ID: e08f34413eeced47478c14d5005726f9bdd5d80e
---
 ssh_config.5 | 39 ++++++++++++++++++++++-----------------
 1 file changed, 22 insertions(+), 17 deletions(-)

diff --git a/ssh_config.5 b/ssh_config.5
index 082fc8ee3..4ac0d3d45 100644
--- a/ssh_config.5
+++ b/ssh_config.5
@@ -33,8 +33,8 @@
 .\" (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_config.5,v 1.425 2026/06/29 08:21:50 djm Exp $
-.Dd $Mdocdate: June 29 2026 $
+.\" $OpenBSD: ssh_config.5,v 1.426 2026/07/01 00:52:31 djm Exp $
+.Dd $Mdocdate: July 1 2026 $
 .Dt SSH_CONFIG 5
 .Os
 .Sh NAME
@@ -56,31 +56,36 @@ system-wide configuration file
 .Pq Pa /etc/ssh/ssh_config
 .El
 .Pp
-Unless noted otherwise, for each parameter, the first obtained value
-will be used.
-The configuration files contain sections separated by
+Unless noted otherwise, for each configuration directive, the first
+specified value will be used.
+.Pp
+The configuration files may contain sections separated by conditional
 .Cm Host
-specifications, and that section is only applied for hosts that
-match one of the patterns given in the specification.
-The matched host name is usually the one given on the command line
-(see the
-.Cm CanonicalizeHostname
-option for exceptions).
+or
+.Cm Match
+directives.
+Configuration in these sections is only applied if the conditional directive
+that started the section matches.
 .Pp
-Since the first obtained value for each parameter is used, more
+Since the first obtained value for each directive is used, more
 host-specific declarations should be given near the beginning of the
 file, and general defaults at the end.
 .Pp
-The file contains keyword-argument pairs, one per line.
+The file contains directive/values pairs, one per line.
 Lines starting with
 .Ql #
 and empty lines are interpreted as comments.
-Arguments may optionally be enclosed in double quotes
+.Ql #
+outside of a quoted string may be used to add a comment to the end of a line.
+Whitespace at the beginning or end of lines is ignored.
+Values may optionally be enclosed in double quotes
 .Pq \&"
 in order to represent arguments containing spaces.
-Configuration options may be separated by whitespace or
-optional whitespace and exactly one
-.Ql = ;
+.Pp
+Configuration directives are separated from their values by whitespace
+or exactly one
+.Ql =
+character (which may be surrounded by whitespace);
 the latter format is useful to avoid the need to quote whitespace
 when specifying configuration options using the
 .Nm ssh ,

-- 
To stop receiving notification emails like this one, please contact
djm at mindrot.org.