A minor patch for wg.8 manual page
[email protected] Wed, 17 Dec 2025 19:02:55 +0000
| Newsgroups | com.zx2c4.lists.wireguard |
|---|---|
| Message-ID | <[email protected]> |
The wg.8 manual page CONFIGURATION FILE FORMAT EXAMPLE section has a comment
about comments in the configuration file.
Since
1. I think such a comment belong to the CONFIGURATION FILE FORMAT section.
2. The example in the CONFIGURATION FILE FORMAT EXAMPLE section has no comments
I propose
--- a/wg.8 2025-12-17 18:34:56.023484459 +0000
+++ b/wg.8 2025-12-17 18:51:04.271960383 +0000
@@ -132,6 +132,7 @@
The configuration file format is based on \fIINI\fP. There are two top level sections
-- \fIInterface\fP and \fIPeer\fP. Multiple \fIPeer\fP sections may be specified, but
only one \fIInterface\fP section may be specified.
+Characters after and including a '#' are considered comments and are thus ignored.
.P
The \fIInterface\fP section may contain the following fields:
@@ -177,17 +178,20 @@
.SH CONFIGURATION FILE FORMAT EXAMPLE
This example may be used as a model for writing configuration files, following an
-INI-like syntax. Characters after and including a '#' are considered comments and
-are thus ignored.
+INI-like syntax.
[Interface]
.br
+ # A comment: only one [Interface] section may be specified.
+.br
PrivateKey = yAnz5TF+lXXJte14tji3zlMNq+hd2rYUIgJBgB3fBmk=
.br
ListenPort = 51820
.br
.br
+ # A comment: multiple [Peer] sections may be specified.
+.br
[Peer]
.br
PublicKey = xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=