groff-commit
[Top][All Lists]
Advanced

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

[groff] 08/12: [man pages]: Fix content, style, and markup nits.


From: G. Branden Robinson
Subject: [groff] 08/12: [man pages]: Fix content, style, and markup nits.
Date: Sat, 20 Nov 2021 05:19:12 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 3959a9559f897b69a4a704596eef5b81cc1da3ec
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Nov 17 17:19:54 2021 +1100

    [man pages]: Fix content, style, and markup nits.
    
    Content:
    * Say "output driver" instead of "device driver".
    * Identify `-Txhtml` as an acceptable way to invoke grohtml in the
      introductory paragraph.
    
    Style:
    * Stop setting device names in quotation marks.
    
    Markup:
    * Use `ne` request to keep section heading and immediately subsequent
      paragraph tag together.
---
 src/devices/grohtml/grohtml.1.man |  6 ++++--
 src/devices/grolj4/grolj4.1.man   |  1 +
 src/devices/grotty/grotty.1.man   | 41 +++++++++++++++++++++++++++++----------
 src/roff/groff/groff.1.man        | 14 ++++++-------
 4 files changed, 43 insertions(+), 19 deletions(-)

diff --git a/src/devices/grohtml/grohtml.1.man 
b/src/devices/grohtml/grohtml.1.man
index a81d880..2691fb7 100644
--- a/src/devices/grohtml/grohtml.1.man
+++ b/src/devices/grohtml/grohtml.1.man
@@ -106,7 +106,7 @@ The GNU
 .I roff
 system's HTML support consists of a preprocessor,
 .IR pre\-grohtml ,
-and a device driver,
+and an output driver,
 .IR post\-grohtml ;
 together,
 they translate
@@ -119,7 +119,9 @@ via the
 .MR groff @MAN1EXT@
 command with the
 .B \-Thtml
-option.
+or
+.B \-Txhtml
+options.
 .
 If no operands are given,
 or if
diff --git a/src/devices/grolj4/grolj4.1.man b/src/devices/grolj4/grolj4.1.man
index 8cd7903..0143637 100644
--- a/src/devices/grolj4/grolj4.1.man
+++ b/src/devices/grolj4/grolj4.1.man
@@ -200,6 +200,7 @@ and
 .MR groff_font @MAN5EXT@ .
 .
 .
+.ne 3v \" Keep section heading and paragraph tag together.
 .\" ====================================================================
 .SH Files
 .\" ====================================================================
diff --git a/src/devices/grotty/grotty.1.man b/src/devices/grotty/grotty.1.man
index 3154e82..c023c38 100644
--- a/src/devices/grotty/grotty.1.man
+++ b/src/devices/grotty/grotty.1.man
@@ -407,7 +407,9 @@ renders
 commands that have at least one zero argument
 (and so are either horizontal or vertical)
 using Unicode box drawing characters
-(for the \[lq]utf8\[rq] device)
+(for the
+.B utf8
+device)
 or the
 .BR \- ,
 .BR | ,
@@ -536,56 +538,73 @@ option were specified;
 see subsection \[lq]Legacy output format\[rq] above.
 .
 .
+.ne 3v \" Keep section heading and paragraph tag together.
 .\" ====================================================================
 .SH Files
 .\" ====================================================================
 .
 .TP
 .I @FONTDIR@/devascii/DESC
-Device description file for the \[lq]ascii\[rq] device.
+Device description file for the
+.B ascii
+device.
 .
 .
 .TP
 .IR @FONTDIR@/devascii/ F
 Font description file for font
 .I F
-of the \[lq]ascii\[rq] device.
+of the
+.B ascii
+device.
 .
 .
 .TP
 .I @FONTDIR@/devcp1047/DESC
-Device description file for the \[lq]cp1047\[rq] device.
+Device description file for the
+.B cp1047
+device.
 .
 .
 .TP
 .IR @FONTDIR@/devcp1047/ F
 Font description file for font
 .I F
-of the \[lq]cp1047\[rq] device.
+of the
+.B cp1047
+device.
 .
 .
 .TP
 .I @FONTDIR@/devlatin1/DESC
-Device description file for the \[lq]latin1\[rq] device.
+Device description file for the
+.B latin1
+device.
 .
 .
 .TP
 .IR @FONTDIR@/devlatin1/ F
 Font description file for font
 .I F
-of the \[lq]latin1\[rq] device.
+of the
+.B latin1
+device.
 .
 .
 .TP
 .I @FONTDIR@/devutf8/DESC
-Device description file for the \[lq]utf8\[rq] device.
+Device description file for the
+.B utf8
+device.
 .
 .
 .TP
 .IR @FONTDIR@/devutf8/ F
 Font description file for font
 .I F
-of the \[lq]utf8\[rq] device.
+of the
+.B utf8
+device.
 .
 .
 .TP
@@ -604,7 +623,9 @@ Additional character definitions for use with
 .\" font/*/dev*.am files suggests no evidence of it, at any rate.
 .\".P
 .\"Note that on EBCDIC hosts,
-.\"only files for the \[lq]cp1047\[rq] device are installed.
+.\"only files for the
+.\".B cp1047
+.\"device are installed.
 .
 .
 .\" ====================================================================
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index ca2f151..1cf7c49 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -1890,11 +1890,11 @@ are equivalent.
 .\" ====================================================================
 .
 When paging output for the
-.RB \[lq] ascii \[rq],
-.RB \[lq] cp1047 \[rq],
-.RB \[lq] latin1 \[rq],
+.BR ascii ,
+.BR cp1047 ,
+.BR latin1 ,
 and
-.RB \[lq] utf8 \[rq]
+.B utf8
 devices,
 programs like
 .MR more 1
@@ -1909,14 +1909,14 @@ see
 .P
 On EBCDIC hosts such as OS/390 Unix,
 the output devices
-.RB \[lq] ascii \[rq]
+.B ascii
 and
-.RB \[lq] latin1 \[rq]
+.B latin1
 aren't available.
 .
 Conversely,
 the output device
-.RB \[lq] cp1047 \[rq]
+.B cp1047
 is not available on systems based on the ISO\~646 or ISO\~8859 character
 encoding standards.
 .



reply via email to

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