groff-commit
[Top][All Lists]
Advanced

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

[groff] 02/35: [man pages]: Update full-service package intros.


From: G. Branden Robinson
Subject: [groff] 02/35: [man pages]: Update full-service package intros.
Date: Fri, 16 Jul 2021 20:39:36 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit badf16a7b64ffa99eaa90cdf72434bb8b530a8ef
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Jul 13 21:04:24 2021 +1000

    [man pages]: Update full-service package intros.
    
    * contrib/mm/groff_mm.7.man (Description):
      - Describe the package's purpose (cribbed from groff_ms(7)).
      - Explain what "DWB" was.
      - Say "groff mm" when referring to particularities of this
        implementation.
      - Use non-breaking space in ISO standard identifiers.
      - Remove single-sentence paragraph explaining bracketed options in
        syntax synopses.  This is prerequisite knowledge for man page
        readers.
    
    * tmac/groff_mdoc.7.man (Description):
      - Recast introduction using complete sentences.
    
    * tmac/groff_me.7.man (Description):
      - Clarify that the GNU me implementation is based on 4.4BSD's (thanks
        to the permissive licensing).
    
    * contrib/mm/groff_mm.7.man (Description):
    * tmac/groff_man.7.man.in (Description):
    * tmac/groff_mdoc.7.man (Description):
    * tmac/groff_me.7.man (Description):
    * tmac/groff_ms.7.man (Description):
      Situate topic within context ("the groff document formatting system").
---
 contrib/mm/groff_mm.7.man | 45 ++++++++++++++++++++++++---------------------
 tmac/groff_man.7.man.in   |  8 +++++---
 tmac/groff_mdoc.7.man     | 17 ++++++++++-------
 tmac/groff_me.7.man       | 17 +++++++++--------
 tmac/groff_ms.7.man       |  4 ++--
 5 files changed, 50 insertions(+), 41 deletions(-)

diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index d2597b3..266517f 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -53,12 +53,27 @@ groff_mm \- memorandum macros for GNU roff
 .SH Description
 .\" ====================================================================
 .
+The GNU implementation of the
+.I mm
+macro package is part of the
+.I groff
+document formatting system.
+.
 The
-.IR groff (@MAN7EXT@)
 .I mm
-macros are intended to be compatible with the DWB
+package is suitable for the composition of
+letters,
+memoranda,
+reports,
+and books.
+.
+.
+.P
+.I groff mm
+is intended to be compatible with the
 .I mm
-macros with the following limitations.
+implementation found in the AT&T Documenter's Workbench (DWB),
+with the following limitations.
 .
 .
 .IP \[bu]
@@ -74,25 +89,22 @@ are not implemented.
 .
 .
 .IP \[bu]
-.I groff mm
-does not support cut marks.
+Cut marks are not supported.
 .
 .
 .LP
-.I m@TMAC_M_PREFIX@m
-is intended to support easy localization.
+.I groff mm
+is designed to support easy localization.
 .
 Use
 .I m@TMAC_M_PREFIX@mse
-as an example how to adapt the output format to a national standard.
+as an example of how to adapt the output format to a national standard.
 .
 Localized strings are collected in the file
 .IR @MACRODIR@/ xx .tmac ,
 where
 .I xx
-denotes the two-letter code for the
-.IR language ,
-as defined in the ISO 639 standard.
+is an ISO\~639 two-letter language identifier.
 .
 For Swedish,
 this is
@@ -101,27 +113,18 @@ this is
 not
 \[lq]se\[rq].
 .
-The ISO 639 language code,
-not the ISO 3166 territory code,
-is used.
-.
 .
 .LP
 A file called
 .I locale
 or
 .RI territory _locale
-is read after the initialization of the global variables.
+is read after package initialization.
 .
 It is therefore possible to localize the macros with a different company
 name and so on.
 .
 .
-.LP
-In this manual,
-square brackets are used to show optional arguments.
-.
-.
 .\" ====================================================================
 .SS "Number registers and strings"
 .\" ====================================================================
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index 0a06349..94e20cd 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -103,11 +103,13 @@ _endif()dnl
 .SH Description
 .\" ====================================================================
 .
-The
+The GNU implementation of the
 .I man
-macro package for
+macro package is part of the
 .I groff
-is used to produce manual pages
+document formatting system.
+.
+It is used to produce manual pages
 .\" We use an unbreakable space \~ here to keep the phrase intact for
 .\" its introduction; in subsequent discussion, that is not important.
 (\(lqman\~pages\(rq)
diff --git a/tmac/groff_mdoc.7.man b/tmac/groff_mdoc.7.man
index 5a44540..3e57dc9 100644
--- a/tmac/groff_mdoc.7.man
+++ b/tmac/groff_mdoc.7.man
@@ -65,17 +65,20 @@
 .
 .Sh Description
 .
-A complete reference for writing
-.Ux
-manual pages with the
+The GNU implementation of the
 .Nm mdoc
-macro package;
-a
+macro package is part of the
+.Nm groff
+document formatting system.
+.
+.Nm mdoc
+is a
 .Em content Ns -based
 and
 .Em domain Ns -based
-formatting package for
-.Tn GNU
+formatting package designed for writing
+.Ux
+manual pages with
 .Xr @g@troff @MAN1EXT@ .
 .
 Its predecessor,
diff --git a/tmac/groff_me.7.man b/tmac/groff_me.7.man
index 78cf07e..b468042 100644
--- a/tmac/groff_me.7.man
+++ b/tmac/groff_me.7.man
@@ -58,6 +58,12 @@ roff
 .SH Description
 .\" ====================================================================
 .
+The GNU implementation of the
+.I me
+macro package is part of the
+.I groff
+document formatting system.
+.
 The
 .I me
 package of macro definitions for the
@@ -65,16 +71,11 @@ package of macro definitions for the
 language provides a convenient facility for preparing technical papers
 in various formats.
 .
-This manual page describes the GNU version of the
+This version is based on the
 .I me
-macros, which is
-part of the
-.I groff
-document formatting system.
-.
-This version can be used with both GNU
+distributed with 4.4BSD and can be used with the GNU
 .I troff
-and Unix
+formatter as well as those descended from AT&T
 .IR troff .
 .
 .
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index c264ffe..ae2c65e 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -55,9 +55,9 @@ groff_ms \- GNU roff manuscript macro package for formatting 
documents
 .
 The GNU implementation of the
 .I ms
-macros is part of the
+macro package is part of the
 .I groff
-typesetting system.
+document formatting system.
 .
 The
 .I ms



reply via email to

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