groff-commit
[Top][All Lists]
Advanced

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

[groff] 08/10: [ms]: Fix erroneous claim in documentation.


From: G. Branden Robinson
Subject: [groff] 08/10: [ms]: Fix erroneous claim in documentation.
Date: Wed, 17 Mar 2021 02:48:52 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit f33b9bd4d956806b0231256e0d7f10cc2a49107c
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Mar 17 14:42:40 2021 +1100

    [ms]: Fix erroneous claim in documentation.
    
    * doc/groff.texi:
    * doc/ms.ms: The original Lesk ms paper was not, as far as I can tell,
      published in CACM.  I either confused it with another paper or have
      lost track of my supporting material.  Correct the history of the ms
      macros to what I can support with documentary evidence.  Error
      introduced by me in ece515ea1679b29dfbfcd24728aa1b81b94e55b4, 28
      October 2020.
    
      Update and synchronize the introduction and (ms.ms) abstract.
---
 doc/groff.texi | 24 +++++++--------
 doc/ms.ms      | 96 ++++++++++++++++++++++++++++++----------------------------
 2 files changed, 62 insertions(+), 58 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 9bf570a..c5f46e0 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -2475,11 +2475,11 @@ documentation.
 @section @file{ms}
 @cindex @code{ms} macros
 
-The @code{ms} (``manuscript'') macros are suitable for reports, letters,
-memoranda, books, user manuals, and so forth.  The package provides
-macros for cover page and table of contents generation, section
+The @code{ms} (``manuscript'') package is suitable for the preparation
+of reports, letters, memoranda, books, and manuals.  These @code{groff}
+macros support cover page and table of contents generation, section
 headings, multiple paragraph styles, text styling (including font
-changes), lists, footnotes, pagination, and indexing.
+changes), lists, footnotes, pagination control, and indexing.
 
 @code{ms} supports the @command{tbl}, @command{eqn}, @command{pic}, and
 @command{refer} preprocessors for inclusion of tables, mathematical
@@ -2502,18 +2502,18 @@ equations, diagrams, and standardized bibliographic 
citations.
 @subsection Introduction to @file{ms}
 
 The @file{ms} macros are the oldest surviving macro package for
-@code{roff} systems.@footnote{Although man @emph{pages} are even older,
-the @file{man} macro language dates back only to Seventh Edition Unix
-(1979).  @file{ms} was documented by Mike Lesk in an article for the
-@slanted{Communications of the ACM} in 1974.}  While the @file{man}
-package was intended for brief documents to be perused at a terminal,
-the @file{ms} macros are also suitable for longer documents intended for
+@code{roff} systems.@footnote{Although manual pages are even older, the
+@file{man} macro language 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.
 
 The @file{ms} macro package included with @code{groff} is a complete
 re-implementation.  Some macros specific to @acronym{AT&T} or Berkeley
-are not included, while several new commands been introduced.
-@xref{Differences from AT&T ms}.
+@file{ms} are not included, while several features have been added; see
+@ref{Differences from AT&T ms}.
 
 If you're in a hurry to get started, you need only know that @code{ms}
 needs one of its macros called at the beginning of a document so that it
diff --git a/doc/ms.ms b/doc/ms.ms
index 9061742..7af24c3 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -36,39 +36,41 @@ Larry Kollar
 .AI
 kollar@alltel.net
 .AB no
-This document describes the
-.Acr GNU
-re-implementation of the popular
-.I ms
-macro package.
-.
-.
-.PP
 The
 .I ms
-macros are suitable for reports,
+(\[lq]manuscript\[rq]) package is suitable for the preparation
+of reports,
 letters,
+memoranda,
 books,
-user manuals,
-and so forth.
+and manuals.
 .
-The package provides macros for cover pages,
-section headings,
-paragraphs,
+These
+.I groff
+macros support cover page and table of contents generation,
+section
+headings,
+multiple paragraph styles,
+text styling
+(including font changes),
 lists,
 footnotes,
-pagination,
-and a table of contents.
+pagination control,
+and indexing.
 .
 .
 .PP
-This document provides both tutorial and reference material.
-.
-It also discusses differences from the
-.Acr AT&T
 .I ms
-macros,
-both omissions and additions.
+supports the
+.I tbl ,
+.I eqn ,
+.I pic ,
+and
+.I refer
+preprocessors for inclusion of tables,
+mathematical equations,
+diagrams,
+and standardized bibliographic citations.
 .AE
 .
 .
@@ -81,23 +83,30 @@ Introduction
 .
 .
 .LP
-The original
+The
 .I ms
-macros were included with
-.Acr AT&T
-.I troff
-alongside the
+macros are the oldest surviving macro package for
+.I roff
+systems.\**
+.
+.FS
+Although manual pages are even older,
+the
 .I man
-macros.
+macro language originated in Seventh Edition Unix (1979).
+.
+.I ms
+shipped with Sixth Edition (1975) and was documented by Mike Lesk in a
+Bell Labs internal memorandum.
+.FE
 .
 While the
 .I man
-package is intended for brief documents that can be read on-line as well
-as printed,
+package was designed for brief documents to be perused at a terminal,
 the
 .I ms
-macros are suitable for longer documents that are meant to be printed
-rather than read on-line.
+macros are also suitable for longer documents intended for printing and
+possible publication.
 .
 .
 .PP
@@ -105,24 +114,19 @@ The
 .I ms
 macro package included with
 .I groff
-is a complete,
-bottom-up re-implementation.
+is a complete re-implementation.
 .
-Several macros
-(specific to
+Some macros
+specific to
 .Acr AT&T
-or Berkeley)
+or Berkeley
+.I ms
 are not included,
-while several new commands are.
-.
-See
-.I
-Differences from
+while several features have been added;
+see section \[lq]Differences from
 .Acr AT&T
-ms\c
-.R
-, later in this document,
-for more information.
+.I ms \[rq]
+below.
 .
 .
 .PP



reply via email to

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