mdoc | 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 |
Note that this is not the usual macro package for Linux documentation, although it is used for documentation of several widely used programs; see man(7).
The macros are described in two groups, the first includes the structural and physical page layout macros. The second contains the manual and general text domain macros which differentiate the -mdoc package from other troff formatting packages.
PAGE STRUCTURE DOMAIN | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Title Macros | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Page Layout Macros | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Section Headers. | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Li .Ss Subsection Headers. Li .Pp Paragraph Break. Vertical space (one line). Li .D1 (D-one) Display-one Indent and display one text line. Li .Dl (D-ell) Display-one literal. Indent and display one line of literal text. Li .Bd Begin-display block. Display options:
Li .Ed End-display (matches .Bd). Li .Bl Begin-list. Create lists or columns. Options:
Li .El End-list. Li .It List item.
MANUAL AND GENERAL TEXT DOMAIN MACROS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
In this example, the option enclosure macro `.[is] ' parsed, and calls the callable content macro `- ' which operates on the argument `s' and then calls the callable content macro `file ... ' which operates on the argument `file' Some macros may be callable, but are not parsed and vice versa. These macros are indicated in the parsed and callable columns below.
Unless stated, manual domain macros share a common syntax:
.argument [ . , ; : ( ) [ ] argument ...]
Note Opening and closing punctuation characters are only recognized as such if they are presented one at a time. The string `),' is not recognized as punctuation and will be output with a leading white space and in what ever font the calling macro uses. The argument list `]' ) , is recognized as three sequential closing punctuation characters and a leading white space is not output between the characters and the previous argument (if any). The special meaning of a punctuation character may be escaped with the string `\&' For example the following string,
Manual Domain Macros | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
General Text Domain Macros | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Macro names ending in `q' quote remaining items on the argument list. Macro names ending in `o' begin a quote which may span more than one line of input and are close quoted with the matching macro name ending in `c' Enclosure macros may be nested and are limited to eight arguments.
Note: the extended argument list macros ( `. ' `. ' and the function enclosure macros ( `.Fo , ' `.Fc ) ' are irregular. The extended list macros are used when the number of macro arguments would exceed the troff limitation of nine arguments.
The macros UR (starting a URI/URL hypertext reference), UE (ending one), and UN (identifying a target for a reference) are also available. See man(7) for more information on these macros.
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 |
COLOPHON | 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 |