![]() ![]() | ![]() |
version 1.14, 2009/03/06 14:13:47 | version 1.15, 2009/03/08 18:02:36 | ||
---|---|---|---|
|
|
||
.\" 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 | ||
|
|
||
.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. | |||
.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 | This section documents the character-escapes accepted by | ||
|
|
||
.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 , |