version 1.142, 2019/01/01 03:45:29 |
version 1.145, 2020/02/18 17:31:28 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
.\" Copyright (c) 2011-2015,2017,2018,2019 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org> |
.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> |
.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> |
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
.\" |
.\" |
Line 72 comments, escape sequences, whitespace, and quoting. |
|
Line 72 comments, escape sequences, whitespace, and quoting. |
|
Each |
Each |
.Nm |
.Nm |
document starts with the |
document starts with the |
.Sx \&TH |
.Ic TH |
macro specifying the document's name and section, followed by the |
macro specifying the document's name and section, followed by the |
.Sx NAME |
.Sx NAME |
section formatted as follows: |
section formatted as follows: |
Line 88 Deprecated and non-portable macros are not included in |
|
Line 88 Deprecated and non-portable macros are not included in |
|
but can be found in the alphabetical reference below. |
but can be found in the alphabetical reference below. |
.Ss Page header and footer meta-data |
.Ss Page header and footer meta-data |
.Bl -column "RS, RE" description |
.Bl -column "RS, RE" description |
.It Sx TH Ta set the title: Ar name section date Op Ar source Op Ar volume |
.It Ic TH Ta set the title: Ar name section date Op Ar source Op Ar volume |
.It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument) |
.It Ic AT Ta display AT&T UNIX version in the page footer (<= 1 argument) |
.It Sx UC Ta display BSD version in the page footer (<= 1 argument) |
.It Ic UC Ta display BSD version in the page footer (<= 1 argument) |
.El |
.El |
.Ss Sections and paragraphs |
.Ss Sections and paragraphs |
.Bl -column "RS, RE" description |
.Bl -column "RS, RE" description |
.It Sx SH Ta section header (one line) |
.It Ic SH Ta section header (one line) |
.It Sx SS Ta subsection header (one line) |
.It Ic SS Ta subsection header (one line) |
.It Sx PP Ta start an undecorated paragraph (no arguments) |
.It Ic PP Ta start an undecorated paragraph (no arguments) |
.It Sx RS , RE Ta reset the left margin: Op Ar width |
.It Ic RS , RE Ta reset the left margin: Op Ar width |
.It Sx IP Ta indented paragraph: Op Ar head Op Ar width |
.It Ic IP Ta indented paragraph: Op Ar head Op Ar width |
.It Sx TP Ta tagged paragraph: Op Ar width |
.It Ic TP Ta tagged paragraph: Op Ar width |
.It Sx PD Ta set vertical paragraph distance: Op Ar height |
.It Ic PD Ta set vertical paragraph distance: Op Ar height |
.It Sx in Ta additional indent: Op Ar width |
.It Ic in Ta additional indent: Op Ar width |
.El |
.El |
.Ss Physical markup |
.Ss Physical markup |
.Bl -column "RS, RE" description |
.Bl -column "RS, RE" description |
.It Sx B Ta boldface font |
.It Ic B Ta boldface font |
.It Sx I Ta italic font |
.It Ic I Ta italic font |
.It Sx SB Ta small boldface font |
.It Ic SB Ta small boldface font |
.It Sx SM Ta small roman font |
.It Ic SM Ta small roman font |
.It Sx BI Ta alternate between boldface and italic fonts |
.It Ic BI Ta alternate between boldface and italic fonts |
.It Sx BR Ta alternate between boldface and roman fonts |
.It Ic BR Ta alternate between boldface and roman fonts |
.It Sx IB Ta alternate between italic and boldface fonts |
.It Ic IB Ta alternate between italic and boldface fonts |
.It Sx IR Ta alternate between italic and roman fonts |
.It Ic IR Ta alternate between italic and roman fonts |
.It Sx RB Ta alternate between roman and boldface fonts |
.It Ic RB Ta alternate between roman and boldface fonts |
.It Sx RI Ta alternate between roman and italic fonts |
.It Ic RI Ta alternate between roman and italic fonts |
.El |
.El |
.Sh MACRO REFERENCE |
.Sh MACRO REFERENCE |
This section is a canonical reference to all macros, arranged |
This section is a canonical reference to all macros, arranged |
alphabetically. |
alphabetically. |
For the scoping of individual macros, see |
For the scoping of individual macros, see |
.Sx MACRO SYNTAX . |
.Sx MACRO SYNTAX . |
.Ss \&AT |
.Bl -tag -width 3n |
|
.It Ic AT |
Sets the volume for the footer for compatibility with man pages from |
Sets the volume for the footer for compatibility with man pages from |
.At |
.At |
releases. |
releases. |
The optional arguments specify which release it is from. |
The optional arguments specify which release it is from. |
.Ss \&B |
This macro is an extension that first appeared in |
|
.Bx 4.3 . |
|
.It Ic B |
Text is rendered in bold face. |
Text is rendered in bold face. |
.Ss \&BI |
.It Ic BI |
Text is rendered alternately in bold face and italic. |
Text is rendered alternately in bold face and italic. |
Thus, |
Thus, |
.Sq .BI this word and that |
.Sq .BI this word and that |
Line 146 Whitespace between arguments is omitted in output. |
|
Line 149 Whitespace between arguments is omitted in output. |
|
Example: |
Example: |
.Pp |
.Pp |
.Dl \&.BI bold italic bold italic |
.Dl \&.BI bold italic bold italic |
.Ss \&BR |
.It Ic 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. |
See also |
See also |
.Sx \&BI . |
.Ic BI . |
.Ss \&DT |
.It Ic DT |
Restore the default tabulator positions. |
Restore the default tabulator positions. |
They are at intervals of 0.5 inches. |
They are at intervals of 0.5 inches. |
This has no effect unless the tabulator positions were changed with the |
This has no effect unless the tabulator positions were changed with the |
.Xr roff 7 |
.Xr roff 7 |
.Ic \&ta |
.Ic ta |
request. |
request. |
.Ss \&EE |
.It Ic EE |
This is a non-standard GNU extension. |
This is a non-standard Version 9 |
|
.At |
|
extension later adopted by GNU. |
In |
In |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
it does the same as the |
it does the same as the |
.Xr roff 7 |
.Xr roff 7 |
.Sx \&fi |
.Ic fi |
request (switch to fill mode). |
request (switch to fill mode). |
.Ss \&EX |
.It Ic EX |
This is a non-standard GNU extension. |
This is a non-standard Version 9 |
|
.At |
|
extension later adopted by GNU. |
In |
In |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
it does the same as the |
it does the same as the |
.Xr roff 7 |
.Xr roff 7 |
.Ic \&nf |
.Ic nf |
request (switch to no-fill mode). |
request (switch to no-fill mode). |
.Ss \&HP |
.It Ic 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 -filled -offset indent |
|
.Pf \. Sx \&HP |
|
.Op Ar width |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic HP Op Ar width |
|
.Pp |
The |
The |
.Ar width |
.Ar width |
argument is a |
argument is a |
Line 193 if unspecified, the saved or default width is used. |
|
Line 198 if unspecified, the saved or default width is used. |
|
This macro is portable, but deprecated |
This macro is portable, but deprecated |
because it has no good representation in HTML output, |
because it has no good representation in HTML output, |
usually ending up indistinguishable from |
usually ending up indistinguishable from |
.Sx \&PP . |
.Ic PP . |
.Ss \&I |
.It Ic I |
Text is rendered in italics. |
Text is rendered in italics. |
.Ss \&IB |
.It Ic IB |
Text is rendered alternately in italics and bold face. |
Text is rendered alternately in italics and bold face. |
Whitespace between arguments is omitted in output. |
Whitespace between arguments is omitted in output. |
See also |
See also |
.Sx \&BI . |
.Ic BI . |
.Ss \&IP |
.It Ic IP |
Begin an indented paragraph with the following syntax: |
Begin an indented paragraph with the following syntax: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&IP |
|
.Op Ar head Op Ar width |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic IP Op Ar head Op Ar width |
|
.Pp |
The |
The |
.Ar width |
.Ar width |
argument is a |
argument is a |
|
|
.Ar head |
.Ar head |
argument is used as a leading term, flushed to the left margin. |
argument is used as a leading term, flushed to the left margin. |
This is useful for bulleted paragraphs and so on. |
This is useful for bulleted paragraphs and so on. |
.Ss \&IR |
.It Ic 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. |
See also |
See also |
.Sx \&BI . |
.Ic BI . |
.Ss \&LP |
.It Ic LP |
A synonym for |
A synonym for |
.Sx \&PP . |
.Ic PP . |
.Ss \&ME |
.It Ic ME |
End a mailto block started with |
End a mailto block started with |
.Sx \&MT . |
.Ic MT . |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
.Ss \&MT |
.It Ic MT |
Begin a mailto block. |
Begin a mailto block. |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
It has the following syntax: |
It has the following syntax: |
.Bd -literal -offset indent |
.Bd -unfilled -offset indent |
.Pf \. Sx \&MT Ar address |
.Pf . Ic MT Ar address |
link description to be shown |
link description to be shown |
.Pf \. Sx ME |
.Pf . Ic ME |
.Ed |
.Ed |
.Ss \&OP |
.It Ic OP |
Optional command-line argument. |
Optional command-line argument. |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
It has the following syntax: |
It has the following syntax: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&OP |
|
.Ar key Op Ar value |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic OP Ar key Op Ar value |
|
.Pp |
The |
The |
.Ar key |
.Ar key |
is usually a command-line flag and |
is usually a command-line flag and |
.Ar value |
.Ar value |
its argument. |
its argument. |
.Ss \&P |
.It Ic P |
A synonym for |
This synonym for |
.Sx \&PP . |
.Ic PP |
.Ss \&PD |
is an |
|
.At III |
|
extension later adopted by |
|
.Bx 4.3 . |
|
.It Ic PD |
Specify the vertical space to be inserted before each new paragraph. |
Specify the vertical space to be inserted before each new paragraph. |
.br |
.br |
The syntax is as follows: |
The syntax is as follows: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&PD |
|
.Op Ar height |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic PD Op Ar height |
|
.Pp |
The |
The |
.Ar height |
.Ar height |
argument is a |
argument is a |
Line 279 If the unit is omitted, |
|
Line 282 If the unit is omitted, |
|
is assumed. |
is assumed. |
.Pp |
.Pp |
This macro affects the spacing before any subsequent instances of |
This macro affects the spacing before any subsequent instances of |
.Sx \&HP , |
.Ic HP , |
.Sx \&IP , |
.Ic IP , |
.Sx \&LP , |
.Ic LP , |
.Sx \&P , |
.Ic P , |
.Sx \&PP , |
.Ic PP , |
.Sx \&SH , |
.Ic SH , |
.Sx \&SS , |
.Ic SS , |
.Sx \&SY , |
.Ic SY , |
and |
and |
.Sx \&TP . |
.Ic TP . |
.Ss \&PP |
.It Ic PP |
Begin an undecorated paragraph. |
Begin an undecorated paragraph. |
The scope of a paragraph is closed by a subsequent paragraph, |
The scope of a paragraph is closed by a subsequent paragraph, |
sub-section, section, or end of file. |
sub-section, section, or end of file. |
The saved paragraph left-margin width is reset to the default. |
The saved paragraph left-margin width is reset to the default. |
.Ss \&RB |
.It Ic 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. |
See also |
See also |
.Sx \&BI . |
.Ic BI . |
.Ss \&RE |
.It Ic RE |
Explicitly close out the scope of a prior |
Explicitly close out the scope of a prior |
.Sx \&RS . |
.Ic RS . |
The default left margin is restored to the state before that |
The default left margin is restored to the state before that |
.Sx \&RS |
.Ic RS |
invocation. |
invocation. |
.Pp |
.Pp |
The syntax is as follows: |
The syntax is as follows: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&RE |
|
.Op Ar level |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic RE Op Ar level |
|
.Pp |
Without an argument, the most recent |
Without an argument, the most recent |
.Sx \&RS |
.Ic RS |
block is closed out. |
block is closed out. |
If |
If |
.Ar level |
.Ar level |
is 1, all open |
is 1, all open |
.Sx \&RS |
.Ic RS |
blocks are closed out. |
blocks are closed out. |
Otherwise, |
Otherwise, |
.Ar level No \(mi 1 |
.Ar level No \(mi 1 |
nested |
nested |
.Sx \&RS |
.Ic RS |
blocks remain open. |
blocks remain open. |
.Ss \&RI |
.It Ic 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. |
See also |
See also |
.Sx \&BI . |
.Ic BI . |
.Ss \&RS |
.It Ic RS |
Temporarily reset the default left margin. |
Temporarily reset the default left margin. |
This has the following syntax: |
This has the following syntax: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&RS |
|
.Op Ar width |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic RS Op Ar width |
|
.Pp |
The |
The |
.Ar width |
.Ar width |
argument is a |
argument is a |
|
|
If not specified, the saved or default width is used. |
If not specified, the saved or default width is used. |
.Pp |
.Pp |
See also |
See also |
.Sx \&RE . |
.Ic RE . |
.Ss \&SB |
.It Ic 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 |
This macro is an extension that probably first appeared in SunOS 4.0 |
|
and was later adopted by GNU and by |
|
.Bx 4.4 . |
|
.It Ic SH |
Begin a section. |
Begin a section. |
The scope of a section is only closed by another section or the end of |
The scope of a section is only closed by another section or the end of |
file. |
file. |
The paragraph left-margin width is reset to the default. |
The paragraph left-margin width is reset to the default. |
.Ss \&SM |
.It Ic 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 |
.It Ic SS |
Begin a sub-section. |
Begin a sub-section. |
The scope of a sub-section is closed by a subsequent sub-section, |
The scope of a sub-section is closed by a subsequent sub-section, |
section, or end of file. |
section, or end of file. |
The paragraph left-margin width is reset to the default. |
The paragraph left-margin width is reset to the default. |
.Ss \&SY |
.It Ic SY |
Begin a synopsis block with the following syntax: |
Begin a synopsis block with the following syntax: |
.Bd -unfilled -offset indent |
.Bd -unfilled -offset indent |
.Pf \. Sx \&SY Ar command |
.Pf . Ic SY Ar command |
.Ar arguments |
.Ar arguments |
.Pf \. Sx \&YS |
.Pf . Ic YS |
.Ed |
.Ed |
.Pp |
.Pp |
This is a non-standard GNU extension |
This is a non-standard GNU extension |
and very rarely used even in GNU manual pages. |
and very rarely used even in GNU manual pages. |
Formatting is similar to |
Formatting is similar to |
.Sx \&IP . |
.Ic IP . |
.Ss \&TH |
.It Ic TH |
Set the name of the manual page for use in the page header |
Set the name of the manual page for use in the page header |
and footer with the following syntax: |
and footer with the following syntax: |
.Bd -filled -offset indent |
|
.Pf \. Sx \&TH |
|
.Ar name section date |
|
.Op Ar source Op Ar volume |
|
.Ed |
|
.Pp |
.Pp |
|
.D1 Pf . Ic TH Ar name section date Op Ar source Op Ar volume |
|
.Pp |
Conventionally, the document |
Conventionally, the document |
.Ar name |
.Ar name |
is given in all caps. |
is given in all caps. |
Line 415 string replaces the default volume title of the |
|
Line 414 string replaces the default volume title of the |
|
Examples: |
Examples: |
.Pp |
.Pp |
.Dl \&.TH CVS 5 "1992-02-12" GNU |
.Dl \&.TH CVS 5 "1992-02-12" GNU |
.Ss \&TP |
.It Ic 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 |
followed by a newline; if not, the body follows on the same line after |
advancing to the indentation width. |
advancing to the indentation width. |
Subsequent output lines are indented. |
Subsequent output lines are indented. |
The syntax is as follows: |
The syntax is as follows: |
.Bd -unfilled -offset indent |
.Bd -unfilled -offset indent |
.Pf \. Sx \&TP Op Ar width |
.Pf . Ic TP Op Ar width |
.Ar head No \e" one line |
.Ar head No \e" one line |
.Ar body |
.Ar body |
.Ed |
.Ed |
|
|
scaling width. |
scaling width. |
If specified, it's saved for later paragraph left-margins; if |
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. |
.Ss \&TQ |
.It Ic TQ |
Like |
Like |
.Sx \&TP , |
.Ic TP , |
except that no vertical spacing is inserted before the paragraph. |
except that no vertical spacing is inserted before the paragraph. |
This is a non-standard GNU extension |
This is a non-standard GNU extension |
and very rarely used even in GNU manual pages. |
and very rarely used even in GNU manual pages. |
.Ss \&UC |
.It Ic UC |
Sets the volume for the footer for compatibility with man pages from |
Sets the volume for the footer for compatibility with man pages from |
.Bx |
.Bx |
releases. |
releases. |
The optional first argument specifies which release it is from. |
The optional first argument specifies which release it is from. |
.Ss \&UE |
This macro is an extension that first appeared in |
|
.Bx 3 . |
|
.It Ic UE |
End a uniform resource identifier block started with |
End a uniform resource identifier block started with |
.Sx \&UR . |
.Ic UR . |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
.Ss \&UR |
.It Ic UR |
Begin a uniform resource identifier block. |
Begin a uniform resource identifier block. |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
It has the following syntax: |
It has the following syntax: |
.Bd -literal -offset indent |
.Bd -unfilled -offset indent |
.Pf \. Sx \&UR Ar uri |
.Pf . Ic UR Ar uri |
link description to be shown |
link description to be shown |
.Pf \. Sx UE |
.Pf . Ic UE |
.Ed |
.Ed |
.Ss \&YS |
.It Ic YS |
End a synopsis block started with |
End a synopsis block started with |
.Sx \&SY . |
.Ic SY . |
This is a non-standard GNU extension. |
This is a non-standard GNU extension. |
.Ss \&in |
.It Ic in |
Indent relative to the current indentation: |
Indent relative to the current indentation: |
.Pp |
.Pp |
.D1 Pf \. Sx \&in Op Ar width |
.D1 Pf . Ic in Op Ar width |
.Pp |
.Pp |
If |
If |
.Ar width |
.Ar width |
is signed, the new offset is relative. |
is signed, the new offset is relative. |
Otherwise, it is absolute. |
Otherwise, it is absolute. |
This value is reset upon the next paragraph, section, or sub-section. |
This value is reset upon the next paragraph, section, or sub-section. |
|
.El |
.Sh MACRO SYNTAX |
.Sh MACRO SYNTAX |
The |
The |
.Nm |
.Nm |
|
|
.Ed |
.Ed |
.Pp |
.Pp |
is equivalent to |
is equivalent to |
.Sq \&.I foo . |
.Sq .I foo . |
If next-line macros are invoked consecutively, only the last is used. |
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 |
If a next-line macro is followed by a non-next-line macro, an error is |
raised. |
raised. |
Line 504 The syntax is as follows: |
|
Line 506 The syntax is as follows: |
|
.Ed |
.Ed |
.Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent |
.Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It Sx \&AT Ta <=1 Ta current Ta \& |
.It Ic AT Ta <=1 Ta current Ta \& |
.It Sx \&B Ta n Ta next-line Ta \& |
.It Ic B Ta n Ta next-line Ta \& |
.It Sx \&BI Ta n Ta current Ta \& |
.It Ic BI Ta n Ta current Ta \& |
.It Sx \&BR Ta n Ta current Ta \& |
.It Ic BR Ta n Ta current Ta \& |
.It Sx \&DT Ta 0 Ta current Ta \& |
.It Ic DT Ta 0 Ta current Ta \& |
.It Sx \&EE Ta 0 Ta current Ta GNU |
.It Ic EE Ta 0 Ta current Ta Version 9 At |
.It Sx \&EX Ta 0 Ta current Ta GNU |
.It Ic EX Ta 0 Ta current Ta Version 9 At |
.It Sx \&I Ta n Ta next-line Ta \& |
.It Ic I Ta n Ta next-line Ta \& |
.It Sx \&IB Ta n Ta current Ta \& |
.It Ic IB Ta n Ta current Ta \& |
.It Sx \&IR Ta n Ta current Ta \& |
.It Ic IR Ta n Ta current Ta \& |
.It Sx \&OP Ta >=1 Ta current Ta GNU |
.It Ic OP Ta >=1 Ta current Ta GNU |
.It Sx \&PD Ta 1 Ta current Ta \& |
.It Ic PD Ta 1 Ta current Ta \& |
.It Sx \&RB Ta n Ta current Ta \& |
.It Ic RB Ta n Ta current Ta \& |
.It Sx \&RI Ta n Ta current Ta \& |
.It Ic RI Ta n Ta current Ta \& |
.It Sx \&SB Ta n Ta next-line Ta \& |
.It Ic SB Ta n Ta next-line Ta \& |
.It Sx \&SM Ta n Ta next-line Ta \& |
.It Ic SM Ta n Ta next-line Ta \& |
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
.It Ic TH Ta >1, <6 Ta current Ta \& |
.It Sx \&UC Ta <=1 Ta current Ta \& |
.It Ic UC Ta <=1 Ta current Ta \& |
.It Sx \&in Ta 1 Ta current Ta Xr roff 7 |
.It Ic in Ta 1 Ta current Ta Xr roff 7 |
.El |
.El |
.Ss Block Macros |
.Ss Block Macros |
Block macros comprise a head and body. |
Block macros comprise a head and body. |
Line 540 The syntax is as follows: |
|
Line 542 The syntax is as follows: |
|
.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 |
.Sx \&SH ; |
.Ic SH ; |
sub-section, closed by a section or |
sub-section, closed by a section or |
.Sx \&SS ; |
.Ic SS ; |
or paragraph, closed by a section, sub-section, |
or paragraph, closed by a section, sub-section, |
.Sx \&HP , |
.Ic HP , |
.Sx \&IP , |
.Ic IP , |
.Sx \&LP , |
.Ic LP , |
.Sx \&P , |
.Ic P , |
.Sx \&PP , |
.Ic PP , |
.Sx \&RE , |
.Ic RE , |
.Sx \&SY , |
.Ic SY , |
or |
or |
.Sx \&TP . |
.Ic 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 |
Line 560 while another block macro scope is open, and the open |
|
Line 562 while another block macro scope is open, and the open |
|
implicitly closed, is syntactically incorrect. |
implicitly closed, is syntactically incorrect. |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent |
.Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent |
.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 |
.It Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
.It Ic HP Ta <2 Ta current Ta paragraph Ta \& |
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
.It Ic IP Ta <3 Ta current Ta paragraph Ta \& |
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
.It Ic LP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&ME Ta 0 Ta none Ta none Ta GNU |
.It Ic ME Ta 0 Ta none Ta none Ta GNU |
.It Sx \&MT Ta 1 Ta current Ta to \&ME Ta GNU |
.It Ic MT Ta 1 Ta current Ta to \&ME Ta GNU |
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
.It Ic P Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
.It Ic PP Ta 0 Ta current Ta paragraph Ta \& |
.It Sx \&RE Ta <=1 Ta current Ta none Ta \& |
.It Ic RE Ta <=1 Ta current Ta none Ta \& |
.It Sx \&RS Ta 1 Ta current Ta to \&RE Ta \& |
.It Ic RS Ta 1 Ta current Ta to \&RE Ta \& |
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
.It Ic SH Ta >0 Ta next-line Ta section Ta \& |
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
.It Ic SS Ta >0 Ta next-line Ta sub-section Ta \& |
.It Sx \&SY Ta 1 Ta current Ta to \&YS Ta GNU |
.It Ic SY Ta 1 Ta current Ta to \&YS Ta GNU |
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
.It Ic TP Ta n Ta next-line Ta paragraph Ta \& |
.It Sx \&TQ Ta n Ta next-line Ta paragraph Ta GNU |
.It Ic TQ Ta n Ta next-line Ta paragraph Ta GNU |
.It Sx \&UE Ta 0 Ta current Ta none Ta GNU |
.It Ic UE Ta 0 Ta current Ta none Ta GNU |
.It Sx \&UR Ta 1 Ta current Ta part Ta GNU |
.It Ic UR Ta 1 Ta current Ta part Ta GNU |
.It Sx \&YS Ta 0 Ta none Ta none Ta GNU |
.It Ic YS Ta 0 Ta none Ta none Ta GNU |
.El |
.El |
.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 |
Line 594 In text lines, the effect of manual font selection by |
|
Line 596 In text lines, the effect of manual font selection by |
|
only lasts until the next macro invocation; in macro lines, it only lasts |
only lasts until the next macro invocation; in macro lines, it only lasts |
until the end of the macro scope. |
until the end of the macro scope. |
Note that macros like |
Note that macros like |
.Sx \&BR |
.Ic BR |
open and close a font scope for each argument. |
open and close a font scope for each argument. |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr man 1 , |
.Xr man 1 , |