Commit Diff

Commit:
abfa295f9a51b0479be9e96ab74f6ead7e650100
From:
schwarze <schwarze@openbsd.org>
Date:
Message:
In the manual pages for configuration files based on parse.y, describe the syntax of both defining and using macros, rather than exclusively relying on examples, which some of the pages do not even provide. In those pages containing tables of content, also clarify that the "Macros" section contains *definitions* of variables. Both changes were already committed to vm.conf(5) earlier. In those few pages that referenced cpp(1) and m4(1), stop doing that because the macro definition syntax and the macro dereferencing syntax of both languages is totally different from the parse.y syntax. OK florian@, and deraadt also requests keeping these manuals in sync.
Actions:
Patch | Tree
commit - 21645604d9bdeecb445a3c36eb1b1e997bf0801e
commit + abfa295f9a51b0479be9e96ab74f6ead7e650100
blob - 8372875b8537858ba8411bac64a34d4ecdf4085b
blob + 978c51089e2fd81a9ef33cce7f466d7763181257
--- relayd.conf.5
+++ relayd.conf.5
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: relayd.conf.5,v 1.211 2024/10/28 19:56:18 tb Exp $
+.\"	$OpenBSD: relayd.conf.5,v 1.212 2025/07/07 20:56:48 schwarze Exp $
 .\"
 .\" Copyright (c) 2006 - 2016 Reyk Floeter <reyk@openbsd.org>
 .\" Copyright (c) 2006, 2007 Pierre-Yves Ritschard <pyr@openbsd.org>
@@ -15,7 +15,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: October 28 2024 $
+.Dd $Mdocdate: July 7 2025 $
 .Dt RELAYD.CONF 5
 .Os
 .Sh NAME
@@ -30,7 +30,7 @@ is the configuration file for the relay daemon,
 is divided into the following main sections:
 .Bl -tag -width xxxx
 .It Sy Macros
-User-defined variables may be defined and used later, simplifying the
+Definitions of variables that can be used later, simplifying the
 configuration file.
 .It Sy Global Configuration
 Global settings for
@@ -96,15 +96,20 @@ keyword, for example:
 include "/etc/relayd.conf.local"
 .Ed
 .Sh MACROS
-Macros can be defined that will later be expanded in context.
-Macro names must start with a letter, digit, or underscore,
-and may contain any of those characters.
-Macro names may not be reserved words (for example,
+A macro is defined with a command of the form
+.Ar name Ns = Ns Ar value .
+The macro
+.Ar name
+can contain letters, digits, and underscores and cannot be a reserved word
+(for example,
 .Ic table ,
 .Ic relay ,
 or
 .Ic timeout ) .
-Macros are not expanded inside quotes.
+Within unquoted arguments, the string
+.Pf $ Ar name
+is later expanded to
+.Ar value .
 .Pp
 For example:
 .Bd -literal -offset indent