version 1.1, 2009/02/21 21:00:06 |
version 1.10, 2009/03/03 21:07:01 |
|
|
for stdin. |
for stdin. |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
|
.Pp |
The |
The |
.Nm |
.Nm |
utility is a formatting front-end for |
utility is a formatting front-end for |
Line 88 reads from stdin and prints terminal-encoded output to |
|
Line 89 reads from stdin and prints terminal-encoded output to |
|
.Nm |
.Nm |
is |
is |
.Ud |
.Ud |
|
.\" SUB-SECTION |
|
.Ss Character Escapes |
|
This section documents the character-escapes accepted by |
|
.Xr mdocterm 1 . |
|
Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx, |
|
\\*[n] and \\*x forms described in |
|
.Xr mdoc.samples 7 |
|
are deprecated, but still rendered. All one- and two-character |
|
sequences may be used in the n-character sequence \\[n]. |
|
.Pp |
|
Note that the |
|
.Em Output |
|
column will render differently whether executed with |
|
.Xr mdocterm 1 |
|
or another output filter. |
|
.\" PARAGRAPH |
|
.Pp |
|
Grammatic: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(em |
|
\\(em (em-dash) |
|
.It \(en |
|
\\(en (en-dash) |
|
.It \- |
|
\\- (hyphen) |
|
.It \\ |
|
\\ (back-slash) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Enclosures: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(rB |
|
\\(rB (right bracket) |
|
.It \(lB |
|
\\(rB (left bracket) |
|
.It \(lq |
|
\\(lq (left double-quote) |
|
.It \(rq |
|
\\(rq, \\' (right double-quote) |
|
.It \(oq |
|
\\(lq, \\` (left single-quote) |
|
.It \(aq |
|
\\(aq (right single-quote, apostrophe) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Indicatives: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(<- |
|
\\(<- (left arrow) |
|
.It \(-> |
|
\\(-> (right arrow) |
|
.It \(ua |
|
\\(ua (up arrow) |
|
.It \(da |
|
\\(da (down arrow) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Mathematical: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(<= |
|
\\(<= (less-than-equal) |
|
.It \(>= |
|
\\(>= (greater-than-equal) |
|
.It \(== |
|
\\(== (greater-than-equal) |
|
.It \(!= |
|
\\(!= (not equal) |
|
.It \(if |
|
\\(if (infinity) |
|
.It \(na |
|
\\(na (NaN)* |
|
.It \(+- |
|
\\(+- (plus-minus) |
|
.It \(** |
|
\\(** (asterisk) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Diacritics: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(ga |
|
\\(ga (accent grave) |
|
.It \(aa |
|
\\(aa (accent accute) |
|
.El |
|
.\" PARAGRAPH |
|
.Pp |
|
Special symbols: |
|
.Pp |
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
|
.It Em Output |
|
.Em Input (Name) |
|
.It \(bu |
|
\\(bu (bullet) |
|
.It \(ba |
|
\\(ba (bar) |
|
.It \(co |
|
\\(co (copyright) |
|
.El |
|
.Pp |
|
*This is a deviation from the standard, as NaN is usually rendered as |
|
\\*(Na, which is a deprecated form. We introduce \\(na, which follows |
|
the more general syntax. |
.\" SECTION |
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To display this manual page: |
To display this manual page: |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.D1 % mdocmterm \-Wall,error mdocmterm.1 |
.D1 % mdocmterm \-Wall,error mdocmterm.1 |
|
.\" PARAGRAPH |
|
.Pp |
|
To pipe a manual page to the pager: |
|
.Pp |
|
.D1 % mdocterm mdocterm.1 | less -R |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mdoctree 1 , |
|
.Xr mdoclint 1 , |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr mdoc 3 |
.Xr mdoc 3 |
Line 110 utility was written by |
|
Line 238 utility was written by |
|
.Sh CAVEATS |
.Sh CAVEATS |
See |
See |
.Xr mdoc 3 |
.Xr mdoc 3 |
for a list of bugs, caveats, and incomplete macros. |
for a list of bugs, caveats, and incomplete macros regarding the |
|
document parse. |
|
.Pp |
|
The |
|
.Nm |
|
utility doesn't yet know how to display the following: |
|
.Pp |
|
.Bl -bullet -compact |
|
.It |
|
Only \-bullet , \-dash , \-enum , \-hyphen , \-tag and \-ohang |
|
.Sq \&Bl |
|
lists are supported. |
|
.It |
|
The \-literal and \-unfilled |
|
.Sq \&Bd |
|
displays only accept text contents. |
|
.It |
|
The |
|
.Sq \&Xo/Xc |
|
pair isn't supported (and never will be). |
|
.El |