groff-commit
[Top][All Lists]
Advanced

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

[groff] 29/41: [ms]: Fix style nits.


From: G. Branden Robinson
Subject: [groff] 29/41: [ms]: Fix style nits.
Date: Fri, 18 Mar 2022 00:41:31 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit e5c478a310178e196262f0e4bbf69e82b94041d1
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Mar 16 21:50:13 2022 +1100

    [ms]: Fix style nits.
    
    * doc/groff.texi:
    * doc/ms.ms:
    * tmac/groff_ms.7.man: Migrate from the verb "print" to more precise
      terms, like "typeset", or simply "set" where this is clear enough.
      Refer to `UL` macro arguments by name.  Clarify that ms(7) interprets
      the `UL` macro, not the formatter.  Perform minor recasts.
---
 doc/groff.texi      | 36 ++++++++++++++++++------------------
 doc/ms.ms           | 37 ++++++++++++++++++++-----------------
 tmac/groff_ms.7.man | 50 ++++++++++++++++++++++++++++++--------------------
 3 files changed, 68 insertions(+), 55 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index b5c656e4..f4931d5a 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3082,13 +3082,13 @@ reaching an @code{AU}, @code{AB}, or heading or 
paragraphing macro call.
 @endDefmac
 
 @Defmac {DA, [@Var{x} @dots{}], ms}
-Print the current date, or any arguments @var{x} in the center footer,
+Typeset the current date, or any arguments @var{x} in the center footer,
 and, if @code{RP} is also called, left-aligned after other document
 description information on the cover page.
 @endDefmac
 
 @Defmac {ND, [@Var{x} @dots{}], ms}
-Print the current date, or any arguments @var{x}, if @code{RP} is also
+Typeset the current date, or any arguments @var{x}, if @code{RP} is also
 called, left-aligned after other document description information on the
 cover page.  This is the @code{groff} @file{ms} default.
 @endDefmac
@@ -3451,35 +3451,35 @@ otherwise.  This is a Tenth Edition Research Unix 
extension.
 @endDefmac
 
 @Defmac {BX, [@Var{txt}], ms}
-Prints @var{txt} and draws a box around it.  On terminal devices,
+Typeset @var{txt} and draw a box around it.  On terminal devices,
 reverse video is used instead.  If you want the argument to contain
 space, use non-breaking space escape sequences of appropriate width
 (@code{\~}, @code{\^}, @code{\|}, @code{\0}) or @code{\h}.
 @endDefmac
 
 @Defmac {UL, [@Var{txt} [@Var{post}]], ms}
-Prints its first argument with an underline.  If you specify a second
-argument, @code{groff} prints it in the previous font after the
-underlined text, with no intervening space.
+Typeset @var{txt} with an underline.  If you specify @var{post},
+@file{ms} sets it in the previous font after the underlined text, with
+no intervening space.
 @endDefmac
 
 @Defmac {LG, , ms}
-Prints all text following in larger type (two points larger than the
+Set all subsequent text in larger type (two points larger than the
 current size) until the next font size, highlighting, paragraphing, or
 heading macro.  You can specify this macro multiple times to enlarge the
 type size as needed.
 @endDefmac
 
 @Defmac {SM, , ms}
-Prints all text following in smaller type (two points smaller than the
+Set all subsequent text in smaller type (two points smaller than the
 current size) until the next type size, highlighting, paragraphing, or
 heading macro.  You can specify this macro multiple times to reduce the
 type size as needed.
 @endDefmac
 
 @Defmac {NL, , ms}
-Prints all text following in the normal type size (that is, the value
-of the @code{PS} register).
+Set all text following at the normal type size (that is, the value of
+the @code{PS} register).
 @endDefmac
 
 @code{groff} @file{ms} also supports strings to begin and end super- and
@@ -4071,15 +4071,15 @@ pages; the @code{OF} and @code{EF} macros define 
footers for the odd and
 even pages.
 @endDefmac
 
-By default, @file{ms} prints no header on any page numbered ``1''
+By default, @file{ms} places no header on any page numbered ``1''
 (regardless of its assigned format).
 
 @Defmac {P1, , ms}
-Print the header on page@tie{}1.  To be effective, this macro must be
-called before the header trap is sprung on any page numbered ``1''; in
-practice, unless your page numbering is unusual, this means that you
-should call it early, before @code{TL} or any heading or paragraphing
-macro.  This is a Berkeley extension.
+Typeset the header even on page@tie{}1.  To be effective, this macro
+must be called before the header trap is sprung on any page numbered
+``1''; in practice, unless your page numbering is unusual, this means
+that you should call it early, before @code{TL} or any heading or
+paragraphing macro.  This is a Berkeley extension.
 @endDefmac
 
 For even greater flexibility, @file{ms} is designed to permit the
@@ -4089,7 +4089,7 @@ that ordinarily cause the headers and footers to be 
output are sprung.
 be written, and @code{BT} (``bottom trap'') when the footer is to be.
 The @code{groff} trap that @file{ms} sets up to process the header also
 calls the (normally undefined) @code{HD} macro after @code{PT}; you can
-define @code{HD} if you need additional processing after printing the
+define @code{HD} if you need additional processing after setting the
 header (for example, to draw a line below it).  The @code{HD} hook is a
 Berkeley extension.  Any such macros you (re)define must implement any
 desired specialization for odd-, even-, or first-numbered pages.
@@ -4429,7 +4429,7 @@ Uppercase 
 
 The @code{groff} @file{ms} macros are a complete re-implementation,
 using no original @acronym{AT&T} code.  Since they take advantage of the
-extended features in @code{groff}, they cannot be used with
+extended features of @code{groff}, they cannot be used with
 @acronym{AT&T} @code{troff}.  @code{groff} @file{ms} supports several
 features described above as Berkeley and Tenth Edition Research Unix
 extensions, and adds several of its own.
diff --git a/doc/ms.ms b/doc/ms.ms
index a74cc389..4b93dbae 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -576,7 +576,7 @@ or heading or paragraphing macro call.
 T}
 _
 \&.DA \f[R][\f[I]x\f[] .\|.\|.\&]      T{
-Print the current date,
+Typeset the current date,
 or any
 .I x , arguments\~
 in the center footer,
@@ -589,7 +589,7 @@ page.
 T}
 _
 \&.ND \f[R][\f[I]x\f[] .\|.\|.\&]      T{
-Print the current date,
+Typeset the current date,
 or any
 .I x , arguments\~
 if
@@ -1343,9 +1343,9 @@ This is a Tenth Edition Research Unix extension.
 T}
 _
 \&.BX [txt]    T{
-Prints
+Typeset
 .I txt
-and draws a
+and draw a
 .BX box
 around it.
 .
@@ -1364,21 +1364,24 @@ or
 T}
 _
 \&.UL [txt [post]]     T{
-Prints its first argument with an
+Typeset
+.I txt
+with an
 .UL underline .
 .
-If you specify a second argument,
-.I groff
-prints it in the previous font after the underlined text,
+If you specify
+.I post ,
+.I ms
+sets it in the previous font after the underlined text,
 with no intervening space.
 T}
 _
 \&.LG  T{
-Prints all text following in
+Set all subsequent text in
 .LG
 larger type
 .NL
-(2 points larger than the current size)
+(2\~points larger than the current size)
 until
 the next font size,
 highlighting,
@@ -1395,11 +1398,11 @@ to enlarge the type size as needed.
 T}
 _
 \&.SM  T{
-Prints all text following in
+Set all subsequent text in
 .SM
 smaller type
 .NL
-(2 points smaller than the current size)
+(2\~points smaller than the current size)
 until
 the next type size,
 highlighting,
@@ -1416,7 +1419,7 @@ to reduce the type size as needed.
 T}
 _
 \&.NL  T{
-Prints all text following in the normal type size
+Set all subsequent text at the normal type size
 (that is,
 the value of the
 .CW PS
@@ -2629,7 +2632,7 @@ T}
 .PP
 By default,
 .I ms
-prints no header on any page numbered \[lq]1\[rq]
+places no header on any page numbered \[lq]1\[rq]
 (regardless of its assigned format).
 .
 .
@@ -2640,7 +2643,7 @@ lf(CR) lx.
 Macro  Description
 _
 \&.P1  T{
-Print the header on page\~1.
+Typeset the header even on page\~1.
 .
 To be effective,
 this macro must be called before the header trap is sprung on any page
@@ -2687,7 +2690,7 @@ macro after
 .CW .PT ;
 you can define
 .CW .HD
-if you need additional processing after printing the header
+if you need additional processing after setting the header
 (for example,
 to draw a line below it).
 .
@@ -3089,7 +3092,7 @@ The
 macros are a complete re-implementation,
 using no original AT&T code.
 .
-Since they take advantage of the extended features in
+Since they take advantage of the extended features of
 .I groff ,
 they cannot be used with AT&T
 .I troff .
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index aa238cda..69662c46 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -549,7 +549,7 @@ or heading or paragraphing macro call.
 .TP
 .B .DA\c
 .RI "\~[" x "\~.\|.\|.]"
-Print the current date,
+Typeset the current date,
 or any
 .RI arguments\~ x ,
 in the center footer,
@@ -564,7 +564,7 @@ page.
 .TP
 .B .ND\c
 .RI "\~[" x "\~.\|.\|.]"
-Print the current date,
+Typeset the current date,
 or any
 .RI arguments\~ x ,
 if
@@ -1054,9 +1054,9 @@ This is a Tenth Edition Research Unix extension.
 .TP
 .B .BX\c
 .RI " [" txt ]
-Prints
+Typeset
 .I txt
-and draws a box around it.
+and draw a box around it.
 .
 On terminal devices,
 reverse video is used instead.
@@ -1074,37 +1074,47 @@ or
 .TP
 .B .UL\c
 .RI " [" txt " [" post ]]
-Prints its first argument with an underline.
+Typeset
+.I txt
+with an underline.
+.
+If you specify
+.IR post ,
+.I ms
+sets it in the previous font after the underlined text,
+with no intervening space.
 .
-If you specify a second argument,
-.I groff
-prints it in the previous font after the underlined text, with no
-intervening space.
 .
 .TP
 .B .LG
-Prints all text following in larger type
+Set all subsequent text in larger type
 (2\~points larger than the current size) until
-the next font size, highlighting, paragraph, or heading macro.
+the next font size,
+highlighting,
+paragraphing,
+or heading macro.
 .
 You can specify this macro multiple times to enlarge the type size as
 needed.
 .
 .TP
 .B .SM
-Prints all text following in
+Set all subsequent text in
 smaller type
 (2\~points smaller than the current size) until
-the next type size, highlighting, paragraph, or heading macro.
+the next type size,
+highlighting,
+paragraphing,
+or heading macro.
 .
 You can specify this macro multiple times to reduce the type size as
 needed.
 .
 .TP
 .B .NL
-Prints all text following in
-the normal type size
-(that is, the value of the
+Set all subsequent text at the normal type size
+(that is,
+the value of the
 .B PS
 register).
 .
@@ -1745,13 +1755,13 @@ macros define footers for the odd and even pages.
 .P
 By default,
 .I ms
-prints no header on any page numbered \[lq]1\[rq]
+places no header on any page numbered \[lq]1\[rq]
 (regardless of its assigned format).
 .
 .
 .TP
 .B .P1
-Print the header on page\~1.
+Typeset the header even on page\~1.
 .
 To be effective,
 this macro must be called before the header trap is sprung on any page
@@ -1790,7 +1800,7 @@ macro after
 .BR .PT ;
 you can define
 .B .HD
-if you need additional processing after printing the header.
+if you need additional processing after setting the header.
 .
 The
 .B HD
@@ -2190,7 +2200,7 @@ The
 macros are a complete re-implementation,
 using no original AT&T code.
 .
-Since they take advantage of the extended features in
+Since they take advantage of the extended features of
 .IR groff ,
 they cannot be used with AT&T
 .IR troff .



reply via email to

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