version 1.6, 2009/02/27 08:20:15 |
version 1.17, 2009/03/11 00:39:58 |
|
|
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt mdocmterm 1 |
.Dt mdocterm 1 |
.Os |
.Os |
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
|
|
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mdocmterm |
.Nm mdocmterm |
.Op Fl v |
.Op Fl vV |
|
.Op Fl f Ns Ar option... |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Ar infile |
.Op Ar infile |
.\" SECTION |
.\" SECTION |
|
|
utility formats a BSD |
utility formats a BSD |
.Dq mdoc |
.Dq mdoc |
manual page for display on the terminal. The arguments are as follows: |
manual page for display on the terminal. The arguments are as follows: |
.Bl -tag -width "\-Werr... " |
.Bl -tag -width XXXXXXXXXXXX |
.\" ITEM |
.\" ITEM |
.It Fl v |
.It Fl v |
Print verbose parsing output. |
Print verbose parsing output. |
.\" ITEM |
.\" ITEM |
|
.It Fl v |
|
Print version and exit. |
|
.\" ITEM |
|
.It Fl f Ns Ar option... |
|
Override default compiler behaviour. See |
|
.Sx Compiler Options |
|
for details. |
|
.\" 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 |
.Fl W Ns Ar all |
.Fl W Ns Ar all |
Line 75 input, documented at |
|
Line 84 input, documented at |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
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 terminal-encoded output to stdout. |
reads from stdin and prints ANSI |
|
.Qq raw |
|
terminal-encoded output to stdout, at this time to a fixed column with |
|
of 78 characters. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.Ex -std mdocmterm |
.Ex -std mdocmterm |
|
.\" SUB-SECTION |
|
.Ss Compiler Options |
|
Default compiler behaviour may be overriden with the |
|
.Fl f |
|
flag. The available options are as follows: |
|
.Bl -tag -width XXXXXXXXXXXX -offset XXXX |
|
.It Fl f Ns Ar ign-scope |
|
When rewinding the scope of a block macro, forces the compiler to ignore |
|
scope violations. This can seriously mangle the resulting tree. |
|
.It Fl f Ns Ar ign-escape |
|
Ignore invalid escape sequences. |
|
.It Fl f Ns Ar ign-macro |
|
Ignore unknown macros at the start of input lines. |
|
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
As with the |
|
.Fl W |
|
flag, multiple |
|
.Fl f |
|
options may be grouped and delimited with a comma. Using |
|
.Fl f Ns Ar ign-scope,ign-escape , |
|
for example, will try to ignore scope and character-escape errors. |
|
.\" SUB-SECTION |
|
.Ss Input Encoding |
|
The |
.Nm |
.Nm |
is |
utility expects its input to be 7-bit ASCII as defined in |
.Ud |
.Xr ascii 7 . |
|
The only non-graphing characters accepted are spaces, |
|
.Sq \ , |
|
and tabs, |
|
.Sq \et . |
|
Tabs are only accepted in literal block-displays and as column |
|
delimiters. |
|
.Pp |
|
Only Unix-style newlines (\en) are accepted; if the newline is escaped, |
|
the line is concatenated with the next. |
|
.\" 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 \(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 \(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: |
To display this manual page: |
Line 99 To display this manual page: |
|
Line 272 To display this manual page: |
|
.Pp |
.Pp |
To pipe a manual page to the pager: |
To pipe a manual page to the pager: |
.Pp |
.Pp |
.D1 % mdocterm mdocterm.1 | less -R |
.D1 % mdocterm mdocterm.1 2>&1 | less \-R |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mdoctree 1 , |
|
|
.Xr mdoc 3 |
.Xr mdoc 3 |
for a list of bugs, caveats, and incomplete macros regarding the |
for a list of bugs, caveats, and incomplete macros regarding the |
document parse. |
document parse. |
|
.Pp |
|
The |
|
.Nm |
|
utility doesn't yet know how to display the following: |
|
.Pp |
|
.Bl -bullet -compact |
|
.It |
|
The \-hang and \-column |
|
.Sq \&Bl |
|
lists are not yet 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). |
|
.It |
|
The |
|
.Sq \&Sm |
|
macro has no effect, yet. |
|
.El |