version 1.108, 2014/08/22 04:52:55 |
version 1.112, 2014/09/12 00:10:26 |
|
|
.Nd format and display UNIX manuals |
.Nd format and display UNIX manuals |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl acV |
.Op Fl acfhklV |
.Sm off |
.Sm off |
.Op Fl I Cm os Li = Ar name |
.Op Fl I Cm os Li = Ar name |
.Sm on |
.Sm on |
|
|
.Fl T Ns Cm ascii |
.Fl T Ns Cm ascii |
output. |
output. |
.Pp |
.Pp |
The arguments are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl a |
.It Fl a |
If the standard output is a terminal device and |
If the standard output is a terminal device and |
Line 68 to paginate them. |
|
Line 68 to paginate them. |
|
This is the default. |
This is the default. |
It can be specified to override |
It can be specified to override |
.Fl a . |
.Fl a . |
|
.It Fl f |
|
A synonym for |
|
.Xr whatis 1 . |
|
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
.Sm off |
.Sm off |
.It Fl I Cm os Li = Ar name |
.It Fl I Cm os Li = Ar name |
.Sm on |
.Sm on |
|
|
.Xr mdoc 7 |
.Xr mdoc 7 |
.Sq \&Os |
.Sq \&Os |
macro. |
macro. |
|
.It Fl h |
|
Display only the SYNOPSIS lines. |
|
Implies |
|
.Fl a . |
|
.It Fl k |
|
A synonym for |
|
.Xr apropos 1 . |
|
This overrides any earlier |
|
.Fl f |
|
and |
|
.Fl l |
|
options. |
|
.It Fl l |
|
A synonym for |
|
.Fl a . |
|
Also reverts any earlier |
|
.Fl f |
|
and |
|
.Fl k |
|
options. |
.It Fl m Ns Ar format |
.It Fl m Ns Ar format |
Input format. |
Input format. |
See |
See |
Line 137 If multiple files are specified, |
|
Line 165 If multiple files are specified, |
|
.Nm |
.Nm |
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
|
.Pp |
|
In |
|
.Fl f |
|
and |
|
.Fl k |
|
mode, |
|
.Nm |
|
also supports the options |
|
.Fl CMmOSsw |
|
described in the |
|
.Xr apropos 1 |
|
manual. |
.Ss Input Formats |
.Ss Input Formats |
The |
The |
.Nm |
.Nm |
Line 726 The same standard section title occurs more than once. |
|
Line 766 The same standard section title occurs more than once. |
|
.Pq mdoc |
.Pq mdoc |
A standard section header occurs in a section of the manual |
A standard section header occurs in a section of the manual |
where it normally isn't useful. |
where it normally isn't useful. |
|
.It Sy "unusual Xr order" |
|
.Pq mdoc |
|
In the SEE ALSO section, an |
|
.Ic \&Xr |
|
macro with a lower section number follows one with a higher number, |
|
or two |
|
.Ic \&Xr |
|
macros refering to the same section are out of alphabetical order. |
|
.It Sy "unusual Xr punctuation" |
|
.Pq mdoc |
|
In the SEE ALSO section, punctuation between two |
|
.Ic \&Xr |
|
macros differs from a single comma, or there is trailing punctuation |
|
after the last |
|
.Ic \&Xr |
|
macro. |
|
.It Sy "AUTHORS section without An macro" |
|
.Pq mdoc |
|
An AUTHORS sections contains no |
|
.Ic \&An |
|
macros, or only empty ones. |
|
Probably, there are author names lacking markup. |
.El |
.El |
.Ss "Warnings related to macros and nesting" |
.Ss "Warnings related to macros and nesting" |
.Bl -ohang |
.Bl -ohang |