groff_ms | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
NAME | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
SYNOPSIS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
DESCRIPTION | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
USAGE | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Document control registers | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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 | |||||
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 | |
Footnote settings
Reg. | Definition | Effective | Default |
FL | Footnote length | next footnote | LL*5/6 |
FI | Footnote indent | next footnote | 2n |
FF | Footnote format | next footnote | 0 |
Other settings
Reg. | Definition | Effective | Default | |||||
MINGW | Minimum width between columns | next page | 2n | |||||
Cover page macros | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Paragraphs | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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).
Headings | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
The following heading macros are available:
Highlighting | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Indents | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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.
Lists | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Tab stops | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Displays and keeps | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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.
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.
Tables, figures, equations, and references | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Footnotes | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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:
Headers and footers | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Margins | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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.
Multiple columns | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Creating a table of contents | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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.
DIFFERENCES FROM troff ms | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Strings | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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 |
Text Settings | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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.
NAMING CONVENTIONS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
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:
FILES | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
SEE ALSO | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
AUTHOR | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Sommaire | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
Table des mots clés | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
.1C | Multiple columns |
.2C | Multiple columns |
.[ and .] | Tables, figures, equations, and references |
.AB [no] | Cover page macros |
.AE | Cover page macros |
.AI | Cover page macros |
.AU | Cover page macros |
.B [txt [post [pre]]] | Highlighting |
.BI [txt [post [pre]]] | Highlighting |
.BX [txt] | Highlighting |
.CW [txt [post [pre]]] | Highlighting |
.DA [xxx] | Cover page macros |
.EQ [,align/] and .EN | Tables, figures, equations, and references |
.I [txt [post [pre]]] | Highlighting |
.IP [marker [width]] | Lists |
.LG | Highlighting |
.MC [width [gutter]] | Multiple columns |
.ND [xxx] | Cover page macros |
.NH xx | Headings |
.NL | Highlighting |
.P1 | Cover page macros |
.PS and .PE | Tables, figures, equations, and references |
.R [txt [post [pre]]] | Highlighting |
.RP [no] | Cover page macros |
.SH | Headings |
.SM | Highlighting |
.TL | Cover page macros |
.TS [H] and .TE | Tables, figures, equations, and references |
.UL [txt [post]] | Highlighting |
[rs]*{text[rs]*} | Highlighting |
Body | USAGE |
Cover page | USAGE |
Document type | USAGE |
Format and layout | USAGE |
Table of contents | USAGE |