version 1.180, 2017/03/20 14:32:24 |
version 1.184, 2017/03/27 18:51:36 |
|
|
.Os |
.Os |
.Sh NAME |
.Sh NAME |
.Nm mandoc |
.Nm mandoc |
.Nd format and display UNIX manuals |
.Nd format manual pages |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm mandoc |
.Nm mandoc |
.Op Fl acfhkl |
.Op Fl ac |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl I Cm os Ns = Ns Ar name |
.Op Fl K Ar encoding |
.Op Fl K Ar encoding |
.Op Fl mdoc | man |
.Op Fl mdoc | man |
.Op Fl O Ar option |
.Op Fl O Ar options |
.Op Fl T Ar output |
.Op Fl T Ar output |
.Op Fl W Ar level |
.Op Fl W Ar level |
.Op Ar |
.Op Ar |
Line 65 to paginate them. |
|
Line 65 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. |
|
.It Fl h |
|
Display only the SYNOPSIS lines. |
|
Implies |
|
.Fl c . |
|
.It Fl I Cm os Ns = Ns Ar name |
.It Fl I Cm os Ns = Ns Ar name |
Override the default operating system |
Override the default operating system |
.Ar name |
.Ar name |
Line 120 sequence, input is interpreted as |
|
Line 108 sequence, input is interpreted as |
|
Otherwise, input is interpreted as |
Otherwise, input is interpreted as |
.Cm iso-8859-1 . |
.Cm iso-8859-1 . |
.El |
.El |
.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 mdoc | man |
.It Fl mdoc | man |
With |
With |
.Fl mdoc , |
.Fl mdoc , |
|
|
With other arguments, |
With other arguments, |
.Fl m |
.Fl m |
is silently ignored. |
is silently ignored. |
.It Fl O Ar option |
.It Fl O Ar options |
Comma-separated output options. |
Comma-separated output options. |
.It Fl T Ar output |
.It Fl T Ar output |
Output format. |
Output format. |
Line 211 If multiple files are specified, |
|
Line 183 If multiple files are specified, |
|
will halt with the first failed parse. |
will halt with the first failed parse. |
.El |
.El |
.Pp |
.Pp |
|
The options |
|
.Fl fhklw |
|
are also supported and are documented in man(1). |
In |
In |
.Fl f |
.Fl f |
and |
and |
|
|
mode, |
mode, |
.Nm |
.Nm |
also supports the options |
also supports the options |
.Fl CMmOSsw |
.Fl CMmOSs |
described in the |
described in the |
.Xr apropos 1 |
.Xr apropos 1 |
manual. |
manual. |
|
The options |
|
.Fl fkl |
|
are mutually exclusive and override each other. |
.Ss Output Formats |
.Ss Output Formats |
The |
The |
.Nm |
.Nm |