groff-commit
[Top][All Lists]
Advanced

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

[groff] 06/35: [mm]: Update `MT` macro documentation.


From: G. Branden Robinson
Subject: [groff] 06/35: [mm]: Update `MT` macro documentation.
Date: Fri, 16 Jul 2021 20:39:38 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 7f6aef27fcd5bf0bdca5e3c2f7025d584dd9b5f8
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Jul 14 13:21:26 2021 +1000

    [mm]: Update `MT` macro documentation.
    
    * contrib/mm/NOTES: Explain `cov*mt-{type,addresse} strings more.
    
    * contrib/mm/groff_mm.7.man (Description/Macros) <MT>: Recast.
    
      (Files): Document actual files shipped instead of a glob pattern, and
      describe more precisely what the files do.
---
 contrib/mm/NOTES          |  4 ++--
 contrib/mm/groff_mm.7.man | 59 ++++++++++++++++++++++++++++++++++-------------
 2 files changed, 45 insertions(+), 18 deletions(-)

diff --git a/contrib/mm/NOTES b/contrib/mm/NOTES
index 06abd47..1c35133 100644
--- a/contrib/mm/NOTES
+++ b/contrib/mm/NOTES
@@ -78,8 +78,8 @@ cov*abstract          M       The abstract.
 
 cov*new-date           S       date (today if .ND not used)
 
-cov*mt-type            S       MT type
-cov*mt-addressee       S       MT addressee
+cov*mt-type            S       memorandum type set by .MT
+cov*mt-addressee       S       memorandum addressee set by .MT
 
 
 ##########################
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index 7ae4c1a..dc03f23 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -2167,42 +2167,56 @@ sets the indent and overrides
 .
 A third argument prohibits printing of a blank line before each item.
 .
+.
 .TP
-.BI MT\  "\fR[\fParg \fR[\fPaddressee\fR]]\fP"
+.B MT\~\c
+.RI [ number \~[ addressee ]]
 Memorandum type.
 .
 The argument
-.I arg
-is part of a filename in
-.IR @TMAC_MDIR@/ * .MT .
+.I number
+is used to construct the file name
+.IR @TMAC_MDIR@/ number .MT
+and load it with the
+.B mso
+request.
 .
-Memorandum types 0 to\~5 are supported, including type
-\[oq]string\[cq] (which gets internally mapped to type\~6).
+Memorandum types 0 to\~5 are supported;
+any other value of
+.I number
+is mapped to type\~6.
 .
-.I addressee
-just sets a variable, used in the AT&T macros.
+If
+.I number
+is omitted,
+.B 0
+is implied.
 .
-.IP
-.B arg
+.I addressee
+sets a string analogous to one used by AT&T cover sheet macros that are
+not implemented in
+.IR "groff mm" .
 .
 .RS
 .IP
 .TS
 tab(@);
-l l.
+lB l.
 0@Normal memorandum, no type printed.
-1@Memorandum with \[oq]MEMORANDUM FOR FILE\[cq] printed.
-2@Memorandum with \[oq]PROGRAMMER'S NOTES\[cq] printed.
-3@Memorandum with \[oq]ENGINEER'S NOTES\[cq] printed.
+1@Memorandum with \[lq]MEMORANDUM FOR FILE\[rq] printed.
+2@Memorandum with \[lq]PROGRAMMER'S NOTES\[rq] printed.
+3@Memorandum with \[lq]ENGINEER'S NOTES\[rq] printed.
 4@Released paper style.
 5@External letter style.
 .TE
 .RE
 .
+.
 .IP
 See also
 .BR COVER / COVEND ,
-a more flexible type of front page.
+a more flexible type of cover page.
+.
 .
 .TP
 .BI MOVE\  "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
@@ -4012,7 +4026,20 @@ then assigns the argument to the string variable
 .TP
 .IR @TMAC_MDIR@/ * .cov
 .TP
-.IR @TMAC_MDIR@/ * .MT
+.I @TMAC_MDIR@/0.MT
+implements memorandum types 0\[en]3 and 6.
+.
+.
+.TP
+.I @TMAC_MDIR@/4.MT
+implements memorandum type 4.
+.
+.
+.TP
+.I @TMAC_MDIR@/5.MT
+implements memorandum type 5.
+.
+.
 .TP
 .I @TMAC_MDIR@/locale
 .



reply via email to

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