version 1.30, 2009/08/20 11:44:47 |
version 1.68, 2010/05/12 16:52:33 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" |
.\" |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" Permission to use, copy, modify, and distribute this software for any |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" purpose with or without fee is hereby granted, provided that the above |
|
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MAN 7 |
.Dt MAN 7 |
.Os |
.Os |
. |
|
. |
|
.Sh NAME |
.Sh NAME |
. Nm man |
.Nm man |
. Nd man language reference |
.Nd man language reference |
. |
|
. |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
. Nm man |
.Nm man |
language was historically used to format |
language was historically used to format |
. Ux |
.Ux |
manuals. This reference document describes its syntax, structure, and |
manuals. |
usage. |
This reference document describes its syntax, structure, and usage. |
. Pp |
.Pp |
. Bf -emphasis |
.Bf -emphasis |
Do not use |
Do not use |
. Nm |
.Nm |
to write your manuals. |
to write your manuals. |
. Ef |
.Ef |
Use the |
Use the |
. Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
. Pp |
.Pp |
An |
An |
. Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
. Sq \&. |
.Sq \&. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. |
|
Other lines are interpreted within the scope of |
prior macros: |
prior macros: |
. Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.SH Macro lines change control state. |
\&.SH Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
. Ed |
.Ed |
. |
|
. |
|
.Sh INPUT ENCODING |
.Sh INPUT ENCODING |
. Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters, the |
documents may contain only graphable 7-bit ASCII characters, the |
space character, and the tabs character. All manuals must have |
space character, and the tabs character. |
. Ux |
All manuals must have |
|
.Ux |
line termination. |
line termination. |
. Pp |
.Pp |
Blank lines are acceptable; where found, the output will assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
. Pp |
.Ss Comments |
The |
|
. Sq \ec |
|
escape is common in historical |
|
. Nm |
|
documents; if encountered at the end of a word, it ensures that the |
|
subsequent word isn't off-set by whitespace. |
|
. |
|
. |
|
. Ss Comments |
|
Text following a |
Text following a |
. Sq \e\*" , |
.Sq \e\*" , |
whether in a macro or free-form text line, is ignored to the end of |
whether in a macro or free-form text line, is ignored to the end of |
line. A macro line with only a control character and comment escape, |
line. |
. Sq \&.\e" , |
A macro line with only a control character and comment escape, |
is also ignored. Macro lines with only a control charater and |
.Sq \&.\e" , |
optionally whitespace are stripped from input. |
is also ignored. |
. |
Macro lines with only a control character and optionally whitespace are |
. |
stripped from input. |
. Ss Special Characters |
.Ss Special Characters |
Special characters may occur in both macro and free-form lines. |
Special characters may occur in both macro and free-form lines. |
Sequences begin with the escape character |
Sequences begin with the escape character |
. Sq \e |
.Sq \e |
followed by either an open-parenthesis |
followed by either an open-parenthesis |
. Sq \&( |
.Sq \&( |
for two-character sequences; an open-bracket |
for two-character sequences; an open-bracket |
. Sq \&[ |
.Sq \&[ |
for n-character sequences (terminated at a close-bracket |
for n-character sequences (terminated at a close-bracket |
. Sq \&] ) ; |
.Sq \&] ) ; |
or a single one-character sequence. See |
or a single one-character sequence. |
. Xr mandoc_char 7 |
See |
for a complete list. Examples include |
.Xr mandoc_char 7 |
. Sq \e(em |
for a complete list. |
. Pq em-dash |
Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
and |
and |
. Sq \ee |
.Sq \ee |
. Pq back-slash . |
.Pq back-slash . |
. |
.Ss Text Decoration |
. |
|
. Ss Text Decoration |
|
Terms may be text-decorated using the |
Terms may be text-decorated using the |
. Sq \ef |
.Sq \ef |
escape followed by an indicator: B (bold), I, (italic), or P and R |
escape followed by an indicator: B (bold), I, (italic), R (Roman), or P |
(Roman, or reset). |
(revert to previous mode): |
. |
.Pp |
. |
.D1 \efBbold\efR \efIitalic\efP |
. Ss Whitespace |
.Pp |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
A numerical representation 3, 2, or 1 (bold, italic, and Roman, |
from input. These are later re-added, if applicable, by a front-end |
respectively) may be used instead. |
utility such as |
A text decoration is only valid, if specified in free-form text, until |
. Xr mandoc 1 . |
the next macro invocation; if specified within a macro, it's only valid |
. |
until the macro closes scope. |
. |
Note that macros like |
|
.Sx \&BR |
|
open and close a font scope with each argument. |
|
.Pp |
|
Text may also be sized with the |
|
.Sq \es |
|
escape, whose syntax is one of |
|
.Sq \es+-n |
|
for one-digit numerals; |
|
.Sq \es(+-nn |
|
or |
|
.Sq \es+-(nn |
|
for two-digit numerals; and |
|
.Sq \es[+-N] , |
|
.Sq \es+-[N] , |
|
.Sq \es'+-N' , |
|
or |
|
.Sq \es+-'N' |
|
for arbitrary-digit numerals: |
|
.Pp |
|
.D1 \es+1bigger\es-1 |
|
.D1 \es[+10]much bigger\es[-10] |
|
.D1 \es+(10much bigger\es-(10 |
|
.D1 \es+'100'much much bigger\es-'100' |
|
.Pp |
|
Both |
|
.Sq \es |
|
and |
|
.Sq \ef |
|
attributes are forgotten when entering or exiting a macro block. |
|
.Ss Whitespace |
|
Whitespace consists of the space character. |
|
In free-form lines, whitespace is preserved within a line; un-escaped |
|
trailing spaces are stripped from input (unless in a literal context). |
|
Blank free-form lines, which may include spaces, are permitted and |
|
rendered as an empty line. |
|
.Pp |
|
In macro lines, whitespace delimits arguments and is discarded. |
|
If arguments are quoted, whitespace within the quotes is retained. |
|
.Ss Dates |
|
The |
|
.Sx \&TH |
|
macro is the only |
|
.Nm |
|
macro that requires a date. |
|
The form for this date is the ISO-8601 |
|
standard |
|
.Cm YYYY-MM-DD . |
|
.Ss Scaling Widths |
|
Many macros support scaled widths for their arguments, such as |
|
stipulating a two-inch paragraph indentation with the following: |
|
.Bd -literal -offset indent |
|
\&.HP 2i |
|
.Ed |
|
.Pp |
|
The syntax for scaled widths is |
|
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
|
where a decimal must be preceded or proceeded by at least one digit. |
|
Negative numbers, while accepted, are truncated to zero. |
|
The following scaling units are accepted: |
|
.Pp |
|
.Bl -tag -width Ds -offset indent -compact |
|
.It c |
|
centimetre |
|
.It i |
|
inch |
|
.It P |
|
pica (~1/6 inch) |
|
.It p |
|
point (~1/72 inch) |
|
.It f |
|
synonym for |
|
.Sq u |
|
.It v |
|
default vertical span |
|
.It m |
|
width of rendered |
|
.Sq m |
|
.Pq em |
|
character |
|
.It n |
|
width of rendered |
|
.Sq n |
|
.Pq en |
|
character |
|
.It u |
|
default horizontal span |
|
.It M |
|
mini-em (~1/100 em) |
|
.El |
|
.Pp |
|
Using anything other than |
|
.Sq m , |
|
.Sq n , |
|
.Sq u , |
|
or |
|
.Sq v |
|
is necessarily non-portable across output media. |
|
.Pp |
|
If a scaling unit is not provided, the numerical value is interpreted |
|
under the default rules of |
|
.Sq v |
|
for vertical spaces and |
|
.Sq u |
|
for horizontal ones. |
|
.Em Note : |
|
this differs from |
|
.Xr mdoc 7 , |
|
which, if a unit is not provided, will instead interpret the string as |
|
literal text. |
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
. Nm |
.Nm |
document must contain contains at least the |
document must contain contains at least the |
. Sq TH |
.Sx \&TH |
macro describing the document's section and title. It may occur |
macro describing the document's section and title. |
anywhere in the document, although conventionally, it appears as the |
It may occur anywhere in the document, although conventionally, it |
first macro. |
appears as the first macro. |
. Pp |
.Pp |
Beyond |
Beyond |
. Sq TH , |
.Sx \&TH , |
at least one macro or text node must appear in the document. Documents |
at least one macro or text node must appear in the document. |
are generally structured as follows: |
Documents are generally structured as follows: |
. Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.TH FOO 1 "13 Aug 2009" |
\&.TH FOO 1 2009-10-10 |
\&. |
\&. |
\&.SH NAME |
\&.SH NAME |
\efBfoo\efR \e(en a description goes here |
\efBfoo\efR \e(en a description goes here |
|
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .SH LIBRARY |
\&. |
\&. |
\&.SH SYNOPSIS |
\&.SH SYNOPSIS |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\efBfoo\efR [\efB\e-options\efR] arguments... |
\&. |
\&. |
\&.SH DESCRIPTION |
\&.SH DESCRIPTION |
The \efBfoo\efR utility does... |
The \efBfoo\efR utility processes files... |
\&. |
\&. |
|
\&.\e\*q .SH IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH RETURN VALUES |
\&.\e\*q .SH RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH ENVIRONMENT |
\&.\e\*q .SH FILES |
\&.\e\*q .SH FILES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
\&.\e\*q .SH EXAMPLES |
\&.\e\*q .SH EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
\&.\e\*q .SH DIAGNOSTICS |
\&.\e\*q .SH DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH ERRORS |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q .SH SEE ALSO |
\&.\e\*q \efBbar\efR(1) |
\&.\e\*q .BR foo ( 1 ) |
\&.\e\*q .SH STANDARDS |
\&.\e\*q .SH STANDARDS |
\&.\e\*q .SH HISTORY |
\&.\e\*q .SH HISTORY |
\&.\e\*q .SH AUTHORS |
\&.\e\*q .SH AUTHORS |
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH CAVEATS |
\&.\e\*q .SH BUGS |
\&.\e\*q .SH BUGS |
. Ed |
\&.\e\*q .SH SECURITY CONSIDERATIONS |
. |
.Ed |
. |
.Pp |
|
The sections in a |
|
.Nm |
|
document are conventionally ordered as they appear above. |
|
Sections should be composed as follows: |
|
.Bl -ohang -offset indent |
|
.It Em NAME |
|
The name(s) and a short description of the documented material. |
|
The syntax for this is generally as follows: |
|
.Pp |
|
.D1 \efBname\efR \e(en description |
|
.It Em LIBRARY |
|
The name of the library containing the documented material, which is |
|
assumed to be a function in a section 2 or 3 manual. |
|
For functions in the C library, this may be as follows: |
|
.Pp |
|
.D1 Standard C Library (libc, -lc) |
|
.It Em SYNOPSIS |
|
Documents the utility invocation syntax, function call syntax, or device |
|
configuration. |
|
.Pp |
|
For the first, utilities (sections 1, 6, and 8), this is |
|
generally structured as follows: |
|
.Pp |
|
.D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR... |
|
.Pp |
|
For the second, function calls (sections 2, 3, 9): |
|
.Pp |
|
.D1 \&.B char *name(char *\efIarg\efR); |
|
.Pp |
|
And for the third, configurations (section 4): |
|
.Pp |
|
.D1 \&.B name* at cardbus ? function ? |
|
.Pp |
|
Manuals not in these sections generally don't need a |
|
.Em SYNOPSIS . |
|
.It Em DESCRIPTION |
|
This expands upon the brief, one-line description in |
|
.Em NAME . |
|
It usually contains a break-down of the options (if documenting a |
|
command). |
|
.It Em IMPLEMENTATION NOTES |
|
Implementation-specific notes should be kept here. |
|
This is useful when implementing standard functions that may have side |
|
effects or notable algorithmic implications. |
|
.It Em RETURN VALUES |
|
This section is the dual of |
|
.Em EXIT STATUS , |
|
which is used for commands. |
|
It documents the return values of functions in sections 2, 3, and 9. |
|
.It Em ENVIRONMENT |
|
Documents any usages of environment variables, e.g., |
|
.Xr environ 7 . |
|
.It Em FILES |
|
Documents files used. |
|
It's helpful to document both the file and a short description of how |
|
the file is used (created, modified, etc.). |
|
.It Em EXIT STATUS |
|
Command exit status for section 1, 6, and 8 manuals. |
|
This section is the dual of |
|
.Em RETURN VALUES , |
|
which is used for functions. |
|
Historically, this information was described in |
|
.Em DIAGNOSTICS , |
|
a practise that is now discouraged. |
|
.It Em EXAMPLES |
|
Example usages. |
|
This often contains snippets of well-formed, |
|
well-tested invocations. |
|
Make doubly sure that your examples work properly! |
|
.It Em DIAGNOSTICS |
|
Documents error conditions. |
|
This is most useful in section 4 manuals. |
|
Historically, this section was used in place of |
|
.Em EXIT STATUS |
|
for manuals in sections 1, 6, and 8; however, this practise is |
|
discouraged. |
|
.It Em ERRORS |
|
Documents error handling in sections 2, 3, and 9. |
|
.It Em SEE ALSO |
|
References other manuals with related topics. |
|
This section should exist for most manuals. |
|
.Pp |
|
.D1 \&.BR bar \&( 1 \&), |
|
.Pp |
|
Cross-references should conventionally be ordered |
|
first by section, then alphabetically. |
|
.It Em STANDARDS |
|
References any standards implemented or used, such as |
|
.Pp |
|
.D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq) |
|
.Pp |
|
If not adhering to any standards, the |
|
.Em HISTORY |
|
section should be used. |
|
.It Em HISTORY |
|
The history of any manual without a |
|
.Em STANDARDS |
|
section should be described in this section. |
|
.It Em AUTHORS |
|
Credits to authors, if applicable, should appear in this section. |
|
Authors should generally be noted by both name and an e-mail address. |
|
.It Em CAVEATS |
|
Explanations of common misuses and misunderstandings should be explained |
|
in this section. |
|
.It Em BUGS |
|
Extant bugs should be described in this section. |
|
.It Em SECURITY CONSIDERATIONS |
|
Documents any security precautions that operators should consider. |
|
.El |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
Macros are one to three three characters in length and begin with a |
Macros are one to three three characters in length and begin with a |
control character , |
control character , |
. Sq \&. , |
.Sq \&. , |
at the beginning of the line. An arbitrary amount of whitespace may |
at the beginning of the line. |
sit between the control character and the macro name. Thus, |
|
. Sq .PP |
|
and |
|
. Sq \&.\ \ \ PP |
|
are equivalent. |
|
. Pp |
|
The |
The |
. Nm |
.Sq \(aq |
macros are classified by scope: line scope or block scope. Line |
macro control character is also accepted. |
macros are only scoped to the current line (and, in some situations, |
An arbitrary amount of whitespace (spaces or tabs) may sit between the |
the subsequent line). Block macros are scoped to the current line and |
control character and the macro name. |
subsequent lines until closed by another block macro. |
Thus, the following are equivalent: |
. |
.Bd -literal -offset indent |
. |
\&.PP |
. Ss Line Macros |
\&.\ \ \ PP |
|
.Ed |
|
.Pp |
|
The |
|
.Nm |
|
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. |
|
.Ss Line Macros |
Line macros are generally scoped to the current line, with the body |
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 |
consisting of zero or more arguments. |
line and the line arguments are empty, the next line is used instead, |
If a macro is scoped to the next line and the line arguments are empty, |
else the general syntax is used. Thus: |
the next line, which must be text, is used instead. |
. Bd -literal -offset indent |
Thus: |
|
.Bd -literal -offset indent |
\&.I |
\&.I |
foo |
foo |
. Ed |
.Ed |
. Pp |
.Pp |
is equivalent to |
is equivalent to |
. Sq \&.I foo . |
.Sq \&.I foo . |
.\" PARAGRAPH |
If next-line macros are invoked consecutively, only the last is used. |
Consecutive next-line scope invocations are disallowed. |
If a next-line macro is followed by a non-next-line macro, an error is |
. Bd -literal -offset indent |
raised (unless in the case of |
|
.Sx \&br , |
|
.Sx \&sp , |
|
or |
|
.Sx \&na ) . |
|
.Pp |
|
The syntax is as follows: |
|
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
. Ed |
.Ed |
. Pp |
.Pp |
It is considered an error when next-line scope is open at the end of |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
file. |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
. Pp |
.It Sx \&B Ta n Ta next-line Ta \& |
. Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
.It Sx \&BI Ta n Ta current Ta \& |
. It Em Macro Ta Em Arguments Ta Em Scope |
.It Sx \&BR Ta n Ta current Ta \& |
. It B Ta n Ta next-line |
.It Sx \&DT Ta 0 Ta current Ta \& |
. It BI Ta n Ta current |
.It Sx \&I Ta n Ta next-line Ta \& |
. It BR Ta n Ta current |
.It Sx \&IB Ta n Ta current Ta \& |
. It I Ta n Ta next-line |
.It Sx \&IR Ta n Ta current Ta \& |
. It IB Ta n Ta current |
.\" .It Sx \&PD Ta n Ta current Ta compat |
. It IR Ta n Ta current |
.It Sx \&R Ta n Ta next-line Ta \& |
. It R Ta n Ta next-line |
.It Sx \&RB Ta n Ta current Ta \& |
. It RB Ta n Ta current |
.It Sx \&RI Ta n Ta current Ta \& |
. It RI Ta n Ta current |
.It Sx \&SB Ta n Ta next-line Ta \& |
. It SB Ta n Ta next-line |
.It Sx \&SM Ta n Ta next-line Ta \& |
. It SM Ta n Ta next-line |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
. It TH Ta >1, <6 Ta current |
.\" .It Sx \&UC Ta n Ta current Ta compat |
. It br Ta 0 Ta current |
.It Sx \&br Ta 0 Ta current Ta compat |
. It fi Ta 0 Ta current |
.It Sx \&fi Ta 0 Ta current Ta compat |
. It i Ta n Ta current |
.It Sx \&i Ta n Ta current Ta compat |
. It na Ta 0 Ta current |
.It Sx \&na Ta 0 Ta current Ta compat |
. It nf Ta 0 Ta current |
.It Sx \&nf Ta 0 Ta current Ta compat |
. It r Ta 0 Ta current |
.It Sx \&r Ta 0 Ta current Ta compat |
. It sp Ta 1 Ta current |
.It Sx \&sp Ta 1 Ta current Ta compat |
. El |
.\" .It Sx \&Sp Ta 0 Ta current Ta compat |
. Pp |
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
The lower-case |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
. Sq br , |
.El |
. Sq fi , |
.Pp |
. Sq i , |
Macros marked as |
. Sq na , |
.Qq compat |
. Sq nf , |
are included for compatibility with the significant corpus of existing |
. Sq r , |
manuals that mix dialects of roff. |
and |
These macros should not be used for portable |
. Sq sp |
.Nm |
macros aren't historically part of |
manuals. |
. Nm |
.Ss Block Macros |
and should not be used. They're included for compatibility. |
Block macros are comprised of a head and body. |
. |
Like for in-line macros, the head is scoped to the current line and, in |
. |
one circumstance, the next line (the next-line stipulations as in |
. Ss Block Macros |
.Sx Line Macros |
Block macros are comprised of a head and body. Like for in-line macros, |
apply here as well). |
the head is scoped to the current line and, in one circumstance, the |
.Pp |
next line; the body is scoped to subsequent lines and is closed out by a |
The syntax is as follows: |
subsequent block macro invocation. |
.Bd -literal -offset indent |
. Bd -literal -offset indent |
|
\&.YO \(lBhead...\(rB |
\&.YO \(lBhead...\(rB |
\(lBhead...\(rB |
\(lBhead...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
. Ed |
.Ed |
. Pp |
.Pp |
The closure of body scope may be to the section, where a macro is closed |
The closure of body scope may be to the section, where a macro is closed |
by |
by |
. Sq SH ; |
.Sx \&SH ; |
sub-section, closed by a section or |
sub-section, closed by a section or |
. Sq SS ; |
.Sx \&SS ; |
part, closed by a section, sub-section, or |
part, closed by a section, sub-section, or |
. Sq RE ; |
.Sx \&RE ; |
or paragraph, closed by a section, sub-section, part, |
or paragraph, closed by a section, sub-section, part, |
. Sq HP , |
.Sx \&HP , |
. Sq IP , |
.Sx \&IP , |
. Sq LP , |
.Sx \&LP , |
. Sq P , |
.Sx \&P , |
. Sq PP , |
.Sx \&PP , |
or |
or |
. Sq TP . |
.Sx \&TP . |
No closure refers to an explicit block closing macro. |
No closure refers to an explicit block closing macro. |
. Pp |
.Pp |
It is considered an error when part or next-line scope is open at the |
As a rule, block macros may not be nested; thus, calling a block macro |
end of file. |
while another block macro scope is open, and the open scope is not |
. Pp |
implicitly closed, is syntactically incorrect. |
. Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.Pp |
. It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
. It HP Ta <2 Ta current Ta paragraph |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
. It IP Ta <3 Ta current Ta paragraph |
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
. It LP Ta 0 Ta current Ta paragraph |
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
. It P Ta 0 Ta current Ta paragraph |
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
. It PP Ta 0 Ta current Ta paragraph |
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
. It RE Ta 0 Ta current Ta none |
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
. It RS Ta 1 Ta current Ta part |
.It Sx \&RE Ta 0 Ta current Ta none Ta compat |
. It SH Ta >0 Ta current Ta section |
.It Sx \&RS Ta 1 Ta current Ta part Ta compat |
. It SS Ta >0 Ta current Ta sub-section |
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
. It TP Ta n Ta next-line Ta paragraph |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
. El |
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
. Pp |
.El |
|
.Pp |
|
Macros marked |
|
.Qq compat |
|
are as mentioned in |
|
.Sx Line Macros . |
|
.Pp |
If a block macro is next-line scoped, it may only be followed by in-line |
If a block macro is next-line scoped, it may only be followed by in-line |
macros (excluding |
macros for decorating text. |
. Sq br , |
|
. Sq na , |
|
. Sq sp , |
|
. Sq nf , |
|
. Sq fi , |
|
and |
|
. Sq TH ) . |
|
. |
|
. |
|
.Sh REFERENCE |
.Sh REFERENCE |
This section is a canonical reference to all macros, arranged |
This section is a canonical reference to all macros, arranged |
alphabetically. For the scoping of individual macros, see |
alphabetically. |
. Sx MACRO SYNTAX . |
For the scoping of individual macros, see |
. |
.Sx MACRO SYNTAX . |
. |
.Ss \&B |
. Ss Definitions |
|
In this reference, a numerical width may be either a standalone natural |
|
number (such as 3, 4, 10, etc.) or a natural number followed by a width |
|
multiplier |
|
. Qq n , |
|
corresponding to the width of the formatted letter n, or |
|
. Qq m , |
|
corresponding to the width of the formatted letter m. The latter is the |
|
default, if unspecified. Thus, |
|
. Bd -literal -offset indent |
|
\&.HP 12n |
|
. Ed |
|
. Pp |
|
indicates an offset of 12 |
|
. Qq n |
|
. Ns -sized |
|
letters. |
|
. |
|
. |
|
. Ss Macro Reference |
|
. Bl -tag -width Ds |
|
. It B |
|
Text is rendered in bold face. |
Text is rendered in bold face. |
. It BI |
.Pp |
Text is rendered alternately in bold face and italic. Thus, |
See also |
. Sq .BI this word and that |
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
.Ss \&BI |
|
Text is rendered alternately in bold face and italic. |
|
Thus, |
|
.Sq .BI this word and that |
causes |
causes |
. Sq this |
.Sq this |
and |
and |
. Sq and |
.Sq and |
to render in bold face, while |
to render in bold face, while |
. Sq word |
.Sq word |
and |
and |
. Sq that |
.Sq that |
render in italics. Whitespace between arguments is omitted in output. |
render in italics. |
. It BR |
Whitespace between arguments is omitted in output. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.BI bold italic bold italic |
|
.Pp |
|
The output of this example will be emboldened |
|
.Dq bold |
|
and italicised |
|
.Dq italic , |
|
with spaces stripped between arguments. |
|
.Pp |
|
See also |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&BR |
Text is rendered alternately in bold face and roman (the default font). |
Text is rendered alternately in bold face and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
. It HP |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&RB , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&DT |
|
Has no effect. |
|
Included for compatibility. |
|
.Ss \&HP |
Begin a paragraph whose initial output line is left-justified, but |
Begin a paragraph whose initial output line is left-justified, but |
subsequent output lines are indented, with the following syntax: |
subsequent output lines are indented, with the following syntax: |
. Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.HP [width] |
.Pf \. Sx \&HP |
. Ed |
.Op Cm width |
. Pp |
.Ed |
If |
.Pp |
. Va width |
The |
is specified, it's saved for later paragraph left-margins; if |
.Cm width |
unspecified, the saved or default width is used. |
argument must conform to |
. It I |
.Sx Scaling Widths . |
|
If specified, it's saved for later paragraph left-margins; if unspecified, the |
|
saved or default width is used. |
|
.Pp |
|
See also |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&I |
Text is rendered in italics. |
Text is rendered in italics. |
. It IB |
.Pp |
|
See also |
|
.Sx \&B , |
|
.Sx \&R , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
.Ss \&IB |
Text is rendered alternately in italics and bold face. Whitespace |
Text is rendered alternately in italics and bold face. Whitespace |
between arguments is omitted in output. |
between arguments is omitted in output. |
. It IP |
.Pp |
Begin a paragraph with the following syntax: |
See |
. Bd -literal -offset indent |
.Sx \&BI |
\&.IP [head [width]] |
for an equivalent example. |
. Ed |
.Pp |
. Pp |
See also |
This follows the behaviour of the |
.Sx \&BI , |
. Sq TP |
.Sx \&BR , |
except for the macro syntax (all arguments on the line, instead of |
.Sx \&RB , |
having next-line scope). If |
.Sx \&RI , |
. Va width |
and |
is specified, it's saved for later paragraph left-margins; if |
.Sx \&IR . |
unspecified, the saved or default width is used. |
.Ss \&IP |
. It IR |
Begin an indented paragraph with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&IP |
|
.Op Cm head Op Cm width |
|
.Ed |
|
.Pp |
|
The |
|
.Cm width |
|
argument defines the width of the left margin and is defined by |
|
.Sx Scaling Widths , |
|
It's saved for later paragraph left-margins; if unspecified, the saved or |
|
default width is used. |
|
.Pp |
|
The |
|
.Cm head |
|
argument is used as a leading term, flushed to the left margin. |
|
This is useful for bulleted paragraphs and so on. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&IR |
Text is rendered alternately in italics and roman (the default font). |
Text is rendered alternately in italics and roman (the default font). |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
. It LP, P, PP |
.Pp |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
See |
subsequent paragraph, sub-section, section, or end of file. The saved |
.Sx \&BI |
paragraph left-margin width is re-set to the default. |
for an equivalent example. |
. It R |
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RB , |
|
and |
|
.Sx \&RI . |
|
.Ss \&LP |
|
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 re-set to the default. |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&P |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&PP , |
|
and |
|
.Sx \&TP . |
|
.Ss \&PP |
|
Synonym for |
|
.Sx \&LP . |
|
.Pp |
|
See also |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&TP . |
|
.Ss \&R |
Text is rendered in roman (the default font). |
Text is rendered in roman (the default font). |
. It RB |
.Pp |
|
See also |
|
.Sx \&I , |
|
.Sx \&B , |
|
.Sx \&b , |
|
.Sx \&i , |
|
and |
|
.Sx \&r . |
|
.Ss \&RB |
Text is rendered alternately in roman (the default font) and bold face. |
Text is rendered alternately in roman (the default font) and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
. It RE |
.Pp |
|
See |
|
.Sx \&BI |
|
for an equivalent example. |
|
.Pp |
|
See also |
|
.Sx \&BI , |
|
.Sx \&IB , |
|
.Sx \&BR , |
|
.Sx \&RI , |
|
and |
|
.Sx \&IR . |
|
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
. Sq RS . |
.Sx \&RS . |
. It RI |
.Ss \&RI |
Text is rendered alternately in roman (the default font) and italics. |
Text is rendered alternately in roman (the default font) and italics. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
. It RS |
.Pp |
Begin a part setting the left margin. The left margin controls the |
See |
offset, following an initial indentation, to un-indented text such as |
.Sx \&BI |
that of |
for an equivalent example. |
. Sq PP . |
.Pp |
The width may be specified as following: |
See also |
. Bd -literal -offset indent |
.Sx \&BI , |
\&.RS [width] |
.Sx \&IB , |
. Ed |
.Sx \&BR , |
. Pp |
.Sx \&RB , |
If |
and |
. Va width |
.Sx \&IR . |
is not specified, the saved or default width is used. |
.Ss \&RS |
. It SB |
Begin a part setting the left margin. |
|
The left margin controls the offset, following an initial indentation, |
|
to un-indented text such as that of |
|
.Sx \&PP . |
|
This has the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&Rs |
|
.Op Cm width |
|
.Ed |
|
.Pp |
|
The |
|
.Cm width |
|
argument must conform to |
|
.Sx Scaling Widths . |
|
If not specified, the saved or default width is used. |
|
.Ss \&SB |
Text is rendered in small size (one point smaller than the default font) |
Text is rendered in small size (one point smaller than the default font) |
bold face. |
bold face. |
. It SH |
.Ss \&SH |
Begin a section. The scope of a section is only closed by another |
Begin a section. |
section or the end of file. The paragraph left-margin width is re-set |
The scope of a section is only closed by another section or the end of |
to the default. |
file. |
. It SM |
The paragraph left-margin width is re-set to the default. |
|
.Ss \&SM |
Text is rendered in small size (one point smaller than the default |
Text is rendered in small size (one point smaller than the default |
font). |
font). |
. It SS |
.Ss \&SS |
Begin a sub-section. The scope of a sub-section is closed by a |
Begin a sub-section. |
subsequent sub-section, section, or end of file. The paragraph |
The scope of a sub-section is closed by a subsequent sub-section, |
left-margin width is re-set to the default. |
section, or end of file. |
. It TH |
The paragraph left-margin width is re-set to the default. |
|
.Ss \&TH |
Sets the title of the manual page with the following syntax: |
Sets the title of the manual page with the following syntax: |
. Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.TH title section [date [source [volume]]] |
.Pf \. Sx \&TH |
. Ed |
.Cm title section |
. Pp |
.Op Cm date Op Cm source Op Cm volume |
At least the |
.Ed |
. Va title |
.Pp |
and |
At least the upper-case document title |
. Va section |
.Cm title |
arguments must be provided. The |
and numeric manual section |
. Va date |
.Cm section |
argument should be formatted as |
arguments must be provided. |
. Qq %b [%d] %Y |
|
format, described in |
|
. Xr strptime 3 . |
|
The |
The |
. Va source |
.Cm date |
string specifies the organisation providing the utility. The |
argument should be formatted as described in |
. Va volume |
.Sx Dates : |
replaces the default rendered volume as dictated by the manual section. |
if it does not conform, the current date is used instead. |
. It TP |
The |
|
.Cm source |
|
string specifies the organisation providing the utility. |
|
The |
|
.Cm volume |
|
string replaces the default rendered volume, which is dictated by the |
|
manual section. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.D1 \&.TH CVS 5 "1992-02-12" GNU |
|
.Ss \&TP |
Begin a paragraph where the head, if exceeding the indentation width, is |
Begin a paragraph where the head, if exceeding the indentation width, is |
followed by a newline; if not, the body follows on the same line after a |
followed by a newline; if not, the body follows on the same line after a |
buffer to the indentation width. Subsequent output lines are indented. |
buffer to the indentation width. |
. Pp |
Subsequent output lines are indented. |
The indentation width may be set as follows: |
The syntax is as follows: |
. Bd -literal -offset indent |
.Bd -filled -offset indent |
\&.TP [width] |
.Pf \. Sx \&TP |
. Ed |
.Op Cm width |
. Pp |
.Ed |
Where |
.Pp |
. Va width |
The |
must be a properly-formed numeric width. If |
.Cm width |
. Va width |
argument must conform to |
is specified, it's saved for later paragraph left-margins; if |
.Sx Scaling Widths . |
|
If specified, it's saved for later paragraph left-margins; if |
unspecified, the saved or default width is used. |
unspecified, the saved or default width is used. |
. It br |
.Pp |
Breaks the current line. Consecutive invocations have no further effect. |
See also |
. It fi |
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
and |
|
.Sx \&PP . |
|
.\" . |
|
.\" . |
|
.\" .Ss \&PD |
|
.\" Has no effect. Included for compatibility. |
|
.\" . |
|
.\" . |
|
.\" .Ss \&UC |
|
.\" Has no effect. Included for compatibility. |
|
.Ss \&br |
|
Breaks the current line. |
|
Consecutive invocations have no further effect. |
|
.Pp |
|
See also |
|
.Sx \&sp . |
|
.Ss \&fi |
End literal mode begun by |
End literal mode begun by |
. Sq nf . |
.Sx \&nf . |
. It i |
.Ss \&i |
Italicise arguments. If no arguments are specified, all subsequent text |
Italicise arguments. |
is italicised. |
Synonym for |
. It na |
.Sx \&I . |
No alignment to the right margin. |
.Pp |
. It nf |
See also |
|
.Sx \&B , |
|
.Sx \&I , |
|
.Sx \&R . |
|
.Sx \&b , |
|
and |
|
.Sx \&r . |
|
.Ss \&na |
|
Don't align to the right margin. |
|
.Ss \&nf |
Begin literal mode: all subsequent free-form lines have their end of |
Begin literal mode: all subsequent free-form lines have their end of |
line boundaries preserved. May be ended by |
line boundaries preserved. |
. Sq fi . |
May be ended by |
. It r |
.Sx \&fi . |
|
.Ss \&r |
Fonts and styles (bold face, italics) reset to roman (default font). |
Fonts and styles (bold face, italics) reset to roman (default font). |
. It sp |
.Pp |
Insert n spaces, where n is the macro's positive numeric argument. If |
See also |
0, this is equivalent to the |
.Sx \&B , |
. Sq br |
.Sx \&I , |
|
.Sx \&R , |
|
.Sx \&b , |
|
and |
|
.Sx \&i . |
|
.Ss \&sp |
|
Insert vertical spaces into output with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&sp |
|
.Op Cm height |
|
.Ed |
|
.Pp |
|
Insert |
|
.Cm height |
|
spaces, which must conform to |
|
.Sx Scaling Widths . |
|
If 0, this is equivalent to the |
|
.Sx \&br |
macro. |
macro. |
. El |
Defaults to 1, if unspecified. |
. |
.Pp |
. |
See also |
|
.Sx \&br . |
|
.\" .Ss \&Sp |
|
.\" A synonym for |
|
.\" .Sx \&sp |
|
.\" .Cm 0.5v . |
|
.\" . |
|
.\" .Ss \&Vb |
|
.\" A synonym for |
|
.\" .Sx \&nf . |
|
.\" Accepts an argument (the height of the formatted space) which is |
|
.\" disregarded. |
|
.\" . |
|
.\" .Ss \&Ve |
|
.\" A synonym for |
|
.\" .Sx \&fi . |
|
.\" . |
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents compatibility with other roff implementations, at |
This section documents areas of questionable portability between |
this time limited to |
implementations of the |
. Xr groff 1 . |
.Nm |
. Bl -hyphen |
language. |
. It |
.Pp |
In quoted literals, groff allowed pair-wise double-quotes to produce a |
.Bl -dash -compact |
standalone double-quote in formatted output. This idiosyncratic |
.It |
behaviour is no longer applicable. |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
. It |
a standalone double-quote in formatted output. |
|
It is not known whether this behaviour is exhibited by other formatters. |
|
.It |
The |
The |
. Sq sp |
.Sx \&sp |
macro does not accept negative numbers. |
macro does not accept negative values in mandoc. |
. It |
In GNU troff, this would result in strange behaviour. |
Blocks of whitespace are stripped from both macro and free-form text |
.It |
lines (except when in literal mode), while groff would retain whitespace |
The |
in free-form text lines. |
.Sq \(aq |
. El |
macro control character, in GNU troff (and prior troffs) suppresses a |
. |
newline before macro output; in mandoc, it is an alias for the standard |
. |
.Sq \&. |
|
control character. |
|
.El |
.Sh SEE ALSO |
.Sh SEE ALSO |
. Xr mandoc 1 , |
.Xr mandoc 1 , |
. Xr mandoc_char 7 |
.Xr mandoc_char 7 |
. |
|
. |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
. Nm |
.Nm |
reference was written by |
reference was written by |
. An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@bsd.lv . |
. |
|
. |
|
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. Use |
Do not use this language. |
. Xr mdoc 7 , |
Use |
|
.Xr mdoc 7 , |
instead. |
instead. |
. |
|