version 1.9, 2009/02/23 15:19:47 |
version 1.13, 2009/02/27 09:14:02 |
Line 59 library implements only those macros documented in the |
|
Line 59 library implements only those macros documented in the |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr mdoc.samples 7 |
.Xr mdoc.samples 7 |
manuals. |
manuals. Documents with |
|
.Xr refer 1 , |
|
.Xr eqn 1 |
|
and other pre-processor sections aren't accomodated. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.Nm |
.Nm |
Line 89 This section further defines the |
|
Line 92 This section further defines the |
|
.Sx Functions |
.Sx Functions |
and |
and |
.Sx Variables |
.Sx Variables |
available to programmers. The last sub-section, |
available to programmers. Following that, |
|
.Sx Character Encoding |
|
describes input format. Lastly, |
.Sx Abstract Syntax Tree , |
.Sx Abstract Syntax Tree , |
documents the output tree. |
documents the output tree. |
.\" SUBSECTION |
.\" SUBSECTION |
Line 173 An array of string-ified token names. |
|
Line 178 An array of string-ified token names. |
|
.It Va mdoc_argnames |
.It Va mdoc_argnames |
An array of string-ified token argument names. |
An array of string-ified token argument names. |
.El |
.El |
|
.\" SUBSECTION |
|
.Ss Character Encoding |
|
The |
|
.Xr mdoc 3 |
|
library accepts only printable ASCII characters as defined by |
|
.Xr isprint 3 . |
|
Non-ASCII character sequences are delimited in various ways. All are |
|
preceeded by an escape character |
|
.Sq \\ |
|
and 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 \&] ) ; |
|
an asterisk and open-parenthesis |
|
.Sq \&*( |
|
for two-character sequences; |
|
an asterisk and non-open-parenthesis |
|
.Sq \&* |
|
for single-character sequences; or one of a small set of standalone |
|
single characters for other escapes. |
|
.\" PARAGRAPH |
|
.Pp |
|
Examples: |
|
.Pp |
|
.Bl -tag -width "XXXXXXXX" -offset "XXXX" -compact |
|
.\" LIST-ITEM |
|
.It \\*(<= |
|
prints |
|
.Dq \*(<= |
|
.Pq greater-equal |
|
.\" LIST-ITEM |
|
.It \\(<- |
|
prints |
|
.Dq \(<- |
|
.Pq left-arrow |
|
.\" LIST-ITEM |
|
.It \\[<-] |
|
also prints |
|
.Dq \(<- |
|
.Pq left-arrow |
|
.\" LIST-ITEM |
|
.It \\*(Ba |
|
prints |
|
.Dq \*(Ba |
|
.Pq bar |
|
.\" LIST-ITEM |
|
.It \\*q |
|
prints |
|
.Dq \*q |
|
.Pq double-quote |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
All escaped sequences are syntax-checked, but it's up to the front-end |
|
system to correctly render them to the output device. |
.\" SUBSECTION |
.\" SUBSECTION |
.Ss Abstract Syntax Tree |
.Ss Abstract Syntax Tree |
The |
The |