Commit Diff

Commit:
6859aa4cb8eaaf4776e85b5508e8ad808651caad
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 - fbc6024ac5b1e2cb04c968555cc9360de1c12bc8
commit + 6859aa4cb8eaaf4776e85b5508e8ad808651caad
blob - 05fba1c340b500bd9e9558dd785c98f81cbf6878
blob + 0716206c60cbd78167bc6acaf118837912b93716
--- httpd.conf.5
+++ httpd.conf.5
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: httpd.conf.5,v 1.125 2023/11/03 13:03:02 espie Exp $
+.\"	$OpenBSD: httpd.conf.5,v 1.126 2025/07/07 20:56:48 schwarze Exp $
 .\"
 .\" Copyright (c) 2014, 2015 Reyk Floeter <reyk@openbsd.org>
 .\"
@@ -14,7 +14,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: November 3 2023 $
+.Dd $Mdocdate: July 7 2025 $
 .Dt HTTPD.CONF 5
 .Os
 .Sh NAME
@@ -29,7 +29,7 @@ is the configuration file for the HTTP 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
@@ -85,15 +85,20 @@ keyword, for example:
 include "/etc/httpd.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 directory ,
 .Ic log ,
 or
 .Ic root ) .
-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