version 1.3, 2014/08/21 02:38:24 |
version 1.10, 2014/12/28 14:42:27 |
|
|
.\" $Id$ |
.\" $Id$ |
.\" $OpenBSD$ |
|
.\" |
.\" |
.\" Copyright (c) 1989, 1990, 1993 |
.\" Copyright (c) 1989, 1990, 1993 |
.\" The Regents of the University of California. All rights reserved. |
.\" The Regents of the University of California. All rights reserved. |
|
|
.Nd display manual pages |
.Nd display manual pages |
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.Nm man |
.Nm man |
.Op Fl acfhkw |
.Op Fl acfhklVw |
.Op Fl C Ar file |
.Op Fl C Ar file |
|
.Op Fl I Cm os Ns = Ns Ar name |
|
.Op Fl K Ar encoding |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
|
.Op Fl O Ar option Ns = Ns Ar value |
.Op Fl S Ar subsection |
.Op Fl S Ar subsection |
.Op Fl s Ar section |
.Op Fl s Ar section |
|
.Op Fl T Ar output |
|
.Op Fl W Ar level |
.Op Ar section |
.Op Ar section |
.Ar name ... |
.Ar name ... |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
|
|
.Ar name |
.Ar name |
in manual page names and displays the header lines from all matching pages. |
in manual page names and displays the header lines from all matching pages. |
The search is case insensitive and matches whole words only. |
The search is case insensitive and matches whole words only. |
|
This overrides any earlier |
|
.Fl k |
|
and |
|
.Fl l |
|
options. |
|
.It Fl I Cm os Ns = Ns Ar name |
|
Override the default operating system |
|
.Ar name |
|
for the |
|
.Xr mdoc 7 |
|
.Ic \&Os |
|
and for the |
|
.Xr man 7 |
|
.Ic \&TH |
|
macro. |
.It Fl h |
.It Fl h |
Display only the |
Display only the SYNOPSIS lines of the requested manual pages. |
.Dq SYNOPSIS |
Implies |
lines of the requested manual pages. |
.Fl a |
|
and |
|
.Fl c . |
|
.It Fl K Ar encoding |
|
Specify the input encoding. |
|
The supported |
|
.Ar encoding |
|
arguments are |
|
.Cm us-ascii , |
|
.Cm iso-8859-1 , |
|
and |
|
.Cm utf-8 . |
|
By default, the encoding is automatically detected as described in the |
|
.Xr mandoc 1 |
|
manual. |
.It Fl k |
.It Fl k |
A synonym for |
A synonym for |
.Xr apropos 1 . |
.Xr apropos 1 . |
Line 104 an expression can be provided using the syntax describ |
|
Line 137 an expression can be provided using the syntax describ |
|
.Xr apropos 1 |
.Xr apropos 1 |
manual. |
manual. |
By default, it displays the header lines of all matching pages. |
By default, it displays the header lines of all matching pages. |
|
This overrides any earlier |
|
.Fl f |
|
and |
|
.Fl l |
|
options. |
|
.It Fl l |
|
A synonym for |
|
.Xr mandoc 1 |
|
.Fl a . |
|
The |
|
.Ar name |
|
arguments are interpreted as filenames. |
|
No search is done and |
|
.Ar file , |
|
.Ar path , |
|
.Ar section , |
|
and |
|
.Ar subsection |
|
are ignored. |
|
This overrides any earlier |
|
.Fl f , |
|
.Fl k , |
|
and |
|
.Fl w |
|
options. |
.It Fl M Ar path |
.It Fl M Ar path |
Override the list of standard directories which |
Override the list of standard directories which |
.Nm |
.Nm |
Line 142 are specified by the |
|
Line 200 are specified by the |
|
line in the |
line in the |
.Nm |
.Nm |
configuration file. |
configuration file. |
|
.It Fl O Ar option Ns = Ns Ar value |
|
Comma-separated output options. |
|
For each output format, the available options are described in the |
|
.Xr mandoc 1 |
|
manual. |
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Restricts the directories that |
Restricts the directories that |
.Nm |
.Nm |
Line 211 specifies the possible |
|
Line 274 specifies the possible |
|
.Ar section |
.Ar section |
values, and their search order. |
values, and their search order. |
Additional sections may be specified. |
Additional sections may be specified. |
|
.It Fl T Ar output |
|
Select the output format. |
|
The default is |
|
.Cm locale . |
|
The other output modes |
|
.Cm ascii , |
|
.Cm html , |
|
.Cm lint , |
|
.Cm man , |
|
.Cm pdf , |
|
.Cm ps , |
|
.Cm tree , |
|
and |
|
.Cm utf8 |
|
are described in the |
|
.Xr mandoc 1 |
|
manual. |
|
.It Fl V |
|
Print version and exit. |
|
.It Fl W Ar level |
|
Specify the minimum message |
|
.Ar level |
|
to be reported on the standard error output and to affect the exit status. |
|
The |
|
.Ar level |
|
can be |
|
.Cm warning , |
|
.Cm error , |
|
or |
|
.Cm fatal . |
|
The default is |
|
.Cm fatal ; |
|
.Cm all |
|
is an alias for |
|
.Cm warning . |
|
See the |
|
.Xr mandoc 1 |
|
manual for details. |
.It Fl w |
.It Fl w |
List the pathnames of the manual pages which |
List the pathnames of the manual pages which |
.Nm |
.Nm |
|
|
combination. |
combination. |
.El |
.El |
.Pp |
.Pp |
The |
|
.Nm |
|
utility also supports the options |
|
.Fl IOTW |
|
described in the |
|
.Xr mandoc 1 |
|
manual. |
|
.Pp |
|
Guidelines for writing |
Guidelines for writing |
man pages can be found in |
man pages can be found in |
.Xr mdoc 7 . |
.Xr mdoc 7 . |
Line 322 utility is compliant with the |
|
Line 415 utility is compliant with the |
|
specification. |
specification. |
.Pp |
.Pp |
The flags |
The flags |
.Op Fl aCcfhMmSsw , |
.Op Fl aCcfhIKlMmOSsTVWw , |
as well as the environment variables |
as well as the environment variables |
.Ev MACHINE , |
.Ev MACHINE , |
.Ev MANPAGER , |
.Ev MANPAGER , |