groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 35/40: groff_mdoc(7): Revise sectn "A man page template".


From: G. Branden Robinson
Subject: [groff] 35/40: groff_mdoc(7): Revise sectn "A man page template".
Date: Mon, 12 Dec 2022 19:28:08 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 4beea88ea87d577c74e93debf4129aeb46dc6707
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Dec 12 16:03:57 2022 -0600

    groff_mdoc(7): Revise sectn "A man page template".
    
    Revise `Dt`'s second argument description to sync with forthcoming
    change to the macro's own presentation.
    
    Set references to the package's own macros with ".Pf . Ic \&Xx",
    following a suggestion from Ingo Schwarze.
---
 tmac/groff_mdoc.7.man | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index 2a40336fa..f752947c2 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -661,7 +661,7 @@ 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 topic [section-identifier [volume-name]]
+\&.Dt topic [section-identifier [section-keyword-or-title]]
 \&.Os [package-or-operating system [version-or-release]]
 \&.Sh Name
 \&.Nm topic
@@ -697,10 +697,10 @@ to construct a man page from the following template.
 .
 .Pp
 The first items in the template are the commands
-.Ql \&Dd ,
-.Ql \&Dt ,
+.Pf . Ic \&Dd ,
+.Pf . Ic \&Dt ,
 and
-.Ql \&Os .
+.Pf . Ic \&Os .
 .
 These correspond to the document date;
 the page topic and section of the manual to which the page belongs;
@@ -713,7 +713,7 @@ These commands identify the page and are discussed below in 
section
 .
 .Pp
 The remaining items in the template are section headings
-.Pf ( Ql \&Sh ) ;
+.Pf ( Pf . Ic \&Sh ) ;
 of which
 .Sx Name
 and



reply via email to

[Prev in Thread] Current Thread [Next in Thread]