Debian Codegraph @

upstream/debian-unstable/man7/groff_mm.7

raw
1 '\" t
2 .TH groff_mm 7 "2026-04-22" "groff 1.24.1"
3 .SH Name
4 groff_mm \- memorandum macros for GNU
5 .I roff
6 .
7 .
8 .\" ====================================================================
9 .\" Legal Terms
10 .\" ====================================================================
11 .\"
12 .\" Copyright 1989-2019 Free Software Foundation, Inc.
13 .\" 2020-2026 G. Branden Robinson
14 .\"
15 .\" This file is part of mm, a reimplementation of the Documenter's
16 .\" Workbench (DWB) troff memorandum macro package for use with GNU
17 .\" troff.
18 .\"
19 .\" mm is distributed with groff, the GNU roff typesetting system.
20 .\"
21 .\" Permission is granted to make and distribute verbatim copies of this
22 .\" manual provided the copyright notice and this permission notice are
23 .\" preserved on all copies.
24 .\"
25 .\" Permission is granted to copy and distribute modified versions of
26 .\" this manual under the conditions for verbatim copying, provided that
27 .\" the entire resulting derived work is distributed under the terms of
28 .\" a permission notice identical to this one.
29 .\"
30 .\" Permission is granted to copy and distribute translations of this
31 .\" manual into another language, under the above conditions for
32 .\" modified versions, except that this permission notice may be
33 .\" included in translations approved by the Free Software Foundation
34 .\" instead of in the original English.
35 .
36 .
37 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
38 .do nr *groff_groff_mm_7_man_C \n[.cp]
39 .cp 0
40 .
41 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
42 .nr do-fallback 0
43 .if !\n(.f .nr do-fallback 1 \" mandoc
44 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
45 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
46 .if \n[do-fallback] \{\
47 . de MR
48 . ie \\n(.$=1 \
49 . I \%\\$1
50 . el \
51 . IR \%\\$1 (\\$2)\\$3
52 . .
53 .\}
54 .rr do-fallback
55 .
56 .
57 .\" ====================================================================
58 .SH Synopsis
59 .\" ====================================================================
60 .
61 .SY "groff \-m\%m"
62 .RI [ option\~ .\|.\|.\&]
63 .RI [ file\~ .\|.\|.]
64 .YS
65 .
66 .SY "groff \-m m\%m"
67 .RI [ option\~ .\|.\|.\&]
68 .RI [ file\~ .\|.\|.]
69 .YS
70 .
71 .
72 .\" ====================================================================
73 .SH Description
74 .\" ====================================================================
75 .
76 The
77 .I mm
78 macro package distributed with the
79 .I groff
80 document formatting system
81 is suitable for the composition of
82 letters,
83 memoranda,
84 reports,
85 and books.
86 .
87 .
88 .P
89 Call an
90 .I mm
91 macro at the beginning of a document to initialize the package.
92 .
93 A simple
94 .I mm
95 document might use only
96 .B P
97 for paragraphing.
98 .
99 Set numbered and unnumbered section headings with
100 .B H
101 and
102 .BR HU ,
103 respectively.
104 .
105 Change the style of the typeface with
106 .BR B ,
107 .BR I ,
108 and
109 .BR R ;
110 you can alternate styles within a word with
111 .BR BI ,
112 .BR BR ,
113 .BR IB ,
114 .BR IR ,
115 .BR RB ,
116 and
117 .BR RI .
118 .
119 Several nestable list types are available via
120 .BR AL ,
121 .BR BL ,
122 .BR BVL ,
123 .BR DL ,
124 .BR ML ,
125 .BR RL ,
126 and
127 .BR VL ;
128 each of these begins a list,
129 to which
130 .B LI
131 adds an item and
132 .B LE
133 ends the (nested) list.
134 .
135 .B LB
136 begins a list with customizable layout parameters.
137 .
138 .B DS
139 and
140 .B DF
141 start static and floating displays,
142 respectively;
143 .B DE
144 terminates either.
145 .
146 .
147 .P
148 .I groff mm
149 is intended to be compatible with the
150 .I mm
151 implementation found in the AT&T Documenter's Workbench 3.3
152 (\[lq]DWB\[rq]),
153 with the following limitations and changes.
154 .
155 .
156 .IP \[bu] 3n
157 Omitted features include
158 the logo and company name strings,
159 .B }Z
160 and
161 .BR ]S ,
162 respectively;
163 the encoded company site location addresses recognized as the third
164 argument to the
165 .B AU
166 macro;
167 the
168 .B Pv
169 (\[lq]private\[rq] heading)
170 register;
171 and the
172 .B OK
173 (other keywords)
174 and
175 .B PM
176 (proprietary markings)
177 macros.
178 .
179 .
180 .IP \[bu]
181 .I "groff mm"
182 implements the
183 .B CS
184 (output cover page or \[lq]sheet\[rq])
185 macro only for memorandum type 4.
186 .
187 .
188 .IP \[bu]
189 The
190 .I grap
191 preprocessor is not explicitly supported;
192 .I "groff mm"
193 defines no
194 .B G1
195 or
196 .B G2
197 macros.
198 .
199 .
200 .IP \[bu]
201 Registers
202 .BR A ,
203 .BR C ,
204 .BR T ,
205 and
206 .BR U ,
207 set from the
208 .I troff \" generic
209 or
210 .I nroff \" generic
211 command lines with DWB,
212 are not recognized.
213 .
214 .
215 .IP \[bu]
216 When setting the registers
217 .B L
218 or
219 .B W
220 from the command line,
221 use an explicit scaling unit to avoid surprises.
222 .
223 .
224 .IP \[bu]
225 The
226 .B Le
227 register defaults to
228 .BR 1 ,
229 consistently with
230 .BR Lf ,
231 .BR Lt ,
232 and
233 .B Lx
234 in DWB;
235 equations captioned with
236 .B EC
237 appear in tables of contents produced by
238 .BR TC .
239 .
240 .
241 .IP \[bu]
242 The
243 .B Li
244 register configures the text indentation of
245 .B RL
246 list items;
247 DWB used a hard-coded value of 6\~ens.
248 .
249 .
250 .IP \[bu]
251 .I "groff mm"
252 uses the same adjustment and font style defaults in
253 .I nroff
254 and
255 .I troff
256 modes.
257 .
258 .
259 .IP \[bu]
260 Cut marks are not supported.
261 .
262 .
263 .P
264 DWB supported only seven heading levels.
265 .
266 As a compatible extension,
267 .I groff mm
268 supports fourteen,
269 introducing new registers
270 .B H8
271 through
272 .BR H14 ,
273 and affecting the interpretation of the
274 .B HF
275 and
276 .B HP
277 strings.
278 .
279 .
280 .P
281 .I "groff mm"
282 features a citation
283 (or \[lq]bookmark\[rq])
284 system,
285 permitting the document to make (customizable) internal references like
286 \[lq]See chapter 5,
287 page 128.\[rq].
288 .
289 Forward references require two-pass formatting.
290 .
291 See the
292 .B INITR
293 macro description below
294 and
295 .MR mmroff 1 .
296 .
297 .
298 .P
299 Macro,
300 register,
301 and string descriptions in this page frequently mention each other;
302 most references are to macros.
303 .
304 Where a register or string is referenced,
305 its type is explicitly identified.
306 .
307 .IR mm 's
308 macro names are usually in full capitals;
309 registers and strings tend to have mixed-case names.
310 .
311 .
312 .P
313 Except where noted,
314 .I mm
315 assumes that horizontal measurements are reckoned in ens
316 (scaling unit
317 .BR n )
318 and vertical ones in vees
319 (scaling unit
320 .BR v ).
321 .
322 .I "groff mm"
323 permits use of non-integral
324 .I "typographical points"
325 (scaling unit
326 .BR z ).
327 .
328 Use explicit scaling units for clarity and predictable behavior.
329 .
330 .
331 .\" ====================================================================
332 .SS "Document styles"
333 .\" ====================================================================
334 .
335 .I groff mm
336 offers three frameworks for document organization.
337 .
338 .BR \%COVER /\: \%COVEND
339 is a flexible means of preparing any document requiring a cover page.
340 .
341 .BR LT / LO
342 aids preparation of typical Anglophone correspondence
343 (business letters,
344 for example).
345 .
346 The
347 .B MT
348 memorandum type mechanism implements a group of formal styles
349 historically used by AT&T Bell Laboratories.
350 .
351 Your document can select at most one of these approaches;
352 when used,
353 each disables the others.
354 .
355 .
356 .\" ====================================================================
357 .SS Localization
358 .\" ====================================================================
359 .
360 .I groff mm
361 is designed to be easily localized.
362 .
363 For languages other than English,
364 strings that can appear in output are collected in the file
365 .IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\: xx \:.tmac ,
366 where
367 .I xx
368 is an ISO\~639 two-letter language identifier.
369 .
370 Localization packages should be loaded after
371 .IR mm ;
372 for example,
373 you might format a Swedish
374 .I mm
375 document with the command
376 .RB \[lq] "groff \-mm \-msv" \[rq].
377 .
378 .
379 .P
380 This package can also be localized by site or territory;
381 for example,
382 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:\%mse\:.tmac
383 illustrates how to adapt the output to a national standard using its
384 ISO\~3166 territory code.
385 .
386 Such a package can define a string that causes a macro file
387 .IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:mm/\:\% territory _locale
388 to be loaded at package initialization.
389 .
390 If this mechanism is not used,
391 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:mm/\:\%locale
392 is loaded instead.
393 .
394 No diagnostic is produced if these files do not exist.
395 .
396 .
397 .\" ====================================================================
398 .SS "Registers and strings"
399 .\" ====================================================================
400 .
401 Much
402 .I mm
403 behavior can be configured by registers and strings.
404 .
405 The
406 .B nr
407 request assigns a value to a register.
408 .
409 .
410 .RS
411 .P
412 .B .nr
413 .I ident
414 .RB [ \[+-] ]\c
415 .I n
416 .RI [ i ]
417 .RE
418 .
419 .
420 .P
421 .I ident
422 is the name of the register,
423 and
424 .IR n \~is
425 the value to be assigned.
426 .
427 Prefixing
428 .I n
429 with
430 a plus or minus sign increments or decrements (respectively) its
431 existing value.
432 .
433 If assignment of a (possibly) negative
434 .IR n \~is
435 required,
436 further prefix it with a zero or enclose it in parentheses.
437 .
438 If
439 .IR i \~is
440 specified,
441 the register's value automatically changes
442 .RI by \~i
443 prior to interpolation if a plus or minus sign is included in the escape
444 sequence as follows.
445 .
446 .
447 .RS
448 .P
449 .B \[rs]n\c
450 .RB [ \[+-] ]\c
451 .BI [ ident ]
452 .RE
453 .
454 .
455 .P
456 .IR i \~can
457 be negative;
458 it combines algebraically with the sign in the interpolation escape
459 sequence.
460 .
461 The brackets around
462 .I ident
463 are literal.
464 .
465 .
466 .P
467 Many of the registers
468 .I mm
469 provides are as Boolean-valued,
470 meaning that they are considered \[lq]true\[rq]
471 (on,
472 enabled)
473 when they have a positive value,
474 and \[lq]false\[rq]
475 (off,
476 disabled)
477 otherwise.
478 .
479 .
480 .P
481 Define strings with the
482 .B ds
483 request.
484 .
485 .
486 .RS
487 .P
488 .B .ds
489 .I ident contents
490 .RE
491 .
492 .
493 .P
494 .I contents
495 consumes everything up to the end of the line,
496 including trailing spaces.
497 .
498 It is a good practice to end
499 .I contents
500 with a comment escape sequence
501 .RB ( \[rs]\[dq] )
502 so that extraneous spaces do not intrude during document maintenance.
503 .
504 To include leading spaces in
505 .IR contents ,
506 prefix it with a double quote.
507 .
508 Interpolate strings with the
509 .B \[rs]*
510 escape sequence.
511 .
512 .
513 .RS
514 .P
515 .B \[rs]*\c
516 .BI [ ident ]
517 .RE
518 .
519 .
520 .P
521 Register and string name spaces are distinct,
522 but strings and macros share a name space.
523 .
524 Defining a string with the same name as an
525 .I mm
526 macro is not supported and may cause incorrect rendering,
527 the emission of diagnostic messages,
528 and an error exit status from
529 .IR \%troff .
530 .
531 .
532 .\" ====================================================================
533 .SS "Register format"
534 .\" ====================================================================
535 .
536 A register is interpolated using Arabic numerals if no other format has
537 been assigned to it.
538 .
539 Assign a format to a register with the
540 .B af
541 request.
542 .
543 .
544 .RS
545 .LP
546 .BI .af\~ "R c"
547 .RE
548 .
549 .
550 .LP
551 .IR R \~is
552 the name of the register,
553 and
554 .IR c \~is
555 the format.
556 .
557 If
558 .IR c \~is
559 a sequence of Arabic numerals,
560 their quantity defines a zero-padded minimum width for the interpolated
561 register value.
562 .
563 .
564 .RS
565 .LP
566 .TS
567 tab(@);
568 lb lb
569 l l.
570 Form@Sequence
571 1@0, 1, 2, 3, .\|.\|., 10, .\|.\|.
572 001@000, 001, 002, 003, .\|.\|., 1000, .\|.\|.
573 i@0, i, ii, iii, iv, .\|.\|.
574 I@0, I, II, III, IV, .\|.\|.
575 a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|.
576 A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.
577 .TE
578 .RE
579 .
580 .
581 .\" ====================================================================
582 .SS Fonts
583 .\" ====================================================================
584 .
585 .I mm
586 assumes that the font styles
587 .BR R \~(roman),
588 .BR I \~(italic),
589 and
590 .BR B \~(bold)
591 are mounted at font positions
592 .BR 1 ,
593 .BR 2 ,
594 .RB and\~ 3 ,
595 respectively.
596 .
597 Use the
598 .B fp
599 request to mount substitute fonts at these positions as desired.
600 .
601 The default font family is
602 .RB \[lq] T \[rq]
603 (Times).
604 .
605 To select a different one,
606 invoke
607 .IR groff 's
608 .B fam
609 request or use its
610 .B \-f
611 command-line option.
612 .
613 .
614 .\" ====================================================================
615 .SH Macros
616 .\" ====================================================================
617 .
618 Double-quote macro arguments that contain space characters.
619 .
620 An explicitly empty argument may be specified
621 with an empty pair of double quotes;
622 for example,
623 the following macro call has three arguments.
624 .
625 .
626 .P
627 .RS
628 .EX
629 \&.XX \[dq]foo bar\[dq] \[dq]\[dq] baz
630 .EE
631 .RE
632 .
633 .
634 .P
635 Some macros are documented as causing a page break;
636 this does not occur if such a macro is called when the drawing position
637 is already at the top of a page
638 (after a page heading,
639 if any).
640 .
641 .
642 .P
643 .I Hook
644 macros are undefined by default;
645 .I mm
646 calls them to enable customization of its behavior.
647 .
648 (DWB termed these \[lq]exits\[rq].)
649 .
650 .
651 .P
652 Macro names longer than two characters are extensions;
653 some shorter names were not part of DWB's
654 published interface but are documented aspects of
655 .I groff mm.
656 .
657 .
658 .TP 8n \" "COVEND" + 2n
659 .BR 1C\~ [ 1 ]
660 Format page text in one column
661 (the default layout).
662 .
663 The page is broken.
664 .
665 .RB A\~ 1
666 argument suppresses this break;
667 its use may cause body text and a pending footnote to overprint.
668 .
669 See
670 .BR 2C ,
671 .BR MC ,
672 and
673 .BR NCOL .
674 .
675 .
676 .TP
677 .B 2C
678 Begin two-column formatting.
679 .
680 This is a special case of
681 .BR MC .
682 .
683 See
684 .B 1C
685 and
686 .BR NCOL .
687 .
688 .
689 .TP
690 .B AE
691 Abstract end;
692 stop collecting abstract text.
693 .
694 See
695 .BR AS .
696 .
697 .
698 .\" In DWB mm, the mnemonic for `AF` was "alternate first-page format",
699 .\" and was described in the context of the `A` register and `}Z` and
700 .\" `]S` strings, none of which we support.
701 .\"
702 .\" The "mm Reference" in _XENIX 286 Text Formatting Guide_ (1984) used
703 .\" "affiliation", which makes sense to GBR.
704 .TP
705 .BR AF \~[\c
706 .IR org-name ]
707 Specify a memorandum's organizational affiliation.
708 .
709 At most one can be declared;
710 .I org-name
711 is used by
712 .B MT
713 memoranda and available to cover pages.
714 .
715 See
716 .BR COVER .
717 .
718 .
719 .TP
720 .B AFX
721 Define this hook macro to assume responsibility for formatting the
722 affiliated firm name defined by
723 .B AF
724 in memorandum types 0 and 4 and documents using the
725 .I ms
726 cover page style.
727 .
728 If not defined
729 (the default),
730 internally defined macros handle this task;
731 see subsection \[lq]Internals\[rq] and section \[lq]Files\[rq] below.
732 .
733 Applications include setting the firm name in a different font family
734 or at a larger type size,
735 drawing a rule across the page,
736 and including a logo image using
737 .IR groff 's
738 .B PDFPIC
739 or
740 .B PSPIC
741 macros.
742 .
743 See
744 .BR MT ,
745 .BR COVER ,
746 and
747 .MR groff_tmac 5 .
748 .
749 .
750 .TP
751 .BR AL \~[\c
752 .IR number-format \~[ text-indent \~[\c
753 .BR 1 ]]]
754 Begin an auto-incrementing numbered list,
755 where item numbers start at one and are followed by a dot.
756 .
757 .I number-format
758 assigns the register format
759 (see above)
760 .I mm
761 uses for the list item enumerators.
762 .
763 The default
764 .RB is\~ 0 .
765 .
766 A
767 .I text-indent
768 argument overrides register
769 .BR Li .
770 .
771 A third argument suppresses the vertical space that normally precedes
772 each list item;
773 see register
774 .BR Lsp .
775 .
776 Vertical space in the amount of
777 .B Lsp
778 precedes the list itself,
779 but does not accumulate with pre-item space
780 when this list is nested in another.
781 .
782 .B AL
783 calls
784 .BR LB ;
785 use
786 .B LI
787 to declare list items,
788 and
789 .B LE
790 to end the list.
791 .
792 .
793 .TP
794 .BR APP \~\c
795 .RI [ sequence-number\~ [ title ]]
796 Begin an appendix.
797 .
798 If
799 .I sequence-number
800 is omitted,
801 it increments
802 (or is initialized
803 .RB to\~ 1 ,
804 .\" ...technically, initialized to zero but autoincremented.
805 if necessary).
806 .
807 The register format used for
808 .I sequence-number
809 is \[lq]A\[rq].
810 .
811 The page is broken.
812 .
813 The register
814 .B Aph
815 determines whether an appendix heading is then formatted.
816 .
817 This heading uses the string
818 .B App
819 followed by
820 .IR sequence-number .
821 .
822 Appendices appear in any table of contents
823 (see
824 .BR TC ).
825 .
826 The string
827 .B \%Apptxt
828 is set to
829 .I title
830 if the latter is present,
831 and made empty otherwise.
832 .
833 .
834 .TP
835 .BI APPSK\~ "sequence-number n" \~\c
836 .RI [ title ]
837 As
838 .BR APP ,
839 but increment the page number by
840 .IR n .
841 .
842 Use this macro to \[lq]skip pages\[rq] when diagrams or other materials
843 not formatted by
844 .I \%troff
845 are included in appendices.
846 .
847 .
848 .TP
849 .BR AS\~ [\c
850 .IR placement \~[ indentation ]]
851 Abstract start;
852 begin collecting abstract.
853 .
854 Input up to the next
855 .B AE
856 call is included in the abstract.
857 .
858 .I placement
859 influences the location of the abstract on the cover page of a
860 memorandum
861 (see
862 .BR MT ).
863 .
864 .BR \%COVER ,
865 by contrast,
866 ignores
867 .I placement
868 by default,
869 but can be customized to interpret it.
870 .
871 .
872 .br
873 .ne 4v
874 .IP
875 .TS
876 tab(@);
877 lf(BI) lb
878 l lx.
879 placement@Effect
880 0@T{
881 The abstract appears on page\~1 and cover page if the document is a
882 \[lq]released paper\[rq] memorandum
883 .RB (\[lq] ".MT 4" \[rq]);
884 otherwise,
885 it appears on page\~1 without a cover page.
886 T}
887 1@T{
888 The abstract appears only on the cover page
889 .RB (\[lq] ".MT 4" \[rq]
890 only).
891 T}
892 .\" XXX: This does not appear to be implemented.
893 .\"2@T{
894 .\"The abstract is printed only on the cover page (if not
895 .\".BR ".MT 4" )
896 .\".
897 .\"The cover page is printed without a need for \fBCS\fP.
898 .\"T}
899 .TE
900 .
901 .
902 .IP
903 An abstract does not appear at all in external letters
904 .RB (\[lq] ".MT 5" \[rq]).
905 .
906 .RI A\~ placement
907 of
908 .B 2
909 was supported by DWB,
910 but is not by
911 .IR "groff mm" .
912 .
913 .
914 .IP
915 A second argument increases the indentation by
916 .I indentation
917 and reduces the line length by twice this amount.
918 .
919 The default
920 .RB is\~ 0 .
921 .
922 .
923 .TP
924 .BI AT\~ title\c
925 \~.\|.\|.
926 Specify author's title(s).
927 .
928 If present,
929 .B AT
930 must appear just after the corresponding author's
931 .BR AU .
932 .
933 Each
934 .I title
935 occupies an output line beneath the author's name in the signature block
936 used by
937 .B LT
938 letters
939 (see
940 .BR SG )
941 and in
942 .B MT
943 memoranda.
944 .
945 The
946 .I ms
947 cover page style also formats these data.
948 .
949 .
950 .br
951 .ne 7v
952 .TP
953 .BR AU \~\c
954 .RI [ name\~\c
955 .RI [ initials\~\c
956 .RI [ loc\~\c
957 .RI [ dept\~\c
958 .RI [ ext\~\c
959 .RI [ room\~\c
960 .RI [ arg1\~\c
961 .RI [ arg2\~\c
962 .RI [ arg3 ]]]]]]]]]
963 Specify author.
964 .
965 .B AU
966 terminates a document title started with
967 .BR TL ,
968 and can be called without arguments for that purpose.
969 .
970 Author information is used by cover pages,
971 .B MT
972 memoranda,
973 and
974 .BR SG .
975 .
976 Further arguments comprise
977 initials,
978 location,
979 department,
980 telephone extension,
981 room number or name,
982 and up to three additional items.
983 .
984 Repeat
985 .B AU
986 to identify multiple authors.
987 .
988 .
989 .IP
990 Use
991 .BR WA / WE
992 instead to identify the author for documents employing
993 .BR LT .
994 .
995 .
996 .TP
997 .BR AV \~[\c
998 .IR name \~[\c
999 .BR 1 ]]
1000 Format approval lines for a handwritten signature and date.
1001 .
1002 Two horizontal rules are drawn,
1003 with the specified
1004 .I name
1005 and the text of the string
1006 .BR Letdate ,
1007 respectively,
1008 beneath them.
1009 .
1010 Above these rules,
1011 .I mm
1012 formats the text in the string
1013 .BR Letapp ;
1014 a second argument replaces this text with one vee of vertical space.
1015 .
1016 See
1017 .BR LT .
1018 .
1019 .
1020 .\" XXX: AVL is misnamed; it should have been called SGL or similar.
1021 .TP
1022 .BR AVL \~[\c
1023 .IR name ]
1024 As
1025 .BR AV ,
1026 but omitting the approval notation
1027 (the
1028 .B Letapp
1029 string),
1030 the date rule,
1031 and the label below the date rule
1032 (the
1033 .B Letdate
1034 string).
1035 .
1036 .
1037 .TP
1038 .BR B \~\c \" space in roman; we must use 2-font macro with \c
1039 .RI [ bold-text\~\c
1040 .RI [ previous-font-text ]]\~.\|.\|.
1041 Join
1042 .I bold-text
1043 in boldface with
1044 .I previous-font-text
1045 in the previous font,
1046 without space between the arguments.
1047 .
1048 If no arguments,
1049 switch font to bold style.
1050 .
1051 .
1052 .TP
1053 .B B1
1054 Begin boxed static display.
1055 .
1056 The text is indented by
1057 .BR 1n ,
1058 and the line length reduced by
1059 .BR 2n .
1060 .
1061 See
1062 .BR DS .
1063 .
1064 This is a
1065 .I groff mm
1066 extension.
1067 .
1068 .
1069 .TP
1070 .B B2
1071 End boxed static display.
1072 .
1073 See
1074 .BR B1 .
1075 .
1076 This is a
1077 .I groff mm
1078 extension.
1079 .
1080 .
1081 .TP
1082 .B BE
1083 End bottom block; see
1084 .BR BS .
1085 .
1086 .
1087 .TP
1088 .BR BI \~\c \" space in roman; we must use 2-font macro with \c
1089 .RI [ bold-text\~\c
1090 .RI [ italic-text ]]\~.\|.\|.
1091 Join
1092 .I bold-text
1093 in boldface with
1094 .I italic-text
1095 in italics,
1096 without space between the arguments.
1097 .
1098 .
1099 .TP
1100 .BR BL \~[\c
1101 .IR text-indent \~[\c
1102 .BR 1 ]]
1103 Begin bulleted list.
1104 .
1105 .I mm
1106 marks each item with the string
1107 .BR BU .
1108 .
1109 A
1110 .I text-indent
1111 argument overrides register
1112 .BR Pi .
1113 .
1114 A second argument suppresses the vertical space that normally precedes
1115 each list item;
1116 see register
1117 .BR Lsp .
1118 .
1119 Vertical space in the amount of
1120 .B Lsp
1121 precedes the list itself,
1122 but does not accumulate with pre-item space
1123 when this list is nested in another.
1124 .
1125 .B BL
1126 calls
1127 .BR LB ;
1128 use
1129 .B LI
1130 to declare list items,
1131 and
1132 .B LE
1133 to end the list.
1134 .
1135 .
1136 .TP
1137 .BR BR \~\c \" space in roman; we must use 2-font macro with \c
1138 .RI [ bold-text\~\c
1139 .RI [ roman-text ]]\~.\|.\|.
1140 Join
1141 .I bold-text
1142 in boldface with
1143 .I roman-text
1144 in roman style,
1145 without space between the arguments.
1146 .
1147 .
1148 .TP
1149 .B BS
1150 Begin bottom block.
1151 .
1152 .I mm
1153 collects input into the bottom block until the document calls
1154 .BR BE ,
1155 and outputs it between the footnote area and footer of each page.
1156 .
1157 .
1158 .\" XXX: Couldn't this have been done with an extra parameter to `VL`?
1159 .\" Or a register influencing VL behavior?
1160 .TP
1161 .BR BVL \~[\c
1162 .IR text-indent \~[ mark-indent \~[\c
1163 .BR 1 ]]]
1164 Begin broken variable-item
1165 (or \[lq]tagged\[rq])
1166 list.
1167 .
1168 Each item should supply its own mark.
1169 .
1170 The line is always broken after the mark;
1171 contrast
1172 .BR VL .
1173 .
1174 A
1175 .I text-indent
1176 argument overrides register
1177 .BR Pi ;
1178 .I mark-indent
1179 sets the distance from the indentation of the current list to the mark.
1180 .
1181 A third argument suppresses the vertical space that normally precedes
1182 each list item;
1183 see register
1184 .BR Lsp .
1185 .
1186 Vertical space in the amount of
1187 .B Lsp
1188 precedes the list itself,
1189 but does not accumulate with pre-item space
1190 when this list is nested in another.
1191 .
1192 .B BVL
1193 calls
1194 .BR LB ;
1195 use
1196 .B LI
1197 to declare list items,
1198 and
1199 .B LE
1200 to end the list.
1201 .
1202 .
1203 .TP
1204 .BR \%COVER \~\c \" space in roman; we must use 2-font macro with \c
1205 .RI [ style ]
1206 Begin a cover page description.
1207 .
1208 .B \%COVER
1209 must appear before the body text
1210 (or main matter)
1211 of a document.
1212 .
1213 The argument
1214 .I style
1215 is used to construct the file name
1216 .IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/\: style \:.cov
1217 and load it with the
1218 .B mso
1219 request.
1220 .
1221 The default
1222 .I style
1223 is
1224 .RB \[lq] ms \[rq];
1225 the
1226 .I ms.cov
1227 file prepares a cover page resembling that of the
1228 .I ms
1229 package.
1230 .
1231 A
1232 .I .cov
1233 file must define a
1234 .B \%COVEND
1235 macro,
1236 which a document must call at the end of the cover description.
1237 .
1238 Use cover description macros in the following order;
1239 only
1240 .B TL
1241 and
1242 .B AU
1243 are required.
1244 .
1245 .
1246 .IP
1247 .EX
1248 \&.COVER
1249 \&.AF
1250 \&.TL
1251 \&.AU
1252 \&.AT
1253 \&.\[rs]" Add additional AU and AT calls as needed.
1254 \&.AS
1255 .ne 2v
1256 \&.AE
1257 \&.COVEND
1258 .EE
1259 .
1260 .
1261 .TP
1262 .B COVEND
1263 End the cover description.
1264 .
1265 .
1266 .TP
1267 .B DE
1268 End static or floating display begun with
1269 .B DS
1270 or
1271 .BR DF .
1272 .
1273 .
1274 .TP
1275 .BR DF\~ [\c
1276 .IR format \~[ fill \~[ right-indentation ]]]
1277 Begin floating display.
1278 .
1279 A floating display is saved in a queue and output in the order entered.
1280 .
1281 Arguments are handled as in
1282 .BR DS .
1283 .
1284 Floating displays cannot be nested.
1285 .
1286 Placement of floating displays is controlled by the registers
1287 .B De
1288 and
1289 .BR Df .
1290 .
1291 .
1292 .TP
1293 .BR DL \~[\c
1294 .IR text-indent \~[\c
1295 .BR 1 ]]
1296 Begin dashed list.
1297 .
1298 .I mm
1299 marks each item with the string
1300 .BR EM .
1301 .
1302 A
1303 .I text-indent
1304 argument overrides register
1305 .BR Pi .
1306 .
1307 A second argument suppresses the vertical space that normally precedes
1308 each list item;
1309 see register
1310 .BR Lsp .
1311 .
1312 Vertical space in the amount of
1313 .B Lsp
1314 precedes the list itself,
1315 but does not accumulate with pre-item space
1316 when this list is nested in another.
1317 .
1318 .B DL
1319 calls
1320 .BR LB ;
1321 use
1322 .B LI
1323 to declare list items,
1324 and
1325 .B LE
1326 to end the list.
1327 .
1328 .
1329 .TP
1330 .BR DS \~[\c
1331 .IR format \~[\c
1332 .IR fill \~[\c
1333 .IR right-indentation ]]]
1334 Begin static display.
1335 .
1336 .I mm
1337 collects input into a display until the document calls
1338 .BR DE .
1339 .
1340 The display is output on a single page unless it is taller than the
1341 height of the page.
1342 .
1343 .B DS
1344 can be nested
1345 (contrast with
1346 .BR DF ).
1347 .
1348 .
1349 .IP
1350 .TS
1351 tab(@);
1352 Lf(BI) Lb
1353 L Lx.
1354 format@Effect
1355 \f[I]none\f[]@Do not indent the display.
1356 L@Do not indent the display.
1357 I@T{
1358 Indent text by
1359 .BR \[rs]n[Si] .
1360 T}
1361 C@Center each line.
1362 CB@Center the whole display as a block.
1363 R@Right-align each line.
1364 RB@Right-align the whole display as a block.
1365 .TE
1366 .
1367 .
1368 .IP
1369 The values \[lq]L\[rq],
1370 \[lq]I\[rq],
1371 \[lq]C\[rq],
1372 and \[lq]CB\[rq] can also be specified as \[lq]0\[rq],
1373 \[lq]1\[rq],
1374 \[lq]2\[rq],
1375 and
1376 \[lq]3\[rq],
1377 respectively,
1378 for compatibility with DWB.
1379 .
1380 .
1381 .br
1382 .ne 4v
1383 .IP
1384 .TS
1385 tab(@);
1386 Lf(BI) Lb
1387 L Lx.
1388 fill@Effect
1389 \f[I]none\f[]@Disable filling.
1390 N@Disable filling.
1391 F@Enable filling.
1392 .TE
1393 .
1394 .
1395 .IP
1396 \[lq]N\[rq] and \[lq]F\[rq] can also be specified as \[lq]0\[rq] and
1397 \[lq]1\[rq],
1398 respectively,
1399 for compatibility with DWB.
1400 .
1401 .
1402 .IP
1403 A third argument
1404 reduces the line length by
1405 .I right-indentation.
1406 .
1407 .
1408 .IP
1409 .I mm
1410 normally
1411 places vertical space before and after the display.
1412 .
1413 Set register
1414 .B Ds
1415 to \[lq]0\[rq] to suppress it.
1416 .
1417 .
1418 .TP
1419 .BR EC \~\c
1420 .RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
1421 Caption an equation.
1422 .
1423 A caption comprises the string
1424 .B Capec
1425 followed by an automatically incrementing counter stored in the register
1426 .BR Ec ,
1427 punctuation configured by the register
1428 .BR Of ,
1429 then
1430 .I title
1431 (if any).
1432 .
1433 Use the
1434 .B af
1435 request to configure
1436 .BR Ec 's
1437 number format.
1438 .
1439 .I override
1440 and
1441 .I flag
1442 alter the equation number as follows.
1443 .
1444 Omitting
1445 .I flag
1446 and specifying
1447 .B 0
1448 in its place are equivalent.
1449 .
1450 .
1451 .IP
1452 .TS
1453 tab(@);
1454 Lf(BI) Lb
1455 L Lx.
1456 flag@Effect
1457 0@T{
1458 Prefix number with
1459 .IR override .
1460 T}
1461 1@T{
1462 Suffix number with
1463 .IR override .
1464 T}
1465 2@T{
1466 Replace number with
1467 .IR override .
1468 T}
1469 .TE
1470 .
1471 .
1472 .IP
1473 .I mm
1474 centers equation captions irrespective of the alignment of any enclosing
1475 display.
1476 .
1477 .
1478 .IP
1479 Specifying
1480 .I ref-name
1481 stores the equation number as if by
1482 .RB \[lq] .SETR
1483 .I ref-name
1484 .BR \[rs]n[Ec] \[rq].
1485 .
1486 Recognition of this argument is a
1487 .I groff mm
1488 extension.
1489 .
1490 .
1491 .IP
1492 The package lists captioned equations in a table of contents
1493 (see
1494 .BR TC )
1495 if the Boolean register
1496 .B Le
1497 is true.
1498 .
1499 The string
1500 .B Le
1501 captions this list.
1502 .
1503 .
1504 .TP
1505 .BR EF\~ [ \[dq]\|\[aq]\c
1506 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
1507 ]
1508 Define the even-page footer,
1509 which is formatted just above the normal page footer on even-numbered
1510 pages.
1511 .
1512 See
1513 .BR PF .
1514 .
1515 .B EF
1516 defines the string
1517 .BR EOPef .
1518 .
1519 .
1520 .TP
1521 .BR EH\~ [ \[dq]\|\[aq]\c
1522 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
1523 ]
1524 Define the even-page header,
1525 which is formatted just below the normal page header on even-numbered
1526 pages.
1527 .
1528 See
1529 .BR PH .
1530 .
1531 .B EH
1532 defines the string
1533 .BR TPeh .
1534 .
1535 .
1536 .TP
1537 .B EN
1538 End mathematical expression input preprocessed by
1539 .MR \%eqn 1 ;
1540 see
1541 .BR EQ .
1542 .
1543 .
1544 .TP
1545 .B EOP
1546 .I "groff mm"
1547 calls this hook macro in lieu of normal page footer layout.
1548 .
1549 The package uses a separate environment to format headers and footers.
1550 .
1551 See
1552 .BR TP .
1553 .
1554 .
1555 .br
1556 .ie t .ne 4v
1557 .el .ne 5v \" for horizontal rule
1558 .IP
1559 .TS
1560 tab(@);
1561 Cb S
1562 Lb L.
1563 Strings available to EOP
1564 _
1565 EOPf@argument to \fBPF\fP
1566 EOPef@argument to \fBEF\fP
1567 EOPof@argument to \fBOF\fP
1568 .TE
1569 .
1570 .
1571 .TP
1572 .BR EPIC\~ [\c
1573 .BR \-L ]\~\c
1574 .IR "width height" \~[ name ]
1575 Draw a box with the given
1576 .I width
1577 and
1578 .IR height .
1579 .
1580 The text
1581 .I name
1582 (or default text)
1583 is formatted inside the box;
1584 no attempt is made to size the box to fit the text.
1585 .
1586 An application of this macro is to indicate the placement of an image to
1587 be determined later,
1588 or externally composited in postprocessing.
1589 .
1590 .B \-L
1591 as the first argument
1592 left-aligns the box;
1593 the default is to center it.
1594 .
1595 See
1596 .BR PIC .
1597 .
1598 .
1599 .TP
1600 .BR EQ \~[\c
1601 .IR label ]
1602 Start mathematical expression input preprocessed by
1603 .MR \%eqn 1 .
1604 .
1605 .B EQ
1606 and
1607 .B EN
1608 macro calls bracket an equation region.
1609 .
1610 Such regions must be contained in displays
1611 .RB ( DS / DE ),
1612 except when the region is used only to configure
1613 .I \%eqn
1614 and not to produce output.
1615 .
1616 If present,
1617 .I label
1618 appears aligned to the right and
1619 centered vertically within the display;
1620 see register
1621 .BR Eq .
1622 .
1623 .
1624 If multiple
1625 .I eqn \" generic
1626 regions occur within a display,
1627 only the last
1628 .I label
1629 (if any)
1630 is used.
1631 .
1632 .
1633 .TP
1634 .BR EX \~\c
1635 .RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
1636 Caption an exhibit.
1637 .
1638 Arguments are handled analogously to
1639 .BR EC .
1640 .
1641 The register
1642 .B Ex
1643 is the exhibit counter.
1644 .
1645 The string
1646 .B Capex
1647 precedes the exhibit number and any
1648 .I title.
1649 .
1650 .I mm
1651 centers exhibit captions irrespective of the alignment of any enclosing
1652 display.
1653 .
1654 .
1655 .IP
1656 The package lists captioned exhibits in a table of contents
1657 (see
1658 .BR TC )
1659 if the Boolean register
1660 .B Lx
1661 is true.
1662 .
1663 The string
1664 .B Lx
1665 captions this list.
1666 .
1667 .
1668 .TP
1669 .BR FC \~[\c
1670 .IR closing-text ]
1671 Output the string
1672 .BR Letfc ,
1673 or the specified
1674 .I closing-text,
1675 as the formal closing of a letter or memorandum.
1676 .
1677 See
1678 .B LT
1679 and
1680 .BR MT .
1681 .
1682 .
1683 .TP
1684 .BR FD \~[\c
1685 .IR arg \~[\c
1686 .BR 1 ]]
1687 Configure display of footnotes.
1688 .
1689 The first argument encodes enablement of
1690 automatic hyphenation,
1691 adjustment to both margins,
1692 indentation of footnote text,
1693 and left- vs.\& right-alignment of the footnote label within the space
1694 allocated for it.
1695 .
1696 .
1697 .br
1698 .ne 5v
1699 .IP
1700 .\" XXX: We can fit one more row using "nokeep" vs. not using it.
1701 .TS
1702 tab(@) nokeep;
1703 Lf(BI) Lb Lb Lb Lb
1704 L L L L L.
1705 arg@Hyphenate?@Adjust?@Indent?@Label alignment
1706 0@no@yes@yes@left
1707 1@yes@yes@yes@left
1708 2@no@no@yes@left
1709 3@yes@no@yes@left
1710 4@no@yes@no@left
1711 5@yes@yes@no@left
1712 6@no@no@no@left
1713 7@yes@no@no@left
1714 8@no@yes@yes@right
1715 9@yes@yes@yes@right
1716 10@no@no@yes@right
1717 11@yes@no@yes@right
1718 .TE
1719 .
1720 .
1721 .IP
1722 An
1723 .I arg
1724 greater than 11 is treated
1725 .RB as\~ 0 .
1726 .
1727 .IR mm 's
1728 default
1729 .RB is\~ 0 .
1730 .
1731 .
1732 .IP
1733 A second argument resets footnote numbering when a first-level heading
1734 is encountered.
1735 .
1736 See
1737 .BR FS .
1738 .
1739 .
1740 .TP
1741 .B FE
1742 End footnote;
1743 see
1744 .BR FS .
1745 .
1746 .
1747 .TP
1748 .BR FG \~\c
1749 .RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
1750 Caption a figure.
1751 .
1752 Arguments are handled analogously to
1753 .BR EC .
1754 .
1755 The register
1756 .B Fg
1757 is the figure counter.
1758 .
1759 The string
1760 .B Capfg
1761 precedes the figure number and any
1762 .I title.
1763 .
1764 .I mm
1765 centers figure captions irrespective of the alignment of any enclosing
1766 display.
1767 .
1768 .
1769 .IP
1770 The package lists captioned figures in a table of contents
1771 (see
1772 .BR TC )
1773 if the Boolean register
1774 .B Lf
1775 is true.
1776 .
1777 The string
1778 .B Lf
1779 captions this list.
1780 .
1781 .
1782 .TP
1783 .BR FS \~[\c
1784 .IR mark ]
1785 Start footnote.
1786 .
1787 .I mm
1788 collects input into a footnote until the document calls
1789 .BR FE ,
1790 outputting it when the vertical drawing position nears the page bottom.
1791 .
1792 By default,
1793 .I mm
1794 automatically numbers footnotes starting at 1;
1795 the number is available in register
1796 .B Ftnum
1797 and,
1798 with a trailing period,
1799 in
1800 .RB string\~ F .
1801 .
1802 If desired,
1803 interpolate this string in the body text to format the footnote mark.
1804 .
1805 .I mm
1806 interpolates
1807 .RB string\~ F
1808 prior to the footnote text.
1809 .
1810 Footnotes are vertically separated by the product of
1811 .RB registers\~ Fs
1812 and
1813 .BR Lsp .
1814 .
1815 In
1816 .IR "groff mm" ,
1817 footnotes may be used in displays.
1818 .
1819 .
1820 .IP
1821 A
1822 .I mark
1823 argument,
1824 which need not be numeric,
1825 replaces the default footnote mark,
1826 leaving the
1827 .RB string\~ F
1828 unchanged.
1829 .
1830 In that event,
1831 you must explicitly write any footnote mark to appear
1832 in the footnote itself.
1833 .
1834 .
1835 .TP
1836 .BI GETHN\~ ref-name\~\c
1837 .RI [ string ]
1838 Interpolate
1839 .IR ref-name 's
1840 heading mark,
1841 or,
1842 if
1843 .I string
1844 is specified,
1845 store it there.
1846 .
1847 In neither case does
1848 .B GETHN
1849 suffix the interpolation with space.
1850 .
1851 See
1852 .BR INITR .
1853 .
1854 .
1855 .TP
1856 .BI GETPN\~ ref-name\~\c
1857 .RI [ string ]
1858 Interpolate
1859 .IR ref-name 's
1860 page number,
1861 or,
1862 if
1863 .I string
1864 is specified,
1865 store it there.
1866 .
1867 In neither case does
1868 .B GETPN
1869 suffix the interpolation with space.
1870 .
1871 See
1872 .BR INITR .
1873 .
1874 .
1875 .TP
1876 .BI GETR\~ ref-name
1877 Retrieve location data for reference
1878 .IR ref-name ,
1879 call
1880 .B GETHN
1881 and
1882 .B GETPN
1883 to populate strings
1884 .B Qrfh
1885 and
1886 .BR Qrfn ,
1887 respectively,
1888 and interpolate string
1889 .B Qrf
1890 as an internal reference to it.
1891 .
1892 See
1893 .BR INITR .
1894 .
1895 .
1896 .TP
1897 .BI GETST\~ ref-name\~\c
1898 .RI [ string ]
1899 Interpolate
1900 .IR ref-name 's
1901 auxiliary reference datum,
1902 or,
1903 if
1904 .I string
1905 is specified,
1906 store it there.
1907 .
1908 In neither case does
1909 .B GETST
1910 suffix the interpolation with space.
1911 .
1912 See
1913 .BR INITR .
1914 .
1915 .
1916 .TP
1917 .BI H\~ level\~\c
1918 .RI [ title \~[ suffix ]]
1919 Set a numbered section heading at
1920 .IR level .
1921 .
1922 .I mm
1923 calls
1924 .B LC
1925 to clear any lists,
1926 then produces numbered
1927 .I "heading marks"
1928 of the form
1929 .IR a . b . c .\|.\|.,
1930 with up to fourteen levels of nesting.
1931 .
1932 Each level's number increments automatically with each
1933 .B H
1934 call and is reset to zero when a more significant
1935 .I level
1936 is specified.
1937 .
1938 .RB \[lq] 1 \[rq]\~is
1939 the most significant or coarsest division of the document.
1940 .
1941 Text after an
1942 .B H
1943 call is formatted as a paragraph;
1944 calling
1945 .B P
1946 is unnecessary.
1947 .
1948 .
1949 .IP
1950 The optional
1951 .I title
1952 must be double-quoted if it contains spaces.
1953 .
1954 .I mm
1955 appends
1956 .I suffix
1957 to
1958 .I title
1959 in the body of the document,
1960 but omits it from any table of contents
1961 (see
1962 .BR TC ).
1963 .
1964 This facility can be used to annotate the heading title with a footnote.
1965 .
1966 .I suffix
1967 should not interpolate
1968 .RB the\~ F
1969 string;
1970 specify a footnote mark explicitly.
1971 .
1972 See
1973 .BR FS .
1974 .
1975 .
1976 .IP
1977 Heading behavior is configurable.
1978 .
1979 Several registers set
1980 .I thresholds,
1981 where heading levels at or below a threshold value are handled in one
1982 way,
1983 and those above it another.
1984 .
1985 For example,
1986 .I mm
1987 populates a table of contents
1988 (see
1989 .BR TC )
1990 with the title of a heading if its level is within the
1991 .B Cl
1992 register threshold.
1993 .
1994 .
1995 .IP
1996 .I Heading layout.
1997 .
1998 Register
1999 .B Ej
2000 sets a threshold for page breaking (ejection) prior to a heading.
2001 .
2002 If not preceded by a page break,
2003 a heading level within the threshold in register
2004 .B Hps
2005 is preceded by the amount of vertical space in register
2006 .BR Hps1 ,
2007 and by the amount in
2008 .B Hps2
2009 otherwise.
2010 .
2011 The
2012 .B Hb
2013 register sets a threshold at which a break occurs after the heading,
2014 and register
2015 .B Hs
2016 sets a threshold within which vertical space follows it.
2017 .
2018 If the heading level is above both of these,
2019 and the paragraph is not numbered,
2020 .I mm
2021 produces a
2022 .IR "run-in heading" ;
2023 paragraph text follows on the same output line.
2024 .
2025 Otherwise,
2026 register
2027 .B Hi
2028 configures the indentation of text after headings.
2029 .
2030 Threshold register
2031 .B Hc
2032 permits centering;
2033 .I mm
2034 centers a heading with a level within both of the
2035 .B Hb
2036 and
2037 .B Hc
2038 thresholds.
2039 .
2040 .
2041 .IP
2042 .I Heading typeface and size.
2043 .
2044 The
2045 .B HF
2046 string configures the fonts used
2047 for heading marks and titles at each level.
2048 .
2049 The string
2050 .B HP
2051 likewise assigns a type size to each heading level.
2052 .
2053 .\" XXX: Why not an "Hvs" string?
2054 The hook macros
2055 .B HX
2056 and/or
2057 .B HZ
2058 can control the vertical spacing used by headings.
2059 .
2060 .
2061 .IP
2062 .I Heading number format.
2063 .
2064 Registers named
2065 .B H1
2066 through
2067 .B H14
2068 store counters for each heading level.
2069 .
2070 Their values are printed using Arabic numerals by default;
2071 see
2072 .BR HM .
2073 .
2074 The heading levels are catenated with dots for formatting;
2075 to typeset only the deepest,
2076 set the
2077 .B Ht
2078 register.
2079 .
2080 Heading numbers are not suffixed with a trailing dot except when only
2081 the first level is output;
2082 to omit a dot in this case as well,
2083 clear the
2084 .B H1dot
2085 register.
2086 .
2087 .
2088 .IP
2089 .I Customizing heading behavior.
2090 .
2091 .B H
2092 calls
2093 .BR HX ,
2094 .BR HY ,
2095 and
2096 .B HZ
2097 hook macros to further customize headings.
2098 .
2099 These can change the heading's
2100 .I mark
2101 (the numbered portion before any heading title),
2102 its vertical spacing,
2103 and its vertical space requirements
2104 (for instance,
2105 to require a minimum quantity of subsequent output lines on the page,
2106 breaking the page otherwise).
2107 .
2108 Define hook macros in expectation of the following parameters.
2109 .
2110 The argument
2111 .I declared-level
2112 is the
2113 .I level
2114 argument to
2115 .BR H ,
2116 .RB or\~ 0
2117 for unnumbered headings
2118 (see
2119 .BR HU ).
2120 .
2121 .I actual-level
2122 is the same as
2123 .I declared-level
2124 for numbered headings,
2125 and the value of
2126 .RB register\~ Hu
2127 for unnumbered headings.
2128 .
2129 .I title-suffix
2130 is the catenation of the corresponding arguments to
2131 .B H
2132 or
2133 .BR HU .
2134 .
2135 .
2136 .RS
2137 .TP
2138 .BI HX\~ "declared-level actual-level title-suffix"
2139 .I mm
2140 calls
2141 .B HX
2142 before setting the heading.
2143 .
2144 Your definition may alter
2145 .BR }0 ,
2146 .BR }2 ,
2147 and
2148 .BR ;3 .
2149 .
2150 .
2151 .\" XXX: These names are ugly and of no obvious meaning. Make
2152 .\" documented aliases for them.
2153 .RS
2154 .TP
2155 .BR }0\~ (string)
2156 contains the heading mark plus two spaces if
2157 .I declared-level
2158 is non-zero,
2159 and otherwise is empty.
2160 .
2161 .
2162 .TP
2163 .BR ;0\~ (register)
2164 encodes a position for the text after the heading.
2165 .
2166 0\~means that the heading is to be run in,
2167 1\~means that a break is to occur before the text,
2168 and 2\~means that vertical space is to separate heading and text.
2169 .
2170 .
2171 .TP
2172 .BR }2\~ (string)
2173 is the suffix that separates a run-in heading from the text.
2174 .
2175 It contains two spaces if register
2176 .B ;0
2177 is\~0,
2178 and otherwise is empty.
2179 .
2180 .
2181 .TP
2182 .BR ;3\~ (register)
2183 contains the vertical space required for the heading to be typeset.
2184 .
2185 If that amount is not available,
2186 the page is broken prior to the heading.
2187 .
2188 The default is
2189 .BR 2v .
2190 .RE
2191 .
2192 .
2193 .TP
2194 .BI HY\~ "declared-level actual-level title-suffix"
2195 .I mm
2196 calls
2197 .B HY
2198 after determining the heading typeface and size.
2199 .
2200 It could be used to change indentation.
2201 .
2202 .
2203 .TP
2204 .BI HZ\~ "declared-level actual-level title-suffix"
2205 .I mm
2206 calls
2207 .B HZ
2208 after formatting the heading,
2209 just before
2210 .B H
2211 or
2212 .B HU
2213 returns.
2214 .
2215 It could be used to change the page header to include a section heading.
2216 .\" XXX: ...but only for the _next_ page, not the current one. See
2217 .\" Savannah #62825.
2218 .RE
2219 .
2220 .
2221 .TP
2222 .BI HC\~ \fR[\fPhyphenation-character\fR]\fP
2223 Set hyphenation character,
2224 selecting the default,
2225 \[lq]\[rs]%\[rq],
2226 if called without argument.
2227 .
2228 .
2229 .TP
2230 .BI HM\ "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP"
2231 Set the heading mark style.
2232 .
2233 Each argument assigns the specified register format
2234 (see above)
2235 to the corresponding heading level.
2236 .
2237 The default
2238 .RB is\~ 1
2239 for all levels.
2240 .
2241 An explicitly empty argument also indicates the default.
2242 .
2243 .
2244 .TP
2245 .BI HU\~ title \~\c
2246 .RI [ suffix ]
2247 Set an unnumbered section heading with
2248 .I title
2249 and,
2250 as a
2251 .I groff mm
2252 extension,
2253 an optional
2254 .I suffix.
2255 .
2256 The heading is treated as a numbered heading of the level stored in
2257 .RB register\~ Hu ,
2258 but no heading mark is output;
2259 .RB see\~ H .
2260 .
2261 .
2262 .TP
2263 .BR I \~\c \" space in roman; we must use 2-font macro with \c
2264 .RI [ italic-text\~\c
2265 .RI [ previous-font-text ]]\~.\|.\|.
2266 Join
2267 .I italic-text
2268 in italics with
2269 .I previous-font-text
2270 in the previous font,
2271 without space between the arguments.
2272 .
2273 If no arguments,
2274 switch font to italic style.
2275 .
2276 .
2277 .TP
2278 .BR IA \~[\c
2279 .IR recipient-name \~[\c
2280 .IR title ]]
2281 Specify the inside address in a letter.
2282 .
2283 The arguments give each recipient a name and title.
2284 .
2285 .I mm
2286 collects
2287 input into the inside address until the document calls
2288 .BR IE ,
2289 then outputs it.
2290 .
2291 You can specify multiple recipients with empty
2292 .BR IA / IE
2293 pairs;
2294 .I mm
2295 uses only the last address.
2296 .
2297 See
2298 .BR LT .
2299 .
2300 .
2301 .TP
2302 .BR IB \~\c \" space in roman; we must use 2-font macro with \c
2303 .RI [ italic-text\~\c
2304 .RI [ bold-text ]]\~.\|.\|.
2305 Join
2306 .I italic-text
2307 in italics with
2308 .I bold-text
2309 in boldface,
2310 without space between the arguments.
2311 .
2312 .
2313 .TP
2314 .B IE
2315 End the inside address begun with
2316 .BR IA .
2317 .
2318 .
2319 .TP
2320 .BI IND\~ argument\~\c
2321 \&.\|.\|.
2322 If the Boolean register
2323 .B Ref
2324 is true,
2325 write an index entry as a specially prepared
2326 .I roff
2327 comment to the standard error stream,
2328 with each
2329 .I argument
2330 separated from its predecessor by a tab character.
2331 .
2332 The entry's location information is arranged as configured by the most
2333 recent
2334 .B INITI
2335 call.
2336 .
2337 .
2338 .TP
2339 .B INDP
2340 Output the index set up by
2341 .B INITI
2342 and populated by
2343 .B IND
2344 calls.
2345 .
2346 By default,
2347 .B INDP
2348 calls
2349 .B SK
2350 and writes a centered caption interpolating the string
2351 .BR Index .
2352 .
2353 It then disables filling and calls
2354 .BR 2C ;
2355 afterward,
2356 it restores filling and calls
2357 .BR 1C .
2358 .
2359 .
2360 .IP
2361 Define macros to customize this behavior.
2362 .
2363 .B INDP
2364 calls
2365 .B TXIND
2366 before the caption,
2367 .B TYIND
2368 .I instead
2369 of writing the caption,
2370 and
2371 .B TZIND
2372 after formatting the index.
2373 .
2374 .
2375 .TP
2376 .BI INITI\~ "location-type file-name\~"\c
2377 .RI [ macro ]
2378 Initialize
2379 .IR "groff mm" 's
2380 indexing system.
2381 .
2382 Argument
2383 .I location-type
2384 selects how the location of each index entry is reported.
2385 .
2386 .I file-name
2387 populates an internal string used later by
2388 .BR INDP .
2389 .
2390 .
2391 .IP
2392 .TS
2393 tab(@);
2394 Lf(BI) Lb
2395 L Lx.
2396 location-type@Entry format
2397 N@page number
2398 H@heading mark
2399 B@page number, tab character, heading mark
2400 .TE
2401 .
2402 .
2403 .IP
2404 If
2405 .I macro
2406 is specified,
2407 .I "groff mm"
2408 calls it for each index entry
2409 with the arguments given to
2410 .BR IND .
2411 .
2412 .
2413 .TP
2414 .BI INITR\~ file-name-prefix
2415 Initialize the internal reference macros.
2416 .
2417 Internal references are written to the standard error stream,
2418 which should be redirected into a file named
2419 .RI file-name-prefix .qrf .
2420 .
2421 .MR mmroff 1
2422 handles this and the two formatting passes it requires.
2423 .\".
2424 .\"This program exists because
2425 .\".MR groff 1
2426 .\"by default deactivates the unsafe operations that are required by
2427 .\".BR INITR .
2428 .
2429 The first pass identifies internal references;
2430 the second includes them.
2431 .\"
2432 .\".B INITR
2433 .\"can be used several times,
2434 .\"but it is only the first occurrence of
2435 .\".B INITR
2436 .\"that is active.
2437 .
2438 See
2439 .BR SETR ,
2440 .BR GETHN ,
2441 .BR GETPN ,
2442 and
2443 .BR GETST .
2444 .
2445 .
2446 .TP
2447 .BR IR \~\c \" space in roman; we must use 2-font macro with \c
2448 .RI [ italic-text\~\c
2449 .RI [ roman-text ]]\~.\|.\|.
2450 Join
2451 .I italic-text
2452 in italics with
2453 .I roman-text
2454 in roman style,
2455 without space between the arguments.
2456 .
2457 .
2458 .TP
2459 .BI LB\~ "text-indent mark-indent pad type"\~\c
2460 .RI [ mark-or-format \~[ pre-item-space \~[ pre-list-space ]]]
2461 Begin list.
2462 .
2463 The macros
2464 .BR AL ,
2465 .BR BL ,
2466 .BR BVL ,
2467 .BR DL ,
2468 .BR ML ,
2469 .BR RL ,
2470 and
2471 .B VL
2472 call
2473 .B LB
2474 in various ways;
2475 they are simpler to use and may be preferred if they suit the desired
2476 purpose.
2477 .
2478 .
2479 .br
2480 .ne 3v
2481 .IP
2482 .I mm
2483 tracks the nesting level of lists;
2484 the outermost is\~0.
2485 .
2486 It indents
2487 each list item
2488 (text formatted after an
2489 .B LI
2490 call)
2491 by
2492 .I text-indent.
2493 .
2494 The mark is left-aligned at
2495 .IR mark-indent ,
2496 and padded on the left with
2497 .I pad
2498 ens of space.
2499 .
2500 .I type
2501 determines the mark's format.
2502 .
2503 .
2504 .IP
2505 .TS
2506 tab(@);
2507 Lf(BI) Lb
2508 L L.
2509 type@Output for a mark \[lq]x\[rq]
2510 0@x
2511 1@x.
2512 2@x)
2513 3@(x)
2514 4@[x]
2515 5@<x>
2516 6@{x}
2517 .TE
2518 .
2519 .
2520 .IP
2521 If
2522 .I type
2523 .RB is\~ 0 ,
2524 .I mark-or-format
2525 specifies each item's mark
2526 (which can be overridden by an argument to
2527 .BR LI ).
2528 .
2529 If
2530 .I mark-or-format
2531 is empty
2532 (or the dummy character
2533 .RB \[lq] \[rs]& \[rq])
2534 .I mm
2535 sets items at
2536 .I mark-indent
2537 with a hanging indent at
2538 .I text-indent.
2539 .
2540 .
2541 .IP
2542 If
2543 .I type
2544 is greater than zero,
2545 .I mm
2546 supplies an automatically incrementing numeric mark,
2547 and interprets
2548 .I mark-or-format
2549 as a register format.
2550 .
2551 .
2552 .IP
2553 A
2554 .I type
2555 .RB of\~ \-1
2556 causes
2557 .I "groff mm"
2558 to break the line after the mark
2559 even if it fits within
2560 .I text-indent;
2561 this is a
2562 .I groff mm
2563 extension.
2564 .
2565 .
2566 .IP
2567 The last two arguments manage vertical space.
2568 .
2569 Unless a list's nesting level is greater than the value of register
2570 .BR Ls ,
2571 its items are preceded by
2572 .I pre-item-space
2573 multiplied by the register
2574 .BR Lsp ;
2575 the default
2576 .RB is\~ 1 .
2577 .
2578 .B LB
2579 precedes the list by
2580 .I pre-list-space
2581 multiplied by the register
2582 .BR Lsp ;
2583 the default
2584 .RB is\~ 0 .
2585 .
2586 .
2587 .TP
2588 .BR LC \~[\c
2589 .IR list-level ]
2590 Clear list state.
2591 .
2592 Active lists are terminated as if with
2593 .BR LE ,
2594 either all
2595 (the default)
2596 or only those from the current level down to
2597 .I list-level
2598 if specified.
2599 .
2600 .
2601 .TP
2602 .BR LE \~[ 1 ]
2603 End list.
2604 .
2605 The current list is terminated.
2606 .
2607 An argument
2608 .RB of\~ 1
2609 causes
2610 vertical space in the amount of register
2611 .B Lsp
2612 to follow the list.
2613 .
2614 .
2615 .TP
2616 .BR LI \~[\c
2617 .IR mark \~[ pad-prefix ]]
2618 Begin a list item.
2619 .
2620 .I mm
2621 collects input into a list item
2622 until the document terminates the current list
2623 or calls
2624 .B LI
2625 again.
2626 .
2627 By default,
2628 the item's text is preceded by any mark configured by the current list.
2629 .
2630 If
2631 .I mark
2632 is the only argument,
2633 it replaces the mark configured in the corresponding
2634 .B LB
2635 call.
2636 .
2637 If the width of the mark plus any
2638 .I pad
2639 specified in the
2640 .B LB
2641 call
2642 exceeds the text indentation,
2643 .I "groff mm"
2644 warns and uses one en of padding between the mark and the text.
2645 .
2646 The presence of a second argument prefixes
2647 .I mark
2648 to the
2649 .BR LB -configured
2650 mark and,
2651 as a
2652 .I groff mm
2653 extension,
2654 conditionally puts an unbreakable space
2655 between the prefix and mark per the argument's Boolean value.
2656 .
2657 .
2658 .TP
2659 .BI LO\~ option\~\c
2660 .RI [ value ]
2661 Specify letter options;
2662 see
2663 .BR LT .
2664 .
2665 By default,
2666 .I mm
2667 recognizes the following
2668 .I option
2669 values.
2670 .
2671 See
2672 .B IA
2673 regarding the inside address and string
2674 .B DT
2675 regarding the date.
2676 .
2677 .
2678 .IP
2679 .TS
2680 tab(@);
2681 Lf(BI) Lb
2682 L Lx.
2683 option@Meaning and Effect
2684 AT@T{
2685 Attention;
2686 put contents of string
2687 .B LetAT
2688 and
2689 .I value
2690 left-aligned after the inside address.
2691 T}
2692 CN@T{
2693 Confidential;
2694 put
2695 .I value,
2696 or contents of string
2697 .BR LetCN ,
2698 left-aligned after the date.
2699 T}
2700 RN@T{
2701 Reference;
2702 put contents of string
2703 .B LetRN
2704 and
2705 .I value
2706 after the confidential notation
2707 (if any)
2708 and the date,
2709 aligned with the latter.
2710 T}
2711 SA@T{
2712 Salutation;
2713 put
2714 .I value,
2715 or contents of string
2716 .BR LetSA ,
2717 left-aligned after the inside address
2718 and the confidential notation
2719 (if any).
2720 T}
2721 SJ@T{
2722 Subject;
2723 put contents of string
2724 .B LetSJ
2725 and
2726 .I value
2727 left-aligned after the inside address
2728 and the attention and salutation notations
2729 (if any).
2730 .
2731 In letter type \[lq]SP\[rq],
2732 .B LetSJ
2733 is ignored and
2734 .I value
2735 is set in full capitals.
2736 T}
2737 .TE
2738 .
2739 .
2740 .br
2741 .ne 5v
2742 .TP
2743 .BR LT \~[\c
2744 .IR style ]
2745 Format a letter in the designated
2746 .I style,
2747 defaulting to
2748 .B BL
2749 (see below).
2750 .
2751 A letter begins with the writer's address
2752 .RB ( WA / WE ),
2753 followed by the date
2754 .RB ( ND ),
2755 the inside address
2756 .RB ( IA / IE ),
2757 the body of the letter
2758 .RB ( P
2759 and other general-purpose
2760 .I mm
2761 macros),
2762 the formal closing
2763 .RB ( FC ),
2764 the signature
2765 .RB ( SG ),
2766 and notations
2767 .RB ( NS / NE ).
2768 .
2769 Any of these except the body text may be omitted.
2770 .
2771 Letter options specified with
2772 .B LO
2773 add further annotations,
2774 which are extensible;
2775 see subsection \[lq]Internals\[rq] below.
2776 .
2777 .
2778 .br
2779 .ne 6v
2780 .IP
2781 .TS
2782 tab(@);
2783 Lf(BI) Lb
2784 L Lx.
2785 style@Description
2786 BL@T{
2787 Blocked:
2788 the writer's address,
2789 date,
2790 formal closing,
2791 and signature are indented to the center of the line.
2792 .
2793 Everything else is left-aligned.
2794 T}
2795 SB@T{
2796 Semi-blocked:
2797 as
2798 .BR BL ,
2799 but the first line of each paragraph is indented by
2800 .B \[rs]n[Pi]
2801 ens.
2802 T}
2803 FB@T{
2804 Fully blocked:
2805 everything is left-aligned.
2806 T}
2807 SP@T{
2808 Simplified:
2809 as
2810 .BR FB ,
2811 but a formal closing is omitted,
2812 and the signature is set in full capitals.
2813 T}
2814 .TE
2815 .
2816 .
2817 .TP
2818 .BI MC\~ column-width\~\c
2819 .RI [ gutter-width ]
2820 Begin multi-column layout.
2821 .
2822 .I groff mm
2823 creates as many columns of
2824 .I column-width
2825 as the line length will permit.
2826 .
2827 .I gutter-width
2828 is the interior spacing between columns.
2829 .
2830 It defaults to
2831 .IR column-width /15.
2832 .
2833 .B NCOL
2834 moves to the next column,
2835 and
2836 .B 1C
2837 returns to single-column layout.
2838 .
2839 .B MC
2840 is a
2841 .I groff mm
2842 extension,
2843 generalizing
2844 .BR 2C .
2845 .
2846 See
2847 .B MULB
2848 for an alternative.
2849 .
2850 .
2851 .TP
2852 .BI ML\~ mark\c
2853 .RI \~[ text-indent \~[\c
2854 .BR 1 ]]
2855 Start a
2856 .I "marked list;"
2857 the
2858 .I mark
2859 argument precedes each item.
2860 .
2861 .I text-indent
2862 overrides the default indentation of the list items,
2863 which is the width of
2864 .I mark
2865 plus one en.
2866 .
2867 A third argument suppresses the vertical space that normally precedes
2868 each list item;
2869 see register
2870 .BR Lsp .
2871 .
2872 Vertical space in the amount of
2873 .B Lsp
2874 precedes the list itself,
2875 but does not accumulate with pre-item space
2876 when this list is nested in another.
2877 .
2878 .B ML
2879 calls
2880 .BR LB ;
2881 use
2882 .B LI
2883 to declare list items,
2884 and
2885 .B LE
2886 to end the list.
2887 .
2888 .
2889 .TP
2890 .BR MT \~\c \" we must use 2-font macro with \c
2891 .RI [ type \~[ addressee ]]
2892 Select memorandum type.
2893 .
2894 These correspond to formats used by AT&T Bell Laboratories,
2895 where the
2896 .I mm
2897 package was initially developed,
2898 affecting the document layout.
2899 .
2900 Some of these included a cover page with a caption categorizing the
2901 document.
2902 .
2903 .I groff mm
2904 uses
2905 .I type
2906 to construct the file name
2907 .IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/\:\% type \:.MT
2908 and load it with the
2909 .B mso
2910 request.
2911 .
2912 Memorandum types 0 to\~5 are supported;
2913 any other value of
2914 .I type
2915 is mapped to type\~6.
2916 .
2917 Omitting
2918 .I type
2919 implies
2920 .BR 1 .
2921 .
2922 .I addressee
2923 sets a string analogous to one used by AT&T cover page macros
2924 not implemented in
2925 .IR "groff mm" .
2926 .
2927 .
2928 .IP
2929 .TS
2930 tab(@);
2931 Lf(BI) Lb
2932 L L.
2933 type@Description
2934 0@normal memorandum; no caption
2935 1@captioned \[lq]TECHNICAL MEMORANDUM\[rq]
2936 2@captioned \[lq]INTERNAL MEMORANDUM\[rq]
2937 3@captioned \[lq]ADMINISTRATIVE MEMORANDUM\[rq]
2938 4@released paper
2939 5@external letter
2940 .T&
2941 LI L.
2942 string@captioned \fIstring\fP
2943 .TE
2944 .
2945 .
2946 .IP
2947 See
2948 .B \%COVER
2949 for a more flexible cover page mechanism.
2950 .
2951 .
2952 .TP
2953 .BI MOVE\ "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
2954 Move to a position, setting page offset to
2955 .IR x-pos .
2956 .
2957 If
2958 .I line-length
2959 is not given, the difference between current and new page offset is
2960 used.
2961 .
2962 Use
2963 .B PGFORM
2964 without arguments to return to normal.
2965 .
2966 .
2967 .TP
2968 .BR MULB \~\c \" space in roman; we must use 2-font macro with \c
2969 .IR "cw1 sp1\~" [ "cw2 sp2" "] .\|.\|.\~" cwn
2970 Begin alternative multi-column mode.
2971 .
2972 All column widths
2973 .IR cw i
2974 must be specified,
2975 as must the amount of space
2976 .IR sp i
2977 between each column pair.
2978 .
2979 .B MULB
2980 uses a diversion and operates in a separate environment.
2981 .
2982 .
2983 .TP
2984 .B MULE
2985 End alternative multi-column mode and emit the columns.
2986 .
2987 .
2988 .TP
2989 .B MULN
2990 Start next column in alternative column mode.
2991 .
2992 .
2993 .TP
2994 .B NCOL
2995 Start next column
2996 (only when using
2997 .B 2C
2998 or
2999 .BR MC ).
3000 .
3001 Contrast with
3002 .BR MULN .
3003 .
3004 .
3005 .TP
3006 .BR ND \~[\c
3007 .IR arg ]
3008 Set the document's date.
3009 .
3010 .I mm
3011 does not interpret
3012 .IR arg ;
3013 it can be a revision identifier
3014 (or empty).
3015 .
3016 .\" Explain debugging output at level 5 or higher.
3017 .I mm
3018 calls
3019 .B ND
3020 itself when initializing.
3021 .
3022 .
3023 .TP
3024 .B NE
3025 End notation begun with
3026 .BR NS ;
3027 filling is enabled.
3028 .
3029 .
3030 .\" XXX: Could we use a more general mechanism? Call it `NP`?
3031 .TP
3032 .BR nP\~ [\c
3033 .IR type ]
3034 As
3035 .BR P ,
3036 but set a paragraph number in the form
3037 .IR x . yy ,
3038 where
3039 .I x
3040 is the number of the second heading level,
3041 and
3042 .I yy
3043 increments with each
3044 .B nP
3045 call;
3046 its value is not reset when the second-level heading number changes.
3047 .
3048 .I mm
3049 uses a register format of \[lq]00\[rq] for
3050 .I yy.
3051 .
3052 .
3053 .br
3054 .ne 6v
3055 .TP
3056 .BR NS \~[\c
3057 .IR code \~[\c
3058 .BR 1 ]]
3059 Declare notations,
3060 typically for letters or memoranda,
3061 of the type specified by
3062 .IR code .
3063 .
3064 The text corresponding to
3065 .I code
3066 is output,
3067 and filling is disabled
3068 until the document calls
3069 .BR NE .
3070 .
3071 Typically,
3072 a list of names or attachments lies within
3073 .BR NS / NE .
3074 .
3075 If
3076 .I code
3077 is absent or does not match one of the values listed under the
3078 .B \%Letns
3079 string description below,
3080 each line of notations is formatted as
3081 .RI "\[lq]Copy (" line ") to\[rq]."
3082 .
3083 If a second argument,
3084 conventionally
3085 .BR 1 ,
3086 is given,
3087 .I code
3088 becomes the entire notation and
3089 .B NE
3090 is not necessary.
3091 .
3092 In
3093 .IR "groff mm" ,
3094 you can set up further notations to be recognized by
3095 .BR NS ;
3096 see the strings
3097 .B \%Letns
3098 and
3099 .B \%Letnsdef
3100 below.
3101 .
3102 .
3103 .TP
3104 .BR OF\~ [ \[dq]\|\[aq]\c
3105 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
3106 ]
3107 Define the odd-page footer,
3108 which is formatted just above the normal page footer on odd-numbered
3109 pages.
3110 .
3111 See
3112 .BR PF .
3113 .
3114 .B OF
3115 defines the string
3116 .BR EOPof .
3117 .
3118 .
3119 .TP
3120 .BR OH\~ [ \[dq]\|\[aq]\c
3121 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
3122 ]
3123 Define the odd-page header,
3124 which is formatted just below the normal page header on odd-numbered
3125 pages.
3126 .
3127 See
3128 .BR PH .
3129 .
3130 .B OH
3131 defines the string
3132 .BR TPoh .
3133 .
3134 .
3135 .TP
3136 .B OP
3137 Ensure that subsequent text is formatted at the top of an odd-numbered
3138 page;
3139 no page break is performed if the drawing position is already there.
3140 .
3141 .
3142 .br
3143 .ne 4v
3144 .TP
3145 .BR P \~[\c
3146 .IR type ]
3147 Begin new paragraph.
3148 .
3149 If
3150 .I type
3151 is missing
3152 .RB or\~ 0 ,
3153 .BR P \~sets
3154 the paragraph fully left\-aligned.
3155 .
3156 A
3157 .I type
3158 .RB of\~ 1
3159 indents the first line by
3160 .B \[rs][Pi]
3161 ens.
3162 .
3163 Set the register
3164 .B Pt
3165 to select a default paragraph indentation style.
3166 .
3167 The register
3168 .B Ps
3169 determines the amount of vertical space between paragraphs.
3170 .
3171 .
3172 .IP
3173 To set a paragraph with a hanging indent,
3174 use
3175 .B VL
3176 with the desired indentation as the argument,
3177 .B LI
3178 (with no argument),
3179 and
3180 .BR LE .
3181 .
3182 .
3183 .TP
3184 .B PE
3185 End picture input preprocessed by
3186 .MR \%pic 1 ;
3187 see
3188 .BR PS .
3189 .
3190 .
3191 .TP
3192 .BR PF\~ [ \[dq]\|\[aq]\c
3193 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
3194 ]
3195 Define the page footer.
3196 .
3197 The footer is formatted at the bottom of each page;
3198 the argument is otherwise as described in
3199 .BR PH .
3200 .
3201 .B PF
3202 defines the string
3203 .BR EOPf .
3204 .
3205 See
3206 .BR EF ,
3207 .BR OF ,
3208 and
3209 .BR EOP .
3210 .
3211 .TP
3212 .BR PGFORM \~\c
3213 .RI [ line-length \~\c
3214 .RI [ page-length \~\c
3215 .RI [ page-offset \~\c
3216 .RB [ 1 ]]]]
3217 Set line length, page length, and/or page offset.
3218 .
3219 This macro can be used for letterheads and similar.
3220 .
3221 It is normally the first macro call in a file,
3222 though it is not necessary.
3223 .
3224 .B PGFORM
3225 can be used without arguments to reset everything after a
3226 .B MOVE
3227 call.
3228 .
3229 A line break is done unless the fourth argument is given.
3230 .
3231 This can be used to avoid the page number on the first page
3232 while setting new width and length.
3233 .
3234 (It seems as if this macro sometimes doesn't work too well.
3235 .
3236 Use the command-line arguments to change
3237 line length, page length, and page offset instead.)
3238 .
3239 .TP
3240 .B PGNH
3241 Suppress header on the next page.
3242 .
3243 To suppress a header on the first page,
3244 call this macro prior to formatting any text in the document.
3245 .
3246 Also see
3247 .RB register\~ N .
3248 .
3249 .
3250 .TP
3251 .BR PH\~ [ \[dq]\|\[aq]\c
3252 .IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
3253 ]
3254 .RS
3255 Define the page header,
3256 formatted at the top of each page,
3257 as the argument,
3258 where
3259 .IR left ,
3260 .IR center ,
3261 and
3262 .I right
3263 are aligned to the respective locations on the line.
3264 .
3265 A
3266 .RB \[lq] % \[rq]
3267 character in
3268 .I arg
3269 is replaced by the page number.
3270 .
3271 If the argument is absent,
3272 no page header is set.
3273 .
3274 The default page header is
3275 .
3276 .RS
3277 .EX
3278 \[dq]\[aq]\[aq]\- % \-\[aq]\[aq]\[dq]
3279 .EE
3280 .RE
3281 .
3282 which centers the page number between hyphens and formats nothing at the
3283 upper left and right.
3284 .
3285 Header macros call
3286 .B PX
3287 (if defined)
3288 after formatting the header.
3289 .
3290 .B PH
3291 defines the string
3292 .BR TPh .
3293 .
3294 See
3295 .BR EH ,
3296 .BR OH ,
3297 and
3298 .BR TP .
3299 .RE
3300 .
3301 .
3302 .TP
3303 .BR PIC \~\c
3304 .RB [ \-B ]\~\c
3305 .RB [ \-C \||\|\c
3306 .BI \-I\~ n\c
3307 .RB \||\| \-L \c
3308 .RB \||\| \-R ]\~\c
3309 .IR file \~[ width \~[ height ]]
3310 Include PostScript document
3311 .IR file .
3312 .
3313 The optional
3314 .B \-B
3315 argument draws a box around the picture.
3316 .
3317 The optional
3318 .BR \-L ,
3319 .BR \-C ,
3320 .BR \-R ,
3321 and
3322 .BI \-I\~ n
3323 arguments align the picture or indent it by
3324 .IR n .
3325 .
3326 By default,
3327 the picture is left-aligned.
3328 .
3329 Optional
3330 .I width
3331 and
3332 .I height
3333 arguments resize the picture.
3334 .
3335 Use of this macro requires two-pass processing;
3336 see
3337 .B INITR
3338 and
3339 .MR mmroff 1 .
3340 .
3341 .
3342 .TP
3343 .B PS
3344 Start picture input preprocessed by
3345 .MR \%pic 1 .
3346 .
3347 .
3348 .TP
3349 .B PY
3350 As
3351 .BR PE ,
3352 but with \[lq]flyback\[rq],
3353 returning the drawing position to where it was prior to the picture.
3354 .
3355 This is a
3356 .I groff mm
3357 extension.
3358 .
3359 .
3360 .TP
3361 .BR R \~\c \" space in roman; we must use 2-font macro with \c
3362 .RI [ roman-text\~\c
3363 .RI [ previous-font-text ]]\~.\|.\|.
3364 Join
3365 .I roman-text
3366 in roman style with
3367 .I previous-font-text
3368 in the previous font,
3369 without space between the arguments.
3370 .
3371 If no arguments,
3372 switch font to roman style.
3373 .
3374 .
3375 .TP
3376 .BR RB \~\c \" space in roman; we must use 2-font macro with \c
3377 .RI [ roman-text\~\c
3378 .RI [ bold-text ]]\~.\|.\|.
3379 Join
3380 .I roman-text
3381 in roman style with
3382 .I bold-text
3383 in boldface,
3384 without space between the arguments.
3385 .
3386 .
3387 .TP
3388 .BR RD \~\c
3389 .RI [ prompt\~ [ div\~ [ str ]]]
3390 Write
3391 .I prompt
3392 (if specified,
3393 a tab and colon \[lq]:\[rq]
3394 to the standard error stream
3395 and read response from standard input stream,
3396 optionally into a diversion
3397 .I div
3398 and/or string
3399 .I str.
3400 .
3401 Interpolate the saved text by calling its name like a macro.
3402 .
3403 If
3404 .I string
3405 is present,
3406 the input
3407 .\" XXX: DWB 3.3 mm does this; Heirloom Doctools and groff mm do not.
3408 .\" up to the first newline
3409 is also stored in a string of that name.
3410 .
3411 .
3412 .TP
3413 .B RF
3414 End a bibliographic reference citiation started with
3415 .BR RS .
3416 .
3417 See
3418 .BR RP .
3419 .
3420 .
3421 .TP
3422 .BR RI \~\c \" space in roman; we must use 2-font macro with \c
3423 .RI [ roman-text\~\c
3424 .RI [ italic-text ]]\~.\|.\|.
3425 Join
3426 .I roman-text
3427 in roman style with
3428 .I italic-text
3429 in italics,
3430 without space between the arguments.
3431 .
3432 .
3433 .TP
3434 .BR RL \~[\c
3435 .IR text-indent \~[\c
3436 .BR 1 ]]
3437 Begin an auto-incrementing numbered list,
3438 where item numbers start at one and set between square brackets.
3439 .
3440 A
3441 .I text-indent
3442 argument overrides register
3443 .BR Li .
3444 .
3445 A second argument suppresses the vertical space that normally precedes
3446 each list item;
3447 see register
3448 .BR Lsp .
3449 .
3450 Vertical space in the amount of
3451 .B Lsp
3452 precedes the list itself,
3453 but does not accumulate with pre-item space
3454 when this list is nested in another.
3455 .
3456 .B RL
3457 calls
3458 .BR LB ;
3459 use
3460 .B LI
3461 to declare list items,
3462 and
3463 .B LE
3464 to end the list.
3465 .
3466 \[lq]RL\[rq] is a mnemonic for \[lq]reference list\[rq],
3467 but this macro has no relationship with
3468 .IR mm 's
3469 bibliographic reference list facilities.
3470 .
3471 .
3472 .TP
3473 .BR RP \~\c \" space in roman; we must use 2-font macro with \c
3474 .RI [ suppress-counter-reset \~[ page-ejection-policy ]]
3475 Format a reference list,
3476 listing items accumulated within
3477 .BR RS / RF
3478 pairs.
3479 .
3480 The reference counter is reset unless the first argument
3481 .RB is\~ 1 .
3482 .
3483 Normally,
3484 page breaks occur before and after the references are output;
3485 the register
3486 .B Rpej
3487 configures this behavior,
3488 and a second argument overrides its value.
3489 .
3490 .B TC
3491 calls
3492 .B RP
3493 automatically if references have accumulated.
3494 .
3495 .
3496 .IP
3497 .I "groff mm"
3498 calls
3499 .B LB
3500 to format the reference list;
3501 the
3502 .B Rpfmt
3503 string configures the list's appearance.
3504 .
3505 Setting register
3506 .B Ls
3507 .RB to\~ 0
3508 suppresses spacing after the list.
3509 .
3510 The string
3511 .B Rp
3512 contains the reference list caption.
3513 .
3514 .
3515 .TP
3516 .B RPX
3517 This hook macro assumes responsibility for formatting
3518 the heading of the reference page that
3519 .B RP
3520 produces.
3521 .
3522 If not defined
3523 (the default),
3524 .I mm
3525 sets the reference list caption in the string
3526 .B Rp
3527 after two vees of space,
3528 centered in italics,
3529 followed by another vee of space.
3530 .
3531 .
3532 .br
3533 .ne 5v
3534 .TP
3535 .BR RS \~[\c
3536 .IR reference-string ]
3537 Begin citation of an automatically numbered bibliographic reference
3538 entry.
3539 .
3540 .I mm
3541 collects input into a reference entry until the document calls
3542 .BR RF .
3543 .
3544 A subsequent
3545 .B RP
3546 call emits the accumulated entries.
3547 .
3548 References are numbered starting at 1;
3549 the register
3550 .B :R
3551 stores the most recently assigned number.
3552 .
3553 Interpolate the string
3554 .B Rf
3555 where the reference mark should be,
3556 then place the entry between
3557 .B RS
3558 and
3559 .B RF
3560 calls on text lines after the reference mark.
3561 .
3562 The
3563 .B \%Rfstyle
3564 register determines whether the mark is bracketed,
3565 superscripted,
3566 or both.
3567 .
3568 If
3569 .I reference-string
3570 is specified,
3571 .I mm
3572 also stores the reference mark in a string of that name.
3573 .
3574 .
3575 .TP
3576 .BR S \~[\c
3577 .IR type-size \~[ vertical-spacing ]]
3578 Set type size and vertical spacing.
3579 .
3580 Each argument is a
3581 .I groff
3582 measurement,
3583 using an appropriate scaling unit and an optional
3584 .B +
3585 or
3586 .B \-
3587 prefix to increment or decrement the current value.
3588 .
3589 An argument of
3590 .B P
3591 restores the previous value,
3592 .B C
3593 retains the current value,
3594 and
3595 .B D
3596 requests the default.
3597 .
3598 .I mm
3599 treats an empty or omitted argument as
3600 .BR P .
3601 .
3602 .
3603 .TP
3604 .BR SA \~\c
3605 .RI [ mode ]
3606 Set or restore the default enablement of adjustment.
3607 .
3608 Specify
3609 .B 0
3610 or
3611 .B 1
3612 as
3613 .I mode
3614 to set a document's default explicitly;
3615 .I "groff mm"
3616 assumes
3617 .BR 1 .
3618 .\" DWB 3.3 mm assumed 1 for troff mode, 0 for nroff mode.
3619 .
3620 Invoke the
3621 .B na
3622 request as desired to temporarily suspend adjustment.
3623 .
3624 .B H
3625 and
3626 .BR HU ,
3627 and
3628 .B SA
3629 when called without a
3630 .I mode
3631 argument,
3632 restore the default adjustment.
3633 .
3634 .
3635 .TP
3636 .BI SETR\~ ref-name\~\c
3637 .RI [ string ]
3638 Create reference
3639 .IR ref-name ,
3640 storing its heading and page numbers.
3641 .
3642 If
3643 .I string
3644 is present,
3645 .I "groff mm"
3646 saves it as an auxiliary datum for retrieval by
3647 .BR GETST .
3648 .
3649 See
3650 .BR INITR .
3651 .
3652 .
3653 .TP
3654 .BR SG\~ [\c
3655 .IR arg \~[\c
3656 .BR 1 ]]
3657 Output author signature block(s) in
3658 .B LT
3659 letters and
3660 .B MT
3661 memoranda.
3662 .
3663 The format of a signature block depends on the letter or memorandum
3664 type.
3665 .
3666 See subsection \[lq]Internals\[rq] below.
3667 .
3668 .
3669 .IP
3670 .B LT
3671 letters emit a signature for one author at most
3672 (see
3673 .BR WA ).
3674 .
3675 The author's title,
3676 if any,
3677 is set on the next line,
3678 indented to align with the name,
3679 except in letter type \[lq]SP\[rq],
3680 where it is set in full capitals
3681 (like the name)
3682 after a comma and space.
3683 .
3684 .
3685 .IP
3686 Memorandum type\~4 uses no signature block.
3687 .
3688 In other memoranda,
3689 each of an author's titles is set on a subsequent line,
3690 indented to align with the name.
3691 .
3692 .\" DWB 3.3 mm's manual documented the following behavior, including
3693 .\" examples, but it, Plan 9 mm, and Heirloom Doctools mm don't actually
3694 .\" do it. groff mm does.
3695 They furthermore encode a secretarial annotation
3696 including the location,
3697 department,
3698 and initials specified in each author's
3699 .B AU
3700 call,
3701 followed by any
3702 .IR arg ,
3703 writing it at the left margin preceding the last author's name,
3704 or preceding the first if a second
3705 .B SG
3706 argument is present.
3707 .
3708 .
3709 .TP
3710 .BR SK \~\c
3711 .RI [ n ]
3712 Skip
3713 .I n
3714 pages.
3715 .
3716 If
3717 .I n
3718 .RB is\~ 0
3719 or omitted,
3720 .I mm
3721 breaks the page if necessary.
3722 .
3723 Otherwise,
3724 .I mm
3725 prints
3726 .I n
3727 pages,
3728 blank except for any headers and footers.
3729 .
3730 .
3731 .br
3732 .ne 4v \" XXX: 3v should suffice
3733 .TP
3734 .BI SM\~ text\~\c
3735 .RI [ post ]
3736 .TQ
3737 .BI SM\~ "pre text post"
3738 Format
3739 .I text
3740 at a smaller type size,
3741 joined with any specified
3742 .I pre
3743 and
3744 .I post
3745 at normal size,
3746 without space between the arguments.
3747 .
3748 .
3749 .TP
3750 .BR SP \~\c
3751 .RI [ distance ]
3752 Space downward by
3753 .I distance.
3754 .
3755 Multiple
3756 .B SP
3757 calls in sequence produce only the largest of the specified
3758 .I distances.
3759 .
3760 .B SP
3761 accepts boundary-relative motions specified with a prefixed
3762 .B |
3763 operator,
3764 but not negative ones.
3765 .
3766 .
3767 .IP
3768 .B SP
3769 has no effect when the drawing position is at the top of the page.
3770 .
3771 Put the dummy character escape sequence
3772 .B \[rs]&
3773 (followed by
3774 .B \[rs]c
3775 if desired to prevent a break)
3776 on a text line prior to an
3777 .B SP
3778 call to overcome this restriction.
3779 .
3780 .
3781 .TP
3782 .B TAB
3783 Reset tab stops to every 5\~ens.
3784 .
3785 The
3786 .B ta
3787 request customizes them.
3788 .
3789 .
3790 .br
3791 .ne 4v
3792 .TP
3793 .BR TB \~\c
3794 .RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
3795 Caption a table.
3796 .
3797 Arguments are handled analogously to
3798 .BR EC .
3799 .
3800 The register
3801 .B Tb
3802 is the table counter.
3803 .
3804 The string
3805 .B Captb
3806 precedes the table number and any
3807 .I title.
3808 .
3809 .I mm
3810 centers table captions irrespective of the alignment of any enclosing
3811 display.
3812 .
3813 .
3814 .IP
3815 The package lists captioned tables in a table of contents
3816 (see
3817 .BR TC )
3818 if the Boolean register
3819 .B Lt
3820 is true.
3821 .
3822 The string
3823 .B Lt
3824 captions this list.
3825 .
3826 .
3827 .TP
3828 .BR TC \~\c
3829 .RI [ slevel\~\c
3830 .RI [ spacing\~\c
3831 .RI [ tlevel\~\c
3832 .RI [ tab\~\c
3833 .RI [ h1\~\c
3834 .RI [ h2\~\c
3835 .RI [ h3\~\c
3836 .RI [ h4\~\c
3837 .RI [ h5 ]]]]]]]]]
3838 Output table of contents.
3839 .
3840 This macro is normally the last called in the document.
3841 .
3842 It flushes any pending displays and,
3843 if any references are pending
3844 (see
3845 .BR RS ),
3846 calls
3847 .BR RP .
3848 .
3849 It then begins a new page with the contents caption,
3850 stored in the string
3851 .BR Captc ,
3852 centered at the top.
3853 .
3854 The entries follow after three vees of space.
3855 .
3856 Each entry is a
3857 saved section
3858 (number and)
3859 heading title
3860 (see the
3861 .B Cl
3862 register),
3863 along with its associated page number.
3864 .
3865 By default,
3866 .I mm
3867 indents an entry by an amount corresponding to its heading level
3868 and the maximum heading length encountered at that heading level;
3869 if defined,
3870 the string
3871 .B Ci
3872 overrides these indentations.
3873 .
3874 Entries at heading levels up to and including
3875 .I slevel
3876 are preceded by
3877 .I spacing
3878 vees of space.
3879 .
3880 Entries at heading levels up to and including
3881 .I tlevel
3882 are followed by a leader and a right-aligned page number.
3883 .
3884 If the Boolean-valued
3885 .I tab
3886 argument is true,
3887 the leader is replaced with horizontal motion in the same amount.
3888 .
3889 For entries above heading level
3890 .IR tlevel ,
3891 the page number follows the heading text after a word space.
3892 .
3893 Each argument
3894 .IR h1 .\|.\|. h5
3895 appears in order on its own line,
3896 centered,
3897 above the contents caption.
3898 .
3899 Page numbering restarts at 1,
3900 in register format \[lq]i\[rq].
3901 .
3902 If the
3903 .B Oc
3904 register is true,
3905 numbering of these pages is suppressed.
3906 .
3907 .
3908 .IP
3909 If the document calls
3910 .B TC
3911 with at most four arguments,
3912 .I mm
3913 calls the hook macro
3914 .B TX
3915 prior to formatting the contents caption,
3916 and
3917 .B TY
3918 (if defined)
3919 .I instead
3920 of formatting the contents caption.
3921 .
3922 .
3923 .IP
3924 .I mm
3925 then presents lists of
3926 figures,
3927 tables,
3928 equations,
3929 and exhibits,
3930 in that order.
3931 A list appears only if at least one such captioned item is present,
3932 and if its corresponding register
3933 .RB ( Le ,
3934 .BR Lf ,
3935 .BR Lt ,
3936 or
3937 .BR Lx )
3938 is set.
3939 .
3940 .BI TX xx
3941 and
3942 .BI TY xx
3943 macros,
3944 where
3945 .I xx
3946 is \[lq]FG\[rq],
3947 \[lq]TB\[rq],
3948 \[lq]EC\[rq],
3949 or \[lq]EX\[rq],
3950 and strings
3951 .BR Capfg ,
3952 .BR Captb ,
3953 .BR Capec ,
3954 and
3955 .B Capex
3956 analogously configure the output of each captioned list.
3957 .
3958 .
3959 .TP
3960 .B TE
3961 End
3962 .MR \%tbl 1
3963 table.
3964 .
3965 See
3966 .BR TS .
3967 .
3968 .TP
3969 .B TH
3970 Mark the end of a
3971 .BR TS / TE
3972 table heading.
3973 .
3974 When a table spans multiple pages,
3975 the heading repeats at the top of each page.
3976 .
3977 .I "groff mm"
3978 does not implement the
3979 .B N
3980 argument supported by DWB.
3981 .
3982 .
3983 .TP
3984 .BR TL \~[\c
3985 .IR charging-case-number \~[\c
3986 .IR filing-case-number ]]
3987 Begin document title.
3988 .
3989 .I mm
3990 collects
3991 input into the title until a subsequent
3992 .B AU
3993 call and formats it as directed by the
3994 .B MT
3995 memorandum type or cover page macros.
3996 .
3997 .I mm
3998 saves
3999 .I charging-case-number
4000 and
4001 .I filing-case-number
4002 for use in all memorandum types except 4.
4003 .
4004 .
4005 .TP
4006 .BI TM\~ number\c
4007 \~.\|.\|.
4008 Declare technical memorandum number(s) used with
4009 .B MT
4010 memoranda.
4011 .
4012 .
4013 .br
4014 .ne 6v
4015 .TP
4016 .B TP
4017 .I mm
4018 calls this hook macro in lieu of normal page header layout.
4019 .
4020 The package uses a separate environment to format headers and footers.
4021 .
4022 See
4023 .BR EOP .
4024 .
4025 .
4026 .br
4027 .ie t .ne 4v
4028 .el .ne 5v \" for horizontal rule
4029 .IP
4030 .TS
4031 tab(@);
4032 Cb S
4033 Lb L.
4034 Strings available to TP
4035 _
4036 TPh@argument to \fBPH\fP
4037 TPeh@argument to \fBEH\fP
4038 TPoh@argument to \fBOH\fP
4039 .TE
4040 .
4041 .
4042 .TP
4043 .BR TS\~ [ H ]
4044 Start
4045 .MR \%tbl 1
4046 table.
4047 .
4048 Argument \[lq]H\[rq] tells
4049 .I mm
4050 that the table's heading should repeat after page breaks.
4051 .
4052 See
4053 .BR TE ,
4054 .BR TH ,
4055 and
4056 .MR \%tbl 1 .
4057 .
4058 .
4059 .TP
4060 .BR VERBON \~\c \" space in roman; we must use 2-font macro with \c
4061 .RI [ format \~[ type-size \~[ font ]]]
4062 Begin display of verbatim content.
4063 .
4064 .I format
4065 controls several parameters.
4066 .
4067 Add up the values of desired features;
4068 the default
4069 .RB is\~ 0 .
4070 .
4071 Further arguments configure the
4072 .I type-size
4073 in typographical points
4074 (on typesetting devices),
4075 and the face
4076 .RI ( font ).
4077 .
4078 On typesetting devices,
4079 the default face is
4080 .B CR
4081 (Courier roman),
4082 a monospaced font:
4083 all glyphs are equally wide.
4084 .
4085 .
4086 .IP
4087 .TS
4088 tab(@);
4089 lb lb
4090 l lx.
4091 Value@Effect
4092 1@Disable the formatter's escape character (\[rs]).
4093 2@Vertically space before the display.
4094 4@Vertically space after the display.
4095 8@T{
4096 Number output lines; call formatter's
4097 .B nm
4098 request with arguments in string
4099 .BR Verbnm .
4100 T}
4101 16@T{
4102 Indent by the amount stored in register
4103 .BR Verbin .
4104 T}
4105 .TE
4106 .
4107 .
4108 .TP
4109 .B VERBOFF
4110 End verbatim display.
4111 .
4112 .
4113 .TP
4114 .BR VL \~[\c
4115 .IR text-indent \~[ mark-indent \~[\c
4116 .BR 1 ]]]
4117 Begin variable-item
4118 (or \[lq]tagged\[rq])
4119 list.
4120 .
4121 Each item should supply its own mark,
4122 or tag.
4123 .
4124 A
4125 .I text-indent
4126 argument overrides register
4127 .BR Pi ;
4128 .I mark-indent
4129 sets the distance from the indentation of the current list to the mark.
4130 .
4131 A third argument suppresses the vertical space that normally precedes
4132 each list item;
4133 see register
4134 .BR Lsp .
4135 .
4136 Vertical space in the amount of
4137 .B Lsp
4138 precedes the list itself,
4139 but does not accumulate with pre-item space
4140 when this list is nested in another.
4141 .
4142 .B RL
4143 calls
4144 .BR LB ;
4145 use
4146 .B LI
4147 to declare list items,
4148 and
4149 .B LE
4150 to end the list.
4151 .
4152 .
4153 .TP
4154 .BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP"
4155 Configure vertical margins.
4156 .
4157 .
4158 .IP
4159 Without a
4160 .B \-T
4161 argument,
4162 increment the top and bottom margins by
4163 .I top
4164 and
4165 .IR bottom ,
4166 respectively.
4167 .
4168 If absent,
4169 set the corresponding margin to zero.
4170 .
4171 .
4172 .IP
4173 With the
4174 .B \-T
4175 argument,
4176 set the top and bottom margins to
4177 .I top
4178 and
4179 .IR bottom ,
4180 respectively.
4181 .
4182 If absent,
4183 set the respective margin to the default
4184 (top:
4185 .BR 7v ,
4186 bottom:
4187 .BR 6v ).
4188 .
4189 .
4190 .IP
4191 We recommend defining the hook macros
4192 .B TP
4193 and/or
4194 .B EOP
4195 if using
4196 .B \-T
4197 and setting top and/or bottom margin to values less than the default.
4198 .
4199 .I groff mm
4200 exposes this undocumented DWB macro
4201 to enable greater user control of page layout.
4202 .
4203 .
4204 .TP
4205 .BR WA \~[\c
4206 .IR writer's-name \~[\c
4207 .IR title ]]
4208 Specify the writer(s) of an
4209 .B LT
4210 letter.
4211 .
4212 .I mm
4213 collects input into the writer's address until the document calls
4214 .BR WE ,
4215 then outputs it.
4216 .
4217 You can specify multiple writers with empty
4218 .BR WA / WE
4219 pairs;
4220 only the last address is used.
4221 .
4222 The arguments give each writer a name and title.
4223 .
4224 .
4225 .TP
4226 .BR WC \~[\c
4227 .IR format \~.\|.\|.]
4228 Control width of footnotes and displays.
4229 .
4230 .
4231 .IP
4232 .RS
4233 .TS
4234 tab(@);
4235 Lf(BI) Lb
4236 Lb Lx.
4237 format@Effect
4238 N@T{
4239 equivalent to
4240 .RB \[lq] "\-WF \-FF \-WD" \[rq]
4241 .\" FB \" XXX: see Savannah ticket reference below
4242 (default)
4243 T}
4244 WF@T{
4245 set footnotes at full line length,
4246 even in two-column mode
4247 .\" XXX: what about multi-column modes more generally?
4248 T}
4249 \-WF@T{
4250 set footnotes using column line length
4251 T}
4252 FF@T{
4253 apply width of first footnote to encountered to subsequent ones
4254 T}
4255 \-FF@T{
4256 footnote width determined by
4257 .B WF
4258 and
4259 .B \-WF
4260 T}
4261 WD@T{
4262 set displays at full line length,
4263 even in two-column mode
4264 .\" XXX: what about multi-column modes more generally?
4265 T}
4266 \-WD@T{
4267 set displays using column line length
4268 T}
4269 .TE
4270 .RE
4271 .\" XXX: See <https://savannah.gnu.org/bugs/?64316>.
4272 .\"FB@T{
4273 .\"Break when outputting floating displays.
4274 .\"T}
4275 .\"\-FB@T{
4276 .\"Do not break when outputting floating displays.
4277 .\"T}
4278 .
4279 .
4280 .TP
4281 .B WE
4282 End the writer's address begun with
4283 .BR WA .
4284 .
4285 .
4286 .br
4287 .ne 4v
4288 .\" ====================================================================
4289 .SH Strings
4290 .\" ====================================================================
4291 .
4292 Many
4293 .I mm
4294 strings interpolate predefined,
4295 localizable text.
4296 .
4297 We present their contents in quotation marks.
4298 .
4299 .
4300 .TP 10n \" "Abstract" + 2n
4301 .B Abstract
4302 \[lq]ABSTRACT\[rq]
4303 .
4304 .
4305 .TP
4306 .B App
4307 \[lq]APPENDIX\[rq]
4308 .
4309 .
4310 .TP
4311 .B Apptxt
4312 stores the
4313 .I title
4314 argument to the most recent
4315 .B APP
4316 call.
4317 .
4318 .
4319 .TP
4320 .B Aumt
4321 lists
4322 space-separated indices of positional arguments to the
4323 .B AU
4324 macro that should be suppressed from appearance in the document heading
4325 on the first page of
4326 .B MT
4327 memorandum types 0\[en]3 and 6.
4328 .
4329 By default,
4330 it is undefined;
4331 all arguments are formatted
4332 except the second
4333 (author initials).
4334 .
4335 .
4336 .TP
4337 .B BU
4338 interpolates a bullet mark,
4339 .BR \[rs][bu] .
4340 .
4341 .
4342 .TP
4343 .B Capec
4344 \[lq]Equation\[rq]
4345 .
4346 .
4347 .TP
4348 .B Capex
4349 \[lq]Exhibit\[rq]
4350 .
4351 .
4352 .TP
4353 .B Capfg
4354 \[lq]Figure\[rq]
4355 .
4356 .
4357 .TP
4358 .B Captb
4359 \[lq]Table\[rq]
4360 .
4361 .
4362 .TP
4363 .B Captc
4364 \[lq]CONTENTS\[rq]
4365 .
4366 .
4367 .TP
4368 .B Ci
4369 assigns indentation amounts used by each heading level listed
4370 in a table of contents,
4371 in one-to-one correspondence,
4372 overriding those computed by
4373 .BR TC .
4374 .
4375 Each word must be a horizontal measurement
4376 (like
4377 .RB \[lq] 1i \[rq]).
4378 .
4379 .
4380 .TP
4381 .B DT
4382 stores the date or other identifier set by
4383 .BR ND ,
4384 if called,
4385 and otherwise one constructed using
4386 the formatter's date registers;
4387 see
4388 .MR groff 1 .
4389 .
4390 The
4391 .I groff
4392 locale determines its format,
4393 but register
4394 .B Isodate
4395 may override it.
4396 .
4397 .
4398 .TP
4399 .B EM
4400 interpolates an em dash,
4401 .BR \[rs][em] .
4402 .
4403 .
4404 .TP
4405 .B F
4406 interpolates an automatically numbered footnote mark;
4407 the number is used by the next
4408 .B FS
4409 call without an argument.
4410 .
4411 In
4412 .I troff
4413 mode,
4414 the mark is superscripted;
4415 in
4416 .I nroff
4417 mode,
4418 it is surrounded by square brackets.
4419 .
4420 .
4421 .TP
4422 .B H1txt
4423 stores the text of the current first-level heading;
4424 .B H
4425 and
4426 .B HU
4427 update it,
4428 as does
4429 .B TC
4430 when processing table of contents entries and captions of displayed
4431 figures,
4432 tables,
4433 equations,
4434 and exhibits.
4435 .
4436 .
4437 .TP
4438 .B HF
4439 assigns font identifiers,
4440 separated by spaces,
4441 to heading levels in one-to-one correspondence.
4442 .
4443 Each identifier may be a font mounting position,
4444 font name,
4445 or style name.
4446 .
4447 Omitted values are assumed to be\~1.
4448 .
4449 The default is
4450 .RB \[lq] "2 2 2 2 2 2 2 2 2 2 2 2 2 2" \[rq],
4451 which places all headings in italics.
4452 .
4453 DWB's default was
4454 .RB \[lq] "3 3 2 2 2 2 2" \[rq].
4455 .
4456 .
4457 .TP
4458 .B HP
4459 assigns type sizes,
4460 separated by spaces,
4461 to heading levels in one-to-one correspondence.
4462 .
4463 .I "groff mm"
4464 interprets each size in typographical points,
4465 translating
4466 zero values to
4467 .BR 10 .
4468 .
4469 Omitted values are assumed to be\~0
4470 (and are translated accordingly).
4471 .
4472 The default is
4473 .RB \[lq] "0 0 0 0 0 0 0 0 0 0 0 0 0 0" \[rq].
4474 .
4475 .
4476 .TP
4477 .B Index
4478 \[lq]INDEX\[rq]
4479 .
4480 .
4481 .TP
4482 .B Le
4483 \[lq]LIST OF EQUATIONS\[rq]
4484 .
4485 .
4486 .TP
4487 .B Letfc
4488 \[lq]Yours very truly,\[rq]
4489 (see
4490 .BR FC )
4491 .
4492 .
4493 .TP
4494 .B Letapp
4495 \[lq]APPROVED:\[rq]
4496 (see
4497 .BR AV )
4498 .
4499 .
4500 .TP
4501 .B LetAT
4502 \[lq]ATTENTION:\[rq]
4503 (see
4504 .BR LO )
4505 .
4506 .
4507 .TP
4508 .B LetCN
4509 \[lq]CONFIDENTIAL\[rq]
4510 (see
4511 .BR LO )
4512 .
4513 .
4514 .TP
4515 .B Letdate
4516 \[lq]Date\[rq]
4517 (see
4518 .BR AV )
4519 .
4520 .
4521 .TP
4522 .B Letns
4523 is a group of strings structuring the notations produced by
4524 .BR NS .
4525 .
4526 If the
4527 .I code
4528 argument to
4529 .B NS
4530 has no corresponding string,
4531 the notation is included between parentheses,
4532 prefixed with
4533 .BR Letns!copy ,
4534 and suffixed with
4535 .BR Letns!to .
4536 .
4537 Observe the spaces after \[lq]Copy\[rq] and before \[lq]to\[rq].
4538 .
4539 .
4540 .br
4541 .ne 3v
4542 .RS
4543 .P
4544 .TS
4545 tab(@);
4546 Lb Lb Lb
4547 L L L.
4548 NS code@String@Contents
4549 0@Letns!0@Copy to
4550 1@Letns!1@Copy (with att.\&) to
4551 2@Letns!2@Copy (without att.\&) to
4552 3@Letns!3@Att.
4553 4@Letns!4@Atts.
4554 5@Letns!5@Enc.
4555 6@Letns!6@Encs.
4556 7@Letns!7@Under separate cover
4557 8@Letns!8@Letter to
4558 9@Letns!9@Memorandum to
4559 10@Letns!10@Copy (with atts.\&) to
4560 11@Letns!11@Copy (without atts.\&) to
4561 12@Letns!12@Abstract Only to
4562 13@Letns!13@Complete Memorandum to
4563 14@Letns!14@CC
4564 \[em]@Letns!copy@Copy \fI(with trailing space)\fP
4565 \[em]@Letns!to@ to \fI(note leading space)\fP
4566 .TE
4567 .RE
4568 .
4569 .
4570 .TP
4571 .B Letnsdef
4572 selects the notation format when
4573 .B NS
4574 is given no argument.
4575 .
4576 The default
4577 .RB is\~ 0 .
4578 .
4579 .
4580 .TP
4581 .B LetRN
4582 \[lq]In reference to:\[rq]
4583 (see
4584 .BR LO )
4585 .
4586 .
4587 .TP
4588 .B LetSA
4589 \[lq]To Whom It May Concern:\[rq]
4590 (see
4591 .BR LO )
4592 .
4593 .
4594 .TP
4595 .B LetSJ
4596 \[lq]SUBJECT:\[rq]
4597 (see
4598 .BR LO )
4599 .
4600 .
4601 .TP
4602 .B Lf
4603 \[lq]LIST OF FIGURES\[rq]
4604 .
4605 .
4606 .TP
4607 .B Lt
4608 \[lq]LIST OF TABLES\[rq]
4609 .
4610 .
4611 .TP
4612 .B Lx
4613 \[lq]LIST OF EXHIBITS\[rq]
4614 .
4615 .
4616 .TP
4617 .B MO1
4618 .TQ
4619 \&.\|.\|.
4620 .TQ
4621 .B MO12
4622 \[lq]January\[rq] through \[lq]December\[rq]
4623 .
4624 .
4625 .TP
4626 .B Qrf
4627 \[lq]See chapter \[rs]E*[Qrfh],
4628 page \[rs]En[Qrfp].\[rq]
4629 .
4630 If your document uses multiple heading levels,
4631 you might redefine this string to use the word \[lq]section\[rq]
4632 instead of \[lq]chapter\[rq].
4633 .
4634 .
4635 .TP
4636 .B Qrfh
4637 stores the heading mark corresponding to the most recent
4638 .B \%GETR
4639 call.
4640 .
4641 .
4642 .TP
4643 .B Qrfp
4644 stores the page number corresponding to the most recent
4645 .B \%GETR
4646 call.
4647 .
4648 .
4649 .TP
4650 .B Rf
4651 interpolates an automatically numbered reference mark;
4652 the number is used by the next
4653 .B RS
4654 call.
4655 .
4656 .
4657 .TP
4658 .B Rp
4659 \[lq]REFERENCES\[rq]
4660 .
4661 .
4662 .TP
4663 .B Rpfmt
4664 specifies the
4665 .B LB
4666 arguments that
4667 .I "groff mm"
4668 uses to format the items in an
4669 .B RP
4670 reference list.
4671 .
4672 The default is
4673 .RB \[lq] "\|\[rs]\[rs]n[Li] 0 1 0 \[rs]& 0\|" \[rq].
4674 .
4675 .
4676 .TP
4677 .B Rg
4678 interpolates the registered (trade) mark sign.
4679 .
4680 .
4681 .TP
4682 .B Sm
4683 interpolates the service mark sign.
4684 .
4685 .
4686 .TP
4687 .B Tcstatus
4688 interpolates an indicator of the
4689 .B TC
4690 macro's processing status.
4691 .
4692 If
4693 .B TC
4694 is not operating,
4695 it is empty.
4696 .
4697 User-defined
4698 .B TP
4699 or
4700 .B EOP
4701 macros might condition page headers or footers on its contents.
4702 .
4703 .
4704 .IP
4705 .TS
4706 tab(@);
4707 lb lb
4708 l l.
4709 Value@Meaning
4710 co@Table of contents
4711 fg@List of figures
4712 tb@List of tables
4713 ec@List of equations
4714 ex@List of exhibits
4715 ap@Appendix
4716 .TE
4717 .
4718 .
4719 .TP
4720 .B Tm
4721 interpolates
4722 .if c \[tm] \[tm],
4723 the trade mark sign.
4724 .
4725 .
4726 .TP
4727 .B Verbnm
4728 supplies argument(s) to the
4729 .B nm
4730 request employed by the
4731 .B VERBON
4732 macro.
4733 .
4734 The default
4735 .RB is\~ 1 .
4736 .
4737 .
4738 .br
4739 .ne 4v
4740 .\" ====================================================================
4741 .SH Registers
4742 .\" ====================================================================
4743 .
4744 Default register values,
4745 where meaningful,
4746 are shown in parentheses.
4747 .
4748 .
4749 .TP 9n \" "Letwam" + 2n + hand-tuned for PDF
4750 .B .mgm
4751 indicates that
4752 .I groff mm
4753 is in use
4754 (Boolean-valued;
4755 .BR 1 ).
4756 .
4757 .
4758 .TP
4759 .B Aph
4760 formats an appendix heading
4761 (and title,
4762 if supplied);
4763 see
4764 .B APP
4765 (Boolean-valued;
4766 .BR 1 ).
4767 .
4768 .
4769 .TP
4770 .B Au
4771 includes supplemental author information
4772 (the third and subsequent arguments to
4773 .BR AU )
4774 in memorandum \[lq]from\[rq] information;
4775 see
4776 .B COVER
4777 and
4778 .BR MT ,
4779 and the
4780 .B Aumt
4781 string
4782 (Boolean-valued;
4783 .BR 1 ).
4784 .
4785 .
4786 .TP
4787 .B Cl
4788 sets the threshold for inclusion of headings in a table of contents.
4789 .
4790 Headings at levels above this value are excluded;
4791 see
4792 .B H
4793 and
4794 .BR TC .
4795 .
4796 The
4797 .B Cl
4798 register controls whether a heading is
4799 .I saved
4800 for output in the table of contents at the time
4801 .B H
4802 or
4803 .B HU
4804 is called;
4805 if you change
4806 .BR Cl 's
4807 value immediately prior to calling
4808 .BR TC ,
4809 you are unlikely to get the result you want
4810 .RB ( 2 ).
4811 .
4812 .
4813 .TP
4814 .B Cp
4815 suppresses page breaks before lists of captioned
4816 equations,
4817 exhibits,
4818 figures,
4819 and tables,
4820 and before an index;
4821 see
4822 .BR EC ,
4823 .BR EX ,
4824 .BR FG ,
4825 .BR TB ,
4826 and
4827 .B INDP
4828 (Boolean-valued;
4829 .\" DWB 3.3's manual said this was 1, but the code said 0.
4830 .BR 0 ).
4831 .
4832 .
4833 .TP
4834 .B D
4835 produces debugging information for the
4836 .I mm
4837 package on the standard error stream.
4838 .
4839 A value of\~0 outputs nothing;
4840 1\~reports formatting progress.
4841 .
4842 Higher values communicate internal state information of increasing
4843 verbosity
4844 .RB ( 0 ).
4845 .
4846 .
4847 .TP
4848 .B De
4849 causes a page break after a floating display is output;
4850 see
4851 .B DF
4852 (Boolean-valued;
4853 .BR 0 ).
4854 .
4855 .
4856 .TP
4857 .B Df
4858 configures the behavior of
4859 .BR DF .
4860 .
4861 The following values are recognized;
4862 4 and 5 do not override the
4863 .B De
4864 register
4865 .RB ( 5 ).
4866 .
4867 .
4868 .IP
4869 .TS
4870 tab(@);
4871 Lb Lb
4872 L Lx.
4873 Value@Effect
4874 0@T{
4875 Flush pending displays
4876 at the end of each section
4877 when section-page numbering is active,
4878 otherwise at the end of the document.
4879 T}
4880 1@T{
4881 Flush a pending display
4882 on the current page or column
4883 if there is enough space,
4884 otherwise at the end of the document.
4885 T}
4886 2@T{
4887 Flush one pending display
4888 at the top of each page or column.
4889 T}
4890 3@T{
4891 Flush a pending display
4892 on the current page or column
4893 if there is enough space,
4894 otherwise at the top of the next.
4895 T}
4896 4@T{
4897 Flush as many pending displays
4898 as possible in a new page or column.
4899 T}
4900 5@T{
4901 Fill columns or pages with flushed displays
4902 until none remain.
4903 T}
4904 .TE
4905 .
4906 .
4907 .TP
4908 .B Ds
4909 puts vertical space in the amount of register
4910 .B Dsp
4911 (if defined) or
4912 .B Lsp
4913 before and after each static display;
4914 see
4915 .B DS
4916 (Boolean-valued;
4917 .BR 1 ).
4918 .
4919 .
4920 .TP
4921 .B Dsp
4922 configures the amount of vertical space placed
4923 before and after static displays;
4924 see
4925 .B DS
4926 and register
4927 .B Ds
4928 .RI ( undefined ).
4929 .
4930 .
4931 .TP
4932 .B Ec
4933 is an auto-incrementing equation counter;
4934 see
4935 .BR EC .
4936 .
4937 .
4938 .TP
4939 .B E
4940 determines the font style used by
4941 .B MT
4942 memoranda,
4943 .B LT
4944 letters,
4945 and the
4946 .I ms.cov
4947 cover page style to set the date and certain other document data;
4948 .B 0
4949 selects roman,
4950 and
4951 .B 1
4952 bold
4953 (Boolean-valued;
4954 .BR 1 ).
4955 .
4956 .
4957 .TP
4958 .B Ej
4959 sets the threshold for page breaks (ejection) prior to the format of
4960 headings.
4961 .
4962 Headings at levels above this value are set on the same page and column
4963 as any preceding text if possible;
4964 see
4965 .B H
4966 .RB ( 0 ).
4967 .
4968 .
4969 .TP
4970 .B Eq
4971 aligns an equation label to the left of a display instead of the right
4972 (Boolean-valued;
4973 .BR 0 ).
4974 .
4975 .
4976 .TP
4977 .B Ex
4978 is an auto-incrementing exhibit counter;
4979 see
4980 .BR EX .
4981 .
4982 .
4983 .TP
4984 .B Fg
4985 is an auto-incrementing figure counter;
4986 see
4987 .BR FG .
4988 .
4989 .
4990 .TP
4991 .B Fs
4992 is multiplied by register
4993 .B Lsp
4994 to vertically separate footnotes;
4995 see
4996 .B FS
4997 .RB ( 1 ).
4998 .
4999 .
5000 .TP
5001 .B Ftnum
5002 is an auto-incrementing footnote counter;
5003 see
5004 .BR FS .
5005 .
5006 .I "groff mm"
5007 recognizes
5008 .B :p
5009 as an alias of
5010 .B Ftnum
5011 for DWB compatibility.
5012 .
5013 .
5014 .TP
5015 .B H1
5016 .TQ
5017 \&.\|.\|.
5018 .TQ
5019 .B H14
5020 are auto-incrementing counters corresponding to each heading level;
5021 see
5022 .BR H .
5023 .
5024 .
5025 .\" XXX: This could be generalized to an "Hdot" threshold register with
5026 .\" a default of 0. ("Apply dots after heading marks beyond/above this
5027 .\" threshold.")
5028 .TP
5029 .B H1dot
5030 appends a period to the number of a level one heading;
5031 see
5032 .B H
5033 (Boolean-valued;
5034 .BR 1 ).
5035 .
5036 .
5037 .\" XXX: This may be insufficiently general; see Savannah #62825.
5038 .TP
5039 .B H1h
5040 is a copy of register
5041 .BR H1 ,
5042 but it is incremented just before a page break.
5043 .
5044 This can be useful in hook macros;
5045 see
5046 .B H
5047 and
5048 .BR HX .
5049 .
5050 .
5051 .TP
5052 .B Hb
5053 sets the threshold for breaking the line after formatting a heading.
5054 .
5055 Text after headings at levels above this value is set on the same
5056 output line if possible.
5057 .
5058 Paragraphs numbered via
5059 .B nP
5060 or the
5061 .B Np
5062 register cause a break regardless;
5063 see
5064 .B H
5065 .RB ( 2 ).
5066 .
5067 .
5068 .TP
5069 .B Hc
5070 sets the threshold for centering a heading.
5071 .
5072 Headings at levels above this value use the prevailing alignment
5073 (that is,
5074 they are not centered);
5075 see
5076 .B H
5077 .RB ( 0 ).
5078 .
5079 .
5080 .br
5081 .ne 7v
5082 .TP
5083 .B Hi
5084 selects an indentation policy for text formatted after headings.
5085 .
5086 It does not affect \[lq]run-in\[rq] headings.
5087 .
5088 The following values are recognized;
5089 see
5090 .B H
5091 and
5092 .B P
5093 .RB ( 1 ).
5094 .
5095 .
5096 .IP
5097 .TS
5098 tab(@);
5099 Lb Lb
5100 L Lx.
5101 Value@Effect
5102 0@no indentation
5103 1@indent per the paragraph type
5104 2@indent to align with heading title
5105 .TE
5106 .
5107 .
5108 .TP
5109 .B Hps
5110 sets the heading level threshold for application of preceding vertical
5111 space;
5112 see
5113 .BR H .
5114 .
5115 Headings at levels above the value in register
5116 .B Hps
5117 use the amount of space in register
5118 .BR Hps1 ;
5119 otherwise that in
5120 .BR Hps2 .
5121 .
5122 The value of
5123 .B Hps
5124 should be strictly greater than that of
5125 .B Ej
5126 .RB ( 1 ).
5127 .
5128 .
5129 .TP
5130 .B Hps1
5131 configures the amount of vertical space preceding a heading above the
5132 .B Hps
5133 threshold;
5134 see
5135 .B H
5136 .RI ( troff
5137 devices:
5138 .BR 0.5v ;
5139 .I nroff
5140 devices:
5141 .BR 1v ).
5142 .
5143 .
5144 .TP
5145 .B Hps2
5146 configures the amount of vertical space preceding a heading within the
5147 .B Hps
5148 threshold;
5149 see
5150 .B H
5151 .RI ( troff
5152 devices:
5153 .BR 1v ;
5154 .I nroff
5155 devices:
5156 .BR 2v ).
5157 .
5158 .
5159 .TP
5160 .B Hs
5161 sets the heading level threshold for application of succeeding vertical
5162 space.
5163 .
5164 If the heading level is greater than
5165 .BR Hs ,
5166 the heading is followed by vertical space in the amount of
5167 .RB register\~ Hss ;
5168 see
5169 .B H
5170 .RB ( 2 ).
5171 .
5172 .
5173 .TP
5174 .B Hss
5175 is multiplied by register
5176 .B Lsp
5177 to produce vertical space after headings above the
5178 threshold in
5179 .RB register\~ Hs ;
5180 see
5181 .B H
5182 .RB ( 1 ).
5183 .
5184 .
5185 .TP
5186 .B Ht
5187 suppresses output of heading level counters above the deepest when a
5188 heading mark is formatted;
5189 see
5190 .B H
5191 (Boolean-valued;
5192 .BR 0 ).
5193 .
5194 .
5195 .
5196 .TP
5197 .B Hu
5198 sets the heading level used by unnumbered headings;
5199 see
5200 .B HU
5201 .RB ( 2 ).
5202 .
5203 .
5204 .TP
5205 .B Hy
5206 enables automatic hyphenation of words
5207 (Boolean-valued;
5208 .BR 0 ).
5209 .
5210 .
5211 .TP
5212 .B Isodate
5213 configures the use of ISO\~8601 date format;
5214 that is,
5215 .IR YYYY - MM - DD
5216 instead of the format specified by the localization file.
5217 .
5218 Call
5219 .B ND
5220 without arguments after updating its value
5221 (Boolean-valued;
5222 .BR 0 ).
5223 .
5224 .
5225 .TP
5226 .B L
5227 defines the page length for the document,
5228 and must be set from the command line.
5229 .
5230 A scaling unit should be appended.
5231 .
5232 The default is that of the selected
5233 .I groff
5234 output device.
5235 .
5236 .
5237 .br
5238 .ne 5v
5239 .TP
5240 .B Le
5241 .TQ
5242 .B Lf
5243 .TQ
5244 .B Lt
5245 .TQ
5246 .B Lx
5247 configure the report of lists of equation,
5248 figure,
5249 table,
5250 and exhibit captions,
5251 respectively,
5252 after a table of contents;
5253 see
5254 .B TC
5255 (all:
5256 Boolean-valued;
5257 .BR 1 ).
5258 .
5259 .
5260 .\" XXX: What is the rationale for this feature?
5261 .TP
5262 .B Letwam
5263 sets the maximum number of input lines permitted in a writer's address;
5264 see
5265 .B WA
5266 and
5267 .B WE
5268 .RB ( 14 ).
5269 .
5270 .
5271 .TP
5272 .B Li
5273 configures the text indentation
5274 (in ens)
5275 applied to enumerated list types;
5276 that is,
5277 to items in
5278 .B AL
5279 and
5280 .B RL
5281 lists,
5282 and in
5283 .B LB
5284 lists whose
5285 .I type
5286 argument is greater than zero
5287 .RB ( 5 ).
5288 .
5289 .
5290 .TP
5291 .B Ls
5292 sets a threshold for placement of vertical space before list items.
5293 .
5294 If the list nesting level is greater than this value,
5295 no such spacing occurs;
5296 see
5297 .B LI
5298 .RB ( \[rs]n[.R] ).
5299 .
5300 .
5301 .TP
5302 .B Lsp
5303 configures the base amount of vertical space used for separation
5304 in the document.
5305 .
5306 .I mm
5307 applies this spacing to many contexts,
5308 sometimes with multipliers;
5309 see
5310 .BR DS ,
5311 .BR FS ,
5312 .BR H ,
5313 .BR LI ,
5314 and
5315 .B P
5316 .RI ( troff
5317 devices:
5318 .BR 0.5v ;
5319 .I nroff
5320 devices:
5321 .BR 1v ).
5322 .
5323 .
5324 .TP
5325 .B N
5326 configures the header and footer placements used by
5327 .BR PH .
5328 .
5329 The default footer is empty.
5330 .
5331 If \[lq]section-page\[rq] numbering is selected,
5332 the default header becomes empty
5333 and the default footer becomes
5334 .RI \[lq] x - y \[rq],
5335 where
5336 .IR x \~is
5337 is the section number
5338 (the number of the current first-level heading)
5339 .RI and\~ y
5340 the page number within the section.
5341 .\" XXX: section-figure numbering needs more documentation.
5342 .
5343 The following values are recognized;
5344 for finer control,
5345 see
5346 .BR PH ,
5347 .BR PF ,
5348 .BR EH ,
5349 .BR EF ,
5350 .BR OH ,
5351 and
5352 .BR OF ,
5353 and registers
5354 .B Sectf
5355 and
5356 .BR Sectp .
5357 .
5358 Value 5 is a
5359 .I groff mm
5360 extension
5361 .RB ( 0 ).
5362 .
5363 .
5364 .br
5365 .ne 3v
5366 .IP
5367 .TS
5368 tab(@);
5369 Lb Lb
5370 L Lx.
5371 Value@Effect
5372 0@Set header on all pages.
5373 1@Move header to footer on page 1.
5374 2@Omit header on page 1.
5375 3@Use \[lq]section-page\[rq] numbering style on all pages.
5376 4@Omit header on all pages.
5377 5@T{
5378 Use \[lq]section-page\[rq] and \[lq]section-figure\[rq] \
5379 numbering style on all pages.
5380 T}
5381 .TE
5382 .
5383 .
5384 .TP
5385 .B Np
5386 numbers paragraphs with a leading mark in the format
5387 .IR s . p ,
5388 where
5389 .IR s \~is
5390 is first-level heading number and
5391 .IR p \~is
5392 the paragraph number,
5393 starting at 1;
5394 see
5395 .B H
5396 and
5397 .B P
5398 (Boolean-valued;
5399 .BR 0 ).
5400 .
5401 .
5402 .TP
5403 .B O
5404 defines the page offset of the document,
5405 and must be set from the command line.
5406 .
5407 A scaling unit should be appended.
5408 .
5409 The default
5410 .RB is\~ \&.75i
5411 on terminal devices.
5412 .
5413 On typesetters,
5414 it is
5415 .B \&.963i
5416 or set to
5417 .B 1i
5418 by the
5419 .I papersize.tmac
5420 package;
5421 see
5422 .MR groff_tmac 5 .
5423 .
5424 .
5425 .TP
5426 .B Oc
5427 suppresses the appearance of page numbers in the table of contents;
5428 see
5429 .B TC
5430 (Boolean-valued;
5431 .BR 0 ).
5432 .
5433 .
5434 .br
5435 .ne 7v
5436 .\" XXX: This really should just be a string, shouldn't it?
5437 .TP
5438 .B Of
5439 selects a separator format within equation,
5440 exhibit,
5441 figure,
5442 and table captions;
5443 see
5444 .BR EC ,
5445 .BR EX ,
5446 .BR FG ,
5447 and
5448 .BR TB .
5449 .
5450 The punctuation in the separator is either a dot or the
5451 .B EM
5452 string.
5453 .
5454 The following values are recognized;
5455 the spaces shown are unpaddable
5456 .RB ( 0 ).
5457 .
5458 .
5459 .IP
5460 .TS
5461 tab(@);
5462 Lb Lb
5463 L Lx.
5464 Value@Effect
5465 0@\[dq]. \[dq]
5466 1@\[dq] \[em] \[dq]
5467 .TE
5468 .
5469 .
5470 .TP
5471 .B P
5472 interpolates the current page number;
5473 it is the same as
5474 .RB register\~ %
5475 except when
5476 \[lq]section-page\[rq] numbering is enabled.
5477 .
5478 .
5479 .TP
5480 .B Pi
5481 configures the indentation
5482 (in ens)
5483 applied to the first line of an unnumbered paragraph that has such
5484 (see
5485 .BR P );
5486 and the text indentation of non-enumerated list items;
5487 that is,
5488 to items in
5489 .BR BL ,
5490 .BR BVL ,
5491 .BR DL ,
5492 and
5493 .B VL
5494 lists
5495 (but not
5496 .BR ML ),
5497 and in
5498 .B LB
5499 lists whose
5500 .I type
5501 argument is zero or less
5502 .RB ( 5 ).
5503 .
5504 .
5505 .TP
5506 .B Pgps
5507 causes the type size and vertical spacing set by
5508 .B S
5509 to apply to headers and footers,
5510 overriding the
5511 .B HP
5512 string.
5513 .
5514 If not set,
5515 .B S
5516 calls affect headers and footers only when followed by
5517 .BR PH ,
5518 .BR PF ,
5519 .BR OH ,
5520 .BR EH ,
5521 .BR OF ,
5522 or
5523 .B EF
5524 calls
5525 (Boolean-valued;
5526 .BR 1 ).
5527 .
5528 .
5529 .TP
5530 .B Ps
5531 is multiplied by register
5532 .B Lsp
5533 to vertically separate paragraphs;
5534 see
5535 .B P
5536 .RB ( 1 ).
5537 .
5538 .
5539 .TP
5540 .B Pt
5541 determines when a first-line indentation is applied to a paragraph;
5542 see
5543 .B P
5544 .RB ( 0 ).
5545 .
5546 .
5547 .br
5548 .ne 4v
5549 .IP
5550 .TS
5551 tab(@);
5552 Lb Lb
5553 L Lx.
5554 Value@Effect
5555 0@never
5556 1@always
5557 2@T{
5558 always,
5559 except immediately after
5560 .BR H ,
5561 .BR HU ,
5562 .BR DE ,
5563 or
5564 .B LE
5565 T}
5566 .TE
5567 .
5568 .
5569 .TP
5570 .B Ref
5571 is used internally to control
5572 .MR mmroff 1 's
5573 two-pass approach to index and reference management;
5574 see
5575 .BR IND ,
5576 .BR INDP ,
5577 .BR INITI ,
5578 .BR INITR ,
5579 and
5580 .B PIC
5581 (Boolean-valued;
5582 .BR 0 ).
5583 .
5584 .
5585 .TP
5586 .B Rfnum
5587 is an auto-incrementing reference counter;
5588 see
5589 .BR RS .
5590 .
5591 .I "groff mm"
5592 recognizes
5593 .B :R
5594 as an alias of
5595 .B Rfnum
5596 for DWB compatibility.
5597 .
5598 .
5599 .TP
5600 .B Rfstyle
5601 determines the format of the reference number in the
5602 .B Rf
5603 string.
5604 .
5605 .I "groff mm"
5606 maps
5607 .B 0
5608 to
5609 .B 1
5610 in
5611 .I nroff
5612 mode
5613 and
5614 .B 2
5615 in
5616 .I troff
5617 mode
5618 .RB ( 0 ).
5619 .
5620 .
5621 .IP
5622 .TS
5623 tab(@);
5624 lb lb
5625 l l.
5626 Value@Meaning
5627 0@automatic
5628 1@bracketed
5629 2@superscripted
5630 3@bracketed and superscripted
5631 .TE
5632 .
5633 .
5634 .IP
5635 Changes to
5636 .BR Rfstyle 's
5637 value
5638 may not take effect until the next heading or paragraphing macro call.
5639 .\" ...and in certain other cases we don't document.
5640 .
5641 .
5642 .TP
5643 .B Rpej
5644 configures the default page ejection policy for reference pages;
5645 see
5646 .B RP
5647 .RB ( 0 ).
5648 .
5649 .
5650 .IP
5651 .TS
5652 tab(@);
5653 Lb Lb
5654 L Lx.
5655 Value@Effect
5656 0@T{
5657 Break the page before and after the reference list.
5658 T}
5659 1@T{
5660 Suppress page break after the list.
5661 T}
5662 2@T{
5663 Suppress page break before the list.
5664 T}
5665 3@T{
5666 Suppress page breaks before and after the list.
5667 T}
5668 .TE
5669 .
5670 .
5671 .TP
5672 .B S
5673 defines the type size for the document,
5674 and must be set from the command line.
5675 .
5676 A scaling unit should be appended;
5677 .B p
5678 is typical
5679 .RB ( 10p ).
5680 .
5681 .
5682 .TP
5683 .B Sectf
5684 selects the \[lq]section-figure\[rq] numbering style.
5685 .
5686 Its default
5687 .RB is\~ 0
5688 unless
5689 .RB register\~ N
5690 is set
5691 .RB to\~ 5
5692 at the command line
5693 (Boolean-valued).
5694 .
5695 .
5696 .TP
5697 .B Sectp
5698 selects the \[lq]section-page\[rq] numbering style.
5699 .
5700 Its default
5701 .RB is\~ 0
5702 unless
5703 .RB register\~ N
5704 is set
5705 .RB to\~ 3
5706 .RB or\~ 5
5707 at the command line
5708 (Boolean-valued).
5709 .
5710 .
5711 .TP
5712 .B Si
5713 configures the amount of display indentation in ens;
5714 see
5715 .B DS
5716 .RB ( 5 ).
5717 .
5718 .
5719 .TP
5720 .B Tb
5721 is an auto-incrementing table counter;
5722 see
5723 .BR TB .
5724 .
5725 .
5726 .TP
5727 .B V
5728 defines the vertical spacing for the document,
5729 and must be set from the command line.
5730 .
5731 A scaling unit should be appended;
5732 .B p
5733 is typical.
5734 .
5735 The default vertical spacing is 120% of the type size.
5736 .
5737 This register is a
5738 .I groff mm
5739 extension.
5740 .
5741 .
5742 .TP
5743 .B Verbin
5744 configures the amount of indentation for verbatim displays
5745 when indentation is selected;
5746 see
5747 .B \%VERBON
5748 .RB ( 5n ).
5749 .
5750 .
5751 .TP
5752 .B W
5753 defines the \[lq]width\[rq]
5754 of the document
5755 (that is,
5756 the length of an output line with no indentation);
5757 it must be set from the command line.
5758 .
5759 A scaling unit should be appended.
5760 .
5761 The default
5762 .RB is\~ 6i
5763 or assigned by the
5764 .I papersize.tmac
5765 package;
5766 see
5767 .MR groff_tmac 5 .
5768 .
5769 .
5770 .\" ====================================================================
5771 .SS Internals
5772 .\" ====================================================================
5773 .
5774 The argument
5775 (if any)
5776 to a
5777 .B COVER
5778 or
5779 .B MT
5780 call determines the file that
5781 .I "groff mm"
5782 loads to configure the document's layout;
5783 see section \[lq]Files\[rq] below.
5784 .
5785 .
5786 .P
5787 .BR LT 's
5788 behavior depends on the
5789 .I style
5790 argument given to it;
5791 it calls macros with names suffixed accordingly.
5792 .
5793 It is therefore possible to define additional letter types,
5794 either in the territory-specific macro file,
5795 or as local additions.
5796 .
5797 .B LT
5798 sets the registers
5799 .B Pt
5800 and
5801 .B Pi
5802 to 0 and\~5,
5803 respectively.
5804 .
5805 (DWB used a value of 3 for
5806 .BR Pi .)
5807 .
5808 It then calls an initialization macro corresponding to the type.
5809 .
5810 Define the following macros to support a new letter type.
5811 .
5812 .
5813 .TP
5814 .BI let@init_ type
5815 initializes
5816 any registers and other data needed by the letter type.
5817 .
5818 .
5819 .TP
5820 .BI let@head_ type
5821 formats the letterhead;
5822 it is called instead of the usual page header macro.
5823 .
5824 Its definition should remove the alias
5825 .B let@header
5826 unless the letterhead is desired on subsequent pages.
5827 .
5828 .
5829 .TP
5830 .BI let@sg_ type\~\c
5831 .IR "name title n is-final\~" [ SG-arg\~ .\|.\|.]
5832 is called by
5833 .B SG
5834 only for
5835 .B LT
5836 letters;
5837 .B MT
5838 memoranda implement their own signature processing.
5839 .
5840 .I name
5841 and
5842 .I title
5843 are specified through
5844 .BR WA / WE .
5845 .
5846 .IR n \~is
5847 the index of the
5848 .IR n th
5849 writer,
5850 and
5851 .I is-final
5852 is true for the last writer to be listed.
5853 .
5854 Further
5855 .B SG
5856 arguments are appended to the signature line.
5857 .
5858 .
5859 .TP
5860 .BI let@fc_ "type closing"
5861 is called by
5862 .BR FC ,
5863 and takes the formal closing as its argument.
5864 .
5865 .
5866 .P
5867 .B LO
5868 implements letter options.
5869 .
5870 It requires that a string named
5871 .BI Let type
5872 be defined,
5873 where
5874 .I type
5875 is the letter type.
5876 .
5877 .B LO
5878 then assigns its second argument
5879 .RI ( value )
5880 to the string
5881 .BI let*lo\- type\c
5882 \&.
5883 .
5884 .
5885 .\" ====================================================================
5886 .\".SH BUGS
5887 .\" ====================================================================
5888 .
5889 .
5890 .\" ====================================================================
5891 .SH Files
5892 .\" ====================================================================
5893 .
5894 .TP
5895 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\%m.tmac
5896 is the
5897 .I groff
5898 implementation of the memorandum macros.
5899 .
5900 .
5901 .TP
5902 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm.tmac
5903 is a wrapper enabling the package to be loaded with the option
5904 .RB \[lq] "\-m mm" \[rq].
5905 .
5906 .
5907 .TP
5908 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/refer\-mm.tmac
5909 implements
5910 .MR \%refer 1
5911 support for
5912 .IR mm .
5913 .
5914 .
5915 .TP
5916 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/ms.cov
5917 implements an
5918 .IR ms -like
5919 cover page.
5920 .
5921 .
5922 .TP
5923 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/0.MT
5924 implements memorandum types 0\[en]3 and 6.
5925 .
5926 .
5927 .TP
5928 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/4.MT
5929 implements memorandum type 4.
5930 .
5931 .
5932 .TP
5933 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/5.MT
5934 implements memorandum type 5.
5935 .
5936 .
5937 .TP
5938 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/locale
5939 performs any (further) desired localization if present.
5940 .
5941 .
5942 .TP
5943 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/examples/letter.mm
5944 illustrates features of the
5945 .B LT
5946 letter formats.
5947 .
5948 .
5949 .TP
5950 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/examples/memorandum.mm
5951 illustrates features of the
5952 .B MT
5953 memorandum formats.
5954 .
5955 .
5956 .TP
5957 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/examples/story.mm
5958 illustrates use of
5959 .I mm
5960 for literary purposes.
5961 .
5962 .
5963 .br
5964 .ne 5v \" 4v plus bigger type size for heading
5965 .\" ====================================================================
5966 .SH Authors
5967 .\" ====================================================================
5968 .
5969 .MT jh@\:axis\:.se
5970 J\[:o]rgen H\[:a]gg
5971 .ME
5972 of Lund, Sweden,
5973 wrote the version of the
5974 .I mm
5975 macro package distributed with
5976 .I groff
5977 based on an early version of
5978 .I "groff ms"
5979 by
5980 .MT jjc@\:jclark\:.com
5981 James Clark
5982 .ME .
5983 .
5984 .MT wl@\:gnu\:.org
5985 Werner Lemberg
5986 .ME
5987 and
5988 .MT g.branden\:.robinson@\:gmail\:.com
5989 G.\& Branden Robinson
5990 .ME
5991 revised and updated it.
5992 .
5993 .
5994 .\" ====================================================================
5995 .SH "See also"
5996 .\" ====================================================================
5997 .
5998 .UR https://tkurtbond\:.github\:.io/\:troff/\:mm\-all\:.pdf
5999 .I MM \- A Macro Package for Generating Documents
6000 .UE ,
6001 the DWB\~3.3
6002 .I mm
6003 manual,
6004 introduces the package but does not document
6005 .I groff mm
6006 extensions.
6007 .
6008 .
6009 .P
6010 .IR "Groff: The GNU Implementation of troff" ,
6011 by Trent A.\& Fisher and Werner Lemberg,
6012 is the primary
6013 .I groff
6014 manual.
6015 .
6016 You can browse it interactively with \[lq]info groff\[rq].
6017 .
6018 .
6019 .P
6020 .MR groff 1 ,
6021 .MR \%troff 1 ,
6022 .MR \%tbl 1 ,
6023 .MR \%pic 1 ,
6024 .MR \%eqn 1 ,
6025 .MR \%refer 1 ,
6026 .MR groff_mmse 7
6027 (only in Swedish locales)
6028 .
6029 .
6030 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
6031 .cp \n[*groff_groff_mm_7_man_C]
6032 .do rr *groff_groff_mm_7_man_C
6033 .
6034 .
6035 .\" Local Variables:
6036 .\" fill-column: 72
6037 .\" mode: nroff
6038 .\" End:
6039 .\" vim: set filetype=groff textwidth=72: