Copyright (C) 1989-1995, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English. .. . .do nr groff_ms_C \n[.C] .cp 0 .
groff -m ms [ options .\|.\|.\& ] [ files .\|.\|.\& ] . . .
"Document type" If you use the RP (report) macro at the beginning of the document, groff prints the cover page information on its own page; otherwise it prints the information on the first page with your document text immediately following. Other document formats found in AT&T troff are specific to AT&T or Berkeley, and are not supported in "groff ms" . .
"Format and layout" By setting number registers, you can change your document's type (font and size), margins, spacing, headers and footers, and footnotes. See "Document control registers" below for more details. .
"Cover page" A cover page consists of a title, and optionally the author's name and institution, an abstract, and the date. See "Cover page macros" below for more details. .
"Body" Following the cover page is your document. It consists of paragraphs, headings, and lists. .
"Table of contents" Longer documents usually include a table of contents, which you can add by placing the TC macro at the end of your document. . .
Margin settings
Reg. Definition Effective Default |
PO |
Page offset (left margin) |
next page |
1i |
LL |
Line length |
next para. 6i |
LT |
Header/footer length |
next para. 6i |
HM |
Top (header) margin |
next page 1i |
FM |
Bottom (footer) margin |
next page 1i |
Text settings
Reg. Definition Effective Default |
PS |
Point size |
next para. 10p |
VS |
Line spacing (leading) |
next para. 12p |
PSINCR |
Point size increment |
for section headings of |
increasing importance |
next heading 1p |
GROWPS |
Heading level |
beyond which PSINCR |
is ignored |
next heading 0 |
Paragraph settings
Reg. Definition Effective Default |
PI |
Initial indent |
next para. 5n |
PD |
Space between paragraphs |
next para. 0.3v |
QI |
Quoted paragraph indent |
next para. 5n |
PORPHANS |
Number of initial lines |
to be kept together |
next para. 1 |
HORPHANS |
Number of initial lines |
to be kept with heading |
next heading 1 |
Footnote settings
Reg. Definition Effective Default |
FL Footnote length next footnote \[rs]n[LL]*5/6 |
FI Footnote indent next footnote 2n |
FF Footnote format next footnote 0 |
FPS Point size next footnote \[rs]n[PS]-2 |
FVS Vert. spacing next footnote \[rs]n[FPS]+2 |
FPD Para. spacing next footnote \[rs]n[PD]/2 |
Other settings
Reg. Definition Effective Default |
MINGW |
Minimum width between columns |
next page 2n |
.RP [no] Specifies the report format for your document. The report format creates a separate cover page. With no RP macro, groff prints a subset of the cover page on page\~1 of your document. .
If you use the optional no argument, groff prints a title page but does not repeat any of the title page information (title, author, abstract, etc.) on page\~1 of the document. ..P1 (P-one) Prints the header on page\~1. The default is to suppress the header. .
".DA [" xxx ] (optional) Print the current date, or the arguments to the macro if any, on the title page (if specified) and in the footers. This is the default for nroff . .
".ND [" xxx ] (optional) Print the current date, or the arguments to the macro if any, on the title page (if specified) but not in the footers. This is the default for troff . .
.TL Specifies the document title. Groff collects text following the TL macro into the title, until reaching the author name or abstract. .
.AU Specifies the author's name. You can specify multiple authors by using an AU macro for each author. .
.AI Specifies the author's institution. You can specify multiple institutions. .
.AB [no] Begins the abstract. The default is to print the word ABSTRACT , centered and in italics, above the text of the abstract. The option no suppresses this heading. .
.AE End the abstract. . .
The QP macro indents all text at both left and right margins. The effect is identical to the HTML <BLOCKQUOTE> element. The next paragraph or heading returns margins to normal. .
The XP macro produces an exdented paragraph. The first line of the paragraph begins at the left margin, and subsequent lines are indented (the opposite of PP ). .
For each of the above paragraph types, and also for any list entry introduced by the IP macro (described later), the document control register PORPHANS , sets the minimum number of lines which must be printed, after the start of the paragraph, and before any page break occurs. If there is insufficient space remaining on the current page to accommodate this number of lines, then a page break is forced before the first line of the paragraph is printed. .
Similarly, when a section heading (see subsection Headings below) preceeds any of these paragraph types, the HORPHANS document control register specifies the minimum number of lines of the paragraph which must be kept on the same page as the heading. If insufficient space remains on the current page to accommodate the heading and this number of lines of paragraph text, then a page break is forced before the heading is printed. . .
The following heading macros are available: .
.NH xx Numbered heading. The argument xx is either a numeric argument to indicate the level of the heading, or S xx xx \c ".\|.\|." to set the section number explicitly. If you specify heading levels out of sequence, such as invoking ".NH 3" after ".NH 1" , groff prints a warning on standard error. .
If the GROWPS register is set to a value greater than the level of the heading, then the point size of the heading will be increased by PSINCR units over the text size specified by the PS register, for each level by which the heading level is less than the value of GROWPS . For example, the sequence: .
.nr PS 10 .nr GROWPS 3 .nr PSINCR 1.5p . .NH 1 Top Level Heading . .NH 2 Second Level Heading . .NH 3 Third Level Heading
.ds SN-NO-DOT .als SN SN-NO-DOT
.als SN SN-NO-DOT
.SH [ xx ] Unnumbered subheading. The use of the optional xx argument is a GNU extension, which adjusts the point size of the unnumbered subheading to match that of a numbered heading, introduced using .NH xx with the same value of xx . For example, given the same settings for PS , GROWPS and PSINCR , as used in the preceeding .NH example, the sequence: .
.SH 2 An Unnumbered Subheading
".B [txt [post [pre]]]" Sets its first argument in "bold type" . If you specify a second argument, groff prints it in the previous font after the bold text, with no intervening space (this allows you to set punctuation after the highlighted text without highlighting the punctuation). Similarly, it prints the third argument (if any) in the previous font before the first argument. For example,
.
.B foo ) (".R [txt [post [pre]]]" Sets its first argument in roman (or regular) type. It operates similarly to the B macro otherwise. .
".I [txt [post [pre]]]" Sets its first argument in "italic type" . It operates similarly to the B macro otherwise. .
".CW [txt [post [pre]]]" Sets its first argument in a constant width face. It operates similarly to the B macro otherwise. .
".BI [txt [post [pre]]]" Sets its first argument in bold italic type. It operates similarly to the B macro otherwise. .
".BX [" txt ] Prints its argument and draws a box around it. If you want to box a string that contains spaces, use a digit-width space (\[rs]0). .
".UL [" txt " [" post ]] Prints its first argument with an underline. If you specify a second argument, groff prints it in the previous font after the underlined text, with no intervening space. .
.LG Prints all text following in larger type (2\~points larger than the current point size) until the next font size, highlighting, paragraph, or heading macro. You can specify this macro multiple times to enlarge the point size as needed. .
.SM Prints all text following in smaller type (2\~points smaller than the current point size) until the next type size, highlighting, paragraph, or heading macro. You can specify this macro multiple times to reduce the point size as needed. .
.NL Prints all text following in the normal point size (that is, the value of the PS register). .
\[rs]*{ text \[rs]*} Print the enclosed text as a superscript. . .
Use the RS and RE macros to start and end a section of indented text, respectively. The PI register controls the amount of indent. .
You can nest indented sections as deeply as needed by using multiple, nested pairs of RS and RE . . .
".IP [" marker " [" width ]] .
The marker is usually a bullet character \[rs](bu for unordered lists, a number (or auto-incrementing number register) for numbered lists, or a word or phrase for indented (glossary-style) lists. . The width specifies the indent for the body of each list item. Once specified, the indent remains the same for all list items in the document until specified again. -----. .
Display macro Type of display |
With keep No keep |
.DS L .LD Left-justified. |
.DS I [indent] .ID |
Indented (default indent in the DI register). |
.DS B .BD |
Block-centered (left-justified, longest line centered). |
.DS C .CD Centered. |
.DS R .RD Right-justified. |
Use the DE macro to end any display type. The macros Ds and De were formerly provided as aliases for DS and DE , respectively, but they have been removed, and should no longer be used. X11 documents which actually use Ds and De always load a specific macro file from the X11 distribution (macros.t) which provides proper definitions for the two macros.
To keep text together on a page, such as a paragraph that refers to a table (or list, or other item) immediately following, use the KS and KE macros. The KS macro begins a block of text to be kept on a single page, and the KE macro ends the block. .
You can specify a "floating keep" using the KF and KE macros. If the keep cannot fit on the current page, groff holds the contents of the keep and allows text following the keep (in the source file) to fill in the remainder of the current page. When the page breaks, whether by an explicit bp request or by reaching the end of the page, groff prints the floating keep at the top of the new page. This is useful for printing large graphics or tables that do not need to appear exactly where specified. .
The macros B1 and B2 can be used to enclose a text within a box; .B1 begins the box, and .B2 ends it. Text in the box is automatically placed in a diversion (keep). . .
".TS [H]" " and " .TE Denotes a table, to be processed by the tbl preprocessor. The optional H "\~argument" instructs groff to create a running header with the information up to the TH macro. Groff prints the header at the beginning of the table; if the table runs onto another page, groff prints the header on the next page as well. .
.PS " and " .PE Denotes a graphic, to be processed by the pic preprocessor. You can create a pic file by hand, using the AT&T pic manual available on the Web as a reference, or by using a graphics program such as xfig . .
".EQ [\,align\/]" " and " .EN Denotes an equation, to be processed by the eqn preprocessor. The optional align argument can be C , L , or\~\c I to center (the default), left-justify, or indent the equation. .
.[ " and " .] Denotes a reference, to be processed by the refer preprocessor. The GNU @g@refer (@MAN1EXT@) manual page provides a comprehensive reference to the preprocessor and the format of the bibliographic database. . .
You can specify symbolic footnotes by placing the mark character (such as \[rs](dg for the dagger character) in the body text, followed by the text of the footnote enclosed by FS \[rs](dg and FE macros. .
You can control how groff prints footnote numbers by changing the value of the FF register as follows:
.
0 Prints the footnote number as a superscript; indents the footnote (default). .
1 Prints the number followed by a period (like\~1.) and indents the footnote. .
2 Like\~1, without an indent. .
3 Like\~1, but prints the footnote number as a hanging paragraph. .
.
".OH 'left'center'right'"
Reg. Definition Effective Default |
PO |
Page offset (left margin) |
next page 1i |
LL |
Line length |
next para. 6i |
LT |
Header/footer length |
next para. 6i |
HM |
Top (header) margin |
next page 1i |
FM |
Bottom (footer) margin |
next page 1i |
Note that there is no right margin setting. The combination of page offset and line length provide the information necessary to derive the right margin. . .
.1C Single-column mode. .
.2C Two-column mode. .
".MC [" width " [" gutter ]] Multi-column mode. If you specify no arguments, it is equivalent to the 2C macro. Otherwise, width is the width of each column and gutter is the space between columns. The MINGW number register is the default gutter width. . .
You can manually create a table of contents by specifying a page number as the first argument to XS . Add subsequent entries using the XA macro. For example:
.
.XS 1 Introduction .XA 2 A Brief History of the Universe .XA 729 Details of Galactic Formation .\|.\|. .XE
Use the PX macro to print a manually-generated table of contents without resetting the page number. .
If you give the argument no to either PX or TC , groff suppresses printing the title specified by the \[rs]*[TOC] string. . .
The following four registers accept fractional point sizes: PS , VS , FPS , and FVS . .
Due to backwards compatibility, the value of VS must be smaller than 40000 (this is 40.0 points). . . .
. .
String Default Value |
REFERENCES References |
ABSTRACT ABSTRACT |
TOC Table of Contents |
MONTH1 January |
MONTH2 February |
MONTH3 March |
MONTH4 April |
MONTH5 May |
MONTH6 June |
MONTH7 July |
MONTH8 August |
MONTH9 September |
MONTH10 October |
MONTH11 November |
MONTH12 December |
The \[rs]*- string produces an em dash \[em] like this. .
Use \[rs]*Q and \[rs]*U to get a left and right typographer's quote, respectively, in troff (and plain quotes in nroff ). . .
The point size, vertical spacing, and inter-paragraph spacing for footnotes are controlled by the number registers FPS , FVS , and FPD ; at initialization these are set to \[rs]n(PS-2 , \[rs]n[FPS]+2 , and \[rs]n(PD/2 , respectively. If any of these registers are defined before initialization, the initialization macro does not change them. .
The hyphenation flags (as set by the hy request) are set from the HY register; the default is\~14. .
Improved accent marks (as originally defined in Berkeley's ms version) are available by specifying the AM macro at the beginning of your document. You can place an accent over most characters by specifying the string defining the accent directly after the character. For example, n\[rs]*~ produces an n with a tilde over it. . . .
The following conventions are used for names of macros, strings and number registers. External names available to documents that use the "groff ms" macros contain only uppercase letters and digits. .
Internally the macros are divided into modules; naming conventions are as follows: .
Thus the groff ms macros reserve the following names: .
@MACRODIR@/s.tmac . . .
mode: nroff
End: