version 1.17, 2009/06/25 11:35:28 |
version 1.19, 2009/07/14 15:56:44 |
|
|
.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 Em |
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 53 Other lines are interpreted within the current state. |
|
Line 55 Other lines are interpreted within the current state. |
|
.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 |
space character, and the tabs character. All manuals must have |
.Sq \ , |
|
and tabs |
|
.Sq \et . |
|
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 |
Line 95 or a single one-character sequence. |
|
Line 92 or a single one-character sequence. |
|
.Pp |
.Pp |
Characters may alternatively be escaped by a slash-asterisk, |
Characters may alternatively be escaped by a slash-asterisk, |
.Sq \e* , |
.Sq \e* , |
with the same combinations as described above. This form is deprecated. |
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 |
.\" SUB-SECTION |
.Ss Whitespace |
.Ss Whitespace |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
Unless specifically escaped, consecutive blocks of whitespace are pruned |
Line 217 system, the following macros are also supported: |
|
Line 219 system, the following macros are also supported: |
|
These follow the same calling conventions as the above |
These follow the same calling conventions as the above |
.Nm |
.Nm |
macros. |
macros. |
|
.\" SECTION |
|
.Sh COMPATIBILITY |
|
See |
|
.Xr mdoc 7 |
|
for groff compatibility notes. |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |