.NH Dummy Header .NH 2 Listing of \fIms\fP macros .LP .IX "ms macros" This section lists the \fIms\fP macros available for use with \fIgroff\fP. They are sorted in two ways: once by function, and once alphabetically. In the following lists, the reference to \fIkeep\fP is a reference to a macro action wherein all formatted text is kept together. The text is added to the output on the current page if there is sufficient room for all of it, or it is placed at the top of the next page if there was not sufficient room. .\" .\" To cause the third column of text to wrap properly, use the .\" following substitution command (where ^I is a TAB, and ^M a CR) .\" .\" s/\([a-zA-Z][ a-zA-Z]*^I.*^I\)\(.*\)/\1T{^M\2^MT}/ .\" .TS H center tab ( ) box; cb s s cb | cb | cb l | lb | lw(3i). Alphabetical Listing of \fIms\fP Macros _ Type Macro Description _ .TH Page Format .1C T{ Set single column mode (causes a page break) T} Page Format .2C T{ Set two column mode. Return to single column with .1C T} Cover Page .AB [no] T{ Begin the abstract on the cover page, ending it with .AE ("no" means do not label the abstract) T} Cover Page .AE T{ End the abstract T} Cover Page .AI [name] T{ Print the name of the author's institution. If "name" is omitted, then it should appear on the next line. Up to 9 .AI entries may be used, or separate lines with .br T} Text Format .AM T{ Create better accent mark definitions T} Cover Page .AU [name] T{ Print the author's name. If "name" is omitted, then it should appear on the next line. This macro normally follows .TL, and precedes .AI T} Text Format .B [text] [trail [precede]] T{ Print \fItext\fP in bold face. Multiple words should be surrounded by quotes (i.e. .B "some text"). If "text" is omitted, then the font used for rendering subsequent text is bold. Optional trailing and preceding punctuation is suffixed and prefixed to the \fItext\fP in the normal format. See also .BI, .I and .C T} Text Highlight .B1 T{ Enclose the following text in a box. End with .B2 T} Text Highlight .B2 T{ End the boxed text which was begun with .B1 T} Page Format .BD T{ Commence block display of text. All text is displayed as it is found in the source file, centered on the longest line, until terminated with .DE Compare with .DS B T} Text Format .BI [text] [trail [precede]] T{ Print \fItext\fP in bold italic. See also .B, .I and .C T} Bibliography .BR T{ In some version of the \fIms\fP macros, commence the bibliographic format (i.e. precede a bibliographic record). This is not used in \fIgroff\fP, and so may be defined by the user. T} Page Format .BT [text] T{ Set the bottom title (i.e. at the foot of the page) to "text". This is the date if not otherwise specified. T} Text Highlight .BX text T{ Surround the text (usually a single word) with a box. To surround multiple words, separate them with a digit-width space (i.e. \\0). T} Page Format .CD T{ Commence centered display with each line individually centered, until terminated with a .DE Compare with .DS C T} Text Format .C [text] [trail [precede]] T{ Print \fItext\fP in constant width font. See also .B, .BI and .I T} Page Format .DA text T{ Print the current date as the center footer of each page. If \fItext\fP is specified, use that value in each page footer. T} Page Format .DE T{ End text displayed under the control of .BD, .CD, .ID, .LD or .DS T} Page Format .DS [type] T{ Start displayed text with \fIkeep\fP, of type block centered (\fBB\fP: same as .BD), centered (\fBC\fP: same as .CD), indented (\fBI\fP: same as .ID), left centered (\fBL\fP: same as .LD) or right aligned (\fBR\fP: same as .RD). Type \fBI\fP is the default. Note that .DS tries to keep all the text on a single page, while the macros similar to .DS do not. Thus if all the text cannot appear on the current page, a page break occurs if .DS is used. T} Page Format .EF 'left'center'right' T{ Place the specified text (left, center or right) in the footers for all evenly numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .EH 'left'center'right' T{ Place the specified text (left, center or right) in the headers for all evenly numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Mathematics .EN T{ End an equation which was begun with .EQ T} Mathematics .EQ [x [y]] T{ Commence an equation. "x" may be L, I or C, corresponding to left, indented or centered alignment. "y" is an optional equation label (use quotes to enclose multi-word labels). T} Page Format .FE T{ End a footnote. T} Page Format .FP T{ Create a numbered footnote paragraph. T} Page Format .FS [label] T{ Commence a footnote which is terminated by .FE. Optional label "label" will appear as a superscript at the beginning of the footnote. The user should cause the same "label" to appear in his text as a superscript, possibly by enclosing it as \\*{label\\*}. An alternative is to use the automatic numbering scheme afforded by the \\** macro (place this macro at the appropriate place in your text) and then use .FS, .FE without any label. T} Page Format .HD [header text] T{ Place the specified \fIheader text\fP below the normal page header. T} Text Format .I [text] [trail [precede]] T{ Print \fItext\fP in italic. See also .B, .BI and .C T} Page Format .ID [indent] T{ Begin an indented display without a \fIkeep\fP, meaning that the display will commence immediately, and carry onto the next page if necessary. Compare with .DS I T} Paragraph Format .IP [tag [indent]] T{ Commence a new paragraph with an optional hanging word (or phrase if surrounded by quote marks. The amount of indentation may also be specified (such as .IP "Label 1" 1i which will add the text \fILabel 1\fP to the output, and indent all following lines by 1 inch). T} Index .IX [a [b [c [d]]] T{ Place up to 4 index words or phrases (if surrounded by quote marks) in the error output file after appending the arguments to .IX with the current page number. It is up to another program or script to format these additional data for inclusion into the final document. See elsewhere in this HOWTO for a possible script. T} Page Format .KE T{ End a collection of lines of text which together will be kept together as a \fIkeep\fP. See .KF and .KS for a description of the types of \fIkeep\fPs available. T} Page Format .KF T{ Begin a collection of lines of text which will be kept together as a \fIkeep\fP. This \fIkeep\fP is known as a floating \fIkeep\fP in that if there is insufficient room on the current page for the entire block, then it will be placed at the top of the next page. See also .KS T} Page Format .KS T{ Begin a collection of lines of text which will be kept together as a \fIkeep\fP. This \fIkeep\fP is known as a fixed keep. IF there is at least one line of room available for output text on the present page, then this collection will be added to the current page. T} Page Format .LD T{ Begin a left justified display without a \fIkeep\fP. Compare with .DS L T} Text Format .LG T{ Increase the point size of the text by 2. T} Paragraph Format .LP T{ Commence a left justified paragraph. T} Page Format .MC width T{ Begin outputting multiple columns of width \fIwidth\fP. The width parameter should be specified in units like inches (such as .MC 2i). T} Page Format .ND text T{ Prevent the placing of the date in each page footer (see .DA). Place \fItext\fP on the cover page. T} Section Header .NH [level [start level]] T{ Place a numbered chapter or section header in the output (the header text follows on the next line or lines, until a .LP or other paragraph macro is encountered). A \fIlevel\fP of zero or one (or if none is specified) causes a section header of the highest level to be created. Levels 2 through 4 are subordinate (i.e. level 0 would appear as "\fB1. Title\fP", and level 2 would appears as "\fB1.1 Section\fP"). If \fIstart level\fP is specified and \fIlevel\fP equals \fBS\fP then the current section number is set to that value (such as .NH S 3 would cause the next section level to be something like "\fB3. Section Title\fP", even though the previous section was (say) 17. T} Text Format .NL T{ Set point size to the default (10 pts, if not specified via the number register PS at the beginning of the document). T} Page Format .OF 'left'center'right' T{ Place the specified text (left, center or right) in the footers of all odd numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .OH 'left'center'right' T{ Place the specified text (left, center or right) in the headers of all odd numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .P1 T{ May be used to print the header on the first page, if macro .TM is defined. In \fIgroff\fP, it is defined to set the first page to page 1. T} Paragraph Format .PP T{ Commence a paragraph with the first line indented by the amount given in number register PI. T} Page Format .PT [text] T{ Specify the page title, placed at the head of each page via \fItext\fP. If not specified, the page title defaults to "-%-", where % is the current page number. T} Table of Contents .PX [no] T{ Print the table of contents. If \fIno\fP is used as the argument, then no title is added. Normally, this is invoked by the .TC macro. T} Paragraph Format .QP T{ Commence a paragraph that is fully indented on both the left and right hand sides. This is often used for quotations. T} Text Format .R T{ Return to Roman font. Note that there is no argument for this macro. Compare to .B, .BI and .C, all of which accept arguments. T} Page Format .RD T{ Begin a right justified display without a \fIkeep\fP. Compare with .DS R T} Text Format .RE T{ Retreat one level of relative indentation. See also .RS T} Document Format .RP [no] T{ Format the document in \fIreleased paper\fP format. If \fIno\fP is used as the argument, then suppress the title on the first page. T} Text Format .RS T{ Indent by one level of relative indentation. The amount of indentation may be altered by use of the \fItroff\fP command .in (default \fI5n\fP) within a .RS/.RE pair (such as .RS, .in 10n, ... text..., .RS) T} Section Header .SH T{ Create a new section using the line (or lines following, up to another paragraph command like .NH) as a bold title. Unlike .NH, this section will not be numbered. T} Text Format .SM T{ Decrease the size of following text by 2 points. Compare to .LG and .NL T} Paragraph Format .TA T{ Set the tab setting to to \fI5n\fP. This macro may be redefined (say as .de TA, .ta T 2i, .fc :, .., which would cause text separated by colons to appear to separated by 2 inch tabs). T} Table of Contents .TC [no] T{ Print a table of contents page with the first page having page number one, set in Roman numerals. Compare to .PX which does not alter the page numbers in any way. If \fIno\fP is specified, then the title (\fITable of Contents\fP) is not printed. T} Table Format .TE T{ End a table which was commenced by the macro .TS, and which will be formatted by the \fItbl\fP processor. T} Table Format .TH T{ End a table header which will be printed at the head of each page if the table exceeds a single page. This requires the use of option \fIH\fP on the .TS invocation. T} Cover Page .TL T{ Set the title, which is all following text up to the next macro command (generally .AU) in bold text, two points larger than the default font size. T} Document Format .TM T{ This macro is not implemented in \fIgroff\fP, but was used to set documents in the University of California thesis format. It may be defined by users for their own purpose. T} Table Format .TS [H] T{ Begin a table to be formatted by the \fItbl\fP processor (generally invoked with the -\fIt\fP option to \fIgroff\fP). If \fIH\fP is specified, then the table will have a multi-page header (see .TH). T} Text Format .UL [text] T{ Underline the text on the macro command line. Multiple words may be underlined if enclosed in double quotes. Unlike commands such as .B, following lines of text are not processed by the .UL macro. T} Text Format .UX [text] T{ Place the word \fCUNIX\(rg\fP in the text the first time the macro is used, but only the word \fCUNIX\fP on subsequent invocations. If \fItext\fP (multiple words allows if enclosed in quotes) appears on the macro command, the text will be appended to the word \fCUNIX\fP. This is useful for adding punctuation. T} Table of Contents .XA [no [indent]] T{ Add an entry to the table of contents. If \fIno\fP appears as the first argument, then do not include the page number. The \fIindent\fP determines the relative horizontal position of the entry in the generated table. T} Table of Contents .XE T{ Terminate the addition of a single (or multiple) entry to the table of contents. Compare to .XS and .XA T} Paragraph Format .XP T{ Commence a paragraph with the first line having no indent, but with subsequent lines having an indent equal to the value of number register PI (default is \fI5n\fP). Subsequent paragraphs will all be indented. T} Table of Contents .XS [page | no [indent]] T{ Add an entry to the table of contents. if \fIno\fP appears, then the page number will not be included. If \fIpage\fP (i.e. a page number) appears, then that page number will be used for the entry. The \fIindent\fP determines the relative horizontal position of the entry in the generated table. T} .TE .bp The following is a listing sorted by macro type. .TS H center tab ( ) box; cb s s cb | cb | cb r | lb | lw(3i). Functional Listing of \fIms\fP Macros _ Type Macro Description _ .TH Bibliography .BR T{ In some version of the \fIms\fP macros, commence the bibliographic format (i.e. precede a bibliographic record). This is not used in \fIgroff\fP, and so may be defined by the user. T} Cover Page .AB [no] T{ Begin the abstract on the cover page, ending it with .AE ("no" means do not label the abstract) T} Cover Page .AE T{ End the abstract. T} Cover Page .AI [name] T{ Print the name of the author's institution. If "name" is omitted, then it should appear on the next line. Up to 9 .AI entries may be used, or separate lines with .br T} Cover Page .AU [name] T{ Print the author's name. If "name" is omitted, then it should appear on the next line. This macro normally follows .TL, and precedes .AI T} Cover Page .TL T{ Set the title, which is all following text up to the next macro command (generally .AU) in bold text, two points larger than the default font size. T} Document Format .RP [no] T{ Format the document in \fIreleased paper\fP format. If \fIno\fP is used as the argument, then suppress the title on the first page. T} Document Format .TM T{ This macro is not implemented in \fIgroff\fP, but was used to set documents in the University of California thesis format. It may be defined by users for their own purpose. T} Index .IX [a [b [c [d]]] T{ Place up to 4 index words or phrases (if surrounded by quote marks) in the error output file after appending the arguments to .IX with the current page number. It is up to another program or script to format these additional data for inclusion into the final document. See elsewhere in this HOWTO for a possible script. T} Mathematics .EN T{ End an equation which was begun with .EQ T} Mathematics .EQ [x [y]] T{ Commence an equation. "x" may be L, I or C, corresponding to left, indented or centered alignment. "y" is an optional equation label (use quotes to enclose multi-word labels). T} Page Format .1C T{ Set single column mode (causes a page break). T} Page Format .2C T{ Set two column mode. Return to single column with .1C T} Page Format .BD T{ Commence block display of text. All text is displayed as it is found in the source file, centered on the longest line, without a \fIkeep\fP, until terminated with .DE Compare with .DS B T} Page Format .BT [text] T{ Set the bottom title (i.e. at the foot of the page) to "text". This is the date if not otherwise specified. T} Page Format .CD T{ Commence centered display with each line individually centered, until terminated with a .DE Compare with .DS C T} Page Format .DA text T{ Print the current date as the center footer of each page. If \fItext\fP is specified, use that value in each page footer. T} Page Format .DE T{ End text displayed under the control of .BD, .CD, .ID, .LD or .DS T} Page Format .DS [type] T{ Start displayed text with \fIkeep\fP, of type block centered (\fBB\fP: same as .BD), centered (\fBC\fP: same as .CD), indented (\fBI\fP: same as .ID), left centered (\fBL\fP: same as .LD) or right aligned (\fBR\fP: same as .RD). Type \fBI\fP is the default. Note that .DS tries to keep all the text on a single page, while the macros similar to .DS do not. Thus if all the text cannot appear on the current page, a page break occurs if .DS is used. T} Page Format .EF 'left'center'right' T{ Place the specified text (left, center or right) in the footers for all evenly numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .EH 'left'center'right' T{ Place the specified text (left, center or right) in the headers for all evenly numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .FE T{ End a footnote. T} Page Format .FP T{ Create a numbered footnote paragraph. T} Page Format .FS [label] T{ Commence a footnote which is terminated by .FE. Optional label "label" will appear as a superscript at the beginning of the footnote. The user should cause the same "label" to appear in his text as a superscript, possibly by enclosing it as \\*{label\\*}. An alternative is to use the automatic numbering scheme afforded by the \\** macro (place this macro at the appropriate place in your text) and then use .FS, .FE without any label. T} Page Format .HD [header text] T{ Place the specified \fIheader text\fP below the normal page header. T} Page Format .ID [indent] T{ Begin an indented display without a \fIkeep\fP, meaning that the display will commence immediately, and carry onto the next page if necessary. Compare with .DS I T} Page Format .KE T{ End a collection of lines of text which together will be kept together as a \fIkeep\fP. See .KF and .KS for a description of the types of \fIkeep\fPs available. T} Page Format .KF T{ Begin a collection of lines of text which will be kept together as a \fIkeep\fP. This \fIkeep\fP is known as a floating \fIkeep\fP in that if there is insufficient room on the current page for the entire block, then it will be placed at the top of the next page. See also .KS T} Page Format .KS T{ Begin a collection of lines of text which will be kept together as a \fIkeep\fP. This \fIkeep\fP is known as a fixed keep. IF there is at least one line of room available for output text on the present page, then this collection will be added to the current page. T} Page Format .LD T{ Begin a left justified display without a \fIkeep\fP. Compare with .DS L T} Page Format .MC width T{ Begin outputting multiple columns of width \fIwidth\fP. The width parameter should be specified in units like inches (such as .MC 2i). T} Page Format .ND text T{ Prevent the placing of the date in each page footer (see .DA). Place \fItext\fP on the cover page. T} Page Format .OF 'left'center'right' T{ Place the specified text (left, center or right) in the footers of all odd numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .OH 'left'center'right' T{ Place the specified text (left, center or right) in the headers of all odd numbered pages. One or more of the text strings may be omitted, but all single quote marks must be given. T} Page Format .P1 T{ May be used to print the header on the first page, if macro .TM is defined. In \fIgroff\fP, it is defined to set the first page to page 1. T} Page Format .PT [text] T{ Specify the page title, placed at the head of each page via \fItext\fP. If not specified, the page title defaults to "-%-", where % is the current page number. T} Page Format .RD T{ Begin a right justified display without a \fIkeep\fP. Compare with .DS R T} Paragraph Format .IP [tag [indent]] T{ Commence a new paragraph with an optional hanging word (or phrase if surrounded by quote marks. The amount of indentation may also be specified (such as .IP "Label 1" 1i which will add the text \fILabel 1\fP to the output, and indent all following lines by 1 inch). T} Paragraph Format .LP T{ Commence a left justified paragraph. T} Paragraph Format .PP T{ Commence a paragraph with the first line indented by the amount given in number register PI. T} Paragraph Format .QP T{ Commence a paragraph that is fully indented on both the left and right hand sides. This is often used for quotations. T} Paragraph Format .TA T{ Set the tab setting to to \fI5n\fP. This macro may be redefined (say as .de TA, .ta T 2i, .fc :, .., which would cause text separated by colons to appear to separated by 2 inch tabs). T} Paragraph Format .XP T{ Commence a paragraph with the first line having no indent, but with subsequent lines having an indent equal to the value of number register PI (default is \fI5n\fP). Subsequent paragraphs will all be indented. T} Section Header .NH [level [start level]] T{ Place a numbered chapter or section header in the output (the header text follows on the next line or lines, until a .LP or other paragraph macro is encountered). A \fIlevel\fP of zero or one (or if none is specified) causes a section header of the highest level to be created. Levels 2 through 4 are subordinate (i.e. level 0 would appear as "\fB1. Title\fP", and level 2 would appears as "\fB1.1 Section\fP"). If \fIstart level\fP is specified and \fIlevel\fP equals \fBS\fP then the current section number is set to that value (such as .NH S 3 would cause the next section level to be something like "\fB3. Section Title\fP", even though the previous section was (say) 17. T} Section Header .SH T{ Create a new section using the line (or lines following, up to another paragraph command like .NH) as a bold title. Unlike .NH, this section will not be numbered. T} Table Format .TE T{ End a table which was commenced by the macro .TS, and which will be formatted by the \fItbl\fP processor. T} Table Format .TH T{ End a table header which will be printed at the head of each page if the table exceeds a single page. This requires the use of option \fIH\fP on the .TS invocation. T} Table Format .TS [H] T{ Begin a table to be formatted by the \fItbl\fP processor (generally invoked with the -\fIt\fP option to \fIgroff\fP). If \fIH\fP is specified, then the table will have a multi-page header (see .TH). T} Table of Contents .PX [no] T{ Print the table of contents. If \fIno\fP is used as the argument, then no title is added. Normally, this is invoked by the .TC macro. T} Table of Contents .TC [no] T{ Print a table of contents page with the first page having page number one, set in Roman numerals. Compare to .PX which does not alter the page numbers in any way. If \fIno\fP is specified, then the title (\fITable of Contents\fP) is not printed. T} Table of Contents .XA [no [indent]] T{ Add an entry to the table of contents. If \fIno\fP appears as the first argument, then do not include the page number. The \fIindent\fP determines the relative horizontal position of the entry in the generated table. T} Table of Contents .XE T{ Terminate the addition of a single (or multiple) entry to the table of contents. Compare to .XS and .XA T} Table of Contents .XS [page | no [indent]] T{ Add an entry to the table of contents. if \fIno\fP appears, then the page number will not be included. If \fIpage\fP (i.e. a page number) appears, then that page number will be used for the entry. The \fIindent\fP determines the relative horizontal position of the entry in the generated table. T} Text Format .AM T{ Create better accent mark definitions T} Text Format .B [text] [trail [precede]] T{ Print \fItext\fP in bold face. Multiple words should be surrounded by quotes (i.e. .B "some text"). If "text" is omitted, then the font used for rendering subsequent text is bold. Optional trailing and preceding punctuation is suffixed and prefixed to the \fItext\fP in the normal format. See also .BI, .I and .C T} Text Format .BI [text] [trail [precede]] T{ Print \fItext\fP in bold italic. See also .B, .I and .C T} Text Format .C [text] [trail [precede]] T{ Print \fItext\fP in constant width font. See also .B, .BI and .I T} Text Format .I [text] [trail [precede]] T{ Print \fItext\fP in italic. See also .B, .BI and .C T} Text Format .LG T{ Increase the point size of the text by 2. T} Text Format .NL T{ Set point size to the default (10 pts, if not specified via the number register PS at the beginning of the document). T} Text Format .R T{ Return to Roman font. Note that there is no argument for this macro. Compare to .B, .BI and .C, all of which accept arguments. T} Text Format .RE T{ Retreat one level of relative indentation. See also .RS T} Text Format .RS T{ Indent by one level of relative indentation. The amount of indentation may be altered by use of the \fItroff\fP command .in (default \fI5n\fP) within a .RS/.RE pair (such as .RS, .in 10n, ... text..., .RS) T} Text Format .SM T{ Decrease the size of following text by 2 points. Compare to .LG and .NL T} Text Format .UL [text] T{ Underline the text on the macro command line. Multiple words may be underlined if enclosed in double quotes. Unlike commands such as .B, following lines of text are not processed by the .UL macro. T} Text Format .UX [text] T{ Place the word \fCUNIX\(rg\fP in the text the first time the macro is used, but only the word \fCUNIX\fP on subsequent invocations. If \fItext\fP (multiple words allows if enclosed in quotes) appears on the macro command, the text will be appended to the word \fCUNIX\fP. This is useful for adding punctuation. T} Text Highlight .B1 T{ Enclose the following text in a box. End with .B2 T} Text Highlight .B2 T{ End the boxed text which was begun with .B1 T} Text Highlight .BX text T{ Surround the text (usually a single word) with a box. To surround multiple words, separate them with a digit-width space (i.e. \\0). T} .TE