[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 18/23: [man pages]: Fix style nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 18/23: [man pages]: Fix style nits. |
Date: |
Mon, 21 Mar 2022 03:44:56 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 0b251a7596eca5e1d3af33b5b46500e90759434a
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Mar 21 15:13:18 2022 +1100
[man pages]: Fix style nits.
* contrib/chem/chem.1.man: Spell out small numerals in prose.
* contrib/chem/chem.1.man:
* contrib/hdtbl/groff_hdtbl.7.man: Break input lines after commas.
* contrib/groff_filenames/groff_filenames.5.man: Tighten wording.
* contrib/groff_filenames/groff_filenames.5.man: Reduce use of italics
and bold.
* contrib/hdtbl/groff_hdtbl.7.man: Refer to fonts by their actual names
rather than versions transformed for file system storage.
* contrib/hdtbl/groff_hdtbl.7.man: Clarify reference to "main" macro
packages.
* contrib/hdtbl/groff_hdtbl.7.man:
* man/groff_out.5.man: Set "groff" in italics.
* contrib/hdtbl/groff_hdtbl.7.man: Tighten wording.
* contrib/hdtbl/groff_hdtbl.7.man: Set an example within a sentence.
* man/groff_diff.7.man:
* man/roff.7.man: Set bulleted lists (`IP` paragraphs using \[bu] as a
tag) with an indentation of only 2n.
* man/groff_diff.7.man: Slightly recast discussion of "legacy" output
command. (This really needs a rewrite given the clear motivation for
the feature documented in CSTR #97.)
* man/groff_out.5.man: Stop setting an ellipsis in italics.
* src/preproc/eqn/eqn.1.man: Tighten discussion of "nroff" parameter.
* src/preproc/grn/grn.1.man: Italicize "x" and "y" when used as
coordinate axes.
* tmac/groff_man.7.man.in: Drop hyphen when using "cross reference" as a
noun.
---
contrib/chem/chem.1.man | 16 ++++++++--------
contrib/groff_filenames/groff_filenames.5.man | 13 ++++++-------
contrib/hdtbl/groff_hdtbl.7.man | 25 ++++++++++++++-----------
man/groff_diff.7.man | 2 +-
man/groff_out.5.man | 16 ++++++++--------
man/roff.7.man | 4 ++--
src/preproc/eqn/eqn.1.man | 9 ++++-----
src/preproc/grn/grn.1.man | 14 ++++++++++----
tmac/groff_man.7.man.in | 2 +-
9 files changed, 54 insertions(+), 47 deletions(-)
diff --git a/contrib/chem/chem.1.man b/contrib/chem/chem.1.man
index 3874aba0..438a80c6 100644
--- a/contrib/chem/chem.1.man
+++ b/contrib/chem/chem.1.man
@@ -361,11 +361,11 @@ place.
.SS Rings
.\" ====================================================================
.
-There are lots of rings, but only 5 and 6-sided rings get
-much support.
+There are lots of rings,
+but only five- and six-sided rings get much support.
.
.B ring
-by itself is a 6-sided ring;
+by itself is a six-sided ring;
.B benzene
is the benzene ring with a circle inside.
.B aromatic
@@ -478,16 +478,16 @@ and
.
.
.P
-There are two 5-sided rings.
+There are two five-sided rings.
.
.B ring5
-is pentagonal with a side that matches the 6-sided ring; it has four
-natural directions.
+is pentagonal with a side that matches the six-sided ring;
+it has four natural directions.
.
A
.B \%flatring
-is a 5-sided ring created by chopping one corner of a 6-sided ring so
-that it exactly matches the 6-sided rings.
+is a five-sided ring created by chopping one corner of a six-sided ring
+so that it exactly matches the six-sided rings.
.
.
.P
diff --git a/contrib/groff_filenames/groff_filenames.5.man
b/contrib/groff_filenames/groff_filenames.5.man
index 17e05fd6..378e408f 100644
--- a/contrib/groff_filenames/groff_filenames.5.man
+++ b/contrib/groff_filenames/groff_filenames.5.man
@@ -331,13 +331,13 @@ programs.
.
.
.P
-There were several
+The
.I roff
-languages, each represented by a
-.IR "macro-package" .
+language has been extended by a variety of macro packages,
+each producing a sort of dialect of the common language.
.
-Each of these provided a suitable file name
-.IR extension :
+Documents written using such packages tend to bear a characteristic
+file name extension.
.
.
.TP
@@ -534,8 +534,7 @@ files written in the
.
.TP
.IB <name> .www
-files written in
-.BR HTML -like
+files written in HTML-like
.I groff
.IR macros .
.
diff --git a/contrib/hdtbl/groff_hdtbl.7.man b/contrib/hdtbl/groff_hdtbl.7.man
index b286a664..7b284c37 100644
--- a/contrib/hdtbl/groff_hdtbl.7.man
+++ b/contrib/hdtbl/groff_hdtbl.7.man
@@ -1013,11 +1013,14 @@ The foreground color of the cell contents.
The font family for the table.
.
.CI name
-is one of the groff font families, for example
+is a
+.I groff
+font familiy identifier,
+such as
.CR A
-for the AvantGarde fonts or
+for Avant Garde or
.CR HN
-for Helvetica-Narrow.
+for Helvetica Narrow.
.
.XDEF
The font family found before the table (string
@@ -1234,13 +1237,15 @@ and for missing
.CR ETB
macros (table not closed).
.
-You can append this macro
-to the \[lq]end\[rq] macro of your document's main macro package.
+You can call this macro by appending it the to end-of-input macro of
+the main,
+or \[lq]full-service\[rq],
+macro package your document uses.
.
-For example:
+For example,
+try
.
.
-.PP
.RS
.EX
\&.am pg@end\-text
@@ -1249,11 +1254,9 @@ For example:
.EE
.RE
.
-.
-.PP
-If you use the
+if you use the
.I ms
-macro package.
+package.
.
.
.\" ====================================================================
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 4489daae..1d48370a 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -1995,7 +1995,7 @@ The following environment data are not copied:
.
.
.RS
-.IP \[bu]
+.IP \[bu] 2n
a partially collected line, if present;
.
.
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 31a29399..0f9cd7fd 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -1017,7 +1017,7 @@ rightmost point of the ellipse.
.
.
.TP
-.D-command F "color-scheme \fR[\fPcomponent .\|.\|.\fR]\fP"
+.D-command F "color-scheme \fR[\fPcomponent\fR .\|.\|.]\fP"
Set fill color for solid drawing objects using different color
schemes; the analogous command for setting the color of text, line
graphics, and the outline of graphic objects is
@@ -1483,20 +1483,20 @@ because the width of the glyphs can become much larger
than two
decimal digits.
.
In
-.BR groff ,
-this is only used for the devices
+.IR groff ,
+it is used only for output to the
.BR X75 ,
.BR X75\-12 ,
.BR X100 ,
and
-.BR X100\-12 .
+.B X100\-12
+devices.
.
-For other devices,
+For others,
the commands
.B t
-and\~\c
-.B u
-provide a better functionality.
+.RB and\~ u
+provide greater functionality and superior troubleshooting capacity.
.
.
.\" ====================================================================
diff --git a/man/roff.7.man b/man/roff.7.man
index 8df8c505..220968e6 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -2013,7 +2013,7 @@ formatter.
Several traditions have accrued in service of these goals.
.
.
-.IP \[bu]
+.IP \[bu] 2n
Break input lines after sentence-ending punctuation to ease their
recognition.
.\" Texinfo: (@pxref{Sentences}).
@@ -2221,7 +2221,7 @@ It is also possible to have the mode automatically
selected when a
file is loaded into the editor.
.
.
-.IP \(bu
+.IP \(bu 2n
The most general method is to include file-local variables at the end of
the file;
we can also configure the fill column this way.
diff --git a/src/preproc/eqn/eqn.1.man b/src/preproc/eqn/eqn.1.man
index af5092bb..087cb4bd 100644
--- a/src/preproc/eqn/eqn.1.man
+++ b/src/preproc/eqn/eqn.1.man
@@ -1115,17 +1115,16 @@ and
.B ndefine
is ignored.
.
-The default value is\~0.
-.
-(This is typically changed to\~1 by the
+The default value is\~0;
+the
.I eqnrc
-file for the
+file sets it to\~1 for the
.BR ascii ,
.BR latin1 ,
.BR utf8 ,
and
.B cp1047
-drivers.)
+output devices.)
.
.
.LP
diff --git a/src/preproc/grn/grn.1.man b/src/preproc/grn/grn.1.man
index d12e1bc0..684e5151 100644
--- a/src/preproc/grn/grn.1.man
+++ b/src/preproc/grn/grn.1.man
@@ -782,12 +782,18 @@ was designed for AED terminals,
and its coordinates reflect the AED coordinate space.
.
For vertical pictures,
-x-values range 116 to 511,
-and y-values from 0 to 483.
+.IR x \~values
+range 116 to 511,
+and
+.IR y \~values
+from 0 to 483.
.
For horizontal pictures,
-x-values range from 0 to 511,
-and y-values from 0 to 367.
+.IR x \~values
+range from 0 to 511,
+and
+.IR y \~values
+from 0 to 367.
.
Although you needn't absolutely stick to this range,
you'll get better results if you at least stay in this vicinity.
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 5c3975d8..b27b2658 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -116,7 +116,7 @@ like the one you are reading.
This document presents the macros thematically;
for those needing only a quick reference,
the following table lists them alphabetically,
-with cross-references to appropriate subsections below.
+with cross references to appropriate subsections below.
.
.
_ifnotstyle()dnl
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 18/23: [man pages]: Fix style nits.,
G. Branden Robinson <=