diff options
author | G. Branden Robinson <g.branden.robinson@gmail.com> | 2023-01-16 10:43:15 -0600 |
---|---|---|
committer | G. Branden Robinson <g.branden.robinson@gmail.com> | 2023-01-17 16:16:01 -0600 |
commit | 7a90dadd6d83d78e962475e953c8eab654496153 (patch) | |
tree | 988278ee7fe68eaeaed4532ae9b85001be4deca6 /contrib/mm/groff_mm.7.man | |
parent | 2a2c0e23c558d30f387f84d9c742e2bbba4353d3 (diff) | |
download | groff-git-7a90dadd6d83d78e962475e953c8eab654496153.tar.gz |
groff_mm(7): Recast description of .AS.
* Use more descriptive metasyntactic variable names for parameters.
* Generalize; collected abstract "text" could conceivably include
drawing commands (or embedded EPS).
* Drop caveat about mixture of .COVER and .MT; this is now diagnosed.
* Describe what the indentation argument actually _does_.
* Document indentation defaults (scaling unit and value).
Diffstat (limited to 'contrib/mm/groff_mm.7.man')
-rw-r--r-- | contrib/mm/groff_mm.7.man | 45 |
1 files changed, 20 insertions, 25 deletions
diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man index 3b4ddc366..93c63fa16 100644 --- a/contrib/mm/groff_mm.7.man +++ b/contrib/mm/groff_mm.7.man @@ -623,32 +623,26 @@ are included in appendices. . .TP .BR AS\~ [\c -.IR arg \~[ indent ]] +.IR placement \~[ indentation ]] Abstract start; begin collecting abstract. . -Text up to the next +Input up to the next .B AE call is included in the abstract. . -Depending on the cover sheet macros used, -.I arg -influences the placement of the abstract. +.I placement +influences the location of the abstract on the cover sheet of a +memorandum +(see +.BR MT ). . -The default cover sheet style used when -.B .COVER -is called without arguments -(and -.B .MT -is not called at all) -places the abstract on the cover sheet and ignores -.IR arg . -. -. -.IP -The memorandum types interpret -.I arg -as follows. +.BR COVER , +by contrast, +ignores +.I placement +by default, +but can be customized to interpret it. . . .IP @@ -656,7 +650,7 @@ as follows. tab(@); lf(BI) lb l lx. -arg@Placement +placement@Effect 0@T{ The abstract is printed on page\~1 and on the cover sheet if used in the released-paper style @@ -692,12 +686,13 @@ but is not by . . .IP -The -.I indent -parameter controls the indentation of both margins; -otherwise normal text indentation is used. +A second argument increases the indentation and reduces the line length +by +.IR indentation . . -Its value is interpreted in ens by default. +A scaling unit of ens is assumed. +. +The default is\~0. . . .TP |