version 1.2, 2009/03/26 09:55:39 |
version 1.5, 2009/03/26 23:01:26 |
|
|
.Nm |
.Nm |
language. |
language. |
.Pp |
.Pp |
.Em \&Do not |
.Em \&Do not ever |
use |
use |
.Nm |
.Nm |
to write your manuals. Use the |
to write your manuals. Use the |
|
|
.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 |
Line 64 documents may contain only graphable 7-bit ASCII chara |
|
Line 60 documents may contain only graphable 7-bit ASCII chara |
|
space character |
space character |
.Sq \ . |
.Sq \ . |
All manuals must have |
All manuals must have |
|
.Ux |
.Sq \en |
.Sq \en |
line termination. |
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 Special Characters |
.Ss Special Characters |
Special character sequences begin with the escape character |
Special character sequences begin with the escape character |
Line 91 contains a table of all available escapes. |
|
Line 95 contains a table of all available escapes. |
|
.\" SECTION |
.\" SECTION |
.Sh STRUCTURE |
.Sh STRUCTURE |
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. |
|
.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. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.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 136 macros, arranged alphabetically, with the number of ar |
|
Line 178 macros, arranged alphabetically, with the number of ar |
|
.It \&.B Ta n |
.It \&.B Ta n |
.It \&.I Ta n |
.It \&.I Ta n |
.It \&.IR Ta n |
.It \&.IR Ta n |
|
.It \&.RI Ta n |
.El |
.El |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |