[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 32/46: groff_mdoc(7): Tweak `Dd`, `Dt` discussion.
From: |
G. Branden Robinson |
Subject: |
[groff] 32/46: groff_mdoc(7): Tweak `Dd`, `Dt` discussion. |
Date: |
Wed, 7 Dec 2022 04:32:36 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit c055e87d9be6e12150669804b4e4b4a71dabc06b
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Dec 4 00:41:01 2022 -0600
groff_mdoc(7): Tweak `Dd`, `Dt` discussion.
Style:
* Use "topic" instead of "page-topic" as metasyntactic variable, to
align better with recent groff_man*(7) changes.
* Tighten wording (what's a non-full four-digit year?).
Markup:
* Mark "," in historical date format as literal.
---
tmac/groff_mdoc.7.man | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index ec289d23f..48d283ddb 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -625,10 +625,10 @@ to construct a man page from the following template.
.Bd -literal -offset indent
\&.\e" The following commands are required for all man pages.
\&.Dd date
-\&.Dt page-topic [section-identifier [volume-name]]
+\&.Dt topic [section-identifier [volume-name]]
\&.Os [package-or-operating system [version-or-release]]
\&.Sh Name
-\&.Nm page-topic
+\&.Nm topic
\&.Nd summary-description
\&.\e" The next heading is used in sections 2 and 3.
\&.\e" .Sh Library
@@ -825,7 +825,7 @@ Historically,
.Ar date
was written in U.S.\& traditional format,
.Do
-.Em Month day , year
+.Em Month day Li , Em year
.Dc
where
.Em Month
@@ -834,7 +834,7 @@ is the full month name in English,
an integer without a leading zero,
and
.Ar year
-the full four-digit year.
+the four-digit year.
.
This localism is not enforced,
however.
@@ -857,9 +857,9 @@ manuals to automatically insert the current date when
committing.
This macro is neither callable nor parsed.
.
.
-.It Li .Dt Ar page-topic Op Ar section-identifier Op Ar section-name
+.It Li .Dt Ar topic Op Ar section-identifier Op Ar section-name
.
-.Ar page-topic
+.Ar topic
is the subject of the man page.
.
A
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 32/46: groff_mdoc(7): Tweak `Dd`, `Dt` discussion.,
G. Branden Robinson <=