[groff] 04/12: groff_mm(7): Document more features.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 29c67b57a01b78ac833abfa5574bd9a547d390ca
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Aug 1 19:52:59 2022 -0500

    groff_mm(7): Document more features.
    
    * contrib/mm/groff_mm.7.man: Document more features.
      (Macros) <)E, VM>: Document these DWB mm internals as exposed by groff
      mm.
      (Macros) <B1, B2, MC>: Document as GNU extensions.
      (Strings) <BU, Ci, F>: Document.
      (Registers) <:R, Au, Ex, Fg, H8...H14, Oc, S>: Document.
    
    Also relocate Le, Lf, Lt, Lx registers to be in lexicographic order, and
    set them with `TP` and `TQ` macros instead of an ad hoc list.  Also
    recast their description.
---
 contrib/mm/ChangeLog      |   9 +++
 contrib/mm/groff_mm.7.man | 138 ++++++++++++++++++++++++++++++++++++++++++----
 2 files changed, 135 insertions(+), 12 deletions(-)

diff --git a/contrib/mm/ChangeLog b/contrib/mm/ChangeLog
index 47a97cf36..25fed3c17 100644
--- a/contrib/mm/ChangeLog
+++ b/contrib/mm/ChangeLog
@@ -1,3 +1,12 @@
+2022-08-01  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       * groff_mm.7.man: Document more features.
+       (Macros) <)E, VM>: Document these DWB mm internals as exposed by
+       groff mm.
+       (Macros) <B1, B2, MC>: Document as GNU extensions.
+       (Strings) <BU, Ci, F>: Document.
+       (Registers) <:R, Au, Ex, Fg, H8...H14, Oc, S>: Document.
+
 2022-07-29  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        * groff_mm.7.man: Document further differences between DWB mm
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man
index bfe20c42a..b2884f98c 100644
--- a/contrib/mm/groff_mm.7.man
+++ b/contrib/mm/groff_mm.7.man
@@ -442,7 +442,12 @@ which is either\~0 or in the range 1 to\~7.
 See also
 .BR .H .
 .
-This macro is used for customized tables of contents.
+This undocumented DWB
+.I mm
+macro is exposed by
+.I groff mm
+to enable customized tables of contents.
+.
 .
 .TP
 .BR 1C\  [ 1 ]
@@ -721,12 +726,16 @@ kept display.
 The text is indented one character,
 and the right margin is one character shorter.
 .
+This is a GNU extension.
+.
 .
 .TP
 .B B2
 End boxed,
 kept display.
 .
+This is a GNU extension.
+.
 .
 .TP
 .B BE
@@ -2428,7 +2437,9 @@ is the space between two columns.
 Default separation is
 .IR column-size /15.
 .
-See also
+.
+This is a GNU extension;
+see also
 .BR 1C .
 .
 .
@@ -3473,6 +3484,13 @@ are defined if using
 .B \-T
 and setting top and/or bottom margin to less than the default.
 .
+This undocumented DWB
+.I mm
+macro is exposed by
+.I groff mm
+to increase user control of page layout.
+.
+.
 .TP
 .BI WA\  "\fR[\fPwriter-name \fR[\fPtitle\fR]]\fP"
 Begin specification of the writer and writer's address.
@@ -3545,6 +3563,20 @@ The current appendix text.
 .
 .
 .TP
+.B BU
+bullet
+(see
+.B BL
+macro)
+.
+.
+.TP
+.B Ci
+list of indentation amounts to use for table of contents heading levels,
+overriding automatic computation
+.
+.
+.TP
 .B DT
 The date;
 set by the
@@ -3566,6 +3598,12 @@ register.
 .B EM
 Em dash string
 .
+.
+.TP
+.B F
+auto-incrementing footnote marker
+.
+.
 .TP
 .B H1txt
 Updated by
@@ -3832,6 +3870,13 @@ Always\~1.
 .
 .
 .TP
+.B :R
+auto-incrementing reference counter;
+see
+.B RS
+.
+.
+.TP
 .B Aph
 Print an appendix page for every new appendix if this register
 is non-zero.
@@ -3841,6 +3886,20 @@ No output occurs if
 is zero,
 but there is always an appendix entry in the \[lq]List of contents\[rq].
 .
+.
+.TP
+.B Au
+includes supplemental author information
+(the third and subsequent arguments to
+.B AU )
+in memorandum \[lq]from\[rq] information.
+.
+It defaults
+.RB to\~ 1 ;
+.BR 0 \~excludes
+the information.
+.
+.
 .TP
 .B Cl
 Contents level (in the range 0 to 14).
@@ -3918,15 +3977,34 @@ set to\~1.
 .
 Default is\~0.
 .
+.
+.TP
+.B Ex
+auto-incrementing exhibit counter;
+see
+.B EX
+.
+.
+.TP
+.B Fg
+auto-incrementing figure counter;
+see
+.B FG
+.
+.
 .TP
 .B Fs
 Footnote spacing.
 .
 Default is\~1.
 .
+.
 .TP
-.B "H1 \(en H7"
-Heading counters
+.BR H1 \|.\|.\|.\| H14
+auto-incrementing heading counters;
+see
+.B H
+.
 .
 .TP
 .B H1dot
@@ -4091,6 +4169,29 @@ above.
 .B L
 Page length, only for command-line settings.
 .
+.
+.TP
+.B Le
+.TQ
+.B Lf
+.TQ
+.B Lt
+.TQ
+.B Lx
+enable (1) or disable (0) the inclusion of lists of equations.
+figures,
+tables,
+and exhibits,
+respectively.
+.
+All default
+.RB to\~ 1
+except
+.BR Le ,
+which defaults
+.RB to\~ 0 .
+.
+.
 .TP
 .B Letwam
 Maximum lines in return-address, used in
@@ -4098,14 +4199,6 @@ Maximum lines in return-address, used in
 .
 Default is\~14.
 .
-.TP
-.BR Lf ,\  Lt ,\  Lx ,\  Le
-Enable (1) or disable (0) the printing of List of figures,
-.
-List of tables, List of exhibits and List of equations, respectively.
-.
-Default values are Lf=1, Lt=1, Lx=1, and Le=0.
-.
 .
 .TP
 .B Li
@@ -4201,6 +4294,17 @@ Default is\~0.
 .B O
 Page offset, only for command-line settings.
 .
+.
+.TP
+.B Oc
+controls the presence of page numbers in the table of contents.
+.
+The default
+.RB is\~ 0 ,
+which numbers the pages with Arabic numerals;
+any positive value suppresses them.
+.
+.
 .TP
 .B Of
 Format of figure, table, exhibit, and equation titles.
@@ -4296,6 +4400,16 @@ Set default value for second argument of
 .
 Default is\~0.
 .
+.
+.TP
+.B S
+defines the type size for the document in (scaled) points,
+and must be set from the command line.
+.
+.\" FIXME: This is a defect.  It should be 120%.
+The vertical spacing is set two points larger.
+.
+.
 .TP
 .B Sectf
 A flag controlling \[lq]section-figures\[rq] numbering style.