version 1.3, 2009/03/26 14:38:11 |
version 1.21, 2009/07/27 12:35:53 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org> |
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se> |
.\" |
.\" |
.\" 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 |
.\" purpose with or without fee is hereby granted, provided that the above |
.\" above copyright notice and this permission notice appear in all |
.\" copyright notice and this permission notice appear in all copies. |
.\" copies. |
|
.\" |
.\" |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL |
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
.\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED |
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE |
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
.\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL |
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
.\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
|
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt man 7 |
.Dt MAN 7 |
.Os |
.Os |
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
|
|
.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. In this reference document, we describe the syntax and |
manuals. This reference document describes its syntax, structure, and |
structure of the |
usage. |
.Nm |
|
language. |
|
.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 |
.\" PARAGRAPH |
Line 45 language, instead. |
|
Line 43 language, instead. |
|
An |
An |
.Nm |
.Nm |
document follows simple rules: lines beginning with the control |
document follows simple rules: lines beginning with the control |
character |
character |
.Sq \&. |
.Sq \&. |
are parsed for macros. Other lines are interpreted within the scope of |
are parsed for macros. Other lines are interpreted within the scope of |
prior macros: |
prior macros: |
.Bd -literal -offset XXX |
.Bd -literal -offset indent |
\&.SH Macro lines change control state. |
\&.SH Macro lines change control state. |
Other lines are interpreted within the current state. |
Other lines are interpreted within the current state. |
.Ed |
.Ed |
.\" PARAGRAPH |
|
.Pp |
|
Macros are character sequences whose structural rules are described |
|
later in this document. |
|
.\" SECTION |
.\" 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 \ . |
.Ux |
All manuals must have |
line termination. |
.Sq \en |
|
line termination. |
|
.Pp |
.Pp |
Blank lines are acceptable; where found, the output will also assert a |
Blank lines are acceptable; where found, the output will assert a |
vertical space. |
vertical space. |
|
.Pp |
|
The |
|
.Sq \ec |
|
escape is common in historical |
|
.Nm |
|
documents; if encountered at the end of a word, it ensures that the |
|
subsequent word isn't off-set by whitespace. |
.\" SUB-SECTION |
.\" 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. |
|
.\" SUB-SECTION |
.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 |
.Pp |
.Xr mandoc_char 7 |
Characters may alternatively be escaped by a slash-asterisk, |
for a complete list. Examples include |
.Sq \e* , |
.Sq \e(em |
with the same combinations as described above. This form is deprecated. |
.Pq em-dash |
.Pp |
and |
The |
.Sq \ee |
.Xr mdoc 7 |
.Pq back-slash . |
contains a table of all available escapes. |
.\" SUB-SECTION---------------------- |
|
.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). |
|
.\" 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 |
.\" SECTION |
.Sh STRUCTURE |
.Sh STRUCTURE |
|
Each |
|
.Nm |
|
document must contain contains at least the |
|
.Sq \&.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 the |
|
.Sq \&.TH , |
|
at least one macro or text node must appear in the document. |
|
.\" SECTION |
|
.Sh 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, |
.Sq \&PP |
.Sq \&.PP |
and |
and |
.Sq \&.\ \ \ \&PP |
.Sq \&.\ \ \ \&PP |
are equivalent. |
are equivalent. |
.Pp |
.Pp |
All follow the same |
All |
structural rules: |
.Nm |
.Bd -literal -offset XXXX |
macros follow the same structural rules: |
\&.Yo \(lBbody...\(rB |
.Bd -literal -offset indent |
|
\&.YO \(lBbody...\(rB |
.Ed |
.Ed |
.Pp |
.Pp |
The |
The |
.Dq body |
.Dq body |
consists of zero or more arguments to the macro. |
consists of zero or more arguments to the macro. |
.\" PARAGRAPH |
.Pp |
|
.Nm |
|
has a primitive notion of multi-line scope for the following macros: |
|
.Sq \&.TM , |
|
.Sq \&.SM , |
|
.Sq \&.SB , |
|
.Sq \&.BI , |
|
.Sq \&.IB , |
|
.Sq \&.BR , |
|
.Sq \&.RB , |
|
.Sq \&.R , |
|
.Sq \&.B , |
|
.Sq \&.I , |
|
.Sq \&.IR |
|
and |
|
.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 |
|
.Ed |
|
.Pp |
|
is equivalent to |
|
.Sq \&.RI foo . |
|
If two consecutive lines exhibit the latter behaviour, |
|
an error is raised. Thus, the following is not acceptable: |
|
.Bd -literal -offset indent |
|
\&.RI |
|
\&.I |
|
Hello, world. |
|
.Ed |
|
.Pp |
|
The |
|
.Sq \&.TP |
|
macro is similar, but does not need an empty argument line to trigger |
|
the behaviour. |
|
.\" SECTION |
.Sh MACROS |
.Sh MACROS |
This section contains a complete list of all |
This section contains a complete list of all |
.Nm |
.Nm |
macros, arranged alphabetically, with the number of arguments. |
macros and corresponding number of arguments. |
.Pp |
.Pp |
.Bl -column "MacroX" "Arguments" -compact -offset XXXX |
.Bl -column "MacroX" "Arguments" -compact -offset indent |
.It Em Macro Ta Em Arguments |
.It Em Macro Ta Em Arguments |
.It \&.TH Ta >0 |
.It \&.TH Ta >1, <6 |
.It \&.SH Ta n |
.It \&.SH Ta >0 |
.It \&.SS Ta n |
.It \&.SS Ta >0 |
.It \&.TP Ta n |
.It \&.TP Ta n |
.It \&.LP Ta n |
.It \&.LP Ta 0 |
.It \&.PP Ta n |
.It \&.PP Ta 0 |
.It \&.P Ta n |
.It \&.P Ta 0 |
.It \&.IP Ta n |
.It \&.IP Ta <3 |
.It \&.HP Ta n |
.It \&.HP Ta <2 |
.It \&.SM Ta n |
.It \&.SM Ta n |
.It \&.SB Ta n |
.It \&.SB Ta n |
.It \&.BI Ta n |
.It \&.BI Ta n |
Line 138 macros, arranged alphabetically, with the number of ar |
|
Line 208 macros, arranged alphabetically, with the number of ar |
|
.It \&.IR Ta n |
.It \&.IR Ta n |
.It \&.RI Ta n |
.It \&.RI Ta n |
.El |
.El |
|
.Pp |
|
Although not historically part of the |
|
.Nm |
|
system, the following macros are also supported: |
|
.Pp |
|
.Bl -column "MacroX" "Arguments" -compact -offset indent |
|
.It Em Macro Ta Em Arguments |
|
.It \&.br Ta 0 |
|
.It \&.i Ta n |
|
.El |
|
.Pp |
|
These follow the same calling conventions as the above |
|
.Nm |
|
macros. |
.\" SECTION |
.\" SECTION |
|
.Sh COMPATIBILITY |
|
See |
|
.Xr mdoc 7 |
|
for groff compatibility notes. |
|
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 |
.Xr mandoc 1 , |
|
.Xr mandoc_char 7 |
.\" SECTION |
.\" SECTION |
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
utility was written by |
.An Kristaps Dzonsons Aq kristaps@openbsd.org . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.\" SECTION |
.\" SECTION |
.Sh CAVEATS |
.Sh CAVEATS |
Do not use this language. Use |
Do not use this language. Use |