commit a18d66510bf87c86e74854eb4a4543b8ce8c03bf
from: Omar Polo <op@omarpolo.com>
via: Thomas Adam <thomas@xteddy.org>
date: Tue Oct 01 23:00:28 2024 UTC

gotd.conf: document macro syntax, stealing from gotwebd

commit - 82fb769c61e5d3d84df5fa95cd9998051044edb8
commit + a18d66510bf87c86e74854eb4a4543b8ce8c03bf
blob - 1966116e9ec44033ba77d02cf4bb5478e07f4d94
blob + 38d7d96fc6021f99baaeba36d8f87ebd7e64714b
--- gotd/gotd.conf.5
+++ gotd/gotd.conf.5
@@ -34,6 +34,16 @@ as well as reserved words
 must be quoted.
 Arguments containing whitespace should be surrounded by double quotes
 .Pq \&" .
+.Pp
+Macros can be defined that are later expanded in context.
+Macro names must start with a letter, digit, or underscore, and may
+contain any of those characters, but may not be reserved words.
+Macros are not expanded inside quotes.
+For example:
+.Bd -literal -offset indent
+path = "/var/run/gotd.sock"
+listen on $path
+.Ed
 .Sh GLOBAL CONFIGURATION
 The available global configuration directives are as follows:
 .Bl -tag -width Ds