groff-commit
[Top][All Lists]
Advanced

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

[groff] 34/40: groff_man*(7): Fix content nits.


From: G. Branden Robinson
Subject: [groff] 34/40: groff_man*(7): Fix content nits.
Date: Sat, 12 Nov 2022 14:43:39 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 54119b8931dfe6668cd06716bdd79a75dfe74549
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Nov 12 07:09:25 2022 -0600

    groff_man*(7): Fix content nits.
    
    * Add paragraph explaining "man" terminology, borrowed from
      groff_mdoc(7).
    * Relate `TH` macro name more clearly to _roff_ titles.
    * Drop "line" from "{header,footer} line".
    * Say "presentation-oriented" rather than "presentation-level".  (What
      are the other levels?  What is their ordering?)
---
 tmac/groff_man.7.man.in | 31 +++++++++++++++++++++++--------
 1 file changed, 23 insertions(+), 8 deletions(-)

diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index fbcbc6965..2f8fabd76 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -189,6 +189,14 @@ Macros whose use we discourage
 and
 .BR .UC )
 are described in subsection \(lqDeprecated features\(rq below.
+.
+.
+.P
+Throughout Unix documentation,
+a manual entry is referred simply to as a \(lqman page\(rq,
+regardless of its length,
+without gendered implication,
+and irrespective of the macro package selected for its composition.
 _ifstyle()dnl
 .
 .
@@ -368,9 +376,16 @@ macros.
 .RI " [" footer-middle ]\c
 .RI " [" footer-inside ]\c
 .RI " [" header-middle ]
-Define the subject of the man page as
+Determine the contents of the page header and footer.
+_ifstyle()dnl
+.
+.I roff
+systems refer to these collectively as \(lqtitles\(rq.
+_endif()dnl
+.
+The subject of the man page is
 .I topic
-and the section of the manual to which it belongs as
+and the section of the manual to which it belongs is
 .I section.
 _ifstyle()dnl
 .
@@ -388,14 +403,14 @@ system.
 .I topic
 and
 .I section
-are positioned together at the left and right in the header line
+are positioned together at the left and right in the header
 (with
 .I section
 in parentheses immediately appended to
 .IR topic ).
 .
 .I footer-middle
-is centered in the footer line.
+is centered in the footer.
 .
 The arrangement of the rest of the footer depends on whether
 double-sided layout is enabled with the option
@@ -420,7 +435,7 @@ and
 as in the header.
 .
 .I header-middle
-is centered in the header line.
+is centered in the header.
 .
 If
 .I section
@@ -2920,7 +2935,7 @@ _ifstyle()dnl
 _endif()dnl
 .
 .IP
-Use of this presentation-level macro is deprecated.
+Use of this presentation-oriented macro is deprecated.
 .
 It translates poorly to HTML,
 under which exact space control and tabulation are not readily
@@ -2951,7 +2966,7 @@ is handled as with
 .
 .
 .IP
-Use of this presentation-level macro is deprecated.
+Use of this presentation-oriented macro is deprecated.
 .
 A hanging indentation cannot be expressed naturally under HTML,
 and HTML-based man page processors may interpret it as starting an
@@ -3016,7 +3031,7 @@ see subsection \(lqHorizontal and vertical spacing\(rq 
above.
 .
 .
 .IP
-Use of this presentation-level macro is deprecated.
+Use of this presentation-oriented macro is deprecated.
 .
 It translates poorly to HTML,
 under which exact control of inter-paragraph spacing is not readily



reply via email to

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