.\" Copyright (c) 1991 The Regents of the University of California.
.\" %sccs.include.redist.roff%
.\" @(#)mdoc.7 1.2 (Berkeley) %G%
.Nd Quick reference guide for the
package is a set of content-based and domain-based macros
The macro names and their meanings are
listed below for quick reference; for
a detailed explanation on using the package,
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
.Sh PAGE STRUCTURE DOMAIN
To create a valid manual page, these three macros, in this order,
.Bl -tag -width "xxxx.Os OPERATINGxSYSTEM [version/release]" -compact
.It Li "\&.Dd " Ar "Month day, year"
.It Li "\&.Dt " Ar "DOCUMENT_TITLE [section] [volume]"
.It Li "\&.Os " Ar "OPERATING_SYSTEM [version/release]"
Section headers, paragraph breaks, lists and displays.
.Bl -tag -width flag -compact
Valid headers, in the order of presentation:
.Bl -tag -width "RETURN VALUES" -compact
Name section, should include the
General description, should include
Sections two and three function calls.
Describe environment variables.
Files associated with the subject.
Examples and suggestions.
Normally used for section four device interface diagnostics.
Sections two and three error and signal
Cross references and citations.
Conformance to standards if applicable.
If a standard is not applicable, the history
of the subject should be given.
Customized headers may be added at
Vertical space (one line).
Indent and display one text line.
(D-ell) Display-one literal.
Indent and display one line of literal text.
.Bl -tag -width "xoffset string " -compact
Unjustified (ragged edges).
.Bl -tag -width indent-two -compact
Align block on left (default).
Approximate center margin.
Six constant width spaces (a tab).
Left aligns block 2 inches from
is a callable macro name.
End-display (matches \&.Bd).
Create lists or columns. Options:
.Bl -tag -width flag -compact
.Bl -column xbullet -compact
.It Fl bullet Ta "Bullet Item List"
.It Fl item Ta "Unlabeled List"
.It Fl enum Ta "Enumerated List"
.It Fl tag Ta "Tag Labeled List"
.It Fl diag Ta "Diagnostic List"
.It Fl hang Ta "Hanging Labeled List"
.It Fl ohang Ta "Overhanging Labeled List"
.It Fl inset Ta "Inset or Run-on Labeled List"
.Bl -tag -width "xcompact " -compact
.Sh MANUAL AND GENERAL TEXT DOMAIN MACROS
The manual and general text domain macros are special in that
most of them are parsed for callable macros
.Bl -tag -width ".Op Fl s Ar filex" -offset indent
.It Li "\&.Op Fl s Ar file"
In this example, the option enclosure macro
is parsed, and calls the callable content macro
which operates on the argument
and then calls the callable content macro
which operates on the argument
Some macros may be callable, but are not parsed and vice versa.
These macros are indicated in the
Unless stated, manual domain macros share a common syntax:
.Dl \&.Va argument [\ .\ ,\ ;\ :\ (\ )\ [\ ]\ argument \...\ ]
punctuation characters are only recognized as such if they are presented
is not recognized as punctuation and will be output with a leading white
space and in what ever font the calling macro uses.
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
For example the following string,
.Bl -tag -width "&.Ar file1\ , file2\ , file3\ )\ ." -offset indent
.It Li "\&.Ar file1\ , file2\ , file3\ )\ ."
.Ar file1 , file2 , file3 ) .
.Bl -column "Name" "Parsed" Callable" -compact
.It Em Name Parsed Callable Description
.It Li \&Ad Ta Yes Ta Yes Ta Address. "(This macro may be deprecated.)"
.It Li \&Ar Ta Yes Ta Yes Ta "Command line argument."
.It Li \&Cd Ta \&No Ta \&No Ta "Configuration declaration (section four only)."
.It Li \&Cm Ta Yes Ta Yes Ta "Command line argument modifier."
.It Li \&Dv Ta Yes Ta Yes Ta "Defined variable (source code)."
.It Li \&Er Ta Yes Ta Yes Ta "Error number (source code)."
.It Li \&Ev Ta Yes Ta Yes Ta "Environment variable."
.It Li \&Fa Ta Yes Ta Yes Ta "Function argument."
.It Li \&Fd Ta Yes Ta Yes Ta "Function declaration."
.It Li \&Fn Ta Yes Ta Yes Ta "Function call (also .Fo and .Fc)."
.It Li \&Ic Ta Yes Ta Yes Ta "Interactive command."
.It Li \&Li Ta Yes Ta Yes Ta "Literal text."
.It Li \&Nm Ta Yes Ta Yes Ta "Command name."
.It Li \&Op Ta Yes Ta Yes Ta "Option (also .Oo and .Oc)."
.It Li \&Ot Ta Yes Ta Yes Ta "Old style function type (Fortran only)."
.It Li \&Pa Ta Yes Ta Yes Ta "Pathname or file name."
.It Li \&St Ta Yes Ta Yes Ta "Standards (-p1003.2, -p1003.1 or -ansiC)"
.It Li \&Va Ta Yes Ta Yes Ta "Variable name."
.It Li \&Vt Ta Yes Ta Yes Ta "Variable type (Fortran only)."
.It Li \&Xr Ta Yes Ta Yes Ta "Manual Page Cross Reference."
.Ss General Text Domain Macros
.Bl -column "Name" "Parsed" Callable" -compact
.It Em "Name Parsed Callable Description"
.It Li \&%A Ta Yes Ta \&No Ta "Reference author."
.It Li \&%B Ta Yes Ta Yes Ta "Reference book title."
.It Li \&%\&C Ta \&No Ta \&No Ta "Reference place of publishing (city)."
.It Li \&%\&D Ta \&No Ta \&No Ta "Reference date."
.It Li \&%J Ta Yes Ta Yes Ta "Reference journal title."
.It Li \&%N Ta \&No Ta \&No Ta "Reference issue number."
.It Li \&%\&O Ta \&No Ta \&No Ta "Reference optional information."
.It Li \&%P Ta \&No Ta \&No Ta "Reference page number(s)."
.It Li \&%R Ta \&No Ta \&No Ta "Reference report Name."
.It Li \&%T Ta Yes Ta Yes Ta "Reference article title."
.It Li \&%V Ta \&No Ta \&No Ta "Reference volume."
.It Li \&Ac Ta Yes Ta Yes Ta "Angle close quote."
.It Li \&Ao Ta Yes Ta Yes Ta "Angle open quote."
.It Li \&Aq Ta Yes Ta Yes Ta "Angle quote."
.It Li \&At Ta \&No Ta \&No Ta Tn "AT&T UNIX"
.It Li \&Bc Ta Yes Ta Yes Ta "Bracket close quote."
.It Li \&Bf Ta \&No Ta \&No Ta "Begin font mode."
.It Li \&Bo Ta Yes Ta Yes Ta "Bracket open quote."
.It Li \&Bq Ta Yes Ta Yes Ta "Bracket quote."
.It Li \&Bx Ta Yes Ta Yes Ta Bx .
.It Li \&Db Ta \&No Ta \&No Ta "Debug (default is \\*qoff\\*q)"
.It Li \&Dc Ta Yes Ta Yes Ta "Double close quote."
.It Li \&Do Ta Yes Ta Yes Ta "Double open quote."
.It Li \&Dq Ta Yes Ta Yes Ta "Double quote."
.It Li \&Ec Ta Yes Ta Yes Ta "Enclose string close quote."
.It Li \&Ef Ta \&No Ta \&No Ta "End font mode."
.It Li \&Em Ta Yes Ta Yes Ta "Emphasis (traditional English)."
.It Li \&Eo Ta Yes Ta Yes Ta "Enclose string open quote."
.It Li \&No Ta Yes Ta Yes Ta "Normal text (no-op)."
.It Li \&Ns Ta Yes Ta Yes Ta "No space."
.It Li \&Pc Ta Yes Ta Yes Ta "Parenthesis close quote."
.It Li \&Pf Ta Yes Ta \&No Ta "Prefix string."
.It Li \&Po Ta Yes Ta Yes Ta "Parenthesis open quote."
.It Li \&Pq Ta Yes Ta Yes Ta "Parentheses quote."
.It Li \&Qc Ta Yes Ta Yes Ta "Strait Double close quote."
.It Li \&Ql Ta Yes Ta Yes Ta "Quoted literal."
.It Li \&Qo Ta Yes Ta Yes Ta "Strait Double open quote."
.It Li \&Qq Ta Yes Ta Yes Ta "Strait Double quote."
.It Li \&Re Ta \&No Ta \&No Ta "Reference start."
.It Li \&Rs Ta \&No Ta \&No Ta "Reference start."
.It Li \&Sc Ta Yes Ta Yes Ta "Single close quote."
.It Li \&So Ta Yes Ta Yes Ta "Single open quote."
.It Li \&Sq Ta Yes Ta Yes Ta "Single quote."
.It Li \&Sm Ta \&No Ta \&No Ta "Space mode (default is \\*qon\\*q)"
.It Li \&Sx Ta Yes Ta Yes Ta "Section Cross Reference."
.It Li \&Sy Ta Yes Ta Yes Ta "Symbolic (traditional English)."
.It Li \&Tn Ta Yes Ta Yes Ta "Trade or type name (small Caps)."
.It Li \&Ux Ta Yes Ta Yes Ta Ux
.It Li \&Xc Ta Yes Ta Yes Ta "Extend argument list close."
.It Li \&Xo Ta Yes Ta Yes Ta "Extend argument list close."
.\" .It Sy \&Hf Ta \&No Ta \&No Ta "Include file with header"
quote remaining items on the argument list.
begin a quote which may span more than one line of input and
are close quoted with the matching macro name ending in
Enclosure macros may be nested and are limited to
Note: the extended argument list macros
and the function enclosure macros
The extended list macros are used when the number of macro arguments
limitation of nine arguments.
For site specific configuration of the macro package,
.Pa /usr/src/share/tmac/README .
.Bl -tag -width "tmac.doc-ditroff" -compact
Manual and general text domain macros.
Common structural macros and definitions.
Special defines (such as the standards macro).