version 1.12, 2009/03/04 13:57:35 |
version 1.20, 2009/03/14 12:35:02 |
|
|
.\" 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 O 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 O Ns Ar option... |
|
Terminal-encoding options. May be set to |
|
.Fl O Ns Ar ansi |
|
for ANSI/VT100-encoded output (the default) or |
|
.Fl O Ns Ar nroff |
|
for nroff-encoded |
|
.Qq backspace |
|
output. |
|
.\" 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 94 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 |
.Nm |
As with the |
is |
.Fl W |
.Ud |
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 |
.\" SUB-SECTION |
.Ss Character Escapes |
.Ss Character Escapes |
This section documents the character-escapes accepted by |
The following table shows all |
.Xr mdocterm 1 . |
.Xr mdoc 7 |
Note that the \\x, \\(xx and \\[n] forms are described here; the \\*(xx, |
character escapes rendered by |
\\*[n] and \\*x forms described in |
.Nm . |
.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 |
Note that the |
.Em Output |
.Em Output |
column will render differently whether executed with |
column will render differently whether executed with |
|
|
.It \- |
.It \- |
\\- (hyphen) |
\\- (hyphen) |
.It \\ |
.It \\ |
\\ (back-slash) |
\\\\ (back-slash) |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
|
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.Bl -tag -width "OutputXXXX" -offset "XXXX" -compact |
.It Em Output |
.It Em Output |
.Em Input (Name) |
.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 |
.It \(rB |
\\(rB (right bracket) |
\\(rB (right bracket) |
.It \(lB |
.It \(lB |
\\(rB (left bracket) |
\\(lB (left bracket) |
|
.It \q |
|
\\q (double-quote) |
.It \(lq |
.It \(lq |
\\(lq (left double-quote) |
\\(lq (left double-quote) |
.It \(rq |
.It \(rq |
\\(rq, \\' (right double-quote) |
\\(rq (right double-quote) |
.It \(oq |
.It \(oq |
\\(lq, \\` (left single-quote) |
\\(oq, \\` (left single-quote) |
.It \(aq |
.It \(aq |
\\(aq (right single-quote, apostrophe) |
\\(aq, \\' (right single-quote, apostrophe) |
.El |
.El |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
|
|
.It \(>= |
.It \(>= |
\\(>= (greater-than-equal) |
\\(>= (greater-than-equal) |
.It \(== |
.It \(== |
\\(== (greater-than-equal) |
\\(== (equal) |
.It \(!= |
.It \(!= |
\\(!= (not equal) |
\\(!= (not equal) |
.It \(if |
.It \(if |
Line 212 Special symbols: |
|
Line 257 Special symbols: |
|
the more general syntax. |
the more general syntax. |
.\" SECTION |
.\" SECTION |
.Sh EXAMPLES |
.Sh EXAMPLES |
To display this manual page: |
To display this manual page on ANSI-capable terminal: |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.D1 % mdocmterm \-Wall,error mdocmterm.1 |
.D1 % mdocmterm \-Wall,error mdocmterm.1 |
Line 220 To display this manual page: |
|
Line 265 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 -Onroff mdocterm.1 | less |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mdoctree 1 , |
Line 247 utility doesn't yet know how to display the following: |
|
Line 292 utility doesn't yet know how to display the following: |
|
.Pp |
.Pp |
.Bl -bullet -compact |
.Bl -bullet -compact |
.It |
.It |
The \-hang and \-column |
The \-hang |
.Sq \&Bl |
.Sq \&Bl |
lists are not yet supported. |
list is not yet supported. |
.It |
.It |
The \-literal and \-unfilled |
The \-literal and \-unfilled |
.Sq \&Bd |
.Sq \&Bd |