version 1.61, 2010/04/05 07:25:23 |
version 1.62, 2010/04/13 05:26:49 |
|
|
.\" $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 |
Line 31 language was historically used to format |
|
Line 27 language was historically used to format |
|
.Ux |
.Ux |
manuals. This reference document describes its syntax, structure, and |
manuals. This reference document describes its syntax, structure, and |
usage. |
usage. |
. |
|
.Pp |
.Pp |
.Bf -emphasis |
.Bf -emphasis |
Do not use |
Do not use |
Line 41 to write your manuals. |
|
Line 36 to write your manuals. |
|
Use the |
Use the |
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
. |
|
.Pp |
.Pp |
An |
An |
.Nm |
.Nm |
|
|
\&.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. All manuals must have |
.Ux |
.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. |
. |
|
. |
|
.Ss Comments |
.Ss Comments |
Text following a |
Text following a |
.Sq \e\*" , |
.Sq \e\*" , |
Line 76 line. A macro line with only a control character and |
|
Line 65 line. A macro line with only a control character and |
|
.Sq \&.\e" , |
.Sq \&.\e" , |
is also ignored. Macro lines with only a control character and |
is also ignored. Macro lines with only a control character and |
optionally whitespace are stripped from input. |
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 |
Line 96 for a complete list. Examples include |
|
Line 83 for a complete list. Examples include |
|
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 |
|
|
and |
and |
.Sq \ef |
.Sq \ef |
attributes are forgotten when entering or exiting a macro block. |
attributes are forgotten when entering or exiting a macro block. |
. |
|
. |
|
.Ss Whitespace |
.Ss Whitespace |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
from input. These are later re-added, if applicable, by a front-end |
from input. These are later re-added, if applicable, by a front-end |
utility such as |
utility such as |
.Xr mandoc 1 . |
.Xr mandoc 1 . |
. |
|
. |
|
.Ss Dates |
.Ss Dates |
The |
The |
.Sx \&TH |
.Sx \&TH |
Line 157 macro is the only |
|
Line 138 macro is the only |
|
macro that requires a date. The form for this date is the ISO-8601 |
macro that requires a date. The form for this date is the ISO-8601 |
standard |
standard |
.Cm YYYY-MM-DD . |
.Cm YYYY-MM-DD . |
. |
|
. |
|
.Ss Scaling Widths |
.Ss Scaling Widths |
Many macros support scaled widths for their arguments, such as |
Many macros support scaled widths for their arguments, such as |
stipulating a two-inch paragraph indentation with the following: |
stipulating a two-inch paragraph indentation with the following: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.HP 2i |
\&.HP 2i |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
The syntax for scaled widths is |
The syntax for scaled widths is |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
.Sq Li [+-]?[0-9]*.[0-9]*[:unit:]? , |
where a decimal must be preceded or proceeded by at least one digit. |
where a decimal must be preceded or proceeded by at least one digit. |
Negative numbers, while accepted, are truncated to zero. The following |
Negative numbers, while accepted, are truncated to zero. The following |
scaling units are accepted: |
scaling units are accepted: |
. |
|
.Pp |
.Pp |
.Bl -tag -width Ds -offset indent -compact |
.Bl -tag -width Ds -offset indent -compact |
.It c |
.It c |
Line 211 Using anything other than |
|
Line 188 Using anything other than |
|
or |
or |
.Sq v |
.Sq v |
is necessarily non-portable across output media. |
is necessarily non-portable across output media. |
. |
|
.Pp |
.Pp |
If a scaling unit is not provided, the numerical value is interpreted |
If a scaling unit is not provided, the numerical value is interpreted |
under the default rules of |
under the default rules of |
Line 224 this differs from |
|
Line 200 this differs from |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
which, if a unit is not provided, will instead interpret the string as |
which, if a unit is not provided, will instead interpret the string as |
literal text. |
literal text. |
. |
|
. |
|
.Sh MANUAL STRUCTURE |
.Sh MANUAL STRUCTURE |
Each |
Each |
.Nm |
.Nm |
Line 234 document must contain contains at least the |
|
Line 208 document must contain contains at least the |
|
macro describing the document's section and title. It may occur |
macro describing the document's section and title. It may occur |
anywhere in the document, although conventionally, it appears as the |
anywhere in the document, although conventionally, it appears as the |
first macro. |
first macro. |
. |
|
.Pp |
.Pp |
Beyond |
Beyond |
.Sx \&TH , |
.Sx \&TH , |
Line 329 which is used for functions. Historically, this infor |
|
Line 302 which is used for functions. Historically, this infor |
|
described in |
described in |
.Em DIAGNOSTICS , |
.Em DIAGNOSTICS , |
a practise that is now discouraged. |
a practise that is now discouraged. |
. |
|
.It Em RETURN VALUES |
.It Em RETURN VALUES |
This section is the dual of |
This section is the dual of |
.Em EXIT STATUS , |
.Em EXIT STATUS , |
which is used for commands. It documents the return values of functions |
which is used for commands. It documents the return values of functions |
in sections 2, 3, and 9. |
in sections 2, 3, and 9. |
. |
|
.It Em ENVIRONMENT |
.It Em ENVIRONMENT |
Documents any usages of environment variables, e.g., |
Documents any usages of environment variables, e.g., |
.Xr environ 7 . |
.Xr environ 7 . |
. |
|
.It Em FILES |
.It Em FILES |
Documents files used. It's helpful to document both the file and a |
Documents files used. It's helpful to document both the file and a |
short description of how the file is used (created, modified, etc.). |
short description of how the file is used (created, modified, etc.). |
. |
|
.It Em EXAMPLES |
.It Em EXAMPLES |
Example usages. This often contains snippets of well-formed, |
Example usages. This often contains snippets of well-formed, |
well-tested invocations. Make doubly sure that your examples work |
well-tested invocations. Make doubly sure that your examples work |
properly! |
properly! |
. |
|
.It Em DIAGNOSTICS |
.It Em DIAGNOSTICS |
Documents error conditions. This is most useful in section 4 manuals. |
Documents error conditions. This is most useful in section 4 manuals. |
Historically, this section was used in place of |
Historically, this section was used in place of |
.Em EXIT STATUS |
.Em EXIT STATUS |
for manuals in sections 1, 6, and 8; however, this practise is |
for manuals in sections 1, 6, and 8; however, this practise is |
discouraged. |
discouraged. |
. |
|
.It Em ERRORS |
.It Em ERRORS |
Documents error handling in sections 2, 3, and 9. |
Documents error handling in sections 2, 3, and 9. |
. |
|
.It Em SEE ALSO |
.It Em SEE ALSO |
References other manuals with related topics. This section should exist |
References other manuals with related topics. This section should exist |
for most manuals. |
for most manuals. |
Line 367 for most manuals. |
|
Line 333 for most manuals. |
|
.Pp |
.Pp |
Cross-references should conventionally be ordered |
Cross-references should conventionally be ordered |
first by section, then alphabetically. |
first by section, then alphabetically. |
. |
|
.It Em STANDARDS |
.It Em STANDARDS |
References any standards implemented or used, such as |
References any standards implemented or used, such as |
.Pp |
.Pp |
Line 376 References any standards implemented or used, such as |
|
Line 341 References any standards implemented or used, such as |
|
If not adhering to any standards, the |
If not adhering to any standards, the |
.Em HISTORY |
.Em HISTORY |
section should be used. |
section should be used. |
. |
|
.It Em HISTORY |
.It Em HISTORY |
The history of any manual without a |
The history of any manual without a |
.Em STANDARDS |
.Em STANDARDS |
section should be described in this section. |
section should be described in this section. |
. |
|
.It Em AUTHORS |
.It Em AUTHORS |
Credits to authors, if applicable, should appear in this section. |
Credits to authors, if applicable, should appear in this section. |
Authors should generally be noted by both name and an e-mail address. |
Authors should generally be noted by both name and an e-mail address. |
. |
|
.It Em CAVEATS |
.It Em CAVEATS |
Explanations of common misuses and misunderstandings should be explained |
Explanations of common misuses and misunderstandings should be explained |
in this section. |
in this section. |
. |
|
.It Em BUGS |
.It Em BUGS |
Extant bugs should be described in this section. |
Extant bugs should be described in this section. |
. |
|
.It Em SECURITY CONSIDERATIONS |
.It Em SECURITY CONSIDERATIONS |
Documents any security precautions that operators should consider. |
Documents any security precautions that operators should consider. |
. |
|
.El |
.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 , |
Line 412 the macro name. Thus, the following are equivalent: |
|
Line 369 the macro name. Thus, the following are equivalent: |
|
\&.PP |
\&.PP |
\&.\ \ \ PP |
\&.\ \ \ PP |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
The |
The |
.Nm |
.Nm |
Line 420 macros are classified by scope: line scope or block sc |
|
Line 376 macros are classified by scope: line scope or block sc |
|
macros are only scoped to the current line (and, in some situations, |
macros are only scoped to the current line (and, in some situations, |
the subsequent line). Block macros are scoped to the current line and |
the subsequent line). Block macros are scoped to the current line and |
subsequent lines until closed by another block macro. |
subsequent lines until closed by another block macro. |
. |
|
. |
|
.Ss Line Macros |
.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. If a macro is scoped to the next |
Line 431 text, is used instead. Thus: |
|
Line 385 text, is used instead. Thus: |
|
\&.I |
\&.I |
foo |
foo |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.I foo . |
.Sq \&.I foo . |
Line 448 The syntax is as follows: |
|
Line 401 The syntax is as follows: |
|
\&.YO \(lBbody...\(rB |
\&.YO \(lBbody...\(rB |
\(lBbody...\(rB |
\(lBbody...\(rB |
.Ed |
.Ed |
. |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
Line 478 The syntax is as follows: |
|
Line 430 The syntax is as follows: |
|
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
.\" .It Sx \&Vb Ta <1 Ta current Ta compat |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.\" .It Sx \&Ve Ta 0 Ta current Ta compat |
.El |
.El |
. |
|
.Pp |
.Pp |
Macros marked as |
Macros marked as |
.Qq compat |
.Qq compat |
Line 487 manuals that mix dialects of roff. These macros shoul |
|
Line 438 manuals that mix dialects of roff. These macros shoul |
|
portable |
portable |
.Nm |
.Nm |
manuals. |
manuals. |
. |
|
. |
|
.Ss Block Macros |
.Ss Block Macros |
Block macros are comprised of a head and body. Like for in-line 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 |
the head is scoped to the current line and, in one circumstance, the |
Line 502 The syntax is as follows: |
|
Line 451 The syntax is as follows: |
|
\(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 |
Line 520 or paragraph, closed by a section, sub-section, part, |
|
Line 468 or paragraph, closed by a section, sub-section, part, |
|
or |
or |
.Sx \&TP . |
.Sx \&TP . |
No closure refers to an explicit block closing macro. |
No closure refers to an explicit block closing macro. |
. |
|
.Pp |
.Pp |
As a rule, block macros may not be nested; thus, calling a block 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 |
while another block macro scope is open, and the open scope is not |
implicitly closed, is syntactically incorrect. |
implicitly closed, is syntactically incorrect. |
. |
|
.Pp |
.Pp |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
.Bl -column -compact -offset indent "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
.It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope Ta Em Notes |
Line 541 implicitly closed, is syntactically incorrect. |
|
Line 487 implicitly closed, is syntactically incorrect. |
|
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.El |
.El |
.Pp |
.Pp |
. |
|
Macros marked |
Macros marked |
.Qq compat |
.Qq compat |
are as mentioned in |
are as mentioned in |
.Sx Line Macros . |
.Sx Line Macros . |
. |
|
.Pp |
.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 for decorating text. |
macros for decorating text. |
. |
|
. |
|
.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. For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
. |
|
. |
|
.Ss \&B |
.Ss \&B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.Pp |
.Pp |
|
|
.Sx \&i , |
.Sx \&i , |
and |
and |
.Sx \&r . |
.Sx \&r . |
. |
|
. |
|
.Ss \&BI |
.Ss \&BI |
Text is rendered alternately in bold face and italic. Thus, |
Text is rendered alternately in bold face and italic. Thus, |
.Sq .BI this word and that |
.Sq .BI this word and that |
|
|
.Sx \&RI , |
.Sx \&RI , |
and |
and |
.Sx \&IR . |
.Sx \&IR . |
. |
|
. |
|
.Ss \&BR |
.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. |
|
|
.Sx \&RI , |
.Sx \&RI , |
and |
and |
.Sx \&IR . |
.Sx \&IR . |
. |
|
. |
|
.Ss \&DT |
.Ss \&DT |
Has no effect. Included for compatibility. |
Has no effect. Included for compatibility. |
. |
|
. |
|
.Ss \&HP |
.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: |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
. |
|
. |
|
.Ss \&I |
.Ss \&I |
Text is rendered in italics. |
Text is rendered in italics. |
.Pp |
.Pp |
|
|
.Sx \&i , |
.Sx \&i , |
and |
and |
.Sx \&r . |
.Sx \&r . |
. |
|
. |
|
.Ss \&IB |
.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. |
|
|
.Sx \&RI , |
.Sx \&RI , |
and |
and |
.Sx \&IR . |
.Sx \&IR . |
. |
|
. |
|
.Ss \&IP |
.Ss \&IP |
Begin an indented paragraph with the following syntax: |
Begin an indented paragraph with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
. |
|
. |
|
.Ss \&IR |
.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. |
|
|
.Sx \&RB , |
.Sx \&RB , |
and |
and |
.Sx \&RI . |
.Sx \&RI . |
. |
|
. |
|
.Ss \&LP |
.Ss \&LP |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
Begin an undecorated paragraph. The scope of a paragraph is closed by a |
subsequent paragraph, sub-section, section, or end of file. The saved |
subsequent paragraph, sub-section, section, or end of file. The saved |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
. |
|
. |
|
.Ss \&P |
.Ss \&P |
Synonym for |
Synonym for |
.Sx \&LP . |
.Sx \&LP . |
|
|
.Sx \&PP , |
.Sx \&PP , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
. |
|
. |
|
.Ss \&PP |
.Ss \&PP |
Synonym for |
Synonym for |
.Sx \&LP . |
.Sx \&LP . |
|
|
.Sx \&P , |
.Sx \&P , |
and |
and |
.Sx \&TP . |
.Sx \&TP . |
. |
|
. |
|
.Ss \&R |
.Ss \&R |
Text is rendered in roman (the default font). |
Text is rendered in roman (the default font). |
.Pp |
.Pp |
|
|
.Sx \&i , |
.Sx \&i , |
and |
and |
.Sx \&r . |
.Sx \&r . |
. |
|
. |
|
.Ss \&RB |
.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. |
|
|
.Sx \&RI , |
.Sx \&RI , |
and |
and |
.Sx \&IR . |
.Sx \&IR . |
. |
|
. |
|
.Ss \&RE |
.Ss \&RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sx \&RS . |
.Sx \&RS . |
. |
|
. |
|
.Ss \&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. |
|
|
.Sx \&RB , |
.Sx \&RB , |
and |
and |
.Sx \&IR . |
.Sx \&IR . |
. |
|
. |
|
.Ss \&RS |
.Ss \&RS |
Begin a part setting the left margin. The left margin controls the |
Begin a part setting the left margin. The left margin controls the |
offset, following an initial indentation, to un-indented text such as |
offset, following an initial indentation, to un-indented text such as |
|
|
argument must conform to |
argument must conform to |
.Sx Scaling Widths . |
.Sx Scaling Widths . |
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
. |
|
. |
|
.Ss \&SB |
.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. |
. |
|
. |
|
.Ss \&SH |
.Ss \&SH |
Begin a section. The scope of a section is only closed by another |
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 |
section or the end of file. The paragraph left-margin width is re-set |
to the default. |
to the default. |
. |
|
. |
|
.Ss \&SM |
.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). |
. |
|
. |
|
.Ss \&SS |
.Ss \&SS |
Begin a sub-section. The scope of a sub-section is closed by a |
Begin a sub-section. The scope of a sub-section is closed by a |
subsequent sub-section, section, or end of file. The paragraph |
subsequent sub-section, section, or end of file. The paragraph |
left-margin width is re-set to the default. |
left-margin width is re-set to the default. |
. |
|
. |
|
.Ss \&TH |
.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 -filled -offset indent |
.Bd -filled -offset indent |
|
|
Examples: |
Examples: |
.Pp |
.Pp |
.D1 \&.TH CVS 5 "1992-02-12" GNU |
.D1 \&.TH CVS 5 "1992-02-12" GNU |
. |
|
. |
|
.Ss \&TP |
.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 |
|
|
.\" . |
.\" . |
.\" .Ss \&UC |
.\" .Ss \&UC |
.\" Has no effect. Included for compatibility. |
.\" Has no effect. Included for compatibility. |
. |
|
. |
|
.Ss \&br |
.Ss \&br |
Breaks the current line. Consecutive invocations have no further effect. |
Breaks the current line. Consecutive invocations have no further effect. |
.Pp |
.Pp |
See also |
See also |
.Sx \&sp . |
.Sx \&sp . |
. |
|
. |
|
.Ss \&fi |
.Ss \&fi |
End literal mode begun by |
End literal mode begun by |
.Sx \&nf . |
.Sx \&nf . |
. |
|
. |
|
.Ss \&i |
.Ss \&i |
Italicise arguments. Synonym for |
Italicise arguments. Synonym for |
.Sx \&I . |
.Sx \&I . |
|
|
.Sx \&b , |
.Sx \&b , |
and |
and |
.Sx \&r . |
.Sx \&r . |
. |
|
. |
|
.Ss \&na |
.Ss \&na |
Don't align to the right margin. |
Don't align to the right margin. |
. |
|
. |
|
.Ss \&nf |
.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. May be ended by |
.Sx \&fi . |
.Sx \&fi . |
. |
|
. |
|
.Ss \&r |
.Ss \&r |
Fonts and styles (bold face, italics) reset to roman (default font). |
Fonts and styles (bold face, italics) reset to roman (default font). |
.Pp |
.Pp |
|
|
.Sx \&b , |
.Sx \&b , |
and |
and |
.Sx \&i . |
.Sx \&i . |
. |
|
. |
|
.Ss \&sp |
.Ss \&sp |
Insert vertical spaces into output with the following syntax: |
Insert vertical spaces into output with the following syntax: |
.Bd -filled -offset indent |
.Bd -filled -offset indent |
Line 978 macro. Defaults to 1, if unspecified. |
|
Line 860 macro. Defaults to 1, if unspecified. |
|
.Pp |
.Pp |
See also |
See also |
.Sx \&br . |
.Sx \&br . |
. |
|
.\" .Ss \&Sp |
.\" .Ss \&Sp |
.\" A synonym for |
.\" A synonym for |
.\" .Sx \&sp |
.\" .Sx \&sp |
|
|
.\" A synonym for |
.\" A synonym for |
.\" .Sx \&fi . |
.\" .Sx \&fi . |
.\" . |
.\" . |
. |
|
.Sh COMPATIBILITY |
.Sh COMPATIBILITY |
This section documents areas of questionable portability between |
This section documents areas of questionable portability between |
implementations of the |
implementations of the |
.Nm |
.Nm |
language. |
language. |
. |
|
.Pp |
.Pp |
.Bl -dash -compact |
.Bl -dash -compact |
.It |
.It |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
In quoted literals, GNU troff allowed pair-wise double-quotes to produce |
a standalone double-quote in formatted output. It is not known whether |
a standalone double-quote in formatted output. It is not known whether |
this behaviour is exhibited by other formatters. |
this behaviour is exhibited by other formatters. |
. |
|
.It |
.It |
Blocks of whitespace are stripped from macro and free-form text lines |
Blocks of whitespace are stripped from macro and free-form text lines |
(except when in literal mode) in mandoc. This is not the case for GNU |
(except when in literal mode) in mandoc. This is not the case for GNU |
troff: for maximum portability, whitespace sensitive blocks should be |
troff: for maximum portability, whitespace sensitive blocks should be |
enclosed in literal contexts. |
enclosed in literal contexts. |
. |
|
.It |
.It |
The |
The |
.Sx \&sp |
.Sx \&sp |
macro does not accept negative values in mandoc. In GNU troff, this |
macro does not accept negative values in mandoc. In GNU troff, this |
would result in strange behaviour. |
would result in strange behaviour. |
. |
|
.It |
.It |
The |
The |
.Sq \(aq |
.Sq \(aq |
Line 1028 newline before macro output; in mandoc, it is an alias |
|
Line 904 newline before macro output; in mandoc, it is an alias |
|
.Sq \&. |
.Sq \&. |
control character. |
control character. |
.El |
.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. Use |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
instead. |
instead. |
. |
|