version 1.20, 2009/03/14 12:35:02 |
version 1.23, 2009/03/16 22:19:19 |
|
|
.Os |
.Os |
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
.Nm mdocmterm |
.Nm mdocterm |
.Nd mdoc macro compiler |
.Nd mdoc macro compiler |
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocmterm |
.Nm mdocterm |
.Op Fl vV |
.Op Fl vV |
.Op Fl f Ns Ar option... |
.Op Fl f Ns Ar option... |
.Op Fl O Ns Ar option... |
.Op Fl O Ns Ar option... |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Ar infile |
.Op Ar infile |
|
.Nm mdocterm |
|
.Op Fl hi |
|
.Op Fl m Ns Ar name |
|
.Op Fl n Ns Ar num |
|
.Op Fl o Ns Ar list |
|
.Op Fl r Ns Ar cn |
|
.Op Fl T Ns Ar name |
|
.Op Ar infile |
.\" SECTION |
.\" SECTION |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
Line 52 Override default compiler behaviour. See |
|
Line 60 Override default compiler behaviour. See |
|
for details. |
for details. |
.\" ITEM |
.\" ITEM |
.It Fl O Ns Ar option... |
.It Fl O Ns Ar option... |
Terminal-encoding options. May be set to |
Front-end options. See |
.Fl O Ns Ar ansi |
.Sx Front-end Options |
for ANSI/VT100-encoded output (the default) or |
for details. |
.Fl O Ns Ar nroff |
|
for nroff-encoded |
|
.Qq backspace |
|
output. |
|
.\" ITEM |
.\" ITEM |
.It Fl W Ns Ar err... |
.It Fl W Ns Ar err... |
Print warning messages. May be set to |
Print warning messages. May be set to |
|
|
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
If |
|
.Xr nroff 1 |
|
arguments are supplied on the command line |
|
.Pq Fl himnorT , |
|
these are ignored unless |
|
.Xr nroff 1 |
|
is invoked on parse failure. |
|
.\" PARAGRAPH |
|
.Pp |
The |
The |
.Nm |
.Nm |
utility is a formatting front-end for |
utility is a formatting front-end for |
Line 95 input, documented at |
|
Line 108 input, documented at |
|
and |
and |
.Xr mdoc.samples 7 , |
.Xr mdoc.samples 7 , |
into an abstract syntax tree. |
into an abstract syntax tree. |
|
.\" PARAGRAPH |
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
reads from stdin and prints ANSI |
reads from stdin and prints nroff |
.Qq raw |
.Qq backspace |
terminal-encoded output to stdout, at this time to a fixed column with |
terminal-encoded output to stdout, at this time to a fixed column with |
of 78 characters. |
of 78 characters. If |
|
.Ar infile |
|
can't be parsed (isn't valid mdoc, doesn't contain valid syntax, etc.), |
|
.Xr nroff 1 |
|
is invoked. If no |
|
.Xr nroff 1 |
|
command-line argumnets aren't provided, |
|
.Fl m Ar Ns andoc |
|
is implied. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.Ex -std mdocmterm |
.Ex -std mdocterm |
.\" SUB-SECTION |
.\" SUB-SECTION |
|
.Ss Front-end Options |
|
The default behaviour may be overriden with the |
|
.Fl O |
|
flag. The available options are as follows: |
|
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
|
.It Fl O Ns Ar nopunt |
|
Don't punt to |
|
.Xr nroff 1 |
|
if |
|
.Ar infile |
|
may not be parsed. |
|
.El |
|
.\" SUB-SECTION |
.Ss Compiler Options |
.Ss Compiler Options |
Default compiler behaviour may be overriden with the |
Default compiler behaviour may be overriden with the |
.Fl f |
.Fl f |
|
|
.Fl W |
.Fl W |
flag, multiple |
flag, multiple |
.Fl f |
.Fl f |
|
and |
|
.Fl O |
options may be grouped and delimited with a comma. Using |
options may be grouped and delimited with a comma. Using |
.Fl f Ns Ar ign-scope,ign-escape , |
.Fl f Ns Ar ign-scope,ign-escape , |
for example, will try to ignore scope and character-escape errors. |
for example, will try to ignore scope and character-escape errors. |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Character Escapes |
.Ss Character Escapes |
The following table shows all |
The |
|
.Nm |
|
utility correctly renders all |
|
.Sx Special Characters |
|
in |
.Xr mdoc 7 |
.Xr mdoc 7 |
character escapes rendered by |
in 7-bit ASCII. |
.Nm . |
|
Note that the |
|
.Em Output |
|
column will render differently whether executed with |
|
.Xr mdocterm 1 |
|
or another output filter. |
|
.\" PARAGRAPH |
|
.Pp |
.Pp |
Grammatic: |
In the general sense, |
.Pp |
.Nm |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
will make a |
.It Em Output |
.Pq best-effort |
.Em Input (Name) |
to render complex characters; however, if a manual is using considerable |
.It \(em |
special characters, some meaning may be lost in translation. |
\\(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 \(rC |
|
\\(rC (right brace) |
|
.It \(lC |
|
\\(lC (left brace) |
|
.It \(ra |
|
\\(ra (right angle) |
|
.It \(la |
|
\\(la (left angle) |
|
.It \(rB |
|
\\(rB (right bracket) |
|
.It \(lB |
|
\\(lB (left bracket) |
|
.It \q |
|
\\q (double-quote) |
|
.It \(lq |
|
\\(lq (left double-quote) |
|
.It \(rq |
|
\\(rq (right double-quote) |
|
.It \(oq |
|
\\(oq, \\` (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 \(== |
|
\\(== (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 on ANSI-capable terminal: |
To display this manual page: |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.D1 % mdocmterm \-Wall,error mdocmterm.1 |
.D1 % mdocterm \-Wall,error mdocterm.1 |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
To pipe a manual page to the pager: |
To pipe a manual page to the pager: |
.Pp |
.Pp |
.D1 % mdocterm -Onroff mdocterm.1 | less |
.D1 % mdocterm mdocterm.1 | less |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mdoctree 1 , |
.Xr mdoclint 1 , |
.Xr mdoclint 1 , |
.Xr mdoc.samples 7 , |
|
.Xr mdoc 7 , |
.Xr mdoc 7 , |
.Xr mdoc 3 |
.Xr mdoc 3 |
.\" |
.\" |