version 1.19, 2009/03/13 07:46:10 |
version 1.20, 2009/03/14 12:35:02 |
|
|
.Nm mdocmterm |
.Nm mdocmterm |
.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 W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Ar infile |
.Op Ar infile |
.\" SECTION |
.\" SECTION |
Line 50 Override default compiler behaviour. See |
|
Line 51 Override default compiler behaviour. See |
|
.Sx Compiler Options |
.Sx Compiler Options |
for details. |
for details. |
.\" ITEM |
.\" 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 119 options may be grouped and delimited with a comma. Us |
|
Line 129 options may be grouped and delimited with a comma. Us |
|
.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 Input Encoding |
|
The |
|
.Nm |
|
utility expects its input to be 7-bit ASCII as defined in |
|
.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 |
.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 |
Line 266 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 274 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 2>&1 | less \-R |
.D1 % mdocterm -Onroff mdocterm.1 | less |
.\" SECTION |
.\" SECTION |
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mdoctree 1 , |
.Xr mdoctree 1 , |