groff-commit
[Top][All Lists]
Advanced

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

[groff] 11/13: [ms]: Fix documentation nits.


From: G. Branden Robinson
Subject: [groff] 11/13: [ms]: Fix documentation nits.
Date: Wed, 27 Apr 2022 15:39:23 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit e252ec480b2f377933fceb0b0e7046ab3cc32608
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Apr 28 01:19:30 2022 +1000

    [ms]: Fix documentation nits.
    
    * Fix characterization of the man(7) package; it was not intended
      specifically for use with terminals, but for typeset output as well.
    * Tighten wording.
---
 doc/groff.texi      |  9 ++++-----
 doc/ms.ms           | 10 +++++-----
 tmac/groff_ms.7.man |  4 ++--
 3 files changed, 11 insertions(+), 12 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 822ebfae..29f69402 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -2553,9 +2553,8 @@ systems.@footnote{Although manual pages are even older, 
the @file{man}
 macros originated in Seventh Edition Unix (1979).  @file{ms} shipped
 with Sixth Edition (1975) and was documented by Mike Lesk in a Bell Labs
 internal memorandum.}  While the @file{man} package was designed for
-brief documents to be perused at a terminal, the @file{ms} macros are
-also suitable for longer documents intended for printing and possible
-publication.
+brief reference documents, the @file{ms} macros are also suitable for
+longer works intended for printing and possible publication.
 
 The @file{ms} macro package included with @code{groff} is an independent
 reimplementation.  Some macros specific to @acronym{AT&T} or Berkeley
@@ -3765,8 +3764,8 @@ in a diversion (keep).
 boxed keep.
 @endDefmac
 
-Box macros cause line breaks; if you need to box a word or phrase within
-a line, see the @code{BX} macro in @ref{Highlighting in ms}.  Box lines
+Box macros cause breaks; if you need to box a word or phrase within a
+line, see the @code{BX} macro in @ref{Highlighting in ms}.  Box lines
 are drawn as close as possible to the text they enclose so that they are
 usable within paragraphs.  If you wish to box one or more paragraphs,
 you may improve the appearance by calling @code{B1} after the first
diff --git a/doc/ms.ms b/doc/ms.ms
index 9df17ac0..263ba59b 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -106,10 +106,10 @@ Bell Labs internal memorandum.
 .
 While the
 .I man
-package was designed for brief documents to be perused at a terminal,
+package was designed for brief reference documents,
 the
 .I ms
-macros are also suitable for longer documents intended for printing and
+macros are also suitable for longer works intended for printing and
 possible publication.
 .
 .
@@ -205,7 +205,7 @@ Longer documents have a structure as follows.
 .
 .IP "\fBDocument type\fP"
 Calling the
-.CW .RP
+.CW RP
 macro at the beginning of your document puts the document description
 (see below)
 on a cover page.
@@ -1831,7 +1831,7 @@ macros for this purpose.
 .
 .PP
 You can alternatively specify a
-.I "floating keep" ;
+.I "floating keep;"
 if a keep cannot fit on the current page,
 .I ms
 holds its contents and allows material following the keep
@@ -1894,7 +1894,7 @@ _
 .
 .
 .LP
-Box macros cause line breaks;
+Box macros cause breaks;
 if you need to box a word or phrase within a line,
 see the
 .CW BX
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 708dc394..f9a85771 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1181,7 +1181,7 @@ This can cause a page break to occur earlier than it 
normally would.
 .
 .P
 You can alternatively specify a
-.IR "floating keep" ;
+.I floating keep;
 if a keep cannot fit on the current page,
 .I ms
 holds its contents and allows text following the keep
@@ -1236,7 +1236,7 @@ End boxed keep.
 .
 .
 .P
-Box macros cause line breaks;
+Box macros cause breaks;
 if you need to box a word or phrase within a line,
 see the
 .B BX



reply via email to

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