mandoc_man(7)

NAME#

man — legacy formatting language for manual pages

DESCRIPTION#

The man language was the standard formatting language for AT&T UNIX manual pages from 1979 to 1989. Do not use it to write new manual pages: it is a purely presentational language and lacks support for semantic markup. Use the mdoc(7) language, instead.

In a man document, lines beginning with the control character ‘.’ are called “macro lines”. The first word is the macro name. It usually consists of two capital letters. For a list of portable macros, see MACRO OVERVIEW. The words following the macro name are arguments to the macro.

Lines not beginning with the control character are called “text lines”. They provide free-form text to be printed; the formatting of the text depends on the respective processing context:

.SH Macro lines change control state.
Text lines are interpreted within the current state.

Many aspects of the basic syntax of the man language are based on the roff(7) language; see the LANGUAGE SYNTAX and MACRO SYNTAX sections in the roff(7) manual for details, in particular regarding comments, escape sequences, whitespace, and quoting.

Each man document starts with the TH macro specifying the document's name and section, followed by the NAME section formatted as follows:

.TH PROGNAME 1 1979-01-10
.SH NAME
\fBprogname\fR \(en one line about what it does

MACRO OVERVIEW#

This overview is sorted such that macros of similar purpose are listed together. Deprecated and non-portable macros are not included in the overview, but can be found in the alphabetical reference below.

Page header and footer meta-data#

Sections and paragraphs#

Physical markup#

MACRO REFERENCE#

This section is a canonical reference to all macros, arranged alphabetically. For the scoping of individual macros, see MACRO SYNTAX.

AT

Sets the volume for the footer for compatibility with man pages from AT&T UNIX releases. The optional arguments specify which release it is from. This macro is an extension that first appeared in 4.3BSD.

B

Text is rendered in bold face.

BI

Example:

BR

Text is rendered alternately in bold face and roman (the default font). Whitespace between arguments is omitted in output. See also BI.

DT

Restore the default tabulator positions. They are at intervals of 0.5 inches. This has no effect unless the tabulator positions were changed with the roff(7)ta request.

EE

This is a non-standard Version 9 AT&T UNIX extension later adopted by GNU. In mandoc(1), it does the same as the roff(7)fi request (switch to fill mode).

EX

This is a non-standard Version 9 AT&T UNIX extension later adopted by GNU. In mandoc(1), it does the same as the roff(7)nf request (switch to no-fill mode).

HP

The width argument is a roff(7) scaling width. If specified, it's saved for later paragraph left margins; if unspecified, the saved or default width is used.

This macro is portable, but deprecated because it has no good representation in HTML output, usually ending up indistinguishable from PP.

I

Text is rendered in italics.

IB

Text is rendered alternately in italics and bold face. Whitespace between arguments is omitted in output. See also BI.

IP

The width argument is a roff(7) scaling width defining the left margin. It's saved for later paragraph left-margins; if unspecified, the saved or default width is used.

The head argument is used as a leading term, flushed to the left margin. This is useful for bulleted paragraphs and so on.

IR

Text is rendered alternately in italics and roman (the default font). Whitespace between arguments is omitted in output. See also BI.

LP

A synonym for PP.

ME

End a mailto block started with MT. This is a non-standard GNU extension.

MT

bash

.\nMT\n \naddress\n
link description to be shown
.\nME

OP

The key is usually a command-line flag and value its argument.

P

This synonym for PP is an AT&T System III UNIX extension later adopted by 4.3BSD.

PD

The height argument is a roff(7) scaling width. It defaults to 1v. If the unit is omitted, v is assumed.

This macro affects the spacing before any subsequent instances of HP, IP, LP, P, PP, SH, SS, SY, and TP.

PP

Begin an undecorated paragraph. The scope of a paragraph is closed by a subsequent paragraph, sub-section, section, or end of file. The saved paragraph left-margin width is reset to the default.

RB

Text is rendered alternately in roman (the default font) and bold face. Whitespace between arguments is omitted in output. See also BI.

RE

The syntax is as follows:

Without an argument, the most recent RS block is closed out. If level is 1, all open RS blocks are closed out. Otherwise, level− 1 nested RS blocks remain open.

RI

Text is rendered alternately in roman (the default font) and italics. Whitespace between arguments is omitted in output. See also BI.

RS

The width argument is a roff(7) scaling width. If not specified, the saved or default width is used.

See also RE.

SB

Text is rendered in small size (one point smaller than the default font) bold face. This macro is an extension that probably first appeared in SunOS 4.0 and was later adopted by GNU and by 4.4BSD.

SH

Begin a section. The scope of a section is only closed by another section or the end of file. The paragraph left-margin width is reset to the default.

SM

Text is rendered in small size (one point smaller than the default font).

SS

Begin a sub-section. The scope of a sub-section is closed by a subsequent sub-section, section, or end of file. The paragraph left-margin width is reset to the default.

SY

bash

.\nSY\n \ncommand\n
\narguments\n
.\nYS

This is a non-standard GNU extension and very rarely used even in GNU manual pages. Formatting is similar to IP.

TH

Conventionally, the document name is given in all caps. The section is usually a single digit, in a few cases followed by a letter. The recommended date format is YYYY-MM-DD as specified in the ISO-8601 standard; if the argument does not conform, it is printed verbatim. If the date is empty or not specified, the current date is used. The optional source string specifies the organisation providing the utility. When unspecified, mandoc(1) uses its -Ios argument. The volume string replaces the default volume title of the section.

Examples:

TP

bash

.\nTP\n [\nwidth\n]
\nhead\n \n\" one line\n
\nbody

The width argument is a roff(7) scaling width. If specified, it's saved for later paragraph left-margins; if unspecified, the saved or default width is used.

TQ

Like TP, except that no vertical spacing is inserted before the paragraph. This is a non-standard GNU extension and very rarely used even in GNU manual pages.

UC

Sets the volume for the footer for compatibility with man pages from BSD releases. The optional first argument specifies which release it is from. This macro is an extension that first appeared in 3BSD.

UE

End a uniform resource identifier block started with UR. This is a non-standard GNU extension.

UR

bash

.\nUR\n \nuri\n
link description to be shown
.\nUE

YS

End a synopsis block started with SY. This is a non-standard GNU extension.

in

If width is signed, the new offset is relative. Otherwise, it is absolute. This value is reset upon the next paragraph, section, or sub-section.

MACRO SYNTAX#

The man macros are classified by scope: line scope or block scope. Line macros are only scoped to the current line (and, in some situations, the subsequent line). Block macros are scoped to the current line and subsequent lines until closed by another block macro.

Line Macros#

Line macros are generally scoped to the current line, with the body consisting of zero or more arguments. If a macro is scoped to the next line and the line arguments are empty, the next line, which must be text, is used instead. Thus:

.I
foo

is equivalent to ‘.I foo’. If next-line macros are invoked consecutively, only the last is used. If a next-line macro is followed by a non-next-line macro, an error is raised.

The syntax is as follows:

.YO [body...]
[body...]

Block Macros#

Block macros comprise a head and body. As with in-line macros, the head is scoped to the current line and, in one circumstance, the next line (the next-line stipulations as in Line Macros apply here as well).

The syntax is as follows:

.YO [head...]
[head...]
[body...]

The closure of body scope may be to the section, where a macro is closed by SH; sub-section, closed by a section or SS; or paragraph, closed by a section, sub-section, HP, IP, LP, P, PP, RE, SY, or TP. No closure refers to an explicit block closing macro.

As a rule, block macros may not be nested; thus, calling a block macro while another block macro scope is open, and the open scope is not implicitly closed, is syntactically incorrect.

If a block macro is next-line scoped, it may only be followed by in-line macros for decorating text.

Font handling#

In man documents, both Physical markup macros and roff(7) ‘\f’ font escape sequences can be used to choose fonts. In text lines, the effect of manual font selection by escape sequences only lasts until the next macro invocation; in macro lines, it only lasts until the end of the macro scope. Note that macros like BR open and close a font scope for each argument.

SEE ALSO#

man(1), mandoc(1), eqn(7), mandoc_char(7), mdoc(7), roff(7), tbl(7)

HISTORY#

The man language first appeared as a macro package for the roff typesetting system in Version 7 AT&T UNIX.

The stand-alone implementation that is part of the mandoc(1) utility first appeared in OpenBSD 4.6.

AUTHORS#

Douglas McIlroy <[email protected]> designed and implemented the original version of these macros, wrote the original version of this manual page, and was the first to use them when he edited volume 1 of the Version 7 AT&T UNIX manual pages.

James Clark later rewrote the macros for groff. Eric S. Raymond <[email protected]> and Werner Lemberg <[email protected]> added the extended man macros to groff in 2007.

The mandoc(1) program and this man reference were written by Kristaps Dzonsons <[email protected]>.