version 1.12, 2009/06/11 07:26:35 |
version 1.41, 2009/10/26 10:36:46 |
|
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MAN 7 |
.Dt MAN 7 |
.Os |
.Os |
.\" SECTION |
. |
|
. |
.Sh NAME |
.Sh NAME |
.Nm man |
.Nm man |
.Nd man language reference |
.Nd man language reference |
.\" SECTION |
. |
|
. |
.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 the syntax and structure of |
manuals. This reference document describes its syntax, structure, and |
this language. |
usage. |
|
. |
.Pp |
.Pp |
.Em \&Do not |
.Bf -emphasis |
use |
Do not use |
.Nm |
.Nm |
to write your manuals. Use the |
to write your manuals. |
|
.Ef |
|
Use the |
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
.\" PARAGRAPH |
. |
.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: |
|
|
\&.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 |
.\" SECTION |
. |
|
. |
.Sh INPUT ENCODING |
.Sh INPUT ENCODING |
.Nm |
.Nm |
documents may contain only graphable 7-bit ASCII characters and the |
documents may contain only graphable 7-bit ASCII characters, the |
space character |
space character, and the tabs character. All manuals must have |
.Sq \ . |
|
All manuals must have |
|
.Ux |
.Ux |
.Sq \en |
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 |
.Pp |
The |
The |
.Sq \ec |
.Sq \ec |
Line 69 escape is common in historical |
|
Line 74 escape is common in historical |
|
.Nm |
.Nm |
documents; if encountered at the end of a word, it ensures that the |
documents; if encountered at the end of a word, it ensures that the |
subsequent word isn't off-set by whitespace. |
subsequent word isn't off-set by whitespace. |
.\" SUB-SECTION |
. |
|
. |
|
.Ss Comments |
|
Text following a |
|
.Sq \e\*" , |
|
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, |
|
.Sq \&.\e" , |
|
is also ignored. Macro lines with only a control charater and |
|
optionally whitespace are stripped from input. |
|
. |
|
. |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special characters may occur in both macro and free-form lines. |
|
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. |
or a single one-character sequence. See |
|
.Xr mandoc_char 7 |
|
for a complete list. Examples include |
|
.Sq \e(em |
|
.Pq em-dash |
|
and |
|
.Sq \ee |
|
.Pq back-slash . |
|
. |
|
. |
|
.Ss Text Decoration |
|
Terms may be text-decorated using the |
|
.Sq \ef |
|
escape followed by an indicator: B (bold), I, (italic), or P and R |
|
(Roman, or reset). |
|
. |
|
. |
|
.Ss Whitespace |
|
Unless specifically escaped, consecutive blocks of whitespace are pruned |
|
from input. These are later re-added, if applicable, by a front-end |
|
utility such as |
|
.Xr mandoc 1 . |
|
. |
|
.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 |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
The syntax for scaled widths is |
.Sq \e* , |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
with the same combinations as described above. This form is deprecated. |
where a decimal must be preceded or proceeded by at least one digit. |
.\" SECTION |
Negative numbers, while accepted, are truncated to zero. The following |
.Sh STRUCTURE |
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. See |
|
.Sx COMPATIBILITY . |
|
. |
|
.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 |
|
Each |
|
.Nm |
|
document must contain contains at least the |
|
.Sx \&TH |
|
macro describing the document's section and title. It may occur |
|
anywhere in the document, although conventionally, it appears as the |
|
first macro. |
|
. |
|
.Pp |
|
Beyond |
|
.Sx \&TH , |
|
at least one macro or text node must appear in the document. Documents |
|
are generally structured as follows: |
|
.Bd -literal -offset indent |
|
\&.TH FOO 1 "13 Aug 2009" |
|
\&. |
|
\&.SH NAME |
|
\efBfoo\efR \e(en a description goes here |
|
\&.\e\*q The next is for sections 2 & 3 only. |
|
\&.\e\*q .SH LIBRARY |
|
\&. |
|
\&.SH SYNOPSIS |
|
\efBfoo\efR [\efB\e-options\efR] arguments... |
|
\&. |
|
\&.SH DESCRIPTION |
|
The \efBfoo\efR utility processes files... |
|
\&. |
|
\&.\e\*q .SH IMPLEMENTATION NOTES |
|
\&.\e\*q The next is for sections 1 & 8 only. |
|
\&.\e\*q .SH EXIT STATUS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .SH RETURN VALUES |
|
\&.\e\*q The next is for sections 1, 6, 7, & 8 only. |
|
\&.\e\*q .SH ENVIRONMENT |
|
\&.\e\*q .SH FILES |
|
\&.\e\*q .SH EXAMPLES |
|
\&.\e\*q The next is for sections 1, 4, 6, 7, & 8 only. |
|
\&.\e\*q .SH DIAGNOSTICS |
|
\&.\e\*q The next is for sections 2, 3, & 9 only. |
|
\&.\e\*q .SH ERRORS |
|
\&.\e\*q .SH SEE ALSO |
|
\&.\e\*q \efBbar\efR(1) |
|
\&.\e\*q .SH STANDARDS |
|
\&.\e\*q .SH HISTORY |
|
\&.\e\*q .SH AUTHORS |
|
\&.\e\*q .SH CAVEATS |
|
\&.\e\*q .SH BUGS |
|
\&.\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 -tag -width Ds -offset Ds |
|
.It 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 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 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 \. Ns Sx \&B No char *name(char *\efIarg\efR); |
|
.Pp |
|
And for the third, configurations (section 4): |
|
.Pp |
|
.D1 \. Ns Sx \&B No name* at cardbus ? function ? |
|
.Pp |
|
Manuals not in these sections generally don't need a SYNOPSIS. |
|
.It DESCRIPTION |
|
This expands upon the brief, one-line description in NAME. It usually |
|
contains a break-down of the options (if documenting a command). |
|
.It 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 EXIT STATUS |
|
.It RETURN VALUES |
|
.It ENVIRONMENT |
|
.It FILES |
|
.It EXAMPLES |
|
.It DIAGNOSTICS |
|
.It ERRORS |
|
.It SEE ALSO |
|
.It STANDARDS |
|
.It HISTORY |
|
.It AUTHORS |
|
.It CAVEATS |
|
.It BUGS |
|
.It SECURITY CONSIDERATIONS |
|
.El |
|
. |
|
. |
|
.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. An arbitrary amount of whitespace may |
sit between the control character and the macro name. Thus, |
sit between the control character and the macro name. Thus, the |
.Sq \&.PP |
following are equivalent: |
and |
|
.Sq \&.\ \ \ \&PP |
|
are equivalent. |
|
.Pp |
|
All |
|
.Nm |
|
macros follow the same structural rules: |
|
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
\&.PP |
|
\&.\ \ \ PP |
.Ed |
.Ed |
|
. |
.Pp |
.Pp |
The |
The |
.Dq body |
|
consists of zero or more arguments to the macro. |
|
.Pp |
|
.Nm |
.Nm |
has a primitive notion of multi-line scope for the following macros: |
macros are classified by scope: line scope or block scope. Line |
.Sq \&.TM , |
macros are only scoped to the current line (and, in some situations, |
.Sq \&.SM , |
the subsequent line). Block macros are scoped to the current line and |
.Sq \&.SB , |
subsequent lines until closed by another block macro. |
.Sq \&.BI , |
. |
.Sq \&.IB , |
. |
.Sq \&.BR , |
.Ss Line Macros |
.Sq \&.RB , |
Line macros are generally scoped to the current line, with the body |
.Sq \&.R , |
consisting of zero or more arguments. If a macro is scoped to the next |
.Sq \&.B , |
line and the line arguments are empty, the next line is used instead, |
.Sq \&.I , |
else the general syntax is used. Thus: |
.Sq \&.IR |
.Bd -literal -offset indent |
and |
\&.I |
.Sq \&.RI . |
|
When these macros are invoked without arguments, the subsequent line is |
|
considered a continuation of the macro. Thus: |
|
.Bd -literal -offset indent |
|
\&.RI |
|
foo |
foo |
.Ed |
.Ed |
|
. |
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.RI foo . |
.Sq \&.I foo . |
If two consecutive lines exhibit the latter behaviour, |
If next-line macros are invoked consecutively, only the last is used. |
an error is raised. Thus, the following is not acceptable: |
If a next-line macro is proceded by a block macro, it is ignored. |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.RI |
\&.YO \(lBbody...\(rB |
\&.I |
\(lBbody...\(rB |
Hello, world. |
|
.Ed |
.Ed |
|
. |
.Pp |
.Pp |
|
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" |
|
.It Em Macro Ta Em Arguments Ta Em Scope |
|
.It Sx \&B Ta n Ta next-line |
|
.It Sx \&BI Ta n Ta current |
|
.It Sx \&BR Ta n Ta current |
|
.It Sx \&DT Ta 0 Ta current |
|
.It Sx \&I Ta n Ta next-line |
|
.It Sx \&IB Ta n Ta current |
|
.It Sx \&IR Ta n Ta current |
|
.It Sx \&PD Ta n Ta current |
|
.It Sx \&R Ta n Ta next-line |
|
.It Sx \&RB Ta n Ta current |
|
.It Sx \&RI Ta n Ta current |
|
.It Sx \&SB Ta n Ta next-line |
|
.It Sx \&SM Ta n Ta next-line |
|
.It Sx \&TH Ta >1, <6 Ta current |
|
.It Sx \&UC Ta n Ta current |
|
.It Sx \&br Ta 0 Ta current |
|
.It Sx \&fi Ta 0 Ta current |
|
.It Sx \&i Ta n Ta current |
|
.It Sx \&na Ta 0 Ta current |
|
.It Sx \&nf Ta 0 Ta current |
|
.It Sx \&r Ta 0 Ta current |
|
.It Sx \&sp Ta 1 Ta current |
|
.El |
|
. |
|
.Pp |
The |
The |
.Sq \&.TP |
.Sx \&PD , |
macro is similar, but does not need an empty argument line to trigger |
.Sx \&RS , |
the behaviour. |
.Sx \&RE , |
.\" PARAGRAPH |
.Sx \&UC , |
.Sh MACROS |
.Sx \&br , |
This section contains a complete list of all |
.Sx \&fi , |
.Nm |
.Sx \&i , |
macros and corresponding number of arguments. |
.Sx \&na , |
|
.Sx \&nf , |
|
.Sx \&r , |
|
and |
|
.Sx \&sp |
|
macros should not be used. They're included for compatibility. |
|
. |
|
. |
|
.Ss Block Macros |
|
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 body is scoped to subsequent lines and is closed out by a |
|
subsequent block macro invocation. |
|
.Bd -literal -offset indent |
|
\&.YO \(lBhead...\(rB |
|
\(lBhead...\(rB |
|
\(lBbody...\(rB |
|
.Ed |
|
. |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
The closure of body scope may be to the section, where a macro is closed |
.It Em Macro Ta Em Arguments |
by |
.It \&.TH Ta >1, <6 |
.Sx \&SH ; |
.It \&.SH Ta >0 |
sub-section, closed by a section or |
.It \&.SS Ta >0 |
.Sx \&SS ; |
.It \&.TP Ta n |
part, closed by a section, sub-section, or |
.It \&.LP Ta 0 |
.Sx \&RE ; |
.It \&.PP Ta 0 |
or paragraph, closed by a section, sub-section, part, |
.It \&.P Ta 0 |
.Sx \&HP , |
.It \&.IP Ta <3 |
.Sx \&IP , |
.It \&.HP Ta <2 |
.Sx \&LP , |
.It \&.SM Ta n |
.Sx \&P , |
.It \&.SB Ta n |
.Sx \&PP , |
.It \&.BI Ta n |
or |
.It \&.IB Ta n |
.Sx \&TP . |
.It \&.BR Ta n |
No closure refers to an explicit block closing macro. |
.It \&.RB Ta n |
. |
.It \&.R Ta n |
.Pp |
.It \&.B Ta n |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" -compact -offset indent |
.It \&.I Ta n |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope |
.It \&.IR Ta n |
.It Sx \&HP Ta <2 Ta current Ta paragraph |
.It \&.RI Ta n |
.It Sx \&IP Ta <3 Ta current Ta paragraph |
|
.It Sx \&LP Ta 0 Ta current Ta paragraph |
|
.It Sx \&P Ta 0 Ta current Ta paragraph |
|
.It Sx \&PP Ta 0 Ta current Ta paragraph |
|
.It Sx \&RE Ta 0 Ta current Ta none |
|
.It Sx \&RS Ta 1 Ta current Ta part |
|
.It Sx \&SH Ta >0 Ta next-line Ta section |
|
.It Sx \&SS Ta >0 Ta next-line Ta sub-section |
|
.It Sx \&TP Ta n Ta next-line Ta paragraph |
.El |
.El |
|
. |
.Pp |
.Pp |
Although not historically part of the |
If a block macro is next-line scoped, it may only be followed by in-line |
.Nm |
macros (excluding |
system, the following macros are also supported: |
.Sx \&DT , |
|
.Sx \&PD , |
|
.Sx \&TH , |
|
.Sx \&UC , |
|
.Sx \&br , |
|
.Sx \&na , |
|
.Sx \&sp , |
|
.Sx \&nf , |
|
and |
|
.Sx \&fi ) . |
|
. |
|
. |
|
.Sh REFERENCE |
|
This section is a canonical reference to all macros, arranged |
|
alphabetically. For the scoping of individual macros, see |
|
.Sx MACRO SYNTAX . |
|
. |
|
.Ss \&B |
|
Text is rendered in bold face. |
|
.Ss \&BI |
|
Text is rendered alternately in bold face and italic. Thus, |
|
.Sq .BI this word and that |
|
causes |
|
.Sq this |
|
and |
|
.Sq and |
|
to render in bold face, while |
|
.Sq word |
|
and |
|
.Sq that |
|
render in italics. Whitespace between arguments is omitted in output. |
|
.Ss \&BR |
|
Text is rendered alternately in bold face and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
.Ss \&DT |
|
Has no effect. Included for compatibility. |
|
.Ss \&HP |
|
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented, with the following syntax: |
|
.Bd -literal -offset indent |
|
\&.HP [width] |
|
.Ed |
|
. |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
If scaling width |
.It Em Macro Ta Em Arguments |
.Va width |
.It \&.br Ta 0 |
is specified, it's saved for later paragraph left-margins; if |
.It \&.i Ta n |
unspecified, the saved or default width is used. |
.El |
.Ss \&I |
|
Text is rendered in italics. |
|
.Ss \&IB |
|
Text is rendered alternately in italics and bold face. Whitespace |
|
between arguments is omitted in output. |
|
.Ss \&IP |
|
Begin a paragraph with the following syntax: |
|
.Bd -literal -offset indent |
|
\&.IP [head [width]] |
|
.Ed |
|
. |
.Pp |
.Pp |
These follow the same calling conventions as the above |
This follows the behaviour of the |
.Nm |
.Sx \&TP |
macros. |
except for the macro syntax (all arguments on the line, instead of |
.\" SECTION |
having next-line scope). If |
|
.Va width |
|
is specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
.Ss \&IR |
|
Text is rendered alternately in italics and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
.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. |
|
.Ss \&P |
|
Synonym for |
|
.Sx \&LP . |
|
.Ss \&PP |
|
Synonym for |
|
.Sx \&LP . |
|
.Ss \&R |
|
Text is rendered in roman (the default font). |
|
.Ss \&RB |
|
Text is rendered alternately in roman (the default font) and bold face. |
|
Whitespace between arguments is omitted in output. |
|
.Ss \&RE |
|
Explicitly close out the scope of a prior |
|
.Sx \&RS . |
|
.Ss \&RI |
|
Text is rendered alternately in roman (the default font) and italics. |
|
Whitespace between arguments is omitted in output. |
|
.Ss \&RS |
|
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 . |
|
A scaling width may be specified as following: |
|
.Bd -literal -offset indent |
|
\&.RS [width] |
|
.Ed |
|
. |
|
.Pp |
|
If |
|
.Va width |
|
is not specified, the saved or default width is used. |
|
.Ss \&SB |
|
Text is rendered in small size (one point smaller than the default font) |
|
bold face. |
|
.Ss \&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 re-set |
|
to the default. |
|
.Ss \&SM |
|
Text is rendered in small size (one point smaller than the default |
|
font). |
|
.Ss \&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 re-set to the default. |
|
.Ss \&TH |
|
Sets the title of the manual page with the following syntax: |
|
.Bd -literal -offset indent |
|
\&.TH title section [date [source [volume]]] |
|
.Ed |
|
. |
|
.Pp |
|
At least the |
|
.Va title |
|
and |
|
.Va section |
|
arguments must be provided. The |
|
.Va date |
|
argument should be formatted as |
|
.Qq %b [%d] %Y |
|
format, described in |
|
.Xr strptime 3 . |
|
The |
|
.Va source |
|
string specifies the organisation providing the utility. The |
|
.Va volume |
|
replaces the default rendered volume as dictated by the manual section. |
|
.Ss \&TP |
|
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 |
|
buffer to the indentation width. Subsequent output lines are indented. |
|
. |
|
.Pp |
|
The indentation scaling width may be set as follows: |
|
.Bd -literal -offset indent |
|
\&.TP [width] |
|
.Ed |
|
. |
|
.Pp |
|
If |
|
.Va width |
|
is specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
.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. |
|
.Ss \&fi |
|
End literal mode begun by |
|
.Sx \&nf . |
|
.Ss \&i |
|
Italicise arguments. If no arguments are specified, all subsequent text |
|
is italicised. |
|
.Ss \&na |
|
Don't align to the right margin. |
|
.Ss \&nf |
|
Begin literal mode: all subsequent free-form lines have their end of |
|
line boundaries preserved. May be ended by |
|
.Sx \&fi . |
|
.Ss \&r |
|
Fonts and styles (bold face, italics) reset to roman (default font). |
|
.Ss \&sp |
|
Insert n spaces, where n is the macro's positive numeric argument. If |
|
0, this is equivalent to the |
|
.Sx \&br |
|
macro. |
|
. |
|
. |
|
.Sh COMPATIBILITY |
|
This section documents compatibility with other roff implementations, at |
|
this time limited to |
|
.Xr groff 1 . |
|
.Bl -hyphen |
|
.It |
|
In quoted literals, groff allowed pair-wise double-quotes to produce a |
|
standalone double-quote in formatted output. This idiosyncratic |
|
behaviour is no longer applicable. |
|
.It |
|
The |
|
.Sq sp |
|
macro does not accept negative numbers. |
|
.It |
|
Blocks of whitespace are stripped from both macro and free-form text |
|
lines (except when in literal mode), while groff would retain whitespace |
|
in free-form text lines. |
|
.El |
|
. |
|
. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr mandoc_char 7 |
.\" SECTION |
. |
|
. |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
reference was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
. |
|
. |
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. Use |
Do not use this language. Use |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
instead. |
instead. |
|
. |