version 1.11, 2009/06/10 20:18:43 |
version 1.15, 2009/06/22 13:09:17 |
Line 52 Other lines are interpreted within the current state. |
|
Line 52 Other lines are interpreted within the current state. |
|
.\" 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 |
.Sq \ . |
.Sq \ , |
|
and tabs |
|
.Sq \et . |
All manuals must have |
All manuals must have |
.Ux |
.Ux |
.Sq \en |
.Sq \en |
Line 70 escape is common in historical |
|
Line 72 escape is common in historical |
|
documents; if encountered at the end of a word, it ensures that the |
documents; if encountered at the end of a word, it ensures that the |
subsequent word isn't off-set by whitespace. |
subsequent word isn't off-set by whitespace. |
.\" SUB-SECTION |
.\" SUB-SECTION |
|
.Ss Comments |
|
Anything following a |
|
.Sq \e" |
|
delimiter is considered a comment (unless the |
|
.Sq \e |
|
itself has been escaped) and is ignored to the end of line. |
|
Furthermore, a macro line with only a control character |
|
.Sq \. , |
|
optionally followed by whitespace, is ignored. |
|
.\" SUB-SECTION |
.Ss Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special character sequences begin with the escape character |
.Sq \e |
.Sq \e |
Line 85 Characters may alternatively be escaped by a slash-ast |
|
Line 97 Characters may alternatively be escaped by a slash-ast |
|
.Sq \e* , |
.Sq \e* , |
with the same combinations as described above. This form is deprecated. |
with the same combinations as described above. This form is deprecated. |
.\" SECTION |
.\" SECTION |
.Sh STRUCTURE |
.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 \&. , |
|
|
.Sq \&.TP |
.Sq \&.TP |
macro is similar, but does not need an empty argument line to trigger |
macro is similar, but does not need an empty argument line to trigger |
the behaviour. |
the behaviour. |
.\" PARAGRAPH |
.\" SECTION |
|
.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 MACROS |
.Sh MACROS |
This section contains a complete list of all |
This section contains a complete list of all |
.Nm |
.Nm |
|
|
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 |