version 1.7, 2009/03/23 09:42:43 |
version 1.8, 2009/03/23 15:41:09 |
|
|
.\" SECTION |
.\" SECTION |
.Sh NAME |
.Sh NAME |
.Nm mandoc |
.Nm mandoc |
.Nd format and display BSD manuals |
.Nd format and display UNIX manuals |
.\" SECTION |
.\" SECTION |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl V |
.Op Fl V |
.Op Fl f Ns Ar option... |
.Op Fl f Ns Ar option... |
|
.Op Fl m Ns Ar format |
.Op Fl W Ns Ar err... |
.Op Fl W Ns Ar err... |
.Op Fl T Ns Ar output |
.Op Fl T Ns Ar output |
.Op Ar infile... |
.Op Ar infile... |
|
|
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
utility formats a BSD |
utility formats |
.Dq mdoc |
.Ux |
manual page for display. The arguments are as follows: |
manual pages for display. The arguments are as follows: |
.Bl -tag -width XXXXXXXXXXXX |
.Bl -tag -width XXXXXXXXXXXX |
.\" ITEM |
.\" ITEM |
.It Fl f Ns Ar option... |
.It Fl f Ns Ar option... |
Line 45 Override default compiler behaviour. See |
|
Line 46 Override default compiler behaviour. See |
|
.Sx Compiler Options |
.Sx Compiler Options |
for details. |
for details. |
.\" ITEM |
.\" ITEM |
|
.It Fl m |
|
Input format. See |
|
.Sx Input Formats |
|
for available formats. Defaults to |
|
.Fl m Ns Ar mdoc . |
|
.\" ITEM |
.It Fl T |
.It Fl T |
Output format. See |
Output format. See |
.Sx Output Formats |
.Sx Output Formats |
Line 80 will halt with the first failed parse. |
|
Line 87 will halt with the first failed parse. |
|
.Pp |
.Pp |
By default, |
By default, |
.Nm |
.Nm |
reads from stdin and prints 78-column backspace-encoded output to stdout |
reads |
as if |
.Xr mdoc 7 |
|
text from stdin, implying |
|
.Fl m Ns Ar mdoc , |
|
and prints 78-column backspace-encoded output to stdout as if |
.Fl T Ns Ar ascii |
.Fl T Ns Ar ascii |
were provided. |
were provided. |
.\" PARAGRAPH |
.\" PARAGRAPH |
.Pp |
.Pp |
.Ex -std mandoc |
.Ex -std mandoc |
.\" SUB-SECTION |
.\" SUB-SECTION |
.Ss Reserved Words |
.Ss Reserved Words (mdoc only) |
The reserved words described in |
The reserved words described in |
.Xr mdoc 7 |
.Xr mdoc 7 |
are handled according to the following rules: |
are handled according to the following rules: |
Line 132 However, if the comma were part of |
|
Line 142 However, if the comma were part of |
|
.Dq ,empirically , |
.Dq ,empirically , |
it would not. |
it would not. |
.\" SUB-SECTION |
.\" SUB-SECTION |
|
.Ss Input Formats |
|
The |
|
.Nm |
|
utility accepts |
|
.Xr mdoc 7 |
|
and |
|
.Xr man 7 |
|
input with |
|
.Fl m Ns Ar mdoc |
|
and |
|
.Fl m Ns Ar man , |
|
respectively. The |
|
.Xr mdoc 7 |
|
format is |
|
.Em strongly |
|
recommended; |
|
.Xr man 7 |
|
should only be used for legacy manuals. |
|
.Pp |
|
Note that the |
|
.Fl m Ns Ar man |
|
option is experimental and only works with |
|
.Fl T Ns Ar tree . |
|
.\" SUB-SECTION |
.Ss Output Formats |
.Ss Output Formats |
The |
The |
.Nm |
.Nm |
|
|
.It Fl f Ns Ar ign-scope |
.It Fl f Ns Ar ign-scope |
When rewinding the scope of a block macro, forces the compiler to ignore |
When rewinding the scope of a block macro, forces the compiler to ignore |
scope violations. This can seriously mangle the resulting tree. |
scope violations. This can seriously mangle the resulting tree. |
|
.Pq mdoc only |
.It Fl f Ns Ar ign-escape |
.It Fl f Ns Ar ign-escape |
Ignore invalid escape sequences. |
Ignore invalid escape sequences. |
.It Fl f Ns Ar ign-macro |
.It Fl f Ns Ar ign-macro |