version 1.18, 2009/07/04 09:00:41 |
version 1.140, 2018/08/18 04:32:10 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> |
|
.\" Copyright (c) 2011-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org> |
|
.\" Copyright (c) 2017 Anthony Bentley <bentley@openbsd.org> |
|
.\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org> |
.\" |
.\" |
.\" 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 |
.\" SECTION |
|
.Sh NAME |
.Sh NAME |
.Nm man |
.Nm man |
.Nd man language reference |
.Nd legacy formatting language for manual pages |
.\" SECTION |
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm man |
.Nm man |
language was historically used to format |
language was the standard formatting language for |
.Ux |
.At |
manuals. This reference document describes the syntax and structure of |
manual pages from 1979 to 1989. |
this language. |
Do not use it to write new manual pages: it is a purely presentational |
.Pp |
language and lacks support for semantic markup. |
.Em \&Do not |
Use the |
use |
|
.Nm |
|
to write your manuals. Use the |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
language, instead. |
language, instead. |
.\" PARAGRAPH |
|
.Pp |
.Pp |
An |
In a |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document, lines beginning with the control character |
character |
|
.Sq \&. |
.Sq \&. |
are parsed for macros. Other lines are interpreted within the scope of |
are called |
prior macros: |
.Dq macro lines . |
|
The first word is the macro name. |
|
It usually consists of two capital letters. |
|
For a list of portable macros, see |
|
.Sx MACRO OVERVIEW . |
|
The words following the macro name are arguments to the macro. |
|
.Pp |
|
Lines not beginning with the control character are called |
|
.Dq text lines . |
|
They provide free-form text to be printed; the formatting of the text |
|
depends on the respective processing context: |
.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. |
Text lines are interpreted within the current state. |
.Ed |
.Ed |
.\" SECTION |
|
.Sh INPUT ENCODING |
|
.Nm |
|
documents may contain only graphable 7-bit ASCII characters, the |
|
space character |
|
.Sq \ , |
|
and tabs |
|
.Sq \et . |
|
All manuals must have |
|
.Ux |
|
.Sq \en |
|
line termination. |
|
.Pp |
.Pp |
Blank lines are acceptable; where found, the output will assert a |
Many aspects of the basic syntax of the |
vertical space. |
|
.Pp |
|
The |
|
.Sq \ec |
|
escape is common in historical |
|
.Nm |
.Nm |
documents; if encountered at the end of a word, it ensures that the |
language are based on the |
subsequent word isn't off-set by whitespace. |
.Xr roff 7 |
.\" SUB-SECTION |
language; see the |
.Ss Comments |
.Em LANGUAGE SYNTAX |
Anything following a |
and |
.Sq \e" |
.Em MACRO SYNTAX |
delimiter is considered a comment (unless the |
sections in the |
.Sq \e |
.Xr roff 7 |
itself has been escaped) and is ignored to the end of line. |
manual for details, in particular regarding |
Furthermore, a macro line with only a control character |
comments, escape sequences, whitespace, and quoting. |
.Sq \. , |
|
optionally followed by whitespace, is ignored. |
|
.\" SUB-SECTION |
|
.Ss Special Characters |
|
Special character sequences begin with the escape character |
|
.Sq \e |
|
followed by either an open-parenthesis |
|
.Sq \&( |
|
for two-character sequences; an open-bracket |
|
.Sq \&[ |
|
for n-character sequences (terminated at a close-bracket |
|
.Sq \&] ) ; |
|
or a single one-character sequence. |
|
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
|
.Sq \e* , |
|
with the same combinations as described above. |
|
.Pp |
|
Terms may also be text-decorated using the |
|
.Sq \ef |
|
escape followed by a text-decoration letter: B (bold), I, (italic), or P |
|
and R (Roman, or reset). |
|
.\" SUB-SECTION |
|
.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 . |
|
.\" SECTION |
|
.Sh STRUCTURE |
|
Each |
Each |
.Nm |
.Nm |
document must contain contains at least the |
document starts with the |
.Sq \&.TH |
.Sx \&TH |
macro describing the document's section and title. It may occur |
macro specifying the document's name and section, followed by the |
anywhere in the document, although conventionally, it appears as the |
.Sx NAME |
first macro. |
section formatted as follows: |
.Pp |
.Bd -literal -offset indent |
Beyond the |
\&.TH PROGNAME 1 1979-01-10 |
.Sq \&.TH , |
\&.SH NAME |
at least one macro or text node must appear in the document. |
\efBprogname\efR \e(en one line about what it does |
.\" SECTION |
.Ed |
.Sh SYNTAX |
.Sh MACRO OVERVIEW |
Macros are one to three three characters in length and begin with a |
This overview is sorted such that macros of similar purpose are listed |
control character , |
together. |
.Sq \&. , |
Deprecated and non-portable macros are not included in the overview, |
at the beginning of the line. An arbitrary amount of whitespace may |
but can be found in the alphabetical reference below. |
sit between the control character and the macro name. Thus, |
.Ss Page header and footer meta-data |
.Sq \&.PP |
.Bl -column "RS, RE" description |
|
.It Sx 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 Sx UC Ta display BSD version in the page footer (<= 1 argument) |
|
.El |
|
.Ss Sections and paragraphs |
|
.Bl -column "RS, RE" description |
|
.It Sx SH Ta section header (one line) |
|
.It Sx SS Ta subsection header (one line) |
|
.It Sx PP Ta start an undecorated paragraph (no arguments) |
|
.It Sx RS , RE Ta reset the left margin: Op Ar width |
|
.It Sx IP Ta indented paragraph: Op Ar head Op Ar width |
|
.It Sx TP Ta tagged paragraph: Op Ar width |
|
.It Sx HP Ta hanged paragraph: Op Ar width |
|
.It Sx PD Ta set vertical paragraph distance: Op Ar height |
|
.It Sx fi , nf Ta fill mode and no-fill mode (no arguments) |
|
.It Sx in Ta additional indent: Op Ar width |
|
.El |
|
.Ss Physical markup |
|
.Bl -column "RS, RE" description |
|
.It Sx B Ta boldface font |
|
.It Sx I Ta italic font |
|
.It Sx SB Ta small boldface font |
|
.It Sx SM Ta small roman font |
|
.It Sx BI Ta alternate between boldface and italic fonts |
|
.It Sx BR Ta alternate between boldface and roman fonts |
|
.It Sx IB Ta alternate between italic and boldface fonts |
|
.It Sx IR Ta alternate between italic and roman fonts |
|
.It Sx RB Ta alternate between roman and boldface fonts |
|
.It Sx RI Ta alternate between roman and italic fonts |
|
.El |
|
.Sh MACRO REFERENCE |
|
This section is a canonical reference to all macros, arranged |
|
alphabetically. |
|
For the scoping of individual macros, see |
|
.Sx MACRO SYNTAX . |
|
.Ss \&AT |
|
Sets the volume for the footer for compatibility with man pages from |
|
.At |
|
releases. |
|
The optional arguments specify which release it is from. |
|
.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 |
and |
.Sq \&.\ \ \ \&PP |
.Sq and |
are equivalent. |
to render in bold face, while |
|
.Sq word |
|
and |
|
.Sq that |
|
render in italics. |
|
Whitespace between arguments is omitted in output. |
.Pp |
.Pp |
All |
Example: |
.Nm |
.Pp |
macros follow the same structural rules: |
.Dl \&.BI bold italic bold italic |
|
.Ss \&BR |
|
Text is rendered alternately in bold face and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Sx \&BI . |
|
.Ss \&DT |
|
Restore the default tabulator positions. |
|
They are at intervals of 0.5 inches. |
|
This has no effect unless the tabulator positions were changed with the |
|
.Xr roff 7 |
|
.Ic \&ta |
|
request. |
|
.Ss \&EE |
|
This is a non-standard GNU extension. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as |
|
.Sx \&fi . |
|
.Ss \&EX |
|
This is a non-standard GNU extension. |
|
In |
|
.Xr mandoc 1 , |
|
it does the same as |
|
.Sx \&nf . |
|
.Ss \&HP |
|
Begin a paragraph whose initial output line is left-justified, but |
|
subsequent output lines are indented, with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&HP |
|
.Op Ar width |
|
.Ed |
|
.Pp |
|
The |
|
.Ar width |
|
argument is a |
|
.Xr roff 7 |
|
scaling width. |
|
If specified, it's saved for later paragraph left-margins; if unspecified, the |
|
saved or default width is used. |
|
.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. |
|
See also |
|
.Sx \&BI . |
|
.Ss \&IP |
|
Begin an indented paragraph with the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&IP |
|
.Op Ar head Op Ar width |
|
.Ed |
|
.Pp |
|
The |
|
.Ar width |
|
argument is a |
|
.Xr roff 7 |
|
scaling width defining the left margin. |
|
It's saved for later paragraph left-margins; if unspecified, the saved or |
|
default width is used. |
|
.Pp |
|
The |
|
.Ar head |
|
argument is used as a leading term, flushed to the left margin. |
|
This is useful for bulleted paragraphs and so on. |
|
.Ss \&IR |
|
Text is rendered alternately in italics and roman (the default font). |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Sx \&BI . |
|
.Ss \&LP |
|
A synonym for |
|
.Sx \&PP . |
|
.Ss \&ME |
|
End a mailto block started with |
|
.Sx \&MT . |
|
This is a non-standard GNU extension. |
|
.Ss \&MT |
|
Begin a mailto block. |
|
This is a non-standard GNU extension. |
|
It has the following syntax: |
.Bd -literal -offset indent |
.Bd -literal -offset indent |
\&.YO \(lBbody...\(rB |
.Pf \. Sx \&MT Ar address |
|
link description to be shown |
|
.Pf \. Sx ME |
.Ed |
.Ed |
|
.Ss \&OP |
|
Optional command-line argument. |
|
This is a non-standard GNU extension. |
|
It has the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&OP |
|
.Ar key Op Ar value |
|
.Ed |
.Pp |
.Pp |
The |
The |
.Dq body |
.Ar key |
consists of zero or more arguments to the macro. |
is usually a command-line flag and |
|
.Ar value |
|
its argument. |
|
.Ss \&P |
|
A synonym for |
|
.Sx \&PP . |
|
.Ss \&PD |
|
Specify the vertical space to be inserted before each new paragraph. |
|
.br |
|
The syntax is as follows: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&PD |
|
.Op Ar height |
|
.Ed |
.Pp |
.Pp |
.Nm |
The |
has a primitive notion of multi-line scope for the following macros: |
.Ar height |
.Sq \&.TM , |
argument is a |
.Sq \&.SM , |
.Xr roff 7 |
.Sq \&.SB , |
scaling width. |
.Sq \&.BI , |
It defaults to |
.Sq \&.IB , |
.Cm 1v . |
.Sq \&.BR , |
If the unit is omitted, |
.Sq \&.RB , |
.Cm v |
.Sq \&.R , |
is assumed. |
.Sq \&.B , |
.Pp |
.Sq \&.I , |
This macro affects the spacing before any subsequent instances of |
.Sq \&.IR |
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
.Sx \&SH , |
|
.Sx \&SS , |
|
.Sx \&SY , |
and |
and |
.Sq \&.RI . |
.Sx \&TP . |
When these macros are invoked without arguments, the subsequent line is |
.Ss \&PP |
considered a continuation of the macro. Thus: |
Begin an undecorated paragraph. |
.Bd -literal -offset indent |
The scope of a paragraph is closed by a subsequent paragraph, |
\&.RI |
sub-section, section, or end of file. |
foo |
The saved paragraph left-margin width is reset to the default. |
|
.Ss \&RB |
|
Text is rendered alternately in roman (the default font) and bold face. |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Sx \&BI . |
|
.Ss \&RE |
|
Explicitly close out the scope of a prior |
|
.Sx \&RS . |
|
The default left margin is restored to the state before that |
|
.Sx \&RS |
|
invocation. |
|
.Pp |
|
The syntax is as follows: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&RE |
|
.Op Ar level |
.Ed |
.Ed |
.Pp |
.Pp |
is equivalent to |
Without an argument, the most recent |
.Sq \&.RI foo . |
.Sx \&RS |
If two consecutive lines exhibit the latter behaviour, |
block is closed out. |
an error is raised. Thus, the following is not acceptable: |
If |
.Bd -literal -offset indent |
.Ar level |
\&.RI |
is 1, all open |
\&.I |
.Sx \&RS |
Hello, world. |
blocks are closed out. |
|
Otherwise, |
|
.Ar level No \(mi 1 |
|
nested |
|
.Sx \&RS |
|
blocks remain open. |
|
.Ss \&RI |
|
Text is rendered alternately in roman (the default font) and italics. |
|
Whitespace between arguments is omitted in output. |
|
See also |
|
.Sx \&BI . |
|
.Ss \&RS |
|
Temporarily reset the default left margin. |
|
This has the following syntax: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&RS |
|
.Op Ar width |
.Ed |
.Ed |
.Pp |
.Pp |
The |
The |
.Sq \&.TP |
.Ar width |
macro is similar, but does not need an empty argument line to trigger |
argument is a |
the behaviour. |
.Xr roff 7 |
.\" SECTION |
scaling width. |
.Sh MACROS |
If not specified, the saved or default width is used. |
This section contains a complete list of all |
.Pp |
|
See also |
|
.Sx \&RE . |
|
.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 reset 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 reset to the default. |
|
.Ss \&SY |
|
Begin a synopsis block with the following syntax: |
|
.Bd -unfilled -offset indent |
|
.Pf \. Sx \&SY Ar command |
|
.Ar arguments |
|
.Pf \. Sx \&YS |
|
.Ed |
|
.Pp |
|
This is a non-standard GNU extension |
|
and very rarely used even in GNU manual pages. |
|
Formatting is similar to |
|
.Sx \&IP . |
|
.Ss \&TH |
|
Set the name of the manual page for use in the page header |
|
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 |
|
Conventionally, the document |
|
.Ar name |
|
is given in all caps. |
|
The recommended |
|
.Ar date |
|
format is |
|
.Sy YYYY-MM-DD |
|
as specified in the ISO-8601 standard; |
|
if the argument does not conform, it is printed verbatim. |
|
If the |
|
.Ar date |
|
is empty or not specified, the current date is used. |
|
The optional |
|
.Ar source |
|
string specifies the organisation providing the utility. |
|
When unspecified, |
|
.Xr mandoc 1 |
|
uses its |
|
.Fl Ios |
|
argument. |
|
The |
|
.Ar volume |
|
string replaces the default rendered volume, which is dictated by the |
|
manual section. |
|
.Pp |
|
Examples: |
|
.Pp |
|
.Dl \&.TH CVS 5 "1992-02-12" GNU |
|
.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. |
|
The syntax is as follows: |
|
.Bd -filled -offset indent |
|
.Pf \. Sx \&TP |
|
.Op Ar width |
|
.Ed |
|
.Pp |
|
The |
|
.Ar width |
|
argument is a |
|
.Xr roff 7 |
|
scaling width. |
|
If specified, it's saved for later paragraph left-margins; if |
|
unspecified, the saved or default width is used. |
|
.Ss \&TQ |
|
Like |
|
.Sx \&TP , |
|
except that no vertical spacing is inserted before the paragraph. |
|
This is a non-standard GNU extension |
|
and very rarely used even in GNU manual pages. |
|
.Ss \&UC |
|
Sets the volume for the footer for compatibility with man pages from |
|
.Bx |
|
releases. |
|
The optional first argument specifies which release it is from. |
|
.Ss \&UE |
|
End a uniform resource identifier block started with |
|
.Sx \&UR . |
|
This is a non-standard GNU extension. |
|
.Ss \&UR |
|
Begin a uniform resource identifier block. |
|
This is a non-standard GNU extension. |
|
It has the following syntax: |
|
.Bd -literal -offset indent |
|
.Pf \. Sx \&UR Ar uri |
|
link description to be shown |
|
.Pf \. Sx UE |
|
.Ed |
|
.Ss \&YS |
|
End a synopsis block started with |
|
.Sx \&SY . |
|
This is a non-standard GNU extension. |
|
.Ss \&fi |
|
End literal mode started with |
|
.Sx \&nf . |
|
.Ss \&in |
|
Indent relative to the current indentation: |
|
.Pp |
|
.D1 Pf \. Sx \&in Op Ar width |
|
.Pp |
|
If |
|
.Ar width |
|
is signed, the new offset is relative. |
|
Otherwise, it is absolute. |
|
This value is reset upon the next paragraph, section, or sub-section. |
|
.Ss \&nf |
|
Begin literal mode: all subsequent free-form lines have their end of |
|
line boundaries preserved. |
|
May be ended by |
|
.Sx \&fi . |
|
Literal mode is implicitly ended by |
|
.Sx \&SH |
|
or |
|
.Sx \&SS . |
|
.Sh MACRO SYNTAX |
|
The |
.Nm |
.Nm |
macros and corresponding number of arguments. |
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 |
|
consisting of zero or more arguments. |
|
If a macro is scoped to the next line and the line arguments are empty, |
|
the next line, which must be text, is used instead. |
|
Thus: |
|
.Bd -literal -offset indent |
|
\&.I |
|
foo |
|
.Ed |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
is equivalent to |
.It Em Macro Ta Em Arguments |
.Sq \&.I foo . |
.It \&.TH Ta >1, <6 |
If next-line macros are invoked consecutively, only the last is used. |
.It \&.SH Ta >0 |
If a next-line macro is followed by a non-next-line macro, an error is |
.It \&.SS Ta >0 |
raised. |
.It \&.TP Ta n |
.Pp |
.It \&.LP Ta 0 |
The syntax is as follows: |
.It \&.PP Ta 0 |
.Bd -literal -offset indent |
.It \&.P Ta 0 |
\&.YO \(lBbody...\(rB |
.It \&.IP Ta <3 |
\(lBbody...\(rB |
.It \&.HP Ta <2 |
.Ed |
.It \&.SM Ta n |
.Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent |
.It \&.SB Ta n |
.It Em Macro Ta Em Arguments Ta Em Scope Ta Em Notes |
.It \&.BI Ta n |
.It Sx \&AT Ta <=1 Ta current Ta \& |
.It \&.IB Ta n |
.It Sx \&B Ta n Ta next-line Ta \& |
.It \&.BR Ta n |
.It Sx \&BI Ta n Ta current Ta \& |
.It \&.RB Ta n |
.It Sx \&BR Ta n Ta current Ta \& |
.It \&.R Ta n |
.It Sx \&DT Ta 0 Ta current Ta \& |
.It \&.B Ta n |
.It Sx \&EE Ta 0 Ta current Ta GNU |
.It \&.I Ta n |
.It Sx \&EX Ta 0 Ta current Ta GNU |
.It \&.IR Ta n |
.It Sx \&I Ta n Ta next-line Ta \& |
.It \&.RI Ta n |
.It Sx \&IB Ta n Ta current Ta \& |
|
.It Sx \&IR Ta n Ta current Ta \& |
|
.It Sx \&OP Ta >=1 Ta current Ta GNU |
|
.It Sx \&PD Ta 1 Ta current Ta \& |
|
.It Sx \&RB Ta n Ta current Ta \& |
|
.It Sx \&RI Ta n Ta current Ta \& |
|
.It Sx \&SB Ta n Ta next-line Ta \& |
|
.It Sx \&SM Ta n Ta next-line Ta \& |
|
.It Sx \&TH Ta >1, <6 Ta current Ta \& |
|
.It Sx \&UC Ta <=1 Ta current Ta \& |
|
.It Sx \&fi Ta 0 Ta current Ta Xr roff 7 |
|
.It Sx \&in Ta 1 Ta current Ta Xr roff 7 |
|
.It Sx \&nf Ta 0 Ta current Ta Xr roff 7 |
.El |
.El |
|
.Ss Block Macros |
|
Block macros comprise a head and body. |
|
As with in-line macros, the head is scoped to the current line and, in |
|
one circumstance, the next line (the next-line stipulations as in |
|
.Sx Line Macros |
|
apply here as well). |
.Pp |
.Pp |
Although not historically part of the |
The syntax is as follows: |
.Nm |
.Bd -literal -offset indent |
system, the following macros are also supported: |
\&.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 \&.br Ta 0 |
.Sx \&SH ; |
.It \&.i Ta n |
sub-section, closed by a section or |
|
.Sx \&SS ; |
|
or paragraph, closed by a section, sub-section, |
|
.Sx \&HP , |
|
.Sx \&IP , |
|
.Sx \&LP , |
|
.Sx \&P , |
|
.Sx \&PP , |
|
.Sx \&RE , |
|
.Sx \&SY , |
|
or |
|
.Sx \&TP . |
|
No closure refers to an explicit block closing macro. |
|
.Pp |
|
As a rule, block macros may not be nested; thus, calling a block macro |
|
while another block macro scope is open, and the open scope is not |
|
implicitly closed, is syntactically incorrect. |
|
.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 Sx \&HP Ta <2 Ta current Ta paragraph Ta \& |
|
.It Sx \&IP Ta <3 Ta current Ta paragraph Ta \& |
|
.It Sx \&LP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&ME Ta 0 Ta none Ta none Ta GNU |
|
.It Sx \&MT Ta 1 Ta current Ta to \&ME Ta GNU |
|
.It Sx \&P Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&PP Ta 0 Ta current Ta paragraph Ta \& |
|
.It Sx \&RE Ta <=1 Ta current Ta none Ta \& |
|
.It Sx \&RS Ta 1 Ta current Ta to \&RE Ta \& |
|
.It Sx \&SH Ta >0 Ta next-line Ta section Ta \& |
|
.It Sx \&SS Ta >0 Ta next-line Ta sub-section Ta \& |
|
.It Sx \&SY Ta 1 Ta current Ta to \&YS Ta GNU |
|
.It Sx \&TP Ta n Ta next-line Ta paragraph Ta \& |
|
.It Sx \&TQ Ta n Ta next-line Ta paragraph Ta GNU |
|
.It Sx \&UE Ta 0 Ta current Ta none Ta GNU |
|
.It Sx \&UR Ta 1 Ta current Ta part Ta GNU |
|
.It Sx \&YS Ta 0 Ta none Ta none Ta GNU |
.El |
.El |
.Pp |
.Pp |
These follow the same calling conventions as the above |
If a block macro is next-line scoped, it may only be followed by in-line |
|
macros for decorating text. |
|
.Ss Font handling |
|
In |
.Nm |
.Nm |
macros. |
documents, both |
.\" SECTION |
.Sx Physical markup |
.Sh COMPATIBILITY |
macros and |
See |
.Xr roff 7 |
.Xr mdoc 7 |
.Ql \ef |
for groff compatibility notes. |
font escape sequences can be used to choose fonts. |
.\" SECTION |
In text lines, the effect of manual font selection by escape sequences |
|
only lasts until the next macro invocation; in macro lines, it only lasts |
|
until the end of the macro scope. |
|
Note that macros like |
|
.Sx \&BR |
|
open and close a font scope for each argument. |
.Sh SEE ALSO |
.Sh SEE ALSO |
|
.Xr man 1 , |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_char 7 |
.Xr eqn 7 , |
.\" SECTION |
.Xr mandoc_char 7 , |
.Sh AUTHORS |
.Xr mdoc 7 , |
|
.Xr roff 7 , |
|
.Xr tbl 7 |
|
.Sh HISTORY |
The |
The |
.Nm |
.Nm |
utility was written by |
language first appeared as a macro package for the roff typesetting |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
system in |
.\" SECTION |
.At v7 . |
.Sh CAVEATS |
It was later rewritten by James Clark as a macro package for groff. |
Do not use this language. Use |
Eric S. Raymond wrote the extended |
.Xr mdoc 7 , |
.Nm |
instead. |
macros for groff in 2007. |
|
The stand-alone implementation that is part of the |
|
.Xr mandoc 1 |
|
utility written by Kristaps Dzonsons appeared in |
|
.Ox 4.6 . |
|
.Sh AUTHORS |
|
This |
|
.Nm |
|
reference was written by |
|
.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv . |