Debian Codegraph @

upstream/debian-unstable/man7/groff_mom.7

raw
1 .TH groff_mom 7 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 groff_mom \- modern macros for document composition with GNU
4 .I roff
5 .
6 .
7 .\" ====================================================================
8 .\" Legal Terms
9 .\" ====================================================================
10 .\"
11 .\" Copyright 2002-2020 Free Software Foundation, Inc.
12 .\"
13 .\" mom is distributed with groff, the GNU roff typesetting system.
14 .\"
15 .\" groff is free software; you can redistribute it and/or modify it
16 .\" under the terms of the GNU General Public License as published by
17 .\" the Free Software Foundation, either version 3 of the License, or
18 .\" (at your option) any later version.
19 .\"
20 .\" groff is distributed in the hope that it will be useful, but WITHOUT
21 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
22 .\" or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
23 .\" License for more details.
24 .\"
25 .\" You should have received a copy of the GNU General Public License
26 .\" along with this program. If not, see
27 .\" <http://www.gnu.org/licenses/>.
28 .
29 .
30 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
31 .do nr *groff_groff_mom_7_man_C \n[.cp]
32 .cp 0
33 .
34 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
35 .nr do-fallback 0
36 .if !\n(.f .nr do-fallback 1 \" mandoc
37 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
38 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
39 .if \n[do-fallback] \{\
40 . de MR
41 . ie \\n(.$=1 \
42 . I \%\\$1
43 . el \
44 . IR \%\\$1 (\\$2)\\$3
45 . .
46 .\}
47 .rr do-fallback
48 .
49 .
50 .\" ====================================================================
51 .\" Setup
52 .\" ====================================================================
53 .
54 .hw line-space
55 .
56 .
57 .\" ====================================================================
58 .\" .FONT (<font name> <text> [<font name> <text> ...])
59 .\"
60 .\" Print in different fonts: R, I, B, CR, CI, CB
61 .\"
62 .de FONT
63 . if (\\n[.$] = 0) \{\
64 . nop \&\f[P]\&
65 . return
66 . \}
67 . ds result \&
68 . while (\\n[.$] >= 2) \{\
69 . as result \,\f[\\$1]\\$2
70 . if !"\\$1"P" .as result \f[P]\""
71 . shift 2
72 . \}
73 . if (\\n[.$] = 1) .as result \,\f[\\$1]
74 . nr saved-hy \\n[.hy]
75 . nh
76 . nop \\*[result]\&
77 . rm result
78 . hy \\n[saved-hy]
79 . rr saved-hy
80 ..
81 .
82 .
83 .\" ====================================================================
84 .SH Synopsis
85 .\" ====================================================================
86 .
87 .SY groff
88 .B \-mom
89 .RI [ option\~ .\|.\|.\&]
90 .RI [ file\~ .\|.\|.]
91 .YS
92 .
93 .SY groff
94 .B "\-m mom"
95 .RI [ option\~ .\|.\|.\&]
96 .RI [ file\~ .\|.\|.]
97 .YS
98 .
99 .
100 .\" ====================================================================
101 .SH Description
102 .\" ====================================================================
103 .
104 .I mom
105 is a macro set for
106 .IR groff ,
107 designed primarily to prepare documents for PDF and PostScript output.
108 .
109 .
110 .I mom
111 provides macros in two categories: typesetting
112 and document processing.
113 .
114 The former provide access to
115 .IR groff 's
116 typesetting capabilities in ways that are simpler to master than
117 .IR groff 's
118 requests and escape sequences.
119 .
120 The latter provide highly customizable markup tags that allow the user
121 to design and output professional-looking documents with a minimum of
122 typesetting intervention.
123 .
124 .
125 .P
126 Files processed with
127 .MR pdfmom 1
128 produce PDF documents.
129 .
130 The documents include a PDF outline that appears in the navigation pane
131 panel of document viewers,
132 and may contain clickable internal and external links.
133 .
134 .P
135 Normally,
136 .IR groff 's
137 native PDF driver,
138 .MR gropdf 1 ,
139 is used to generate the output.
140 .
141 When
142 .I pdfmom
143 is given the
144 .RB \[lq] "\-T ps" \[rq]
145 option,
146 it still produces PDF,
147 but processing is delegated to
148 .IR pdfroff ,
149 which uses
150 .IR groff 's
151 PostScript driver,
152 .MR grops 1 .
153 .
154 Not all PDF features are available when
155 .B \-T ps
156 is given;
157 its primary use is to allow processing of files with embedded PostScript
158 images.
159 .\" XXX: but we have PDFPIC now...so -Tps is necessary only for people
160 .\" who want to avoid use of unsafe mode?
161 .
162 .
163 .P
164 Files processed with
165 .B groff \-mom
166 (or
167 .BR "\-m mom" )
168 format for the device specified with the
169 .B \-T
170 option.
171 .
172 (In this installation,
173 .B \%ps
174 is the default output device.)
175 .
176 .
177 .P
178 .I mom
179 comes with her own comprehensive documentation in HTML.
180 .
181 A PDF manual,
182 \[lq]Producing PDFs with
183 .I groff
184 and
185 .IR mom \[rq],
186 discusses preparation of PDF documents with
187 .I mom
188 in detail.
189 .
190 .
191 .\" ====================================================================
192 .SH Files
193 .\" ====================================================================
194 .
195 .TP
196 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:mom.tmac
197 is a wrapper enabling the package to be loaded with the option
198 .RB \[lq] "\-m mom" \[rq].
199 .
200 .
201 .TP
202 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:om.tmac
203 implements the package.
204 .
205 .
206 .TP
207 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%html/\:mom/\:toc.html
208 is the entry point to the HTML documentation.
209 .
210 .
211 .TP
212 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%pdf/\:mom\-pdf.pdf
213 is \[lq]Producing PDFs with
214 .I groff
215 and
216 .IR mom \[rq],
217 by Deri James and Peter Schaffter.
218 .
219 .
220 .TP
221 .IR /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%examples/\:mom/\: * .mom
222 are examples of
223 .I mom
224 usage.
225 .
226 .
227 .\" ====================================================================
228 .SH Reference
229 .\" ====================================================================
230 .
231 .\" ====================================================================
232 .SS "Escape sequences"
233 .\" ====================================================================
234 .
235 .TP
236 .FONT B \[rs]*[ I <colorname> B ]
237 begin using an initialized colour inline
238 .
239 .
240 .TP
241 .FONT B \[rs]*[BCK I " n" B ]
242 move backward in a line
243 .
244 .
245 .TP
246 .B \[rs]*[BOLDER]
247 invoke pseudo bold inline (related to macro
248 .BR .SETBOLDER )
249 .
250 .
251 .TP
252 .B \[rs]*[BOLDERX]
253 off pseudo bold inline (related to macro
254 .BR .SETBOLDER )
255 .
256 .
257 .TP
258 .FONT B \[rs]*[BU I " n" B ]
259 move characters pairs closer together inline (related to macro
260 .BR \%.KERN )
261 .
262 .
263 .TP
264 .B \[rs]*[COND]
265 invoke pseudo condensing inline (related to macro
266 .BR \%.CONDENSE )
267 .
268 .
269 .TP
270 .B \[rs]*[CONDX]
271 off pseudo condensing inline (related to macro
272 .BR \%.CONDENSE )
273 .
274 .
275 .TP
276 .FONT B \[rs]*[CONDSUP] R .\|.\|. B \[rs]*[CONDSUPX]
277 pseudo-condensed superscript
278 .
279 .
280 .TP
281 .FONT B \[rs]*[DOWN I " n" B ]
282 temporarily move downward in a line
283 .
284 .
285 .TP
286 .B \[rs]*[EN\-MARK]
287 mark initial line of a range of line numbers (for use with line
288 numbered endnotes)
289 .
290 .
291 .TP
292 .B \[rs]*[EXT]
293 invoke pseudo extending inline (related to macro
294 .BR \%.EXTEND )
295 .
296 .
297 .TP
298 .B \[rs]*[EXTX]
299 off pseudo condensing inline (related to macro
300 .BR \%.EXTEND )
301 .
302 .
303 .TP
304 .FONT B \[rs]*[EXTSUP] R .\|.\|. B \[rs]*[EXTSUPX]
305 pseudo extended superscript
306 .
307 .
308 .TP
309 .FONT B \[rs]*[FU I " n" B ]
310 move characters pairs further apart inline (related to macro
311 .BR \%.KERN )
312 .
313 .
314 .TP
315 .FONT B \[rs]*[FWD I " n" B ]
316 move forward in a line
317 .
318 .
319 .TP
320 .B \[rs]*[LEADER]
321 insert leaders at the end of a line
322 .
323 .
324 .TP
325 .B \[rs]*[RULE]
326 draw a full measure rule
327 .
328 .
329 .TP
330 .FONT B \[rs]*[SIZE I " n" B ]
331 change the point size inline (related to macro
332 .BR \%.PT_SIZE )
333 .
334 .
335 .TP
336 .B \[rs]*[SLANT]
337 invoke pseudo italic inline (related to macro
338 .BR \%.SETSLANT )
339 .
340 .
341 .TP
342 .B \[rs]*[SLANTX]
343 off pseudo italic inline (related to macro
344 .BR \%.SETSLANT )
345 .
346 .
347 .TP
348 .FONT B \[rs]*[ST I <n> B ] R .\|.\|. B \[rs]*[ST I <n> B X]
349 string tabs (mark tab positions inline)
350 .
351 .
352 .TP
353 .FONT B \[rs]*[SUP] R .\|.\|. B \[rs]*[SUPX]
354 superscript
355 .
356 .
357 .TP
358 .B \[rs]*[TB+]
359 inline escape for
360 .B .TN
361 .RI ( "Tab Next" )
362 .
363 .
364 .TP
365 .FONT B \[rs]*[UL] R .\|.\|. B \[rs]*[ULX]
366 invoke underlining inline (fixed width fonts only)
367 .
368 .
369 .TP
370 .FONT B \[rs]*[UP I " n" B ]
371 temporarily move upward in a line
372 .
373 .
374 .\" ====================================================================
375 .SS Macros
376 .\" ====================================================================
377 .
378 .TP
379 .B .AUTOLEAD
380 set the linespacing relative to the point size
381 .
382 .
383 .TP
384 .B .B_MARGIN
385 set a bottom margin
386 .
387 .
388 .TP
389 .B .BR
390 break a justified line
391 .
392 .
393 .TP
394 .B .CENTER
395 set line-by-line quad centre
396 .
397 .
398 .TP
399 .B .CONDENSE
400 set the amount to pseudo condense
401 .
402 .
403 .TP
404 .B .EL
405 break a line without advancing on the page
406 .
407 .
408 .TP
409 .B .EXTEND
410 set the amount to pseudo extend
411 .
412 .
413 .TP
414 .B .FALLBACK_FONT
415 establish a fallback font (for missing fonts)
416 .
417 .
418 .TP
419 .B .FAM
420 alias to
421 .B .FAMILY
422 .
423 .
424 .TP
425 .BI ".FAMILY " <family>
426 set the
427 .I family type
428 .
429 .
430 .TP
431 .B .FT
432 set the font style (roman, italic, etc.)
433 .
434 .
435 .TP
436 .BI ".HI [" " <measure> " ]
437 hanging indent
438 .
439 .
440 .TP
441 .B .HY
442 automatic hyphenation on/off
443 .
444 .
445 .TP
446 .B .HY_SET
447 set automatic hyphenation parameters
448 .
449 .
450 .TP
451 .BI ".IB [" " <left measure> <right measure> " ]
452 indent both
453 .
454 .
455 .TP
456 .B .IBX [ CLEAR ]
457 exit indent both
458 .
459 .
460 .TP
461 .BI ".IL [" " <measure> " ]
462 indent left
463 .
464 .
465 .TP
466 .B .ILX [ CLEAR ]
467 exit indent left
468 .
469 .
470 .TP
471 .B .IQ [ CLEAR ]
472 quit any/all indents
473 .
474 .
475 .TP
476 .BI ".IR [" " <measure> " ]
477 indent right
478 .
479 .
480 .TP
481 .B .IRX [ CLEAR ]
482 exit indent right
483 .
484 .
485 .TP
486 .B .JUSTIFY
487 justify text to both margins
488 .
489 .
490 .TP
491 .B .KERN
492 automatic character pair kerning on/off
493 .
494 .
495 .TP
496 .B .L_MARGIN
497 set a left margin (page offset)
498 .
499 .
500 .TP
501 .B .LEFT
502 set line-by-line quad left
503 .
504 .
505 .TP
506 .B .LL
507 set a line length
508 .
509 .
510 .TP
511 .B .LS
512 set a linespacing (leading)
513 .
514 .
515 .TP
516 .B .PAGE
517 set explicit page dimensions and margins
518 .
519 .
520 .TP
521 .B .PAGEWIDTH
522 set a custom page width
523 .
524 .
525 .TP
526 .B .PAGELENGTH
527 set a custom page length
528 .
529 .
530 .TP
531 .BI .PAPER " <paper_type>"
532 set common paper sizes (letter, A4, etc)
533 .
534 .
535 .TP
536 .B .PT_SIZE
537 set the point size
538 .
539 .
540 .TP
541 .B .QUAD
542 "justify" text left, centre, or right
543 .
544 .
545 .TP
546 .B .R_MARGIN
547 set a right margin
548 .
549 .
550 .TP
551 .B .RIGHT
552 set line-by-line quad right
553 .
554 .
555 .TP
556 .B .SETBOLDER
557 set the amount of emboldening
558 .
559 .
560 .TP
561 .B .SETSLANT
562 set the degree of slant
563 .
564 .
565 .TP
566 .B .SPREAD
567 force justify a line
568 .
569 .
570 .TP
571 .B .SS
572 set the sentence space size
573 .
574 .
575 .TP
576 .B .T_MARGIN
577 set a top margin
578 .
579 .
580 .TP
581 .BI ".TI [" " <measure> " ]
582 temporary left indent
583 .
584 .
585 .TP
586 .B .WS
587 set the minimum word space size
588 .
589 .
590 .\" ====================================================================
591 .SH "Documentation of details"
592 .\" ====================================================================
593 .
594 .\" ====================================================================
595 .SS "Details of inline escape sequences in alphabetical order"
596 .\" ====================================================================
597 .
598 .TP
599 .FONT B \[rs]*[ I <colorname> B ]
600 begin using an initialized colour inline
601 .
602 .
603 .TP
604 .FONT B \[rs]*[BCK I " n" B ]
605 move backward in a line
606 .
607 .
608 .\" ====================================================================
609 .\" BOLDER
610 .\" ====================================================================
611 .TP
612 .B \[rs]*[BOLDER]
613 .TQ
614 .B \[rs]*[BOLDERX]
615 Emboldening on/off
616 .
617 .RS
618 .
619 .P
620 .B \[rs]*[BOLDER]
621 begins emboldening type.
622 .
623 .B \[rs]*[BOLDERX]
624 turns the feature off.
625 .
626 Both are inline escape sequences;
627 therefore,
628 they should not appear as separate lines,
629 but rather be embedded in text lines, like this:
630 .RS
631 .EX
632 .FONT R "Not " B \[rs]*[BOLDER] R everything B \[rs]*[BOLDERX] \
633 R " is as it seems."
634 .EE
635 .RE
636 .
637 .P
638 Alternatively, if you wanted the whole line emboldened, you should do
639 .RS
640 .EX
641 .FONT B \[rs]*[BOLDER] R "Not everything is as it seems." \
642 B \[rs]*[BOLDERX]
643 .EE
644 .RE
645 .
646 Once
647 .B \[rs]*[BOLDER]
648 is invoked, it remains in effect until turned off.
649 .
650 .P
651 Note: If you're using the document processing macros with
652 .BR "\%.PRINTSTYLE \%TYPEWRITE" ,
653 .I mom
654 ignores
655 .B \[rs]*[BOLDER]
656 requests.
657 .
658 .RE
659 .
660 .
661 .\" ====================================================================
662 .\" BU
663 .\" ====================================================================
664 .TP
665 .FONT B \[rs]*[BU I " n" B ]
666 move characters pairs closer together inline (related to macro
667 .BR \%.KERN )
668 .
669 .
670 .\" ====================================================================
671 .\" COND
672 .\" ====================================================================
673 .TP
674 .B \[rs]*[COND]
675 .TQ
676 .B \[rs]*[CONDX]
677 Pseudo-condensing on/off
678 .
679 .RS
680 .
681 .P
682 .B \[rs]*[COND]
683 begins pseudo-condensing type.
684 .
685 .B \[rs]*[CONDX]
686 turns the feature off.
687 .
688 Both are inline escape sequences;
689 therefore,
690 they should not appear as separate lines,
691 but rather be embedded in text lines, like this:
692 .RS
693 .EX
694 .FONT B \[rs]*[COND] I "Not everything is as it seems." B \[rs]*[CONDX]
695 .EE
696 .RE
697 .B \%\[rs]*[COND]
698 remains in effect until you turn it off with
699 .BR \%\[rs]*[CONDX] .
700 .
701 .P
702 IMPORTANT: You must turn
703 .B \%\[rs]*[COND]
704 off before making any changes to the point size of your type, either
705 via the
706 .B \%.PT_SIZE
707 macro or with the
708 .B \[rs]s
709 inline escape sequence.
710 .
711 If you wish the new point size to be pseudo-condensed, simply reinvoke
712 .B \%\[rs]*[COND]
713 afterward.
714 .
715 Equally,
716 .B \%\[rs]*[COND]
717 must be turned off before changing the condense percentage with
718 .BR \%.CONDENSE .
719 .
720 .P
721 Note: If you're using the document processing macros with
722 .BR "\%.PRINTSTYLE \%TYPEWRITE" ,
723 .I mom
724 ignores
725 .B \%\[rs]*[COND]
726 requests.
727 .
728 .RE
729 .
730 .
731 .\" ====================================================================
732 .\" CONDSUP
733 .\" ====================================================================
734 .TP
735 .FONT B \[rs]*[CONDSUP] R .\|.\|. B \[rs]*[CONDSUPX]
736 pseudo-condensed superscript
737 .
738 .
739 .\" ====================================================================
740 .\" DOWN
741 .\" ====================================================================
742 .TP
743 .FONT B \[rs]*[DOWN I " n" B ]
744 temporarily move downward in a line
745 .
746 .
747 .\" ====================================================================
748 .\" EN-MARK
749 .\" ====================================================================
750 .TP
751 .B \[rs]*[EN\-MARK]
752 mark initial line of a range of line numbers (for use with line
753 numbered endnotes)
754 .
755 .
756 .\" ====================================================================
757 .\" EXT
758 .\" ====================================================================
759 .TP
760 .B \[rs]*[EXT]
761 .TQ
762 .B \[rs]*[EXTX]
763 Pseudo-extending on/off
764 .
765 .RS
766 .
767 .P
768 .B \[rs]*[EXT]
769 begins pseudo-extending type.
770 .
771 .B \[rs]*[EXTX]
772 turns the feature off.
773 .
774 Both are inline escape sequences;
775 therefore,
776 they should not appear as separate lines,
777 but rather be embedded in text lines, like this:
778 .RS
779 .EX
780 .FONT B \[rs]*[EXT] I "Not everything is as it seems." B \[rs]*[EXTX]
781 .EE
782 .RE
783 .B \[rs]*[EXT]
784 remains in effect until you turn it off with
785 .BR \[rs]*[EXTX] .
786 .
787 .P
788 IMPORTANT: You must turn
789 .B \%\[rs]*[EXT]
790 off before making any changes to the point size of your type, either
791 via the
792 .B \%.PT_SIZE
793 macro or with the
794 .B \[rs]s
795 inline escape sequence.
796 .
797 If you wish the new point size to be
798 .IR \%pseudo-extended ,
799 simply reinvoke
800 .B \%\[rs]*[EXT]
801 afterward.
802 .
803 Equally,
804 .B \%\[rs]*[EXT]
805 must be turned off before changing the extend percentage with
806 .BR \%.EXTEND .
807 .
808 .P
809 Note: If you are using the document processing macros with
810 .BR "\%.PRINTSTYLE \%TYPEWRITE" ,
811 .I mom
812 ignores
813 .B \%\[rs]*[EXT]
814 requests.
815 .
816 .RE
817 .
818 .
819 .\" ====================================================================
820 .\" EXTSUP
821 .\" ====================================================================
822 .TP
823 .FONT B \[rs]*[EXTSUP] R .\|.\|. B \[rs]*[EXTSUPX]
824 pseudo extended superscript
825 .
826 .
827 .\" ====================================================================
828 .\" FU
829 .\" ====================================================================
830 .TP
831 .FONT B \[rs]*[FU I " n" B ]
832 move characters pairs further apart inline (related to macro
833 .BR .KERN )
834 .
835 .
836 .\" ====================================================================
837 .\" FWD
838 .\" ====================================================================
839 .TP
840 .FONT B \[rs]*[FWD I " n" B ]
841 move forward in a line
842 .
843 .
844 .\" ====================================================================
845 .\" LEADER
846 .\" ====================================================================
847 .TP
848 .B \[rs]*[LEADER]
849 insert leaders at the end of a line
850 .
851 .
852 .\" ====================================================================
853 .\" RULE
854 .\" ====================================================================
855 .TP
856 .B \[rs]*[RULE]
857 draw a full measure rule
858 .
859 .
860 .\" ====================================================================
861 .\" PT_SIZE
862 .\" ====================================================================
863 .TP
864 .FONT B \[rs]*[SIZE I " n" B ]
865 change the point size inline (related to macro
866 .BR \%.PT_SIZE )
867 .
868 .
869 .\" ====================================================================
870 .\" SLANT
871 .\" ====================================================================
872 .TP
873 .B \[rs]*[SLANT]
874 .TQ
875 .B \[rs]*[SLANTX]
876 Pseudo italic on/off
877 .
878 .RS
879 .
880 .P
881 .B \%\[rs]*[SLANT]
882 begins
883 .I pseudo-italicizing
884 .IR type .
885 .
886 .B \%\[rs]*[SLANTX]
887 turns the feature off.
888 .
889 Both are inline escape sequences;
890 therefore,
891 they should not appear as separate lines,
892 but rather be embedded in text lines, like this:
893 .RS
894 .EX
895 .FONT R "Not " B \[rs]*[SLANT] R everything B \[rs]*[SLANTX] \
896 R " is as it seems."
897 .EE
898 .RE
899 .
900 .P
901 Alternatively, if you wanted the whole line
902 .IR pseudo-italicized ,
903 you'd do
904 .RS
905 .EX
906 .FONT B \[rs]*[SLANT] R "Not everything is as it seems." \
907 B \[rs]*[SLANTX]
908 .EE
909 .RE
910 .
911 .P
912 Once
913 .B \[rs]*[SLANT]
914 is invoked, it remains in effect until turned off.
915 .
916 .P
917 Note: If you're using the document processing macros with
918 .BR "\%.PRINTSTYLE \%TYPEWRITE" ,
919 .I mom
920 underlines pseudo-italics by default.
921 .
922 To change this behaviour, use the special macro
923 .BR .SLANT_MEANS_SLANT .
924 .
925 .RE
926 .
927 .
928 .\" ====================================================================
929 .\" ST
930 .\" ====================================================================
931 .TP
932 .FONT B \[rs]*[ST I <number> B ] R .\|.\|. B \[rs]*[ST I <number> B X]
933 Mark positions of string tabs
934 .
935 .RS
936 .P
937 The
938 .I quad
939 direction must be
940 .B LEFT
941 or
942 .B \%JUSTIFY
943 (see
944 .B \%.QUAD
945 and
946 .BR \%.JUSTIFY )
947 or the
948 .I no-fill mode
949 set to
950 .B LEFT
951 in order for these inlines to function properly.
952 .
953 Please see
954 .IR \%IMPORTANT ,
955 below.
956 .
957 .P
958 String tabs need to be marked off with inline escape sequences before
959 being set up with the
960 .B .ST
961 macro.
962 .
963 Any input line may contain string tab markers.
964 .
965 .IR <number> ,
966 above, means the numeric identifier of the tab.
967 .
968 .P
969 The following shows a sample input line with string tab markers.
970 .RS
971 .EX
972 .BR \[rs]*[ST1] "De minimus" \[rs]*[ST1X] \c
973 .RB "non curat" \[rs]*[ST2] lex \[rs]*[ST2X] .
974 .EE
975 .RE
976 .
977 .P
978 String
979 .I tab 1
980 begins at the start of the line and ends after the word
981 .IR \%time .
982 .
983 String
984 .I tab 2
985 starts at
986 .I good
987 and ends after
988 .IR men .
989 .
990 .I Inline escape sequences
991 (e.g.,
992 .I font
993 or
994 .I point size
995 .IR changes ,
996 or horizontal movements, including padding) are taken into account
997 when
998 .I mom
999 determines the
1000 .I position
1001 and
1002 .I length
1003 of
1004 .I string
1005 .IR tabs .
1006 .
1007 .P
1008 Up to nineteen string tabs may be marked (not necessarily all on the
1009 same line, of course), and they must be numbered between 1 and 19.
1010 .
1011 .P
1012 Once string tabs have been marked in input lines, they have to be
1013 .I set
1014 with
1015 .BR .ST ,
1016 after which they may be called, by number, with
1017 .BR .TAB .
1018 .
1019 .P
1020 Note: Lines with string tabs marked off in them are normal input
1021 lines, i.e.\& they get printed, just like any input line.
1022 .
1023 If you want to set up string tabs without the line printing, use the
1024 .B \%.SILENT
1025 macro.
1026 .
1027 .P
1028 .I IMPORTANT:
1029 Owing to the way
1030 .I groff
1031 processes input lines and turns them into output lines, it is not
1032 possible for
1033 .I mom
1034 to
1035 .I guess
1036 the correct starting position of string tabs marked off in lines that
1037 are centered or set flush right.
1038 .
1039 .P
1040 Equally, she cannot guess the starting position if a line is fully
1041 justified and broken with
1042 .BR \%.SPREAD .
1043 .
1044 .P
1045 In other words, in order to use string tabs,
1046 .B LEFT
1047 must be active, or, if
1048 .B .QUAD LEFT
1049 or
1050 .B \%JUSTIFY
1051 are active, the line on which the
1052 .I string tabs
1053 are marked must be broken
1054 .I manually
1055 with
1056 .B .BR
1057 (but not
1058 .BR \%.SPREAD ).
1059 .
1060 .P
1061 To circumvent this behaviour, I recommend using the
1062 .B PAD
1063 to set up string tabs in centered or flush right lines.
1064 .
1065 Say, for example, you want to use a
1066 .I string tab
1067 to
1068 .I underscore
1069 the text of a centered line with a rule.
1070 .
1071 Rather than this,
1072 .RS
1073 .EX
1074 .B .CENTER
1075 .B \[rs]*[ST1]A line of text\[rs]*[ST1X]\[rs]c
1076 .B .EL
1077 .B .ST 1
1078 .B .TAB 1
1079 .B .PT_SIZE 24
1080 .B .ALD 3p
1081 .B \[rs]*[RULE]
1082 .B .RLD 3p
1083 .B .TQ
1084 .EE
1085 .RE
1086 you should do:
1087 .RS
1088 .EX
1089 \&.QUAD CENTER
1090 \&.PAD "#\[rs]*[ST1]A line of text\[rs]*[ST1X]#"
1091 \&.EL
1092 \&.ST 1
1093 \&.TAB 1
1094 \&.PT_SIZE 24
1095 \&.ALD 3p
1096 \&\[rs]" You can\[aq]t use \[rs]*[UP] or \[rs]*[DOWN] with \[rs]*[RULE].
1097 \&.RLD 3p
1098 \&.TQ
1099 .EE
1100 .RE
1101 .
1102 .RE
1103 .
1104 .
1105 .\" ====================================================================
1106 .\" SUP
1107 .\" ====================================================================
1108 .TP
1109 .FONT B \[rs]*[SUP] R .\|.\|. B \[rs]*[SUPX]
1110 superscript
1111 .
1112 .
1113 .\" ====================================================================
1114 .\" TB+
1115 .\" ====================================================================
1116 .TP
1117 .B \[rs]*[TB+]
1118 Inline escape for
1119 .B .TN
1120 .RI ( "Tab Next" )
1121 .
1122 .
1123 .\" ====================================================================
1124 .\" UL
1125 .\" ====================================================================
1126 .TP
1127 .FONT B \[rs]*[UL] R .\|.\|. B \[rs]*[ULX]
1128 invoke underlining inline (fixed width fonts only)
1129 .
1130 .
1131 .\" ====================================================================
1132 .\" UP
1133 .\" ====================================================================
1134 .TP
1135 .FONT B \[rs]*[UP I " n" B ]
1136 temporarily move upward in a line
1137 .
1138 .
1139 .\" ====================================================================
1140 .SS "Details of macros in alphabetical order"
1141 .\" ====================================================================
1142 .
1143 .\" ====================================================================
1144 .\" AUTOLEAD
1145 .\" ====================================================================
1146 .TP
1147 .B .AUTOLEAD
1148 set the linespacing relative to the point size
1149 .
1150 .
1151 .\" ====================================================================
1152 .\" Bottom Margin
1153 .\" ====================================================================
1154 .TP
1155 .BI .B_MARGIN " <bottom margin>"
1156 Bottom Margin
1157 .
1158 .RS
1159 .
1160 .P
1161 Requires a unit of measure
1162 .
1163 .P
1164 .B .B_MARGIN
1165 sets a nominal position at the bottom of the page beyond which you
1166 don't want your type to go.
1167 .
1168 When the bottom margin is reached,
1169 .I mom
1170 starts a new page.
1171 .
1172 .B .B_MARGIN requires a unit of measure.
1173 .
1174 Decimal fractions are allowed.
1175 .
1176 To set a nominal bottom margin of 3/4 inch, enter
1177 .RS
1178 .EX
1179 .B .B_MARGIN .75i
1180 .EE
1181 .RE
1182 .
1183 .P
1184 Obviously, if you haven't spaced the type on your pages so that the
1185 last lines fall perfectly at the bottom margin, the margin will vary
1186 from page to page.
1187 .
1188 Usually, but not always, the last line of type that fits on a page
1189 before the bottom margin causes mom to start a new page.
1190 .
1191 .P
1192 Occasionally, owing to a peculiarity in
1193 .IR groff ,
1194 an extra line will fall below the nominal bottom margin.
1195 .
1196 If you're using the document processing macros, this is unlikely to
1197 happen; the document processing macros are very hard-nosed about
1198 aligning bottom margins.
1199 .
1200 .P
1201 Note: The meaning of
1202 .B .B_MARGIN
1203 is slightly different when you're using the document processing
1204 macros.
1205 .
1206 .RE
1207 .
1208 .
1209 .\" ====================================================================
1210 .\" Fallback Font
1211 .\" ====================================================================
1212 .TP
1213 .BI \%.FALLBACK_FONT " <fallback font> " "[ ABORT | WARN ]"
1214 Fallback Font
1215 .
1216 .RS
1217 .
1218 .P
1219 In the event that you pass an invalid argument to
1220 .B \%.FAMILY
1221 (i.e.\& a non-existent
1222 .IR family ),
1223 .IR mom ,
1224 by default, uses the
1225 .IR "fallback font" ,
1226 .B Courier Medium Roman
1227 .RB ( CR ),
1228 in order to continue processing your file.
1229 .
1230 .P
1231 If you'd prefer another
1232 .IR "fallback font" ,
1233 pass
1234 .B \%.FALLBACK_FONT
1235 the full
1236 .I family+font name
1237 of the
1238 .I font
1239 you'd like.
1240 .
1241 For example, if you'd rather the
1242 .I fallback font
1243 were
1244 .BR "Times Roman Medium Roman" ,
1245 .RS
1246 .EX
1247 .B .FALLBACK_FONT TR
1248 .EE
1249 .RE
1250 would do the trick.
1251 .
1252 .P
1253 .B Mom
1254 issues a warning whenever a
1255 .I font style set
1256 with
1257 .B .FT
1258 does not exist, either because you haven't registered the style
1259 or because the
1260 .I font style
1261 does not exist in the current
1262 .I family set
1263 with
1264 .BR .FAMILY .
1265 .
1266 By default,
1267 .B \%mom
1268 then aborts, which allows you to correct the problem.
1269 .
1270 .P
1271 If you'd prefer that
1272 .B \%mom
1273 not abort on non-existent
1274 .IR fonts ,
1275 but rather continue processing using a
1276 .IR "fallback font" ,
1277 you can pass
1278 .B \%.FALLBACK_FONT
1279 the argument
1280 .BR WARN ,
1281 either by itself, or in conjunction with your chosen
1282 .IB "fallback font" .
1283 .
1284 .P
1285 Some examples of invoking
1286 .BR \%.FALLBACK_FONT :
1287 .
1288 .TP
1289 .B .FALLBACK_FONT WARN
1290 .I mom
1291 will issue a warning whenever you try to access a non-existent
1292 .I font
1293 but will continue processing your file with the default
1294 .IR "fallback font" ,
1295 .BR "Courier Medium Roman" .
1296 .
1297 .
1298 .TP
1299 .B .FALLBACK_FONT TR WARN
1300 .B \%mom
1301 will issue a warning whenever you try to access a non-existent
1302 .I font
1303 but will continue processing your file with a
1304 .I fallback font
1305 of
1306 .BR "Times Roman Medium Roman" ;
1307 additionally,
1308 .B TR
1309 will be the
1310 .I fallback font
1311 whenever you try to access a
1312 .I family
1313 that does not exist.
1314 .
1315 .TP
1316 .B .FALLBACK_FONT TR ABORT
1317 .B \%mom
1318 will abort whenever you try to access a non-existent
1319 .BR font ,
1320 and will use the
1321 .I fallback font
1322 .B TR
1323 whenever you try to access a
1324 .I family
1325 that does not exist.
1326 .
1327 If, for some reason, you want to revert to
1328 .BR ABORT ,
1329 just enter
1330 .B \%".FALLBACK_FONT ABORT"
1331 and
1332 .I mom
1333 will once again abort on
1334 .IR "font errors" .
1335 .
1336 .RE
1337 .
1338 .
1339 .\" ====================================================================
1340 .\" FAM
1341 .\" ====================================================================
1342 .TP
1343 .BI .FAM " <family>"
1344 Type Family,
1345 alias of
1346 .B .FAMILY
1347 .
1348 .
1349 .\" ====================================================================
1350 .\" FAMILY
1351 .\" ====================================================================
1352 .TP
1353 .BI .FAMILY " <family>"
1354 Type Family,
1355 alias of
1356 .B .FAM
1357 .
1358 .RS
1359 .
1360 .P
1361 .B .FAMILY
1362 takes one argument: the name of the
1363 .I family
1364 you want.
1365 .
1366 .I Groff
1367 comes with a small set of basic families, each identified by a 1-,
1368 2- or 3-letter mnemonic.
1369 .
1370 The standard families are:
1371 .RS
1372 .EX
1373 .B "A = Avant Garde"
1374 .B "BM = Bookman"
1375 .B "H = Helvetica"
1376 .B "HN = Helvetica Narrow"
1377 .B "N = New Century Schoolbook"
1378 .B "P = Palatino"
1379 .B "T = Times Roman"
1380 .B "ZCM = Zapf Chancery"
1381 .EE
1382 .RE
1383 .
1384 .P
1385 The argument you pass to
1386 .B .FAMILY
1387 is the identifier at left, above.
1388 .
1389 For example, if you want
1390 .BR Helvetica ,
1391 enter
1392 .RS
1393 .EX
1394 .B .FAMILY H
1395 .EE
1396 .RE
1397 .
1398 .P
1399 Note: The font macro
1400 .RB ( .FT )
1401 lets you specify both the type
1402 .I family
1403 and the desired font with a single macro.
1404 .
1405 While this saves a few
1406 keystrokes, I recommend using
1407 .B .FAMILY for
1408 .IR family ,
1409 and
1410 .B .FT for
1411 .IR font ,
1412 except where doing so is genuinely inconvenient.
1413 .
1414 .BR ZCM ,
1415 for example,
1416 only exists in one style:
1417 .B Italic
1418 .RB ( I ).
1419 .
1420 .P
1421 Therefore,
1422 .RS
1423 .EX
1424 .B .FT ZCMI
1425 .EE
1426 .RE
1427 makes more sense than setting the
1428 .I family
1429 to
1430 .BR ZCM ,
1431 then setting the
1432 .I font
1433 to
1434 .IR I .
1435 .
1436 .P
1437 Additional note: If you are running a
1438 .I groff
1439 version prior to
1440 1.19.2,
1441 you must follow all
1442 .B \%.FAMILY
1443 requests with a
1444 .B .FT
1445 request,
1446 otherwise
1447 .I mom
1448 will set all type up to the next
1449 .B .FT
1450 request in the fallback font.
1451 .
1452 .
1453 .P
1454 When running
1455 .I groff
1456 1.19.2 or later,
1457 and you call the
1458 .B \%.FAMILY
1459 macro,
1460 .I mom
1461 .I remembers
1462 the font style
1463 (such as roman or italic)
1464 currently in use
1465 (if the font style exists in the new
1466 .IR family )
1467 and continues to use the same font style in the new family.
1468 For example:
1469 .RS
1470 .EX
1471 .BI ".FAMILY BM " "\[rs]"" Bookman family"
1472 .BI ".FT I " "\[rs]"" Medium Italic"
1473 .I <some text> \[rs]" Bookman Medium Italic
1474 .BI ".FAMILY H " "\[rs]"" Helvetica family"
1475 .I <more text> \[rs]" Helvetica Medium Italic
1476 .EE
1477 .RE
1478 .
1479 .
1480 .P
1481 However,
1482 if the font style does not exist in the new family,
1483 .I mom
1484 sets all subsequent type in the fallback font
1485 (by default,
1486 .B Courier Medium
1487 .BR Roman )
1488 until she encounters a
1489 .B .FT
1490 call that's valid for the
1491 .IR family .
1492 .
1493 .P
1494 For example, assuming you don't have the font
1495 .B Medium Condensed Roman
1496 .RI ( mom
1497 extension
1498 .IR CD )
1499 in the
1500 .I Helvetica
1501 .IR family :
1502 .RS
1503 .EX
1504 .BI ".FAMILY UN " "\[rs]"" Univers family"
1505 .BI ".FT CD " "\[rs]"" Medium Condensed"
1506 .I <some text> \[rs]" Univers Medium Condensed
1507 .BI ".FAMILY H " "\[rs]"" Helvetica family"
1508 .I <more text> \[rs]" Courier Medium Roman!
1509 .EE
1510 .RE
1511 .
1512 .P
1513 In the above example, you must follow
1514 .B .FAMILY H
1515 with a
1516 .B .FT
1517 request that's valid for
1518 .BR Helvetica .
1519 .
1520 .P
1521 Please see the Appendices,
1522 .I Adding fonts to
1523 .IR groff ,
1524 for information on adding fonts and families to
1525 .IR groff , as well as to
1526 see a list of the extensions
1527 .I mom
1528 provides to
1529 .IR groff 's
1530 basic
1531 .BR R ,
1532 .BR I ,
1533 .BR B ,
1534 .B BI
1535 styles.
1536 .
1537 .P
1538 Suggestion: When adding
1539 .I families to
1540 .IR groff ,
1541 I recommend following the established standard for the naming families
1542 and fonts.
1543 .
1544 For example, if you add the
1545 .B Garamond
1546 family, name the font files
1547 .RS
1548 .EX
1549 .B GARAMONDR
1550 .B GARAMONDI
1551 .B GARAMONDB
1552 .B GARAMONDBI
1553 .EE
1554 .RE
1555 .
1556 .B GARAMOND then becomes a valid
1557 .I family name
1558 you can pass to
1559 .BR .FAMILY .
1560 .
1561 (You could, of course, shorten
1562 .B GARAMOND
1563 to just
1564 .BR G ,
1565 or
1566 .BR GD .)
1567 .BR R ,
1568 .BR I ,
1569 .BR B ,
1570 and
1571 .B BI
1572 after
1573 .B GARAMOND
1574 are the
1575 .IR roman ,
1576 .IR italic ,
1577 .I bold
1578 and
1579 .I bold-italic
1580 fonts respectively.
1581 .
1582 .RE
1583 .
1584 .
1585 .\" ====================================================================
1586 .\" FONT
1587 .\" ====================================================================
1588 .TP
1589 .BI ".FONT R | B | BI | " "<any other valid font style>"
1590 Alias to
1591 .B .FT
1592 .
1593 .
1594 .\" ====================================================================
1595 .\" FT
1596 .\" ====================================================================
1597 .TP
1598 .BI ".FT R | B | BI | " "<any other valid font style>"
1599 Set font
1600 .
1601 .RS
1602 .
1603 .P
1604 By default,
1605 .I groff
1606 permits
1607 .B .FT
1608 to take one of four possible arguments specifying the desired font:
1609 .RS
1610 .EX
1611 .B R = (Medium) Roman
1612 .B I = (Medium) Italic
1613 .B B = Bold (Roman)
1614 .B BI = Bold Italic
1615 .EE
1616 .RE
1617 .
1618 .P
1619 For example, if your
1620 .I family
1621 is
1622 .BR Helvetica ,
1623 entering
1624 .RS
1625 .EX
1626 .B .FT B
1627 .EE
1628 .RE
1629 will give you the
1630 .I Helvetica bold
1631 .IR font .
1632 .
1633 If your
1634 .I family
1635 were
1636 .BR \%Palatino ,
1637 you'd get the
1638 .I \%Palatino bold
1639 .IR font .
1640 .
1641 .P
1642 .B Mom
1643 considerably extends the range of arguments you can pass to
1644 .BR .FT ,
1645 making it more convenient to add and access fonts of differing weights
1646 and shapes within the same family.
1647 .
1648 .P
1649 Have a look here for a list of the weight/style arguments
1650 .I mom
1651 allows.
1652 .
1653 Be aware, though, that you must have the fonts, correctly installed
1654 and named, in order to use the arguments.
1655 .
1656 (See
1657 .I Adding fonts to groff
1658 for instructions and information.)
1659 .
1660 Please also read the
1661 .I ADDITIONAL NOTE
1662 found in the description of the
1663 .B \%.FAMILY
1664 macro.
1665 .
1666 .
1667 .P
1668 How
1669 .I mom
1670 reacts to an invalid argument to
1671 .B .FT
1672 depends on which version of
1673 .I groff
1674 you're using.
1675 .
1676 If your
1677 .I groff
1678 version is 1.19.2 or later,
1679 .I mom
1680 will issue a warning and,
1681 depending on how you've set up the fallback font,
1682 either continue processing using the fallback font,
1683 or abort
1684 (allowing you to correct the problem).
1685 .
1686 In earlier versions,
1687 .I mom
1688 will silently continue processing,
1689 using either the fallback font or the font that was in effect prior to
1690 the invalid
1691 .B .FT
1692 call.
1693 .
1694 .
1695 .P
1696 .B .FT
1697 will also accept, as an argument, a full
1698 .I family
1699 and
1700 .I font
1701 .IR name .
1702 .
1703 .P
1704 For example,
1705 .RS
1706 .EX
1707 .B .FT HB
1708 .EE
1709 .RE
1710 will set subsequent type in
1711 .I Helvetica
1712 .IR Bold .
1713 .
1714 .P
1715 However, I strongly recommend keeping
1716 .I family
1717 and
1718 .I font
1719 separate except where doing so is genuinely inconvenient.
1720 .
1721 .P
1722 For inline control of
1723 .IR fonts ,
1724 see
1725 .I Inline
1726 .IR Escapes ,
1727 font control.
1728 .
1729 .RE
1730 .
1731 .
1732 .\" ====================================================================
1733 .\" Hanging Indent
1734 .\" ====================================================================
1735 .TP
1736 .BI "\%.HI [" " <measure> " ]
1737 Hanging indent \[em] the optional argument requires a unit of measure.
1738 .
1739 .RS
1740 .
1741 .P
1742 A hanging indent looks like this:
1743 .RS
1744 .EX
1745 The thousand injuries of Fortunato I had borne as best I
1746 could, but when he ventured upon insult, I vowed
1747 revenge.\& You who so well know the nature of my soul
1748 will not suppose, however, that I gave utterance to a
1749 threat, at length I would be avenged.\|.\|.
1750 .EE
1751 .RE
1752 .
1753 The first line of text
1754 .I hangs
1755 outside the
1756 .IR "left margin" .
1757 .
1758 .P
1759 In order to use
1760 .IR "hanging indents" ,
1761 you must first have a
1762 .I left indent
1763 active (set with either
1764 .B .IL
1765 or
1766 .BR .IB ).
1767 .
1768 .B Mom
1769 will not hang text outside the
1770 .I left margin set
1771 with
1772 .B \%.L_MARGIN
1773 or outside the
1774 .I left margin
1775 of a
1776 .IR \%tab .
1777 .
1778 .P
1779 The first time you invoke
1780 .BR .HI ,
1781 you must give it a
1782 .BR measure .
1783 .
1784 If you want the first line of a paragraph to
1785 .IR "hang by" ,
1786 say,
1787 .IR "1 pica" ,
1788 do
1789 .RS
1790 .EX
1791 .B ".IL 1P"
1792 .B ".HI 1P"
1793 .EE
1794 .RE
1795 .
1796 Subsequent invocations of
1797 .B \%.HI
1798 do not require you to supply a
1799 .IR measure ;
1800 .I mom
1801 keeps track of the last measure you gave it.
1802 .
1803 .P
1804 Generally speaking, you should invoke
1805 .B .HI
1806 immediately prior to the line you want hung (i.e.\& without any
1807 intervening control lines).
1808 .
1809 And because
1810 .I hanging indents
1811 affect only one line, there's no need to turn them off.
1812 .
1813 .P
1814 .I IMPORTANT:
1815 Unlike
1816 .BR IL ,
1817 .B IR
1818 and
1819 .BR IB ,
1820 measures given to
1821 .B .HI
1822 are NOT additive.
1823 .
1824 Each time you pass a measure to
1825 .BR .HI ,
1826 the measure is treated literally.
1827 .
1828 .B
1829 .I Recipe:
1830 A numbered list using
1831 .I hanging indents
1832 .
1833 .P
1834 .I Note:
1835 .I mom
1836 has macros for setting lists.
1837 .
1838 This recipe exists to demonstrate the use of
1839 .I hanging indents
1840 only.
1841 .RS
1842 .EX
1843 \&.PAGE 8.5i 11i 1i 1i 1i 1i
1844 \&.FAMILY T
1845 \&.FT R
1846 \&.PT_SIZE 12
1847 \&.LS 14
1848 \&.JUSTIFY
1849 \&.KERN
1850 \&.SS 0
1851 \&.IL \[rs]w\[aq]\[rs]0\[rs]0.\[aq]
1852 \&.HI \[rs]w\[aq]\[rs]0\[rs]0.\[aq]
1853 1.\[rs]0The most important point to be considered is whether
1854 the answer to the meaning of Life, the Universe, and
1855 Everything really is 42.\& We have no one\[aq]s word on the
1856 subject except Mr.\& Adams\[aq]s.
1857 \&.HI
1858 2.\[rs]0If the answer to the meaning of Life, the Universe,
1859 and Everything is indeed 42, what impact does this have on
1860 the politics of representation?\& 42 is, after all not a
1861 prime number.\& Are we to infer that prime numbers don\[aq]t
1862 deserve equal rights and equal access in the universe?
1863 \&.HI
1864 3.\[rs]0If 42 is deemed non-exclusionary, how do we present
1865 it as the answer and, at the same time, forestall debate
1866 on its exclusionary implications?
1867 .EE
1868 .RE
1869 .
1870 .P
1871 First, we invoke a left indent with a measure equal to the width of 2
1872 figures spaces plus a period (using the \[rs]w inline escape).
1873 .
1874 At this point, the left indent is active; text afterward would
1875 normally be indented.
1876 .
1877 However, we invoke a hanging indent of exactly the same width, which
1878 hangs the first line (and first line only!\&) to the left of the indent
1879 by the same distance (in this case, that means \[lq]out to the left
1880 margin\[rq]).
1881 .
1882 Because we begin the first line with a number, a period, and a figure
1883 space, the actual text
1884 .RI ( "The most important point.\|.\|.\&" )
1885 starts at exactly the same spot as the indented lines that follow.
1886 .
1887 .P
1888 Notice that subsequent invocations of
1889 .B .HI
1890 don't require a
1891 .I measure
1892 to be given.
1893 .
1894 .P
1895 Paste the example above into a file and preview it with
1896 .RS
1897 .EX
1898 .B pdfmom filename.mom | ps2pdf \- filename.pdf
1899 .EE
1900 .RE
1901 to see hanging indents in action.
1902 .
1903 .RE
1904 .
1905 .
1906 .\" ====================================================================
1907 .\" IB - INDENT BOTH
1908 .\" ====================================================================
1909 .TP
1910 .BI "\%.IB [" " <left measure> <right measure> " ]
1911 Indent both \[em] the optional argument requires a unit of measure
1912 .
1913 .RS
1914 .
1915 .P
1916 .B .IB
1917 allows you to set or invoke a left and a right indent at the same time.
1918 .
1919 .P
1920 At its first invocation, you must supply a measure for both indents;
1921 at subsequent invocations when you wish to supply a measure, both must
1922 be given again.
1923 .
1924 As with
1925 .B .IL
1926 and
1927 .BR .IR ,
1928 the measures are added to the values previously passed to the
1929 macro.
1930 .
1931 Hence, if you wish to change just one of the values, you must give an
1932 argument of zero to the other.
1933 .
1934 .P
1935 .I A word of advice:
1936 If you need to manipulate left and right indents separately, use a
1937 combination of
1938 .B .IL
1939 and
1940 .B .IR
1941 instead of
1942 .BR .IB .
1943 .
1944 You'll save yourself a lot of grief.
1945 .
1946 .P
1947 A
1948 .I minus sign
1949 may be prepended to the arguments to subtract from their current
1950 values.
1951 .
1952 The \[rs]w inline escape may be used to specify text-dependent
1953 measures, in which case no unit of measure is required.
1954 .
1955 For example,
1956 .RS
1957 .EX
1958 .B .IB \[rs]w\[aq]margarine\[aq] \[rs]w\[aq]jello\[aq]
1959 .EE
1960 .RE
1961 left indents text by the width of the word
1962 .I margarine
1963 and right indents by the width of
1964 .IR jello .
1965 .
1966 .P
1967 Like
1968 .B .IL
1969 and
1970 .BR .IR ,
1971 .B .IB
1972 with no argument indents by its last active values.
1973 .
1974 See the brief explanation of how mom handles indents for more details.
1975 .
1976 .P
1977 .I Note:
1978 Calling a
1979 .I tab
1980 (with
1981 .BR ".TAB <n>" )
1982 automatically cancels any active indents.
1983 .
1984 .P
1985 .I Additional note:
1986 Invoking
1987 .B .IB
1988 automatically turns off
1989 .B .IL
1990 and
1991 .BR .IR .
1992 .
1993 .RE
1994 .
1995 .
1996 .\" ====================================================================
1997 .\" IL - INDENT LEFT
1998 .\" ====================================================================
1999 .TP
2000 .BI "\%.IL [" " <measure> " ]
2001 Indent left \[em] the optional argument requires a unit of measure
2002 .
2003 .RS
2004 .
2005 .P
2006 .B .IL
2007 indents text from the left margin of the page, or if you're in a
2008 .IR tab ,
2009 from the left edge of the
2010 .IR tab .
2011 .
2012 Once
2013 .I IL
2014 is on, the
2015 .I left indent
2016 is applied uniformly to every subsequent line of text, even if you
2017 change the line length.
2018 .
2019 .P
2020 The first time you invoke
2021 .BR .IL ,
2022 you must give it a measure.
2023 .
2024 Subsequent invocations with a measure add to the previous measure.
2025 .
2026 A minus sign may be prepended to the argument to subtract from the
2027 current measure.
2028 .
2029 The
2030 .B \[rs]w
2031 inline escape may be used to specify a text-dependent measure, in
2032 which case no unit of measure is required.
2033 .
2034 For example,
2035 .RS
2036 .EX
2037 .B .IL \[rs]w\[aq]margarine\[aq]
2038 .EE
2039 .RE
2040 indents text by the width of the word
2041 .IR margarine .
2042 .
2043 .P
2044 With no argument,
2045 .B .IL
2046 indents by its last active value.
2047 .
2048 See the brief explanation of how
2049 .I mom
2050 handles indents for more details.
2051 .
2052 .P
2053 .I Note:
2054 Calling a
2055 .I tab
2056 (with
2057 .BR ".TAB <n>" )
2058 automatically cancels any active indents.
2059 .
2060 .P
2061 .I Additional note:
2062 Invoking
2063 .B .IL
2064 automatically turns off
2065 .BR IB .
2066 .
2067 .RE
2068 .
2069 .
2070 .\" ====================================================================
2071 .\" IQ - quit any/all indents
2072 .\" ====================================================================
2073 .TP
2074 .BI "\%.IQ [" " <measure> " ]
2075 IQ \[em] quit any/all indents
2076 .
2077 .RS
2078 .
2079 .P
2080 .I IMPORTANT NOTE:
2081 The original macro for quitting all indents was
2082 .BR .IX .
2083 .
2084 This usage has been deprecated in favour of
2085 .BR IQ .
2086 .
2087 .B .IX
2088 will continue to behave as before, but
2089 .I mom
2090 will issue a warning to
2091 .I stderr
2092 indicating that you should update your documents.
2093 .
2094 .P
2095 As a consequence of this change,
2096 .BR .ILX ,
2097 .B .IRX
2098 and
2099 .B .IBX
2100 may now also be invoked as
2101 .BR .ILQ ,
2102 .B .IRQ
2103 and
2104 .BR .IBQ .
2105 .
2106 Both forms are acceptable.
2107 .
2108 .P
2109 Without an argument, the macros to quit indents merely restore your
2110 original margins and line length.
2111 .
2112 The measures stored in the indent macros themselves are saved so you
2113 can call them again without having to supply a measure.
2114 .
2115 .P
2116 If you pass these macros the optional argument
2117 .BR CLEAR ,
2118 they not only restore your original left margin and line length, but
2119 also clear any values associated with a particular indent style.
2120 .
2121 The next time you need an indent of the same style, you have to supply
2122 a measure again.
2123 .
2124 .P
2125 .BR ".IQ CLEAR" ,
2126 as you'd suspect, quits and clears the values for all indent
2127 styles at once.
2128 .
2129 .RE
2130 .
2131 .
2132 .\" ====================================================================
2133 .\" IR - INDENT RIGHT
2134 .\" ====================================================================
2135 .TP
2136 .BI "\%.IR [" " <measure> " ]
2137 Indent right \[em] the optional argument requires a unit of measure
2138 .
2139 .RS
2140 .
2141 .P
2142 .B .IR
2143 indents text from the
2144 .I right margin
2145 of the page, or if you're in a
2146 .IR tab ,
2147 from the end of the
2148 .IR tab .
2149 .
2150 .P
2151 The first time you invoke
2152 .BR .IR ,
2153 you must give it a measure.
2154 .
2155 Subsequent invocations with a measure add to the previous indent
2156 measure.
2157 .
2158 A
2159 .I minus sign
2160 may be prepended to the argument to subtract from the current indent
2161 measure.
2162 .
2163 The \[rs]w inline escape may be used to specify a text-dependent
2164 measure, in which case no
2165 .I unit of measure
2166 is required.
2167 .
2168 For example,
2169 .RS
2170 .EX
2171 .B .IR \[rs]w\[aq]jello\[aq]
2172 .EE
2173 .RE
2174 indents text by the width of the word
2175 .IR jello .
2176 .
2177 .P
2178 With no argument,
2179 .B .IR
2180 indents by its last active value.
2181 .
2182 See the brief explanation of how
2183 .I mom
2184 handles indents for more details.
2185 .
2186 .P
2187 .I Note:
2188 Calling a
2189 .I tab
2190 (with
2191 .BR "\%.TAB <n>" )
2192 automatically cancels any active indents.
2193 .
2194 .P
2195 .I Additional note:
2196 Invoking
2197 .B .IR
2198 automatically turns off
2199 .BR IB .
2200 .
2201 .RE
2202 .
2203 .
2204 .\" ====================================================================
2205 .\" Left Margin
2206 .\" ====================================================================
2207 .TP
2208 .BI .L_MARGIN " <left margin>"
2209 Left Margin
2210 .
2211 .RS
2212 .
2213 .P
2214 L_MARGIN establishes the distance from the left edge of the printer
2215 sheet at which you want your type to start.
2216 .
2217 It may be used any time,
2218 and remains in effect until you enter a new value.
2219 .
2220 .P
2221 Left indents and tabs are calculated from the value you pass to
2222 .BR .L_MARGIN ,
2223 hence it's always a good idea to invoke it before starting any serious
2224 typesetting.
2225 .
2226 A unit of measure is required.
2227 .
2228 Decimal fractions are allowed.
2229 .
2230 Therefore,
2231 to set the left margin at 3 picas (1/2 inch),
2232 you'd enter either
2233 .RS
2234 .EX
2235 .B .L_MARGIN 3P
2236 .EE
2237 .RE
2238 or
2239 .RS
2240 .EX
2241 .B .L_MARGIN .5i
2242 .EE
2243 .RE
2244 .
2245 .P
2246 If you use the macros
2247 .BR .PAGE ,
2248 .B .PAGEWIDTH
2249 or
2250 .B .PAPER
2251 without invoking
2252 .B .L_MARGIN
2253 (either before or afterward),
2254 .I mom
2255 automatically sets
2256 .B .L_MARGIN
2257 to
2258 .IR "1 inch" .
2259 .
2260 .P
2261 Note:
2262 .B .L_MARGIN
2263 behaves in a special way when you're using the document processing
2264 macros.
2265 .
2266 .RE
2267 .
2268 .
2269 .\" ====================================================================
2270 .\" MCO - BEGIN MULTI-COLUMN SETTING
2271 .\" ====================================================================
2272 .TP
2273 .B .MCO
2274 Begin multi-column setting.
2275 .
2276 .RS
2277 .P
2278 .B .MCO
2279 .RI ( "Multi-Column On" )
2280 is the
2281 .I macro
2282 you use to begin
2283 .IR "multi-column setting" .
2284 .
2285 It marks the current baseline as the top of your columns, for use
2286 later with
2287 .BR .MCR .
2288 .
2289 See the introduction to columns for an explanation of
2290 .I multi-columns
2291 and some sample input.
2292 .
2293 .P
2294 .I Note:
2295 Do not confuse
2296 .B .MCO
2297 with the
2298 .B .COLUMNS
2299 macro in the document processing macros.
2300 .
2301 .RE
2302 .
2303 .
2304 .\" ====================================================================
2305 .\" MCR - RETURN TO TOP OF COLUMN
2306 .\" ====================================================================
2307 .TP
2308 .B \%.MCR
2309 Once you've turned
2310 .I multi-columns
2311 on (with
2312 .BR \%.MCO ),
2313 .BR .MCR ,
2314 at any time,
2315 returns you to the
2316 .IR "top of your columns" . \" XXX: Are italics truly required here?
2317 .
2318 .
2319 .\" ====================================================================
2320 .\" MCX - EXIT MULTI-COLUMNS
2321 .\" ====================================================================
2322 .TP
2323 .BI "\%.MCX [ " "<distance to advance below longest column>" " ]"
2324 Optional argument requires a unit of measure.
2325 .
2326 .RS
2327 .
2328 .P
2329 Exit multi-columns.
2330 .
2331 .P
2332 .B .MCX
2333 takes you out of any
2334 .I tab
2335 you were in (by silently invoking
2336 .BR .TQ )
2337 and advances to the bottom of the longest column.
2338 .
2339 .P
2340 Without an argument,
2341 .B .MCX
2342 advances
2343 .I 1 linespace
2344 below the longest column.
2345 .
2346 .P
2347 Linespace, in this instance, is the leading in effect at the moment
2348 .B .MCX
2349 is invoked.
2350 .
2351 .P
2352 If you pass the
2353 .I <distance>
2354 argument to
2355 .BR .MCX ,
2356 it advances
2357 .I 1 linespace
2358 below the longest column (see above)
2359 .I PLUS
2360 the distance specified by the argument.
2361 .
2362 The argument requires a unit of measure; therefore, to advance an
2363 extra 6 points below where
2364 .B \%.MCX
2365 would normally place you, you'd enter
2366 .RS
2367 .EX
2368 .B .MCX 6p
2369 .EE
2370 .RE
2371 .
2372 .P
2373 .I Note:
2374 If you wish to advance a precise distance below the baseline of the
2375 longest column, use
2376 .B .MCX
2377 with an argument of
2378 .B 0
2379 (zero; no
2380 .I unit of measure
2381 required) in conjunction with the
2382 .B \%.ALD
2383 macro, like this:
2384 .RS
2385 .EX
2386 .B .MCX 0
2387 .B .ALD 24p
2388 .EE
2389 .RE
2390 .
2391 The above advances to precisely
2392 .I 24 points
2393 below the baseline of the longest column.
2394 .
2395 .RE
2396 .
2397 .
2398 .\" ====================================================================
2399 .\" Start a new Page
2400 .\" ====================================================================
2401 .TP
2402 .B .NEWPAGE
2403 .
2404 .RS
2405 .
2406 .P
2407 Whenever you want to start a new page, use
2408 .BR .NEWPAGE ,
2409 by itself with no argument.
2410 .
2411 .B Mom
2412 will finish up processing the current page and move you to the top of
2413 a new one (subject to the top margin set with
2414 .BR .T_MARGIN ).
2415 .
2416 .RE
2417 .
2418 .
2419 .\" ====================================================================
2420 .\" Page
2421 .\" ====================================================================
2422 .TP
2423 .BI ".PAGE " <width> " [ " <length> " [ " <lm> " [ " <rm> " [ " \
2424 <tm> " [ " <bm> " ] ] ] ] ]"
2425 .
2426 .RS
2427 .
2428 .P
2429 All arguments require a unit of measure
2430 .
2431 .P
2432 .I IMPORTANT:
2433 If you're using the document processing macros,
2434 .B .PAGE
2435 must come after
2436 .BR .START .
2437 .
2438 Otherwise, it should go at the top of a document, prior to any text.
2439 .
2440 And remember, when you're using the document processing macros, top
2441 margin and bottom margin mean something slightly different than when
2442 you're using just the typesetting macros (see Top and bottom margins
2443 in document processing).
2444 .
2445 .P
2446 .B .PAGE
2447 lets you establish paper dimensions and page margins with a single
2448 macro.
2449 .
2450 The only required argument is page width.
2451 .
2452 The rest are
2453 optional, but they must appear in order and you can't skip over
2454 any.
2455 .
2456 .IR <lm> ,
2457 .IR <rm> ,
2458 .I <tm>
2459 and
2460 .I <bm>
2461 refer to the left, right, top and bottom margins respectively.
2462 .
2463 .P
2464 Assuming your page dimensions are 11 inches by 17 inches, and that's
2465 all you want to set, enter
2466 .RS
2467 .EX
2468 .B .PAGE 11i 17i
2469 .EE
2470 .RE
2471 .
2472 If you want to set the left margin as well, say, at 1 inch,
2473 .B PAGE
2474 would look like this:
2475 .RS
2476 .EX
2477 .B .PAGE 11i 17i 1i
2478 .EE
2479 .RE
2480 .
2481 .P
2482 Now suppose you also want to set the top margin,
2483 say,
2484 at 1\(en1/2 inches.
2485 .
2486 .I <tm>
2487 comes after
2488 .I <rm>
2489 in the optional arguments, but you can't skip over any arguments,
2490 therefore to set the top margin, you must also give a right margin.
2491 .
2492 The
2493 .B .PAGE
2494 macro would look like this:
2495 .RS
2496 .EX
2497 .tr -\-
2498 \&.PAGE 11i 17i 1i 1i 1.5i
2499 | |
2500 required right---+ +---top margin
2501 margin
2502 .tr --
2503 .EE
2504 .RE
2505 .
2506 .P
2507 Clearly,
2508 .B .PAGE
2509 is best used when you want a convenient way to tell
2510 .I mom
2511 just the dimensions of your printer sheet (width and length), or when
2512 you want to tell her everything about the page (dimensions and all the
2513 margins), for example
2514 .RS
2515 .EX
2516 .B .PAGE 8.5i 11i 45p 45p 45p 45p
2517 .EE
2518 .RE
2519 .
2520 This sets up an 8\(12 by 11 inch page with margins of 45 points
2521 (5/8-inch) all around.
2522 .
2523 .P
2524 Additionally, if you invoke
2525 .B .PAGE
2526 with a top margin argument, any macros you invoke after
2527 .B .PAGE
2528 will almost certainly move the baseline of the first line of text down
2529 by one linespace.
2530 .
2531 To compensate, do
2532 .RS
2533 .EX
2534 .B .RLD 1v
2535 .EE
2536 .RE
2537 immediately before entering any text, or, if it's feasible, make
2538 .B .PAGE
2539 the last macro you invoke prior to entering text.
2540 .
2541 .P
2542 Please read the
2543 .I Important note
2544 on page dimensions and papersize for information on ensuring
2545 .I groff
2546 respects your
2547 .B .PAGE
2548 dimensions and margins.
2549 .
2550 .RE
2551 .
2552 .
2553 .\" ====================================================================
2554 .\" Page Length
2555 .\" ====================================================================
2556 .TP
2557 .BI .PAGELENGTH " <length of printer sheet>"
2558 tells
2559 .I mom
2560 how long your printer sheet is.
2561 .
2562 It works just like
2563 .BR .PAGEWIDTH .
2564 .
2565 .RS
2566 .
2567 .P
2568 Therefore, to tell
2569 .I mom
2570 your printer sheet is 11 inches long, you enter
2571 .RS
2572 .EX
2573 .B .PAGELENGTH 11i
2574 .EE
2575 .RE
2576 .
2577 Please read the important note on page dimensions and papersize for
2578 information on ensuring
2579 .I groff
2580 respects your
2581 .IR PAGELENGTH .
2582 .
2583 .RE
2584 .
2585 .
2586 .\" ====================================================================
2587 .\" Page Width
2588 .\" ====================================================================
2589 .TP
2590 .BI .PAGEWIDTH " <width of printer sheet>"
2591 .
2592 .RS
2593 .
2594 .P
2595 The argument to
2596 .B .PAGEWIDTH
2597 is the width of your printer sheet.
2598 .
2599 .P
2600 .B .PAGEWIDTH
2601 requires a unit of measure.
2602 .
2603 Decimal fractions are allowed.
2604 .
2605 Hence, to tell
2606 .I mom
2607 that the width of your printer sheet is 8\(12 inches, you enter
2608 .RS
2609 .EX
2610 \&.PAGEWIDTH 8.5i
2611 .EE
2612 .RE
2613 .
2614 .P
2615 Please read the Important note on page dimensions and papersize for
2616 information on ensuring
2617 .I groff
2618 respects your
2619 .IR PAGEWIDTH .
2620 .
2621 .RE
2622 .
2623 .
2624 .\" ====================================================================
2625 .\" Paper
2626 .\" ====================================================================
2627 .TP
2628 .BI .PAPER " <paper type>"
2629 provides a convenient way to set the page dimensions for some common
2630 printer sheet sizes.
2631 .
2632 The argument
2633 .I <paper type>
2634 can be one of:
2635 .BR LETTER ,
2636 .BR LEGAL ,
2637 .BR STATEMENT ,
2638 .BR TABLOID ,
2639 .BR LEDGER ,
2640 .BR FOLIO ,
2641 .BR QUARTO ,
2642 .BR EXECUTIVE ,
2643 .BR 10x14 ,
2644 .BR A3 ,
2645 .BR A4 ,
2646 .BR A5 ,
2647 .BR B4 ,
2648 .BR B5 .
2649 .
2650 .
2651 .TP
2652 .B .PRINTSTYLE
2653 .
2654 .
2655 .\" ====================================================================
2656 .\" PT_SIZE - POINT SIZE OF TYPE
2657 .\" ====================================================================
2658 .TP
2659 .BI .PT_SIZE " <size of type in points>"
2660 Point size of type, does not require a
2661 .IR "unit of measure" .
2662 .
2663 .RS
2664 .
2665 .P
2666 .B \%.PT_SIZE
2667 .RI ( "Point Size" )
2668 takes one argument: the
2669 .I size of type
2670 in
2671 .IR points .
2672 .
2673 Unlike most other macros that establish the
2674 .I size
2675 or
2676 .I measure
2677 of something,
2678 .B \%.PT_SIZE
2679 does not require that you supply a
2680 .I unit of measure
2681 since it's a near universal convention that
2682 .I type size
2683 is measured in
2684 .IR points .
2685 .
2686 Therefore, to change the
2687 .I type size
2688 to, say,
2689 .IR "11 points" ,
2690 enter
2691 .RS
2692 .EX
2693 .B .PT_SIZE 11
2694 .EE
2695 .RE
2696 .
2697 .I Point sizes
2698 may be
2699 .I fractional
2700 (e.g.,
2701 .I 10.25
2702 or
2703 .IR 12.5 ).
2704 .
2705 .P
2706 You can prepend a
2707 .I plus
2708 or a
2709 .I minus sign
2710 to the argument to
2711 .BR \%.PT_SIZE ,
2712 in which case the
2713 .I point size
2714 will be changed by
2715 .I +
2716 or
2717 .I \-
2718 the original value.
2719 .
2720 For example,
2721 if the
2722 .I point size
2723 is
2724 .IR 12 ,
2725 and you want
2726 .IR 14 ,
2727 you can do
2728 .RS
2729 .EX
2730 .B .PT_SIZE +2
2731 .EE
2732 .RE
2733 then later reset it to
2734 .I 12
2735 with
2736 .RS
2737 .EX
2738 .B .PT_SIZE \-2
2739 .EE
2740 .RE
2741 .
2742 The
2743 .I size of type
2744 can also be changed inline.
2745 .
2746 .P
2747 .I Note:
2748 It is unfortunate that the
2749 .B \%pic
2750 preprocessor has already taken the name, PS, and thus
2751 .IR mom 's
2752 macro for setting
2753 .I point sizes
2754 can't use it.
2755 .
2756 However, if you aren't using
2757 .BR pic ,
2758 you might want to alias
2759 .B \%.PT_SIZE
2760 as
2761 .BR .PS ,
2762 since there'd be no conflict.
2763 .
2764 For example
2765 .RS
2766 .EX
2767 .B .ALIAS PS PT_SIZE
2768 .EE
2769 .RE
2770 would allow you to set
2771 .I point sizes
2772 with
2773 .BR .PS .
2774 .
2775 .RE
2776 .
2777 .
2778 .\" ====================================================================
2779 .\" Right Margin
2780 .\" ====================================================================
2781 .TP
2782 .BI .R_MARGIN " <right margin>"
2783 Right Margin
2784 .
2785 .RS
2786 .
2787 .P
2788 Requires a unit of measure.
2789 .
2790 .P
2791 IMPORTANT:
2792 .BR .R_MARGIN ,
2793 if used, must come after
2794 .BR .PAPER ,
2795 .BR .PAGEWIDTH ,
2796 .BR .L_MARGIN ,
2797 and/or
2798 .B .PAGE
2799 (if a right margin isn't given to PAGE).
2800 .
2801 The reason is that
2802 .B .R_MARGIN
2803 calculates line length from the overall page dimensions and the left
2804 margin.
2805 .
2806 .P
2807 Obviously, it can't make the calculation if it doesn't know the page
2808 width and the left margin.
2809 .
2810 .P
2811 .B .R_MARGIN
2812 establishes the amount of space you want between the end of typeset
2813 lines and the right hand edge of the printer sheet.
2814 .
2815 In other words, it sets the line length.
2816 .B .R_MARGIN
2817 requires a unit of measure.
2818 .
2819 Decimal fractions are allowed.
2820 .
2821 .P
2822 The line length macro (LL) can be used in place of
2823 .BR .R_MARGIN .
2824 .
2825 In either case, the last one invoked sets the line length.
2826 .
2827 The choice of which to use is up to you.
2828 .
2829 In some instances, you may find it easier to think of a section of
2830 type as having a right margin.
2831 .
2832 In others, giving a line length may make more sense.
2833 .
2834 .P
2835 For example, if you're setting a page of type you know should have
2836 6-pica margins left and right, it makes sense to enter a left and
2837 right margin, like this:
2838 .RS
2839 .EX
2840 .B .L_MARGIN 6P
2841 .B .R_MARGIN 6P
2842 .EE
2843 .RE
2844 .
2845 .P
2846 That way, you don't have to worry about calculating the line
2847 length.
2848 .
2849 On the other hand, if you know the line length for a patch of type
2850 should be 17 picas and 3 points, entering the line length with LL is
2851 much easier than calculating the right margin, e.g.,
2852 .RS
2853 .EX
2854 .B .LL 17P+3p
2855 .EE
2856 .RE
2857 .
2858 .P
2859 If you use the macros
2860 .BR .PAGE ,
2861 .B .PAGEWIDTH
2862 or
2863 .B PAPER
2864 without invoking
2865 .B .R_MARGIN
2866 afterward,
2867 .I mom
2868 automatically sets
2869 .B .R_MARGIN
2870 to
2871 .IR "1 inch" .
2872 .
2873 If you set a line length after these macros (with
2874 .BR .LL ),
2875 the line length calculated by
2876 .B .R_MARGIN
2877 is, of course, overridden.
2878 .
2879 .P
2880 Note:
2881 .B .R_MARGIN
2882 behaves in a special way when you're using the document processing
2883 macros.
2884 .
2885 .RE
2886 .
2887 .
2888 .\" ====================================================================
2889 .\" ST - Set String Tabs
2890 .\" ====================================================================
2891 .TP
2892 .FONT B .ST I " <tab number> " B "L | R | C | J [ QUAD ]"
2893 .
2894 .RS
2895 .P
2896 After
2897 .I string tabs
2898 have been marked off on an input line (see
2899 .BR \[rs]*[ST].\|.\|.\&\[rs]*[STX] ),
2900 you need to
2901 .I set
2902 them by giving them a direction and, optionally, the
2903 .B \%QUAD
2904 argument.
2905 .
2906 .P
2907 In this respect,
2908 .B .ST
2909 is like
2910 .B \%.TAB_SET
2911 except that you don't have to give
2912 .B .ST
2913 an indent or a line length (that's already taken care of, inline,
2914 by
2915 .BR \[rs]*[ST].\|.\|.\&\[rs]*[STX] ).
2916 .
2917 .P
2918 If you want string
2919 .I tab 1
2920 to be
2921 .BR \%left ,
2922 enter
2923 .RS
2924 .EX
2925 .B .ST 1 L
2926 .EE
2927 .RE
2928 .
2929 If you want it to be
2930 .I \%left
2931 and
2932 .IR \%filled ,
2933 enter
2934 .RS
2935 .EX
2936 .B .ST 1 L \%QUAD
2937 .EE
2938 .RE
2939 .
2940 If you want it to be justified, enter
2941 .RS
2942 .EX
2943 .B .ST 1 J
2944 .EE
2945 .RE
2946 .
2947 .RE
2948 .
2949 .
2950 .\" ====================================================================
2951 .\" TAB - Call Tabs
2952 .\" ====================================================================
2953 .TP
2954 .BI \%.TAB " <tab number>"
2955 After
2956 .I tabs
2957 have been defined (either with
2958 .B \%.TAB_SET
2959 or
2960 .BR .ST ),
2961 .B \%.TAB
2962 moves to whatever
2963 .I tab number
2964 you pass it as an argument.
2965 .
2966 .RS
2967 .
2968 .P
2969 For example,
2970 .RS
2971 .EX
2972 .B \%.TAB 3
2973 .EE
2974 .RE
2975 moves you to
2976 .IR "\%tab 3" .
2977 .
2978 .P
2979 Note:
2980 .B \%.TAB
2981 breaks the line preceding it and advances 1 linespace.
2982 .
2983 Hence,
2984 .RS
2985 .EX
2986 .B .TAB 1
2987 .B A line of text in tab 1.
2988 .B .TAB 2
2989 .B A line of text in tab 2.
2990 .EE
2991 .RE
2992 produces, on output
2993 .RS
2994 .EX
2995 .B "A line of text in tab 1."
2996 .B " A line of text in tab 2."
2997 .EE
2998 .RE
2999 .
3000 .
3001 .P
3002 If you want the tabs to line up,
3003 use
3004 .B .TN
3005 (\[lq]Tab Next\[rq])
3006 or,
3007 more conveniently,
3008 the inline escape sequence
3009 .BR \[rs]*[TB+] :
3010 .RS
3011 .EX
3012 .BR .TAB \~1
3013 A line of text in tab 1.\[rs]*[TB+]
3014 A line of text in tab 2.
3015 .EE
3016 .RE
3017 which produces
3018 .RS
3019 .EX
3020 .B "A line of text in tab 1.\& A line of text in tab 2."
3021 .EE
3022 .RE
3023 .
3024 .
3025 .P
3026 If the text in your tabs runs to several lines, and you want the first
3027 lines of each tab to align, you must use the multi-column macros.
3028 .
3029 .P
3030 .I Additional note:
3031 Any indents in effect prior to calling a tab are automatically turned
3032 off by
3033 .BR TAB .
3034 .
3035 If you were happily zipping down the page with a left indent of
3036 .I 2 picas
3037 turned on, and you call a
3038 .I tab
3039 whose indent from the left margin is
3040 .IR "6 picas" ,
3041 your new distance from the
3042 .I left margin
3043 will be
3044 .IR "6 picas" ,
3045 not
3046 I 6 picas plus the 2 pica
3047 indent.
3048 .
3049 .P
3050 .I \%Tabs
3051 are not by nature columnar, which is to say that if the text inside a
3052 .I tab
3053 runs to several lines, calling another
3054 .I tab
3055 does not automatically move to the baseline of the first line in the
3056 .IR "previous tab" .
3057 .
3058 To demonstrate:
3059 .RS
3060 .EX
3061 TAB 1
3062 Carrots
3063 Potatoes
3064 Broccoli
3065 \&.TAB 2
3066 $1.99/5 lbs
3067 $0.25/lb
3068 $0.99/bunch
3069 .EE
3070 .RE
3071 produces, on output
3072 .RS
3073 .EX
3074 Carrots
3075 Potatoes
3076 Broccoli
3077 $1.99/5 lbs
3078 $0.25/lb
3079 $0.99/bunch
3080 .EE
3081 .RE
3082 .
3083 .RE
3084 .
3085 .\" ====================================================================
3086 .\" TB - Call Tabs Alias
3087 .\" ====================================================================
3088 .TP
3089 .BI .TB " <tab number>"
3090 Alias to
3091 .B .TAB
3092 .
3093 .
3094 .\" ====================================================================
3095 .\" TI - TEMPORARY (LEFT) INDENT
3096 .\" ====================================================================
3097 .TP
3098 .BI "\%.TI [" " <measure> " ]
3099 Temporary left indent \[em] the optional argument requires a
3100 .I unit of measure
3101 .
3102 .RS
3103 .
3104 .P
3105 A temporary indent is one that applies only to the first line of text
3106 that comes after it.
3107 .
3108 Its chief use is indenting the first line of paragraphs.
3109 .RB ( Mom's
3110 .B .PP
3111 macro, for example, uses a
3112 .IR "temporary indent" .)
3113 .
3114 .P
3115 The first time you invoke
3116 .BR .TI ,
3117 you must give it a measure.
3118 .
3119 If you want to
3120 .I indent
3121 the first line of a paragraph by, say, 2 ems, do
3122 .RS
3123 .EX
3124 .B .TI 2m
3125 .EE
3126 .RE
3127 .
3128 .P
3129 Subsequent invocations of
3130 .B .TI
3131 do not require you to supply a measure;
3132 .I mom
3133 keeps track of the last measure you gave it.
3134 .
3135 .P
3136 Because
3137 .I temporary indents
3138 are temporary, there's no need to turn them off.
3139 .
3140 .P
3141 .I IMPORTANT:
3142 Unlike
3143 .BR .IL ,
3144 .B .IR
3145 and
3146 .BR IB ,
3147 measures given to
3148 .B .TI
3149 are NOT additive.
3150 .
3151 In the following example, the second
3152 .B \%".TI 2P"
3153 is exactly
3154 .IR "2 picas" .
3155 .RS
3156 .EX
3157 .B .TI 1P
3158 .B The beginning of a paragraph.\|.\|.\&
3159 .B .TI 2P
3160 .B The beginning of another paragraph.\|.\|.\&
3161 .EE
3162 .RE
3163 .
3164 .RE
3165 .
3166 .
3167 .
3168 .\" ====================================================================
3169 .\" TN - Tab Next
3170 .\" ====================================================================
3171 .TP
3172 .B .TN
3173 Tab Next
3174 .
3175 .RS
3176 .P
3177 Inline escape
3178 .B \[rs]*[TB+]
3179 .
3180 .P
3181 .B TN
3182 moves over to the
3183 .I next tab
3184 in numeric sequence
3185 .RI ( "tab n+1" )
3186 without advancing on the page.
3187 .
3188 See the
3189 .I NOTE
3190 in the description of the
3191 .B \%.TAB
3192 macro for an example of how
3193 .B TN
3194 works.
3195 .
3196 .P
3197 In
3198 .I \%tabs
3199 that aren't given the
3200 .B QUAD
3201 argument when they're set up with
3202 .B \%.TAB_SET
3203 or
3204 .BR ST ,
3205 you must terminate the line preceding
3206 .B .TN
3207 with the
3208 .B \[rs]c
3209 inline escape sequence.
3210 .
3211 Conversely, if you did give a
3212 .B QUAD
3213 argument to
3214 .B \%.TAB_SET
3215 or
3216 .BR ST ,
3217 the
3218 .B \[rs]c must not be used.
3219 .
3220 .P
3221 If you find remembering whether to put in the
3222 .B \[rs]c
3223 bothersome, you may prefer to use the inline escape alternative
3224 to
3225 .BR .TN ,
3226 .BR \[rs]*[TB+] ,
3227 which works consistently regardless of the fill mode.
3228 .
3229 .P
3230 .I Note:
3231 You must put text in the input line immediately after
3232 .BR .TN .
3233 .
3234 Stacking of
3235 .BR .TN 's
3236 is not allowed.
3237 .
3238 In other words, you cannot do
3239 .RS
3240 .EX
3241 \&.TAB 1
3242 Some text\[rs]c
3243 \&.TN
3244 Some more text\[rs]c
3245 \&.TN
3246 \&.TN
3247 Yet more text
3248 .EE
3249 .RE
3250 .
3251 The above example, assuming
3252 .I tabs
3253 numbered from
3254 .I 1
3255 to
3256 .IR 4 ,
3257 should be entered
3258 .RS
3259 .EX
3260 \&.TAB 1
3261 Some text\[rs]c
3262 \&.TN
3263 Some more text\[rs]c
3264 \&.TN
3265 \[rs]&\[rs]c
3266 \&.TN
3267 Yet more text
3268 .EE
3269 .RE
3270 .
3271 \[rs]& is a zero-width, non-printing character that
3272 .I groff
3273 recognizes as valid input, hence meets the requirement for input text
3274 following
3275 .BR .TN .
3276 .
3277 .RE
3278 .
3279 .
3280 .\" ====================================================================
3281 .\" Tab Quit
3282 .\" ====================================================================
3283 .TP
3284 .B .TQ
3285 .B TQ
3286 takes you out of whatever
3287 .I tab
3288 you were in, advances
3289 .IR "1 linespace" ,
3290 and restores the
3291 .IR "left margin" ,
3292 .IR "line length" ,
3293 .I quad direction
3294 and
3295 .I fill mode
3296 that were in effect prior to invoking any
3297 .IR tabs .
3298 .
3299 .
3300 .\" ====================================================================
3301 .\" Top Margin
3302 .\" ====================================================================
3303 .TP
3304 .BI .T_MARGIN " <top margin>"
3305 Top margin
3306 .
3307 .RS
3308 .
3309 .P
3310 Requires a unit of measure
3311 .
3312 .P
3313 .B .T_MARGIN
3314 establishes the distance from the top of the printer sheet at which
3315 you want your type to start.
3316 .
3317 It requires a unit of measure, and decimal fractions are allowed.
3318 .
3319 To set a top margin of 2\(12 centimetres, you'd enter
3320 .RS
3321 .EX
3322 .B .T_MARGIN 2.5c
3323 .EE
3324 .RE
3325 .
3326 .B .T_MARGIN
3327 calculates the vertical position of the first line of type on a page
3328 by treating the top edge of the printer sheet as a baseline.
3329 Therefore,
3330 .RS
3331 .EX
3332 .B .T_MARGIN 1.5i
3333 .EE
3334 .RE
3335 puts the baseline of the first line of type 1\(12 inches beneath the
3336 top of the page.
3337 .
3338 .P
3339 Note:
3340 .B .T_MARGIN
3341 means something slightly different when you're using the document
3342 processing macros.
3343 .
3344 See Top and bottom margins in document processing for an explanation.
3345 .
3346 .P
3347 IMPORTANT:
3348 .B .T_MARGIN
3349 does two things: it establishes the top margin for pages that come
3350 after it and it moves to that position on the current page.
3351 .
3352 Therefore,
3353 .B .T_MARGIN
3354 should only be used at the top of a file (prior to entering text) or
3355 after NEWPAGE, like this:
3356 .RS
3357 .EX
3358 .B .NEWPAGE
3359 .B .T_MARGIN 6P
3360 .I <text>
3361 .EE
3362 .RE
3363 .
3364 .RE
3365 .
3366 .
3367 .\" ====================================================================
3368 .SH Authors
3369 .\" ====================================================================
3370 .
3371 .MT peter@\:schaffter\:.ca
3372 Peter Schaffter
3373 .ME
3374 wrote
3375 .IR mom .
3376 .
3377 .MT deri@\:chuzzlewit\:.myzen\:.co\:.uk
3378 Deri James
3379 .ME
3380 added PDF support.
3381 .
3382 .MT groff\-bernd\:.warken\-72@\:web\:.de
3383 Bernd Warken
3384 .ME
3385 contributed this man page.
3386 .
3387 .
3388 .\" ====================================================================
3389 .SH "See also"
3390 .\" ====================================================================
3391 .
3392 .TP
3393 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%html/\:mom/\:toc\:.html
3394 .I mom
3395 manual
3396 (installed version)
3397 .
3398 .
3399 .TP
3400 .UR http://\:www\:.schaffter\:.ca/\:mom/\:momdoc/\:toc\:.html
3401 .I mom
3402 manual
3403 .UE
3404 (latest version)
3405 .
3406 .
3407 .TP
3408 .UR http://\:www\:.schaffter\:.ca/\:mom/
3409 .I mom
3410 homepage
3411 .UE
3412 .
3413 .
3414 .P
3415 .IR "Groff: The GNU Implementation of troff" ,
3416 by Trent A.\& Fisher and Werner Lemberg,
3417 is the primary
3418 .I groff
3419 manual.
3420 .
3421 You can browse it interactively with \[lq]info groff\[rq].
3422 .
3423 .
3424 .P
3425 .MR pdfmom 1 ,
3426 .MR groff 1 ,
3427 .MR \%troff 1
3428 .
3429 .
3430 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
3431 .cp \n[*groff_groff_mom_7_man_C]
3432 .do rr *groff_groff_mom_7_man_C
3433 .
3434 .
3435 .\" Local Variables:
3436 .\" fill-column: 72
3437 .\" mode: nroff
3438 .\" End:
3439 .\" vim: set filetype=groff textwidth=72: