groff-commit
[Top][All Lists]
Advanced

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

[groff] 17/24: [ms]: Update documentation.


From: G. Branden Robinson
Subject: [groff] 17/24: [ms]: Update documentation.
Date: Wed, 23 Aug 2023 05:30:58 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 4ddc18129d54a2e589e5d3f21d3cf181eac4f9e0
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Aug 23 02:24:47 2023 -0500

    [ms]: Update documentation.
    
    * Migrate terminology: terminals and typesetters.
    * Use active voice (and imperative mood when offering advice) more.
    * Tighten wording.
    * (groff_ms(7)) Update poor man's keeps.
---
 doc/groff.texi      | 24 ++++++++++++------------
 doc/ms.ms           | 17 +++++++++--------
 tmac/groff_ms.7.man | 19 +++++++++++--------
 3 files changed, 32 insertions(+), 28 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 6714d306c..21b64efad 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3021,7 +3021,7 @@ the bottom of a column or page.  This is a Berkeley 
extension.
 @table @code
 @item 0
 Set an automatic number@footnote{defined in @ref{ms Footnotes}} as a
-superscript (on typesetter devices) or surrounded by square brackets (on
+superscript (on typesetters) or surrounded by square brackets (on
 terminals).  The footnote paragraph is indented as with @code{PP} if
 there is an @code{FS} argument or an automatic number, and as with
 @code{LP} otherwise.  This is the default.
@@ -3276,9 +3276,9 @@ The @code{FAM} string, a GNU extension, sets the font 
family for body
 text; the default is @samp{T}.  The @code{PS} and @code{VS} registers
 set the type size and vertical spacing (distance between text
 baselines), respectively.  The font family and type size are ignored on
-terminal devices.  Setting these parameters before the first call of a
-heading, paragraphing, or (non-date) document description macro also
-applies them to headers, footers, and (for @code{FAM}) footnotes.
+terminals.  Set these parameters before the first call of a heading,
+paragraphing, or (non-date) document description macro to apply them to
+headers, footers, and (for @code{FAM}) footnotes.
 
 Which font families are available depends on the output device; as a
 convention, @code{T} selects a serif family (``Times''), @code{H} a
@@ -3592,15 +3592,15 @@ instead of bold.  This is a Research Tenth Edition Unix 
extension.
 @endDefmac
 
 @Defmac {BX, [@Var{text}], ms}
-Typeset @var{text} and draw a box around it.  On terminal devices,
-reverse video is used instead.  If you want @var{text} to contain space,
-use unbreakable space or horizontal motion escape sequences (@code{\~},
+Typeset @var{text} and draw a box around it.  On terminals, reverse
+video is used instead.  If you want @var{text} to contain space, use
+unbreakable space or horizontal motion escape sequences (@code{\~},
 @code{\@key{SP}}, @code{\^}, @code{\|}, @code{\0} or @code{\h}).
 @endDefmac
 
 @Defmac {UL, [@Var{text} [@Var{post}]], ms}
-Typeset @var{text} with an underline.  On terminal devices, @var{text}
-is bracketed with underscores `_'.  @var{post}, if present, is set after
+Typeset @var{text} with an underline.  On terminals, @var{text} is
+bracketed with underscores `_'.  @var{post}, if present, is set after
 @var{text} with no intervening space.
 @endDefmac
 
@@ -4616,9 +4616,9 @@ Many @code{groff} @file{ms} macros, including those for 
paragraphs,
 headings, and displays, cause a reset of paragraph rendering parameters,
 and may change the indentation; they do so not by incrementing or
 decrementing it, but by setting it absolutely.  This can cause problems
-for documents that define additional macros of their own that try to
-manipulate indentation.  Use the @file{ms} @code{RS} and @code{RE}
-macros instead of the @code{in} request.
+for documents that define additional macros of their own that manipulate
+indentation.  Use the @file{ms} @code{RS} and @code{RE} macros instead
+of the @code{in} request.
 
 @item
 @cindex fractional type sizes in @file{ms} macros
diff --git a/doc/ms.ms b/doc/ms.ms
index 83dcc2fae..d3d84931d 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -624,7 +624,7 @@ and
 registers use the larger value if the vertical motion quantum of the
 output device is too coarse for the smaller one;
 usually,
-this is the case only for output to terminals and emulators thereof.
+this is the case only for output to terminals.
 .
 .
 .\" ------------------------
@@ -929,11 +929,12 @@ registers set the type size and vertical spacing
 (distance between text baselines),
 respectively.
 .
-The font family and type size are ignored on terminal devices.
+The font family and type size are ignored on terminals.
 .
-Setting these parameters before the first call of a heading,
+Set these parameters before the first call of a heading,
 paragraphing,
-or (non-date) document description macro also applies them to headers,
+or (non-date) document description macro to apply them to
+headers,
 footers,
 and
 (for
@@ -1657,7 +1658,7 @@ and draw a
 .BX box
 around it.
 .
-On terminal devices,
+On terminals,
 reverse video is used instead
 (see the implementation note below).
 .
@@ -1681,7 +1682,7 @@ Typeset
 with an
 .UL underline .
 .
-On terminal devices,
+On terminals,
 .I text
 is bracketed with underscores (\[lq]_\[rq]).
 .
@@ -2968,7 +2969,7 @@ lf(CR) lx .
 _
 0      T{
 Set an automatic number as a superscript
-(on typesetter devices)
+(on typesetters)
 or surrounded by square brackets
 (on terminals).
 .
@@ -4069,7 +4070,7 @@ they do so not by incrementing or decrementing it,
 but by setting it absolutely.
 .
 This can cause problems for documents that define additional macros of
-their own that try to manipulate indentation.
+their own that manipulate indentation.
 .
 Use
 .CW .RS
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 6d50de180..ea93f8832 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -421,7 +421,7 @@ and
 registers use the larger value if the vertical motion quantum of the
 output device is too coarse for the smaller one;
 usually,
-this is the case only for output to terminals and emulators thereof.
+this is the case only for output to terminals.
 .
 The \[lq]gutter\[rq] affected by
 .B \[rs]n[MINGW]
@@ -637,11 +637,12 @@ registers set the type size and vertical spacing
 (distance between text baselines),
 respectively.
 .
-The font family and type size are ignored on terminal devices.
+The font family and type size are ignored on terminals.
 .
-Setting these parameters before the first call of a heading,
+Set these parameters before the first call of a heading,
 paragraphing,
-or (non-date) document description macro also applies them to headers,
+or (non-date) document description macro to apply them to
+headers,
 footers,
 and
 (for
@@ -891,6 +892,8 @@ resumes using the specified indices as their predecessors.
 This feature is a Berkeley extension.
 .
 .
+.br
+.ne 3v
 .P
 After
 .B .NH
@@ -1137,7 +1140,7 @@ Typeset
 .I text
 and draw a box around it.
 .
-On terminal devices,
+On terminals,
 reverse video is used instead.
 .
 If you want
@@ -1161,7 +1164,7 @@ Typeset
 .I text
 with an underline.
 .
-On terminal devices,
+On terminals,
 .I text
 is bracketed with underscores (\[lq]_\[rq]).
 .
@@ -1750,7 +1753,7 @@ or a specified
 .I marker
 argument,
 as a superscript
-(on typesetter devices)
+(on typesetters)
 or surrounded by square brackets
 (on terminals).
 .
@@ -2414,7 +2417,7 @@ they do so not by incrementing or decrementing it,
 but by setting it absolutely.
 .
 This can cause problems for documents that define additional macros of
-their own that try to manipulate indentation.
+their own that manipulate indentation.
 .
 Use
 .B .RS



reply via email to

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