Debian Codegraph @

upstream/debian-trixie/man7/groff_ms.7

raw
1 '\" t
2 .TH groff_ms 7 "3 June 2025" "groff 1.23.0"
3 .SH Name
4 groff_ms \- GNU
5 .I roff
6 manuscript macro package for formatting documents
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_groff_ms_7_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY "groff \-m\%s"
56 .RI [ option\~ .\|.\|.\&]
57 .RI [ file\~ .\|.\|.]
58 .
59 .SY "groff \-m m\%s"
60 .RI [ option\~ .\|.\|.\&]
61 .RI [ file\~ .\|.\|.]
62 .YS
63 .
64 .
65 .\" ====================================================================
66 .SH Description
67 .\" ====================================================================
68 .
69 The GNU implementation of the
70 .I ms
71 macro package is part of the
72 .I groff
73 document formatting system.
74 .
75 The
76 .I ms
77 package is suitable for the composition of
78 letters,
79 memoranda,
80 reports,
81 and books.
82 .
83 .
84 .LP
85 These
86 .I groff
87 macros support cover page and table of contents generation,
88 automatically numbered headings,
89 several paragraph styles,
90 a variety of text styling options,
91 footnotes,
92 and multi-column page layouts.
93 .
94 .I ms
95 supports the
96 .MR \%tbl 1 ,
97 .MR \%eqn 1 ,
98 .MR \%pic 1 ,
99 and
100 .MR \%refer 1
101 preprocessors for inclusion of tables,
102 mathematical equations,
103 diagrams,
104 and standardized bibliographic citations.
105 .
106 .
107 .LP
108 This implementation is mostly compatible with the documented interface
109 and behavior of AT&T Unix Version\~7
110 .IR ms .
111 .
112 Many extensions from 4.2BSD (Berkeley)
113 .\" Few changes were made in 4.3, Reno, Tahoe, or 4.4.
114 and Tenth Edition Research Unix have been recreated.
115 .
116 .
117 .\" ====================================================================
118 .SH Usage
119 .\" ====================================================================
120 .
121 The
122 .I ms
123 macro package expects a certain amount of structure:
124 a well-formed document contains at least one paragraphing or heading
125 macro call.
126 .
127 .\" This sentence is unique to the man page because we omit the "Basic
128 .\" information" section from ms.ms.
129 To compose a simple document from scratch,
130 begin it by calling
131 .B .LP
132 or
133 .BR .PP .
134 .
135 Longer documents have a structure as follows.
136 .
137 .
138 .TP
139 .B Document type
140 Calling the
141 .B RP
142 macro at the beginning of your document puts the document description
143 (see below)
144 on a cover page.
145 .
146 Otherwise,
147 .I ms
148 places this information
149 on the first page,
150 followed immediately by the body text.
151 .
152 Some document types found in other
153 .I ms
154 implementations are specific to AT&T or Berkeley,
155 and are not supported in
156 .IR "groff ms" .
157 .
158 .
159 .TP
160 .B "Format and layout"
161 By setting registers and strings,
162 you can configure your document's typeface,
163 margins,
164 spacing,
165 headers and footers,
166 and footnote arrangement.
167 .
168 See subsection \[lq]Document control settings\[rq] below.
169 .
170 .
171 .TP
172 .B Document description
173 A document description consists of any of:
174 a title,
175 one or more authors' names and affiliated institutions,
176 an abstract,
177 and a date or other identifier.
178 .
179 See subsection \[lq]Document description macros\[rq] below.
180 .
181 .
182 .TP
183 .B Body text
184 The main matter of your document follows its description
185 (if any).
186 .
187 .I ms
188 supports highly structured text consisting of paragraphs interspersed
189 with multi-level headings
190 (chapters,
191 sections,
192 subsections,
193 and so forth)
194 and augmented by lists,
195 footnotes,
196 tables,
197 diagrams,
198 and similar material.
199 .
200 The preponderance of subsections below covers these matters.
201 .
202 .
203 .TP
204 .B "Table of contents"
205 Macros enable the collection of entries for a table of contents
206 (or index)
207 as the material they discuss appears in the document.
208 .
209 You then call a macro to emit the table of contents at the end of
210 your document.
211 .
212 The table of contents must necessarily follow the rest of the text since
213 GNU
214 .I troff \" GNU
215 is a single-pass formatter;
216 it thus cannot determine the page number of a division of the text until
217 it has been set and output.
218 .
219 Since
220 .I ms
221 output was designed for the production of hard copy,
222 the traditional procedure was to manually relocate the pages containing
223 the table of contents between the cover page and the body text.
224 .
225 Today,
226 page resequencing is more often done in the digital domain.
227 .
228 An index works similarly,
229 but because it typically needs to be sorted after collection,
230 its preparation requires separate processing.
231 .
232 .
233 .\" ====================================================================
234 .SS "Document control settings"
235 .\" ====================================================================
236 .
237 The following tables list the document control registers,
238 strings,
239 and special characters.
240 .
241 For any parameter whose default is unsatisfactory,
242 define it before calling any
243 .I ms
244 macro other than
245 .BR RP .
246 .
247 .
248 .LP
249 .ne 7v
250 .TS
251 cb s s s
252 cb cb cb cb
253 lf(CR) lx l lf(CR).
254 Margin settings
255 Parameter Definition Effective Default
256 _
257 \[rs]n[PO] Page offset (left margin) next page 1i (0)
258 \[rs]n[LL] Line length next paragraph 6.5i (65n)
259 \[rs]n[LT] Title line length next paragraph 6.5i (65n)
260 \[rs]n[HM] Top (header) margin next page 1i
261 \[rs]n[FM] Bottom (footer) margin next page 1i
262 _
263 .TE
264 .
265 .
266 .LP
267 .ne 8v
268 .TS
269 cb s s s
270 cb cb cb cb
271 lf(CR) lx l lf(CR).
272 Titles (headers, footers)
273 Parameter Definition Effective Default
274 _
275 \[rs]*[LH] Left header text next header \f[I]empty
276 \[rs]*[CH] Center header text next header \-\[rs]n[%]\-
277 \[rs]*[RH] Right header text next header \f[I]empty
278 \[rs]*[LF] Left footer text next footer \f[I]empty
279 \[rs]*[CF] Center footer text next footer \f[I]empty
280 \[rs]*[RF] Right footer text next footer \f[I]empty
281 _
282 .TE
283 .
284 .
285 .LP
286 .ne 6v
287 .TS
288 cb s s s
289 cb cb cb cb
290 lf(CR) lx l lf(CR).
291 Text settings
292 Parameter Definition Effective Default
293 _
294 \[rs]n[PS] Point size next paragraph 10p
295 \[rs]n[VS] Vertical spacing (leading) next paragraph 12p
296 \[rs]n[HY] Hyphenation mode next paragraph 6
297 \[rs]*[FAM] Font family next paragraph T
298 _
299 .TE
300 .
301 .
302 .LP
303 .ne 6v
304 .TS
305 cb s s s
306 cb cb cb cb
307 lf(CR)2 lx l lf(CR).
308 Paragraph settings
309 Parameter Definition Effective Default
310 _
311 \[rs]n[PI] Indentation next paragraph 5n
312 \[rs]n[PD] Paragraph distance (spacing) next paragraph 0.3v\
313 \f[R](\f[]1v\f[R])
314 \[rs]n[QI] Quotation indentation next paragraph 5n
315 \[rs]n[PORPHANS] # of initial lines kept next paragraph 1
316 _
317 .TE
318 .
319 .
320 .ne 10v \" Keep table and subsequent paragraph together.
321 .LP
322 .TS
323 cb s s s
324 cb cb cb cb
325 lf(CR) lx l lf(CR).
326 Heading settings
327 Parameter Definition Effective Default
328 _
329 \[rs]n[PSINCR] Point size increment next heading 1p
330 \[rs]n[GROWPS] Size increase depth limit next heading 0
331 \[rs]n[HORPHANS] # of following lines kept next heading 1
332 \[rs]*[SN\-STYLE] Numbering style (alias) next heading \[rs]*[SN\-DOT]
333 _
334 .TE
335 .
336 .
337 .LP
338 .B \[rs]*[SN\-STYLE]
339 can alternatively be made an alias of
340 .B \[rs]*[SN\-NO\-DOT]
341 with the
342 .B als
343 request.
344 .
345 .
346 .LP
347 .ne 8v
348 .TS
349 cb s s s
350 cb cb cb cb
351 lf(CR) lx l lf(CR).
352 Footnote settings
353 Parameter Definition Effective Default
354 _
355 \[rs]n[FI] Indentation next footnote 2n
356 \[rs]n[FF] Format next footnote 0
357 \[rs]n[FPS] Point size next footnote \[rs]n[PS]\-2p
358 \[rs]n[FVS] Vertical spacing (leading) next footnote \[rs]n[FPS]+2p
359 \[rs]n[FPD] Paragraph distance (spacing) next footnote \[rs]n[PD]/2
360 \[rs]*[FR] Line length ratio \f[I]special 11/12
361 _
362 .TE
363 .
364 .
365 .LP
366 .ne 4v
367 .TS
368 cb s s s
369 cb cb cb cb
370 lf(CR) lx l lf(CR).
371 Display settings
372 Parameter Definition Effective Default
373 _
374 \[rs]n[DD] Display distance (spacing) \f[I]special 0.5v\
375 \f[R](\f[]1v\f[R])
376 \[rs]n[DI] Display indentation \f[I]special 0.5i
377 _
378 .TE
379 .
380 .
381 .LP
382 .ne 3v
383 .TS
384 cb s s s
385 cb cb cb cb
386 lf(CR) lx l lf(CR).
387 Other settings
388 Parameter Definition Effective Default
389 _
390 \[rs]n[MINGW] Minimum gutter width next page 2n
391 \[rs]n[TC\-MARGIN] TOC page number margin width \
392 next \f[B]PX\f[] call \[rs]w\[aq]000\[aq]
393 \[rs][TC\-LEADER] TOC leader character next \f[B]PX\f[] call\
394 .\[rs]h\[aq]1m\[aq]
395 _
396 .TE
397 .
398 .
399 .LP
400 For entries marked
401 .RI \[lq] special \[rq]
402 in the \[lq]Effective\[rq] column,
403 see the discussion in the applicable section below.
404 .
405 The
406 .BR PO ,
407 .BR LL ,
408 and
409 .B LT
410 register defaults vary by output device and paper format;
411 the values shown are for typesetters using U.S.\& letter paper,
412 and then terminals.
413 .
414 See section \[lq]Paper format\[rq] of
415 .MR groff 1 .
416 .
417 The
418 .B PD
419 and
420 .B DD
421 registers use the larger value if the vertical motion quantum of the
422 output device is too coarse for the smaller one;
423 usually,
424 this is the case only for output to terminals and emulators thereof.
425 .
426 The \[lq]gutter\[rq] affected by
427 .B \[rs]n[MINGW]
428 is the gap between columns in multiple-column page arrangements.
429 .
430 The
431 .B TC\-MARGIN
432 register and
433 .B TC\-LEADER
434 special character affect the formatting of tables of contents assembled
435 by the
436 .BR XS ,
437 .BR XA ,
438 and
439 .B XE
440 macros.
441 .
442 .
443 .\" ====================================================================
444 .SS "Document description macros"
445 .\" ====================================================================
446 .
447 Define information describing the document by calling the macros below
448 in the order shown;
449 .B .DA
450 or
451 .B .ND
452 can be called to set the document date
453 (or other identifier)
454 at any time before (a) the abstract,
455 if present,
456 or (b) its information is required in a header or footer.
457 .
458 Use of these macros is optional,
459 except that
460 .B .TL
461 is mandatory if any of
462 .BR .RP ,
463 .BR .AU ,
464 .BR .AI ,
465 or
466 .B .AB
467 is called,
468 and
469 .B .AE
470 is mandatory if
471 .B .AB
472 is called.
473 .
474 .
475 .TP
476 .BR .RP\~ [ no\-repeat\-info ]\~[ no\-renumber ]
477 Use the \[lq]report\[rq]
478 (AT&T: \[lq]released paper\[rq])
479 format for your document,
480 creating a separate cover page.
481 .
482 The default arrangement is to place most of the document description
483 (title,
484 author names and institutions,
485 and abstract,
486 but not the date)
487 at the top of the first page.
488 .
489 If the optional
490 .B no\-\:\%repeat\-\:\%info
491 argument is given,
492 .I ms
493 produces a cover page but does not repeat any of its information on
494 subsequently
495 (but see the
496 .B DA
497 macro below regarding the date).
498 .
499 Normally,
500 .B .RP
501 sets the page number following the cover page to\~1.
502 .
503 Specifying the optional
504 .B no\-\:\%renumber
505 argument suppresses this alteration.
506 .
507 Optional arguments can occur in any order.
508 .
509 .RB \[lq] no \[rq]
510 is recognized as a synonym of
511 .B no\-\:\%repeat\-\:\%info
512 for AT&T compatibility.
513 .
514 .
515 .TP
516 .B .TL
517 Specify the document title.
518 .
519 .I ms
520 collects text on input lines following this call into the title until
521 reaching
522 .BR .AU ,
523 .BR .AB ,
524 or a heading or paragraphing macro call.
525 .
526 .
527 .TP
528 .B .AU
529 Specify an author's name.
530 .
531 .I ms
532 collects text on input lines following this call into the author's name
533 until reaching
534 .BR .AI ,
535 .BR .AB ,
536 another
537 .BR .AU ,
538 or a heading or paragraphing macro call.
539 .
540 Call it repeatedly to specify multiple authors.
541 .
542 .
543 .TP
544 .B .AI
545 Specify the preceding author's institution.
546 .
547 An
548 .B .AU
549 call is usefully followed by at most one
550 .B .AI
551 call;
552 if there are more,
553 the last
554 .B .AI
555 call controls.
556 .
557 .I ms
558 collects text on input lines following this call into the author's
559 institution until reaching
560 .BR .AU ,
561 .BR .AB ,
562 or a heading or paragraphing macro call.
563 .
564 .
565 .TP
566 .BR .DA \~[\c
567 .IR x \~.\|.\|.]
568 Typeset the current date,
569 or any
570 .RI arguments\~ x ,
571 in the center footer,
572 and,
573 if
574 .B .RP
575 is also called,
576 left-aligned at the end of the document description on the cover page.
577 .
578 .
579 .TP
580 .BR .ND \~[\c
581 .IR x \~.\|.\|.]
582 Typeset the current date,
583 or any
584 .RI arguments\~ x ,
585 if
586 .B .RP
587 is also called,
588 left-aligned at the end of the document description on the cover page.
589 .
590 This is
591 .IR "groff ms" 's
592 default.
593 .
594 .
595 .TP
596 .BR ".AB " [ no ]
597 Begin the abstract.
598 .
599 .I ms
600 collects text on input lines following this call into the abstract until
601 reaching an
602 .B .AE
603 call.
604 .
605 By default,
606 .I ms
607 places the word \[lq]ABSTRACT\[rq] centered and in italics above the
608 text of the abstract.
609 .
610 The optional argument
611 .RB \[lq] no \[rq]
612 suppresses this heading.
613 .
614 .
615 .TP
616 .B .AE
617 End the abstract.
618 .
619 .
620 .\" ====================================================================
621 .SS "Text settings"
622 .\" ====================================================================
623 .
624 The
625 .B FAM
626 string,
627 a GNU extension,
628 sets the font family for body text;
629 the default is
630 .RB \[lq] T \[rq].
631 .
632 The
633 .B PS
634 and
635 .B VS
636 registers set the type size and vertical spacing
637 (distance between text baselines),
638 respectively.
639 .
640 The font family and type size are ignored on terminal devices.
641 .
642 Setting these parameters before the first call of a heading,
643 paragraphing,
644 or (non-date) document description macro also applies them to headers,
645 footers,
646 and
647 (for
648 .BR FAM )
649 footnotes.
650 .
651 .
652 .br
653 .ne 2v
654 .P
655 The
656 .B HY
657 register defines the automatic hyphenation mode used with the
658 .B hy
659 request.
660 .
661 Setting
662 .B \[rs]n[HY]
663 .RB to\~ 0
664 is equivalent to using the
665 .B nh
666 request.
667 .
668 This is a Tenth Edition Research Unix extension.
669 .
670 .
671 .\" ====================================================================
672 .SS "Typographical symbols"
673 .\" ====================================================================
674 .
675 .I ms
676 provides a few strings to obtain typographical symbols not easily
677 entered with the keyboard.
678 .
679 These and many others are available as special character escape
680 sequences\[em]see
681 .MR groff_char 7 .
682 .
683 .
684 .TP
685 .B \[rs]*[\-]
686 Interpolate an em dash.
687 .
688 .
689 .TP
690 .B \[rs]*[Q]
691 .TQ
692 .B \[rs]*[U]
693 Interpolate typographer's quotation marks where available,
694 and neutral double quotes otherwise.
695 .
696 .B \[rs]*[Q]
697 is the left quote and
698 .B \[rs]*[U]
699 the right.
700 .
701 .
702 .\" ====================================================================
703 .SS Paragraphs
704 .\" ====================================================================
705 .
706 Paragraphing macros
707 .IR break ,
708 or terminate,
709 any pending output line so that a new paragraph can begin.
710 .
711 Several paragraph types are available,
712 differing in how indentation
713 applies to them:
714 to left,
715 right,
716 or both margins;
717 to the first output line of the paragraph,
718 all output lines,
719 or all but the first.
720 .
721 All paragraphing macro calls cause the insertion of vertical space in
722 the amount stored in the
723 .B PD
724 register,
725 except at page or column breaks,
726 or adjacent to displays.
727 .
728 .
729 .PP
730 The
731 .B PORPHANS
732 register defines the minimum number of initial lines of any paragraph
733 that must be kept together to avoid isolated lines at the bottom of a
734 page.
735 .
736 If a new paragraph is started close to the bottom of a page,
737 and there is insufficient space to accommodate
738 .B \[rs]n[PORPHANS]
739 lines before an automatic page break,
740 then a page break is forced before the start of the paragraph.
741 .
742 This is a GNU extension.
743 .
744 .
745 .TP
746 .B .LP
747 Set a paragraph without any (additional) indentation.
748 .
749 .
750 .TP
751 .B .PP
752 Set a paragraph with a first-line left indentation in the amount stored
753 in the
754 .B PI
755 register.
756 .
757 .
758 .TP
759 .BR .IP \~[\c
760 .IR marker \~[ width ]]
761 Set a paragraph with a left indentation.
762 .
763 The optional
764 .I marker
765 is not indented and is empty by default.
766 .
767 .I width
768 overrides the indentation amount in
769 .BR \[rs]n[PI] ;
770 its default unit is
771 .RB \[lq] n \[rq].
772 .
773 Once specified,
774 .I width
775 applies to further
776 .B .IP
777 calls until specified again or a heading or different paragraphing macro
778 is called.
779 .
780 .
781 .TP
782 .B .QP
783 Set a paragraph indented from both left and right margins by
784 .BR \[rs]n[QI] .
785 .
786 .
787 .TP
788 .B .QS
789 .TQ
790 .B .QE
791 Begin
792 .RB ( QS )
793 and end
794 .RB ( QE )
795 a region where each paragraph is indented from both margins by
796 .BR \[rs]n[QI] .
797 .
798 The text between
799 .B .QS
800 and
801 .B .QE
802 can be structured further by use of other paragraphing macros.
803 .
804 .
805 .TP
806 .B .XP
807 Set an \[lq]exdented\[rq] paragraph\[em]one with a left indentation of
808 .B \[rs]n[PI]
809 on every line
810 .I except
811 the first
812 (also known as a hanging indent).
813 .
814 This is a Berkeley extension.
815 .
816 .
817 .\" ====================================================================
818 .SS Headings
819 .\" ====================================================================
820 .
821 Use headings to create a hierarchical structure for your document.
822 .
823 The
824 .I ms
825 macros print headings in
826 .B bold
827 using the same font family and,
828 by default,
829 type size as the body text.
830 .
831 Headings are available with and without automatic numbering.
832 .
833 Text on input lines following the macro call becomes the heading's
834 title.
835 .
836 Call a paragraphing macro to end the heading text and start the
837 section's content.
838 .
839 .
840 .TP
841 .BR .NH \~[\c
842 .IR depth ]
843 Set an automatically numbered heading.
844 .
845 .I ms
846 produces a numbered heading in the form
847 .IR a . b . c .\|.\|.,
848 to any level desired,
849 with the numbering of each depth increasing automatically and being
850 reset to zero when a more significant depth is increased.
851 .
852 .RB \[lq] 1 \[rq]\~is
853 the most significant or coarsest division of the document.
854 .
855 Only non-zero values are output.
856 .
857 If
858 .I depth
859 is omitted,
860 it is taken to be
861 .BR 1 .
862 .
863 If you specify
864 .I depth
865 such that an ascending gap occurs relative to the previous
866 .B NH
867 call\[em]that is,
868 you \[lq]skip a depth\[rq],
869 as by
870 .RB \[lq] ".NH\~1" \[rq]
871 and then
872 .RB \[lq] ".NH\~3" \[rq],
873 .I groff ms
874 emits a warning on the standard error stream.
875 .
876 .
877 .TP
878 .BI ".NH S\~" heading-depth-index\~\c
879 \&.\|.\|.
880 Alternatively,
881 you can give
882 .B NH
883 a first argument
884 .RB of\~\[lq] S \[rq],
885 followed by integers to number the heading depths explicitly.
886 .
887 Further automatic numbering,
888 if used,
889 resumes using the specified indices as their predecessors.
890 .
891 .\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...
892 This feature is a Berkeley extension.
893 .
894 .
895 .P
896 After
897 .B .NH
898 is called,
899 the assigned number is made available in the strings
900 .B SN\-DOT
901 (as it appears in a printed heading with default formatting,
902 followed by a terminating period)
903 and
904 .B SN\-NO\-DOT
905 (with the terminating period omitted).
906 .
907 These are GNU extensions.
908 .
909 .
910 .P
911 You can control the style used to print numbered headings by defining an
912 appropriate alias for the string
913 .BR SN\-STYLE .
914 .
915 By default,
916 .B \[rs]*[SN\-STYLE]
917 is aliased to
918 .BR \[rs]*[SN\-DOT] .
919 .
920 If you prefer to omit the terminating period from numbers appearing in
921 numbered headings,
922 you may alias it to
923 .BR \[rs]*[SN\-NO\-DOT] .
924 .
925 Any such change in numbering style becomes effective from the next use
926 of
927 .B .NH
928 following redefinition of the alias for
929 .BR \[rs]*[SN\-STYLE] .
930 .
931 The formatted number of the current heading is available in
932 .B \[rs]*[SN]
933 (a feature first documented by Berkeley);
934 this string facilitates its inclusion in,
935 for example,
936 table captions,
937 equation labels,
938 and
939 .BR .XS / .XA / .XE
940 table of contents entries.
941 .
942 .
943 .TP
944 .BR .SH \~[\c
945 .IR depth ]
946 Set an unnumbered heading.
947 .
948 The optional
949 .I depth
950 argument is a GNU extension indicating the heading depth corresponding
951 to the
952 .I depth
953 argument of
954 .BR .NH .
955 .
956 It matches the type size at which the heading is set to that of a
957 numbered heading at the same depth when the
958 .B \[rs]n[GROWPS]
959 and
960 .B \[rs]n[PSINCR]
961 heading size adjustment mechanism is in effect.
962 .
963 .
964 .P
965 The
966 .B PSINCR
967 register defines an increment in type size to be applied to a heading at
968 a lesser depth than that specified in
969 .BR \[rs]n[GROWPS] .
970 .
971 The value of
972 .B \[rs]n[PSINCR]
973 should be specified in points with the
974 .RB \[lq] p \[rq]
975 scaling unit and may include a fractional component.
976 .
977 .
978 .P
979 The
980 .B GROWPS
981 register defines the heading depth above which the type size increment
982 set by
983 .B \[rs]n[PSINCR]
984 becomes effective.
985 .
986 For each heading depth less than the value of
987 .BR \[rs]n[GROWPS] ,
988 the type size is increased by
989 .BR \[rs]n[PSINCR] .
990 .
991 Setting
992 .B \[rs]n[GROWPS]
993 to a value less than\~2 disables the incremental heading size feature.
994 .
995 .
996 .P
997 In other words,
998 if the value of
999 .B GROWPS
1000 register is greater than the
1001 .I depth
1002 argument to a
1003 .B .NH
1004 or
1005 .B .SH
1006 call,
1007 the type size of a heading produced by these macros increases by
1008 .B \[rs]n[PSINCR]
1009 units over
1010 .B \[rs]n[PS]
1011 multiplied by the difference of
1012 .B \[rs]n[GROWPS]
1013 and
1014 .IR depth .
1015 .
1016 .
1017 .P
1018 The
1019 .B \[rs]n[HORPHANS]
1020 register operates in conjunction with the
1021 .B NH
1022 and
1023 .B SH
1024 macros to inhibit the printing of isolated headings at the bottom of a
1025 page;
1026 it specifies the minimum number of lines of the subsequent paragraph
1027 that must be kept on the same page as the heading.
1028 .
1029 If insufficient space remains on the current page to accommodate the
1030 heading and this number of lines of paragraph text,
1031 a page break is forced before the heading is printed.
1032 .
1033 Any display macro call or
1034 .IR tbl ,
1035 .IR pic ,
1036 or
1037 .I eqn
1038 region between the heading and the subsequent paragraph suppresses this
1039 grouping.
1040 .
1041 .
1042 .\" ====================================================================
1043 .SS "Typeface and decoration"
1044 .\" ====================================================================
1045 .
1046 .
1047 .P
1048 The
1049 .I ms
1050 macros provide a variety of ways to style text.
1051 .
1052 Attend closely to the ordering of arguments labeled
1053 .I pre
1054 and
1055 .I post,
1056 which is not intuitive.
1057 .
1058 Support for
1059 .I pre
1060 arguments is a GNU extension.
1061 .
1062 .
1063 .TP
1064 .BR .B \~[\c
1065 .IR text \~[ post \~[ pre ]]]
1066 Style
1067 .I text
1068 in bold,
1069 followed by
1070 .I post
1071 in the previous font style without intervening space,
1072 and preceded by
1073 .I pre
1074 similarly.
1075 .
1076 Without arguments,
1077 .I ms
1078 styles subsequent text in bold
1079 until the next
1080 paragraphing,
1081 heading,
1082 or no-argument typeface macro call.
1083 .
1084 .
1085 .TP
1086 .BR .R \~[\c
1087 .IR text \~[ post \~[ pre ]]]
1088 As
1089 .BR .B ,
1090 but use the roman style
1091 (upright text of normal weight)
1092 instead of bold.
1093 .
1094 Argument recognition is a GNU extension.
1095 .
1096 .
1097 .TP
1098 .BR .I \~[\c
1099 .IR text \~[ post \~[ pre ]]]
1100 As
1101 .BR .B ,
1102 but use an italic or oblique style instead of bold.
1103 .
1104 .
1105 .TP
1106 .BR .BI \~[\c
1107 .IR text \~[ post \~[ pre ]]]
1108 As
1109 .BR .B ,
1110 but use a bold italic or bold oblique style instead of upright bold.
1111 .
1112 This is a Tenth Edition Research Unix extension.
1113 .\" possibly 9th, but definitely not Berkeley
1114 .
1115 .
1116 .TP
1117 .BR .CW \~[\c
1118 .IR text \~[ post \~[ pre ]]]
1119 As
1120 .BR .B ,
1121 but use a constant-width (monospaced) roman typeface instead of bold.
1122 .
1123 This is a Tenth Edition Research Unix extension.
1124 .\" possibly 9th, but definitely not Berkeley
1125 .
1126 .
1127 .TP
1128 .BR .BX \~[\c
1129 .IR text ]
1130 Typeset
1131 .I text
1132 and draw a box around it.
1133 .
1134 On terminal devices,
1135 reverse video is used instead.
1136 .
1137 If you want
1138 .I text
1139 to contain space,
1140 use unbreakable space or horizontal motion escape sequences
1141 .RB ( \[rs]\[ti] ,
1142 .BI \[rs] space\c
1143 ,
1144 .BR \[rs]\[ha] ,
1145 .BR \[rs]| ,
1146 .BR \[rs]0 ,
1147 or
1148 .BR \[rs]h ).
1149 .
1150 .
1151 .TP
1152 .BR .UL \~[\c
1153 .IR text \~[ post ]]
1154 Typeset
1155 .I text
1156 with an underline.
1157 .
1158 .I post,
1159 if present,
1160 is set after
1161 .I text
1162 with no intervening space.
1163 .
1164 .
1165 .TP
1166 .B .LG
1167 Set subsequent text in larger type
1168 (2\~points larger than the current size)
1169 until the next
1170 type size,
1171 paragraphing,
1172 or heading macro call.
1173 .
1174 You can specify this macro multiple times to enlarge the type size as
1175 needed.
1176 .
1177 .
1178 .TP
1179 .B .SM
1180 Set subsequent text in smaller type
1181 (2\~points smaller than the current size)
1182 until the next
1183 type size,
1184 paragraphing,
1185 or heading macro call.
1186 .
1187 You can specify this macro multiple times to reduce the type size as
1188 needed.
1189 .
1190 .
1191 .TP
1192 .B .NL
1193 Set subsequent text at the normal type size
1194 .RB ( \[rs]n[PS] ).
1195 .
1196 .
1197 .P
1198 When
1199 .I pre
1200 is used,
1201 a hyphenation control escape sequence
1202 .B \[rs]%
1203 that would ordinarily start
1204 .I text
1205 must start
1206 .I pre
1207 instead.
1208 .
1209 .
1210 .P
1211 .I groff ms
1212 also offers strings to begin and end super- and subscripting.
1213 .
1214 These are GNU extensions.
1215 .
1216 .
1217 .TP
1218 .B \[rs]*{
1219 .TQ
1220 .B \[rs]*}
1221 Begin and end superscripting,
1222 respectively.
1223 .
1224 .
1225 .TP
1226 .B \[rs]*<
1227 .TQ
1228 .B \[rs]*>
1229 Begin and end subscripting,
1230 respectively.
1231 .
1232 .
1233 .\" ====================================================================
1234 .SS "Indented regions"
1235 .\" ====================================================================
1236 .
1237 You may need to indent a region of text while otherwise formatting it
1238 normally.
1239 .
1240 Indented regions can be nested.
1241 .
1242 .
1243 .TP
1244 .B .RS
1245 Begin a region where headings,
1246 paragraphs,
1247 and displays are indented (further) by
1248 .BR \[rs]n[PI] .
1249 .
1250 .
1251 .TP
1252 .B .RE
1253 End the (next) most recent indented region.
1254 .
1255 .
1256 .\" ====================================================================
1257 .SS "Keeps, boxed keeps, and displays"
1258 .\" ====================================================================
1259 .
1260 On occasion,
1261 you may want to
1262 .I keep
1263 several lines of text,
1264 or a region of a document,
1265 together on a single page,
1266 preventing an automatic page break within certain boundaries.
1267 .
1268 This can cause a page break to occur earlier than it normally would.
1269 .
1270 .
1271 .P
1272 You can alternatively specify a
1273 .I floating keep:
1274 if a keep cannot fit on the current page,
1275 .I ms
1276 holds its contents and allows text following the keep
1277 (in the source document)
1278 to fill in the remainder of the current page.
1279 .
1280 When the page breaks,
1281 whether by reaching the end or
1282 .B bp
1283 request,
1284 .I ms
1285 puts the floating keep at the beginning of the next page.
1286 .
1287 .
1288 .TP
1289 .B .KS
1290 Begin a keep.
1291 .
1292 .
1293 .TP
1294 .B .KF
1295 Begin a floating keep.
1296 .
1297 .
1298 .TP
1299 .B .KE
1300 End (floating) keep.
1301 .
1302 .
1303 .P
1304 As an alternative to the keep mechanism,
1305 the
1306 .B ne
1307 request forces a page break if there is not at least the amount of
1308 vertical space specified in its argument remaining on the page.
1309 .
1310 .
1311 .PP
1312 A
1313 .I boxed keep
1314 has a frame drawn around it.
1315 .
1316 .
1317 .TP
1318 .B .B1
1319 Begin a keep with a box drawn around it.
1320 .
1321 .
1322 .TP
1323 .B .B2
1324 End boxed keep.
1325 .
1326 .
1327 .P
1328 Boxed keep macros cause breaks;
1329 if you need to box a word or phrase within a line,
1330 see the
1331 .B BX
1332 macro in section \[lq]Highlighting\[rq] above.
1333 .
1334 Box lines are drawn as close as possible to the text they enclose so
1335 that they are usable within paragraphs.
1336 .
1337 If you wish to place one or more paragraphs in a boxed keep,
1338 you may improve their appearance by calling
1339 .B .B1
1340 after the first paragraphing macro,
1341 and by adding a small amount of vertical space before calling
1342 .BR .B2 .
1343 .
1344 .
1345 .br
1346 .ne 2v
1347 .P
1348 If you want a boxed keep to float,
1349 you will need to enclose the
1350 .B .B1
1351 and
1352 .B .B2
1353 calls within a pair of
1354 .B .KF
1355 and
1356 .B .KE
1357 calls.
1358 .
1359 .
1360 .P
1361 .I Displays
1362 turn off filling;
1363 lines of verse or program code are shown with their lines broken as in
1364 the source document without requiring
1365 .B br
1366 requests between lines.
1367 .
1368 Displays can be kept on a single page or allowed to break across pages.
1369 .
1370 The
1371 .B DS
1372 macro begins a kept display of the layout specified in its first
1373 argument;
1374 non-kept displays are begun with dedicated macros corresponding to their
1375 layout.
1376 .
1377 .
1378 .TP
1379 .B .DS L
1380 .TQ
1381 .B .LD
1382 Begin
1383 .RB ( DS ": kept)"
1384 left-aligned display.
1385 .
1386 .
1387 .TP
1388 .BR .DS \~\c
1389 .RB [ I \~\c
1390 .RI [ indent ]]
1391 .TQ
1392 .BR .ID \~\c
1393 .RI [ indent ]
1394 Begin
1395 .RB ( DS ": kept)"
1396 display indented by
1397 .I indent
1398 if specified,
1399 .B \[rs]n[DI]
1400 otherwise.
1401 .
1402 .
1403 .TP
1404 .B .DS B
1405 .TQ
1406 .B .BD
1407 Begin
1408 .RB ( DS ": kept)"
1409 block display:
1410 the entire display is left-aligned,
1411 but indented such that the longest line in the display is centered on
1412 the page.
1413 .
1414 .
1415 .TP
1416 .B .DS C
1417 .TQ
1418 .B .CD
1419 Begin
1420 .RB ( DS ": kept)"
1421 centered display:
1422 each line in the display is centered.
1423 .
1424 .
1425 .TP
1426 .B .DS R
1427 .TQ
1428 .B .RD
1429 Begin
1430 .RB ( DS ": kept)"
1431 right-aligned display.
1432 .
1433 This is a GNU extension.
1434 .
1435 .
1436 .TP
1437 .B .DE
1438 End any display.
1439 .
1440 .
1441 .P
1442 The distance stored in
1443 .B \[rs]n[DD]
1444 is inserted before and after each pair of display macros;
1445 this is a Berkeley extension.
1446 .
1447 In
1448 .IR "groff ms" ,
1449 this distance replaces any adjacent inter-paragraph distance
1450 or subsequent spacing prior to a section heading.
1451 .
1452 The
1453 .B DI
1454 register is a GNU extension;
1455 its value is an indentation applied to displays created with
1456 .B .DS
1457 and
1458 .B .ID
1459 without arguments,
1460 to
1461 .RB \[lq] .DS\~I \[rq]
1462 without an indentation argument,
1463 and to equations set with
1464 .RB \[lq] .EQ\~I \[rq].
1465 .
1466 Changes to either register take effect at the next display boundary.
1467 .
1468 .
1469 .\" ====================================================================
1470 .SS "Tables, figures, equations, and references"
1471 .\" ====================================================================
1472 .
1473 The
1474 .I ms
1475 package is often used with the
1476 .IR \%tbl ,
1477 .IR \%pic ,
1478 .IR \%eqn ,
1479 and
1480 .I \%refer
1481 preprocessors.
1482 .
1483 The
1484 .B \[rs]n[DD]
1485 distance is also applied to regions of the document preprocessed with
1486 .IR \%eqn ,
1487 .IR \%pic ,
1488 and
1489 .IR \%tbl .
1490 .
1491 Mark text meant for preprocessors by enclosing it in pairs of tokens as
1492 follows,
1493 with nothing between the dot and the macro name.
1494 .
1495 The preprocessors match these tokens only at the start of an input line.
1496 .
1497 .
1498 .TP
1499 .BR .TS " [" H "]
1500 .TQ
1501 .B .TE
1502 Demarcate a table to be processed by the
1503 .I tbl
1504 preprocessor.
1505 .
1506 The optional
1507 .BR H "\~argument"
1508 instructs
1509 .I ms
1510 to repeat table rows
1511 (often column headings)
1512 at the top of each new page the table spans,
1513 if applicable;
1514 calling the
1515 .B TH
1516 macro marks the end of such rows.
1517 .
1518 .MR \%tbl 1
1519 provides a comprehensive reference to the preprocessor and offers
1520 examples of its use.
1521 .
1522 .
1523 .TP
1524 .B .PS
1525 .TQ
1526 .B .PE
1527 .TQ
1528 .B .PF
1529 .B .PS
1530 begins a picture to be processed by the
1531 .I pic
1532 preprocessor;
1533 either of
1534 .B .PE
1535 or
1536 .B .PF
1537 ends it,
1538 the latter with \[lq]flyback\[rq] to the vertical position at its top.
1539 .
1540 .
1541 .TP
1542 .BR .EQ \~[\c
1543 .IR align \~[\c]
1544 .IR label ]]
1545 .TQ
1546 .B .EN
1547 Demarcate an equation to be processed by the
1548 .I eqn
1549 preprocessor.
1550 .
1551 The equation is centered by default;
1552 .I align
1553 can be
1554 .BR C ,
1555 .BR L ,
1556 .RB or\~ I
1557 to (explicitly) center,
1558 left-align,
1559 or indent it by
1560 .BR \[rs]n[DI] ,
1561 respectively.
1562 .
1563 If specified,
1564 .I label
1565 is set right-aligned.
1566 .
1567 .
1568 .TP
1569 .B .[
1570 .TQ
1571 .B .]
1572 Demarcate a bibliographic citation to be processed by the
1573 .I refer
1574 preprocessor.
1575 .
1576 .MR \%refer 1
1577 provides a comprehensive reference to the preprocessor and the format of
1578 its bibliographic database.
1579 .
1580 .
1581 .P
1582 When
1583 .I \%refer
1584 emits collected references
1585 (as might be done on a \[lq]Works Cited\[rq] page),
1586 it interpolates the string
1587 .B \[rs]*[REFERENCES]
1588 as an unnumbered heading
1589 .RB ( .SH ).
1590 .
1591 .
1592 .br
1593 .ne 2v
1594 .P
1595 Attempting to place a multi-page table inside a keep can lead to
1596 unpleasant results,
1597 particularly if the
1598 .I tbl \" generic
1599 .RB \[lq] allbox \[rq]
1600 option is used.
1601 .
1602 .
1603 .\" ====================================================================
1604 .SS Footnotes
1605 .\" ====================================================================
1606 .
1607 A footnote is typically anchored to a place in the text with a
1608 .I marker,
1609 which is a small integer,
1610 a symbol,
1611 or arbitrary user-specified text.
1612 .
1613 .
1614 .TP
1615 .B \[rs]**
1616 Place an
1617 .I automatic number,
1618 an automatically generated numeric footnote marker,
1619 in the text.
1620 .
1621 Each time this string is interpolated,
1622 the number it produces increments by one.
1623 .
1624 Automatic numbers start at 1.
1625 .
1626 This is a Berkeley extension.
1627 .
1628 .
1629 .P
1630 Enclose the footnote text in
1631 .B FS
1632 and
1633 .B FE
1634 macro calls to set it at the nearest available \[lq]foot\[rq],
1635 or bottom,
1636 of a text column or page.
1637 .
1638 .
1639 .TP
1640 .BR .FS \~[\c
1641 .IR marker ]
1642 Begin a footnote.
1643 .
1644 The
1645 .B .FS\-MARK
1646 hook
1647 (see below)
1648 is called with any supplied
1649 .I marker
1650 argument,
1651 which is then also placed at the beginning of the footnote text.
1652 .
1653 If
1654 .I marker
1655 is omitted,
1656 the next pending automatic number enqueued by interpolation of the
1657 .B *
1658 string is used,
1659 and if none exists,
1660 nothing is prefixed.
1661 .
1662 .
1663 .TP
1664 .B .FE
1665 End footnote text.
1666 .
1667 .
1668 .P
1669 .I groff ms
1670 provides a hook macro,
1671 .BR FS\-MARK ,
1672 for user-determined operations to be performed when the
1673 .B FS
1674 macro is called.
1675 .
1676 It is passed the same arguments as
1677 .B .FS
1678 itself.
1679 .
1680 By default,
1681 this macro has an empty definition.
1682 .
1683 .B .FS\-MARK
1684 is a GNU extension.
1685 .
1686 .
1687 .P
1688 Footnote text is formatted as paragraphs are,
1689 using analogous parameters.
1690 .
1691 The registers
1692 .BR FI ,
1693 .BR FPD ,
1694 .BR FPS ,
1695 and
1696 .B FVS
1697 correspond to
1698 .BR PI ,
1699 .BR PD ,
1700 .BR PS ,
1701 and
1702 .BR VS ,
1703 respectively;
1704 .BR FPD ,
1705 .BR FPS ,
1706 and
1707 .B FVS
1708 are GNU extensions.
1709 .
1710 .
1711 .P
1712 The
1713 .B FF
1714 register controls the formatting of automatically numbered footnote
1715 paragraphs,
1716 and those for which
1717 .B .FS
1718 is given a
1719 .I marker
1720 argument,
1721 at the bottom of a column or page as follows.
1722 .
1723 .
1724 .RS
1725 .TP
1726 0
1727 Set an automatic number,
1728 or a specified
1729 .B FS
1730 .I marker
1731 argument,
1732 as a superscript
1733 (on typesetter devices)
1734 or surrounded by square brackets
1735 (on terminals).
1736 .
1737 The footnote paragraph is indented as with
1738 .B .PP
1739 if there is an
1740 .B .FS
1741 argument or an automatic number,
1742 and as with
1743 .B .LP
1744 otherwise.
1745 .
1746 This is the default.
1747 .
1748 .
1749 .TP
1750 1
1751 As
1752 .BR 0 ,
1753 but set the marker as regular text,
1754 and follow an automatic number with a period.
1755 .
1756 .
1757 .TP
1758 2
1759 As
1760 .BR 1 ,
1761 but without indentation
1762 (like
1763 .BR .LP ).
1764 .
1765 .
1766 .TP
1767 3
1768 As
1769 .BR 1 ,
1770 but set the footnote paragraph with the marker hanging
1771 (like
1772 .BR .IP ).
1773 .RE
1774 .
1775 .
1776 .\" ====================================================================
1777 .SS "Language and localization"
1778 .\" ====================================================================
1779 .
1780 .I groff ms
1781 provides several strings that you can customize for your own purposes,
1782 or redefine to adapt the macro package to languages other than English.
1783 .
1784 It is already localized for
1785 .\" cs, de, fr, it, sv
1786 Czech,
1787 German,
1788 French,
1789 Italian,
1790 and
1791 Swedish.
1792 .
1793 Load the desired localization macro package after
1794 .IR ms ;
1795 see
1796 .MR groff_tmac 5 .
1797 .
1798 .
1799 .P
1800 .RS
1801 .TS
1802 cb cb
1803 lf(CR) lf(CR).
1804 String Default
1805 _
1806 \[rs]*[REFERENCES] References
1807 \[rs]*[ABSTRACT] \[rs]f[I]ABSTRACT\[rs]f[]
1808 \[rs]*[TOC] Table of Contents
1809 \[rs]*[MONTH1] January
1810 \[rs]*[MONTH2] February
1811 \[rs]*[MONTH3] March
1812 \[rs]*[MONTH4] April
1813 \[rs]*[MONTH5] May
1814 \[rs]*[MONTH6] June
1815 \[rs]*[MONTH7] July
1816 \[rs]*[MONTH8] August
1817 \[rs]*[MONTH9] September
1818 \[rs]*[MONTH10] October
1819 \[rs]*[MONTH11] November
1820 \[rs]*[MONTH12] December
1821 _
1822 .TE
1823 .RE
1824 .
1825 The default for
1826 .B ABSTRACT
1827 includes font selection escape sequences to set the word in italics.
1828 .
1829 .
1830 .\" ====================================================================
1831 .SS "Headers and footers"
1832 .\" ====================================================================
1833 .
1834 There are multiple ways to produce headers and footers.
1835 .
1836 One is to define the strings
1837 .BR LH ,
1838 .BR CH ,
1839 and
1840 .B RH
1841 to set the left,
1842 center,
1843 and right headers,
1844 respectively;
1845 and
1846 .BR LF ,
1847 .BR CF ,
1848 and
1849 .B RF
1850 to set the left,
1851 center,
1852 and right footers.
1853 .
1854 This approach suffices for documents that do not distinguish odd- and
1855 even-numbered pages.
1856 .
1857 .
1858 .P
1859 Another method is to call macros that set headers or footers for odd- or
1860 even-numbered pages.
1861 .
1862 Each such macro takes a delimited argument separating the left,
1863 center,
1864 and right header or footer texts from each other.
1865 .
1866 You can replace the neutral apostrophes (\[aq]) shown below with any
1867 character not appearing in the header or footer text.
1868 .
1869 These macros are Berkeley extensions.
1870 .
1871 .
1872 .br
1873 .ne 5v
1874 .TP
1875 .BR .OH \~\[aq]\c
1876 .IR left \[aq] center \[aq] right \[aq]
1877 .TQ
1878 .BR .OF \~\[aq]\c
1879 .IR left \[aq] center \[aq] right \[aq]
1880 .TQ
1881 .BR .EH \~\[aq]\c
1882 .IR left \[aq] center \[aq] right \[aq]
1883 .TQ
1884 .BR .EF \~\[aq]\c
1885 .IR left \[aq] center \[aq] right \[aq]
1886 The
1887 .B OH
1888 and
1889 .B EH
1890 macros define headers for odd- (recto) and even-numbered (verso) pages,
1891 respectively;
1892 the
1893 .B OF
1894 and
1895 .B EF
1896 macros define footers for them.
1897 .
1898 .
1899 .P
1900 With either method,
1901 a percent sign
1902 .B %
1903 in header or footer text is replaced by the current page number.
1904 .
1905 By default,
1906 .I ms
1907 places no header on a page numbered \[lq]1\[rq]
1908 (regardless of its number format).
1909 .
1910 .
1911 .TP
1912 .B .P1
1913 Typeset the header even on page\~1.
1914 .
1915 To be effective,
1916 this macro must be called before the header trap is sprung on any page
1917 numbered \[lq]1\[rq].
1918 .
1919 This is a Berkeley extension.
1920 .
1921 .
1922 .P
1923 For even greater flexibility,
1924 .I ms
1925 permits redefinition of the macros called when the page header and
1926 footer traps are sprung.
1927 .
1928 .B PT
1929 (\[lq]page trap\[rq])
1930 is called by
1931 .I ms
1932 when the header is to be written,
1933 and
1934 .B BT
1935 (\[lq]bottom trap\[rq])
1936 when the footer is to be.
1937 .
1938 The
1939 .I groff
1940 page location trap that
1941 .I ms
1942 sets up to format the header also calls the
1943 (normally undefined)
1944 .B HD
1945 macro after
1946 .BR .PT ;
1947 you can define
1948 .B .HD
1949 if you need additional processing after setting the header.
1950 .
1951 .\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...
1952 The
1953 .B HD
1954 hook is a Berkeley extension.
1955 .
1956 Any such macros you (re)define must implement any desired specialization
1957 for odd-,
1958 even-,
1959 or first numbered pages.
1960 .
1961 .
1962 .\" ====================================================================
1963 .SS "Tab stops"
1964 .\" ====================================================================
1965 .
1966 Use the
1967 .B ta
1968 request to set tab stops as needed.
1969 .
1970 .
1971 .TP
1972 .B .TA
1973 Reset the tab stops to the
1974 .I ms
1975 default
1976 (every 5 ens).
1977 .
1978 Redefine this macro to create a different set of default tab stops.
1979 .
1980 .
1981 .\" ====================================================================
1982 .SS Margins
1983 .\" ====================================================================
1984 .
1985 Control margins using the registers summarized in the \[lq]Margins\[rq]
1986 portion of the table in section \[lq]Document control settings\[rq]
1987 above.
1988 .
1989 There is no setting for the right margin;
1990 the combination of page offset
1991 .B \[rs]n[PO]
1992 and line length
1993 .B \[rs]n[LL]
1994 determines it.
1995 .
1996 .
1997 .\" ====================================================================
1998 .SS "Multiple columns"
1999 .\" ====================================================================
2000 .
2001 .I ms
2002 can set text in as many columns as reasonably fit on the page.
2003 .
2004 The following macros force a page break if a multi-column layout is
2005 active when they are called.
2006 .
2007 .B \[rs]n[MINGW]
2008 is the default minimum gutter width;
2009 it is a GNU extension.
2010 .
2011 When multiple columns are in use,
2012 keeps
2013 and the
2014 .B \%HORPHANS
2015 and
2016 .B \%PORPHANS
2017 registers
2018 work with respect to column breaks instead of page breaks.
2019 .
2020 .
2021 .TP
2022 .B .1C
2023 Arrange page text in a single column
2024 (the default).
2025 .
2026 .
2027 .TP
2028 .B .2C
2029 Arrange page text in two columns.
2030 .
2031 .
2032 .TP
2033 .BR .MC \~[\c
2034 .IR column-width " [" gutter-width ]]
2035 Arrange page text in multiple columns.
2036 .
2037 If you specify no arguments,
2038 it is equivalent to the
2039 .B 2C
2040 macro.
2041 .
2042 Otherwise,
2043 .I column-width
2044 is the width of each column and
2045 .I gutter-width
2046 is the minimum distance between columns.
2047 .
2048 .
2049 .\" ====================================================================
2050 .SS "Creating a table of contents"
2051 .\" ====================================================================
2052 .
2053 Define an entry to appear in the table of contents by bracketing its
2054 text between calls to the
2055 .B XS
2056 and
2057 .B XE
2058 macros.
2059 .
2060 A typical application is to call them immediately after
2061 .B NH
2062 or
2063 .B SH
2064 and repeat the heading text within them.
2065 .
2066 The
2067 .B XA
2068 macro,
2069 used within
2070 .BR .XS / .XE
2071 pairs,
2072 supplements an entry\[em]for instance,
2073 when it requires multiple output lines,
2074 whether because a heading is too long to fit or because style dictates
2075 that page numbers not be repeated.
2076 .
2077 You may wish to indent the text thus wrapped to correspond to its
2078 heading depth;
2079 this can be done in the entry text by prefixing it with tabs or
2080 horizontal motion escape sequences,
2081 or by providing a second argument to the
2082 .B XA
2083 macro.
2084 .
2085 .B .XS
2086 and
2087 .B .XA
2088 automatically associate the page number where they are called with the
2089 text following them,
2090 but they accept arguments to override this behavior.
2091 .
2092 At the end of the document,
2093 call
2094 .B TC
2095 or
2096 .B PX
2097 to emit the table of contents;
2098 .B .TC
2099 resets the page number
2100 .RB to\~ i
2101 (Roman numeral one),
2102 and then calls
2103 .BR PX .
2104 .
2105 All of these macros are Berkeley extensions.
2106 .
2107 .
2108 .TP
2109 .BR .XS \~[\c
2110 .IR page-number ]
2111 .TQ
2112 .BR .XA \~[\c
2113 .IR page-number \~[ indentation ]]
2114 .TQ
2115 .B .XE
2116 Begin,
2117 supplement,
2118 and end a table of contents entry.
2119 .
2120 Each entry is associated with
2121 .I page-number
2122 (otherwise the current page number);
2123 a
2124 .I page-number
2125 of
2126 .RB \[lq] no \[rq]
2127 prevents a leader and page number from being emitted for that entry.
2128 .
2129 Use of
2130 .B .XA
2131 within
2132 .BR .XS / .XE
2133 is optional;
2134 it can be repeated.
2135 .
2136 If
2137 .I indentation
2138 is present,
2139 a supplemental entry is indented by that amount;
2140 ens are assumed if no unit is indicated.
2141 .
2142 Text on input lines between
2143 .B .XS
2144 and
2145 .B .XE
2146 is stored for later recall by
2147 .BR .PX .
2148 .
2149 .
2150 .TP
2151 .BR .PX \~[ no ]
2152 Switch to single-column layout.
2153 .
2154 Unless
2155 .RB \[lq] no \[rq]
2156 is specified,
2157 center and interpolate
2158 .B \[rs]*[TOC]
2159 in bold and two points larger than the body text.
2160 .
2161 Emit the table of contents entries.
2162 .
2163 .
2164 .TP
2165 .BR .TC \~[ no ]
2166 Set the page number to\~1,
2167 the page number format to lowercase Roman numerals,
2168 and call
2169 .B PX
2170 (with a
2171 .RB \[lq] no \[rq]
2172 argument,
2173 if present).
2174 .
2175 .
2176 .P
2177 The remaining features in this subsection are GNU extensions.
2178 .
2179 .I groff ms
2180 obviates the need to repeat heading text after
2181 .B .XS
2182 calls.
2183 .
2184 Call
2185 .B .XN
2186 and
2187 .B .XH
2188 after
2189 .B .NH
2190 and
2191 .BR .SH ,
2192 respectively.
2193 .
2194 Text to be appended to the formatted section heading,
2195 but not to appear in the table of contents entry,
2196 can follow these calls.
2197 .
2198 .
2199 .TP
2200 .BI .XN\~ heading-text
2201 Format
2202 .I heading-text
2203 and create a corresponding table of contents entry;
2204 the indentation is computed from the
2205 .I depth
2206 argument of the preceding
2207 .B NH
2208 call.
2209 .
2210 .
2211 .TP
2212 .BI .XH\~ "depth heading-text"
2213 As
2214 .BR .XN ,
2215 but use
2216 .I depth
2217 to determine the indentation.
2218 .
2219 .
2220 .P
2221 .I groff ms
2222 encourages customization of table of contents entry production.
2223 .
2224 (Re-)define any of the following macros as desired.
2225 .
2226 .
2227 .TP
2228 .BI \%.XN\-REPLACEMENT\~ heading-text
2229 .TQ
2230 .BI \%.XH\-REPLACEMENT\~ "depth heading-text"
2231 These hook macros implement
2232 .B .XN
2233 and
2234 .BR .XH ,
2235 and call
2236 .B \%XN\-INIT
2237 and
2238 .BR \%XH\-INIT ,
2239 respectively,
2240 then call
2241 .B \%XH\-UPDATE\-TOC
2242 with the arguments given them.
2243 .
2244 .
2245 .TP
2246 .B \%.XH\-INIT
2247 .TQ
2248 .B \%.XN\-INIT
2249 These hook macros do nothing by default.
2250 .
2251 .
2252 .TP
2253 .BI \%.XH\-UPDATE\-TOC\~ "depth heading-text"
2254 Bracket
2255 .I heading-text
2256 with
2257 .B XS
2258 and
2259 .B XE
2260 calls,
2261 indenting it by 2 ens per level of
2262 .I depth
2263 beyond the first.
2264 .
2265 .
2266 .P
2267 You can customize the style of the leader that bridges each table of
2268 contents entry with its page number;
2269 define the
2270 .B TC\-LEADER
2271 special character by using the
2272 .B char
2273 request.
2274 .
2275 A typical leader combines the dot glyph
2276 .RB \[lq] .\& \[rq]
2277 with a horizontal motion escape sequence to spread the dots.
2278 .
2279 The width of the page number field is stored in the
2280 .B TC\-MARGIN
2281 register.
2282 .
2283 .
2284 .\" ====================================================================
2285 .SH "Differences from AT&T \f[I]ms\f[]"
2286 .\" ====================================================================
2287 .
2288 The
2289 .I groff ms
2290 macros are an independent reimplementation,
2291 using no AT&T code.
2292 .
2293 Since they take advantage of the extended features of
2294 .IR groff ,
2295 they cannot be used with AT&T
2296 .IR troff .
2297 .
2298 .I groff ms
2299 supports features described above as Berkeley and Tenth Edition Research
2300 Unix extensions,
2301 and adds several of its own.
2302 .
2303 .
2304 .IP \[bu] 3n
2305 The internals of
2306 .I groff ms
2307 differ from the internals of AT&T
2308 .IR ms .
2309 .
2310 Documents that depend upon implementation details of AT&T
2311 .I ms
2312 may not format properly with
2313 .IR "groff ms" .
2314 .
2315 Such details include macros whose function was not documented in the
2316 AT&T
2317 .I ms
2318 manual
2319 (\[lq]Typing Documents on the UNIX System: Using the \-ms Macros with
2320 Troff and Nroff\[rq],
2321 M.\& E.\& Lesk,
2322 Bell Laboratories,
2323 1978).
2324 .\" TODO: Use refer(1)?
2325 .\" XXX: We support RT anyway; maybe we should stop?
2326 .
2327 .
2328 .IP \[bu]
2329 The error-handling policy of
2330 .I groff ms
2331 is to detect and report errors,
2332 rather than to ignore them silently.
2333 .
2334 .
2335 .IP \[bu]
2336 Tenth Edition \" possibly 9th
2337 Research Unix supported
2338 .BR P1 / P2
2339 macros to bracket code examples;
2340 .I groff ms
2341 does not.
2342 .
2343 .
2344 .IP \[bu]
2345 .I groff ms
2346 does not work in GNU
2347 .IR troff 's \" GNU
2348 AT&T compatibility mode.
2349 .
2350 If loaded when that mode is enabled,
2351 it aborts processing with a diagnostic message.
2352 .
2353 .
2354 .IP \[bu]
2355 Multiple line spacing is not supported.
2356 .
2357 Use a larger vertical spacing instead.
2358 .
2359 .
2360 .IP \[bu]
2361 .I groff ms
2362 uses the same header and footer defaults in both
2363 .I nroff
2364 and
2365 .I troff
2366 modes
2367 as AT&T
2368 .I ms
2369 does in
2370 .I troff
2371 mode;
2372 AT&T's default in
2373 .I nroff
2374 mode is to put the date,
2375 in U.S.\& traditional format
2376 (e.g.,
2377 \[lq]January 1, 2021\[rq]),
2378 in the center footer
2379 (the
2380 .B CF
2381 string).
2382 .
2383 .
2384 .IP \[bu]
2385 Many
2386 .I groff ms
2387 macros,
2388 including those for paragraphs,
2389 headings,
2390 and displays,
2391 cause a reset of paragraph rendering parameters,
2392 and may change the indentation;
2393 they do so not by incrementing or decrementing it,
2394 but by setting it absolutely.
2395 .
2396 This can cause problems for documents that define additional macros of
2397 their own that try to manipulate indentation.
2398 .
2399 Use
2400 .B .RS
2401 and
2402 .B .RE
2403 instead of the
2404 .B in
2405 request.
2406 .
2407 .
2408 .IP \[bu]
2409 AT&T
2410 .I ms
2411 interpreted the values of the registers
2412 .B PS
2413 and
2414 .B VS
2415 in points,
2416 and did not support the use of scaling units with them.
2417 .
2418 .I groff ms
2419 interprets values of the registers
2420 .BR PS ,
2421 .BR VS ,
2422 .BR FPS ,
2423 and
2424 .BR FVS ,
2425 equal to or larger than\~1,000
2426 (one thousand)
2427 as decimal fractions multiplied by\~1,000.
2428 .
2429 (Register values are converted to and stored as basic
2430 units.
2431 .
2432 See \[lq]Measurements\[rq] in the
2433 .I groff
2434 Texinfo manual or in
2435 .MR groff 7 ).
2436 .
2437 This threshold makes use of a scaling unit with these parameters
2438 practical for high-resolution devices while preserving backward
2439 compatibility.
2440 .
2441 It also permits expression of non-integral type sizes.
2442 .
2443 For example,
2444 .RB \[lq] "groff \-rPS=10.5p" \[rq]
2445 at the shell prompt is equivalent to placing
2446 .RB \[lq] ".nr PS 10.5p" \[rq]
2447 at the beginning of the document.
2448 .
2449 .
2450 .IP \[bu]
2451 AT&T
2452 .IR ms 's
2453 .B AU
2454 macro supported arguments used with some document types;
2455 .I groff ms
2456 does not.
2457 .
2458 .
2459 .IP \[bu]
2460 Right-aligned displays are available.
2461 .
2462 The AT&T
2463 .I ms
2464 manual observes that \[lq]it is tempting to assume that
2465 .RB \[lq] ".DS R" \[rq]
2466 will right adjust lines,
2467 but it doesn't work\[rq].
2468 .
2469 In
2470 .IR "groff ms" ,
2471 it does.
2472 .
2473 .
2474 .IP \[bu]
2475 To make
2476 .I groff ms
2477 use the default page offset
2478 (which also specifies the left margin),
2479 the
2480 .B PO
2481 register must stay undefined until the first
2482 .I ms
2483 macro is called.
2484 .
2485 This implies that
2486 .B \[rs]n[PO]
2487 should not be used early in the document,
2488 unless it is changed also:
2489 accessing an undefined register automatically defines it.
2490 .
2491 .
2492 .IP \[bu]
2493 .I groff ms
2494 supports the
2495 .B PN
2496 register,
2497 but it is not necessary;
2498 you can access the page number via the usual
2499 .B %
2500 register and invoke the
2501 .B af
2502 request to assign a different format to it if desired.
2503 .
2504 (If you redefine the
2505 .I ms
2506 .B PT
2507 macro \" I wouldn't mention that, but Lesk 1978 encourages doing so. :-/
2508 and desire special treatment of certain page numbers\[em]like
2509 .RB \[lq] 1 \[rq]\[em]you
2510 may need to handle a non-Arabic page number format,
2511 as
2512 .IR "groff ms" 's
2513 .B .PT
2514 does;
2515 see the macro package source.
2516 .
2517 .I groff ms
2518 aliases the
2519 .B PN
2520 register to
2521 .BR % .)
2522 .
2523 .
2524 .IP \[bu]
2525 The AT&T
2526 .I ms
2527 manual documents registers
2528 .B CW
2529 and
2530 .B GW
2531 as setting the default column width and \[lq]intercolumn gap\[rq],
2532 respectively,
2533 and which applied when
2534 .B .MC
2535 was called with fewer than two arguments.
2536 .
2537 .I groff ms
2538 instead treats
2539 .B .MC
2540 without arguments as synonymous with
2541 .BR .2C ;
2542 there is thus no occasion for a default column width register.
2543 .
2544 Further,
2545 the
2546 .B MINGW
2547 register
2548 and the second argument to
2549 .B .MC
2550 specify a
2551 .I minimum
2552 space between columns,
2553 not the fixed gutter width of AT&T
2554 .IR ms .
2555 .
2556 .
2557 .IP \[bu]
2558 The AT&T
2559 .I ms
2560 manual did not document the
2561 .B QI
2562 register;
2563 Berkeley and
2564 .I "groff ms"
2565 do.
2566 .
2567 .
2568 .IP \[bu]
2569 The register
2570 .B GS
2571 is set to\~1 by the
2572 .I groff ms
2573 macros,
2574 but is not used by the AT&T
2575 .I ms
2576 package.
2577 .
2578 Documents that need to determine whether they are being formatted with
2579 .I groff ms
2580 or another implementation should test this register.
2581 .
2582 .
2583 .\" ====================================================================
2584 .SS "Unix Version\~7 macros not implemented by \f[I]groff ms\f[]"
2585 .\" ====================================================================
2586 .
2587 Several macros described in the Unix Version\~7
2588 .I ms
2589 documentation are unimplemented by
2590 .I groff ms
2591 because they are specific to the requirements of documents produced
2592 internally by Bell Laboratories,
2593 some of which also require a glyph for the Bell System logo that
2594 .I groff
2595 does not support.
2596 .
2597 These macros implemented several document type formats
2598 (\c
2599 .BR EG , \" engineer's notes
2600 .BR IM , \" internal memorandum
2601 .BR MF , \" memorandum for file
2602 .BR MR , \" memorandum for record
2603 .BR TM , \" technical memorandum
2604 .BR TR ), \" technical report
2605 were meaningful only in conjunction with the use of certain document
2606 types
2607 (\c
2608 .BR AT , \" attachments
2609 .BR CS , \" cover sheet info for `TM` documents
2610 .BR CT , \" copies to
2611 .BR OK , \" "other keywords" for `TM` documents
2612 .BR SG ), \" signatures for `TM` documents
2613 stored the postal addresses of Bell Labs sites
2614 (\c
2615 .BR HO , \" Holmdel
2616 .BR IH , \" Naperville
2617 .BR MH , \" Murray Hill
2618 .BR PY , \" Piscataway
2619 .BR WH ), \" Whippany
2620 or lacked a stable definition over time
2621 (\c
2622 .BR UX ). \" Unix; on 1st use, add footnote identifying trademark owner
2623 .
2624 .
2625 .\" ====================================================================
2626 .SH "Legacy features"
2627 .\" ====================================================================
2628 .
2629 .I "groff ms"
2630 retains some legacy features solely to support formatting of historical
2631 documents;
2632 contemporary ones should not use them because they can render poorly.
2633 .
2634 See
2635 .MR groff_char 7
2636 instead.
2637 .
2638 .
2639 .\" ====================================================================
2640 .SS "AT&T \f[I]ms\f[] accent mark strings"
2641 .\" ====================================================================
2642 .
2643 AT&T
2644 .I ms
2645 defined
2646 accent mark strings as follows.
2647 .
2648 .
2649 .P
2650 .TS
2651 Cb Lb
2652 Lf(CR) L.
2653 String Description
2654 _
2655 \[rs]*[\[aq]] Apply acute accent to subsequent glyph.
2656 \[rs]*[\[ga]] Apply grave accent to subsequent glyph.
2657 \[rs]*[:] Apply dieresis (umlaut) to subsequent glyph.
2658 \[rs]*[\[ha]] Apply circumflex accent to subsequent glyph.
2659 \[rs]*[\[ti]] Apply tilde accent to subsequent glyph.
2660 \[rs]*[C] Apply caron to subsequent glyph.
2661 .\" \*v was an undocumented (in Lesk 1978-11-13) synonym for \*C.
2662 \[rs]*[,] Apply cedilla to subsequent glyph.
2663 .TE
2664 .
2665 .
2666 .\" ====================================================================
2667 .SS "Berkeley \f[I]ms\f[] accent mark and glyph strings"
2668 .\" ====================================================================
2669 .
2670 Berkeley
2671 .I ms
2672 offered an
2673 .B AM
2674 macro;
2675 calling it redefined the AT&T accent mark strings
2676 (except for
2677 .BR \[rs]*C ),
2678 applied them to the
2679 .I preceding
2680 glyph,
2681 and defined additional strings,
2682 some for spacing glyphs.
2683 .
2684 .
2685 .TP
2686 .B .AM
2687 Enable alternative accent mark and glyph-producing strings.
2688 .
2689 .
2690 .P
2691 .TS
2692 Cb Lb
2693 Lf(CR) L.
2694 String Description
2695 _
2696 \[rs]*[\[aq]] Apply acute accent to preceding glyph.
2697 \[rs]*[\[ga]] Apply grave accent to preceding glyph.
2698 \[rs]*[:] Apply dieresis (umlaut) to preceding glyph.
2699 \[rs]*[\[ha]] Apply circumflex accent to preceding glyph.
2700 \[rs]*[\[ti]] Apply tilde accent to preceding glyph.
2701 \[rs]*[,] Apply cedilla to preceding glyph.
2702 \[rs]*[/] Apply stroke (slash) to preceding glyph.
2703 \[rs]*[v] Apply caron to preceding glyph.
2704 \[rs]*[_] Apply macron to preceding glyph.
2705 \[rs]*[.] Apply underdot to preceding glyph.
2706 \[rs]*[o] Apply ring accent to preceding glyph.
2707 _
2708 \[rs]*[?] Interpolate inverted question mark.
2709 \[rs]*[!] Interpolate inverted exclamation mark.
2710 \[rs]*[8] Interpolate small letter sharp s.
2711 \[rs]*[q] Interpolate small letter o with hook accent (ogonek).
2712 \[rs]*[3] Interpolate small letter yogh.
2713 \[rs]*[d-] Interpolate small letter eth.
2714 \[rs]*[D-] Interpolate capital letter eth.
2715 \[rs]*[th] Interpolate small letter thorn.
2716 \[rs]*[TH] Interpolate capital letter thorn.
2717 \[rs]*[ae] Interpolate small ae ligature.
2718 \[rs]*[AE] Interpolate capital ae ligature.
2719 \[rs]*[oe] Interpolate small oe ligature.
2720 \[rs]*[OE] Interpolate capital oe ligature.
2721 .TE
2722 .
2723 .
2724 .\" ====================================================================
2725 .SH "Naming conventions"
2726 .\" ====================================================================
2727 .
2728 The following conventions are used for names of macros,
2729 strings,
2730 and registers.
2731 .
2732 External names available to documents that use the
2733 .I groff ms
2734 macros contain only uppercase letters and digits.
2735 .
2736 .
2737 .LP
2738 Internally,
2739 the macros are divided into modules.
2740 .
2741 Conventions for identifier names are as follows.
2742 .
2743 .IP \[bu] 3n
2744 Names used only within one module are of the form
2745 .IB \%module * name\c
2746 \&.
2747 .
2748 .IP \[bu]
2749 Names used outside the module in which they are defined are of the form
2750 .IB \%module @ name\c
2751 \&.
2752 .
2753 .IP \[bu]
2754 Names associated with a particular environment are of the form
2755 .IB \%environment : name\c
2756 \&;
2757 these are used only within the
2758 .B par
2759 module.
2760 .
2761 .IP \[bu]
2762 .I name
2763 does not have a module prefix.
2764 .
2765 .IP \[bu]
2766 Constructed names used to implement arrays are of the form
2767 .IB \%array ! index\c
2768 \&.
2769 .
2770 .
2771 .PP
2772 Thus the
2773 .I groff ms
2774 macros reserve the following names:
2775 .
2776 .IP \[bu] 3n
2777 Names containing the characters
2778 .BR * ,
2779 .BR @ ,
2780 and\~\c
2781 .BR : .
2782 .
2783 .IP \[bu]
2784 Names containing only uppercase letters and digits.
2785 .
2786 .
2787 .\" ====================================================================
2788 .SH Files
2789 .\" ====================================================================
2790 .
2791 .TP
2792 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:\%s\:.tmac
2793 implements the package.
2794 .
2795 .
2796 .TP
2797 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/refer\-ms.tmac
2798 implements
2799 .MR \%refer 1
2800 support for
2801 .IR ms .
2802 .
2803 .
2804 .TP
2805 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:ms\:.tmac
2806 is a wrapper enabling the package to be loaded with
2807 .RB \[lq] "groff \-m ms" \[rq].
2808 .
2809 .
2810 .
2811 .\" ====================================================================
2812 .SH Authors
2813 .\" ====================================================================
2814 .
2815 The GNU version of the
2816 .I ms
2817 macro package was written by James Clark and contributors.
2818 .
2819 This document was written by Clark,
2820 .MT lkollar@\:despammed\:.com
2821 Larry Kollar
2822 .ME ,
2823 and
2824 .MT g.branden\:.robinson@\:gmail\:.com
2825 G.\& Branden Robinson
2826 .ME .
2827 .
2828 .
2829 .br
2830 .ne 8v
2831 .\" ====================================================================
2832 .SH "See also"
2833 .\" ====================================================================
2834 .
2835 A manual is available in source and rendered form.
2836 .
2837 On your system,
2838 it may be compressed and/or available in additional formats.
2839 .
2840 .
2841 .TP
2842 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:ms\:.ms
2843 .TQ
2844 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:ms\:.ps
2845 \[lq]Using
2846 .I groff
2847 with the
2848 .I ms
2849 Macro Package\[rq];
2850 Larry Kollar and \%G.\~Branden Robinson.
2851 .
2852 .
2853 .br
2854 .ne 5v
2855 .TP
2856 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%msboxes\:.ms
2857 .TQ
2858 .I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%msboxes\:.pdf
2859 \[lq]Using PDF boxes with
2860 .I groff
2861 and the
2862 .I ms
2863 macros\[rq];
2864 Deri James.
2865 .
2866 .B \%BOXSTART
2867 and
2868 .B \%BOXSTOP
2869 macros are available via the
2870 .I sboxes
2871 extension package,
2872 enabling colored,
2873 bordered boxes when the
2874 .B pdf
2875 output device is used.
2876 .
2877 .
2878 .PP
2879 .IR "Groff: The GNU Implementation of troff" ,
2880 by Trent A.\& Fisher and Werner Lemberg,
2881 is the primary
2882 .I groff
2883 manual.
2884 .
2885 You can browse it interactively with \[lq]info groff\[rq].
2886 .
2887 .
2888 .PP
2889 .MR groff 1 ,
2890 .MR \%troff 1 ,
2891 .MR \%tbl 1 ,
2892 .MR \%pic 1 ,
2893 .MR \%eqn 1 ,
2894 .MR \%refer 1
2895 .
2896 .
2897 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
2898 .cp \n[*groff_groff_ms_7_man_C]
2899 .do rr *groff_groff_ms_7_man_C
2900 .
2901 .
2902 .\" Local Variables:
2903 .\" fill-column: 72
2904 .\" mode: nroff
2905 .\" End:
2906 .\" vim: set filetype=groff textwidth=72: