version 1.8, 1998/09/26 19:55:06 |
version 1.9, 1999/06/05 01:21:33 |
|
|
.Fl f Ar filename |
.Fl f Ar filename |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm man |
.Nm |
utility |
utility |
displays the |
displays the |
.Bx |
.Bx |
|
|
combination. |
combination. |
(Normally, only the first manual page found is displayed.) |
(Normally, only the first manual page found is displayed.) |
.It Fl C Ar file |
.It Fl C Ar file |
Use the specified |
Use the specified |
.Ar file |
.Ar file |
instead of the default configuration file. |
instead of the default configuration file. |
This permits users to configure their own manual environment. |
This permits users to configure their own manual environment. |
|
|
lines of the requested manual pages. |
lines of the requested manual pages. |
.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 man |
.Nm |
searches for manual pages. |
searches for manual pages. |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon (``:'') separated list of directories. |
must be a colon |
|
.Pq Ql \&: |
|
separated list of directories. |
This search path may also be set using the environment variable |
This search path may also be set using the environment variable |
.Ev MANPATH . |
.Ev MANPATH . |
The subdirectories to be searched, and their search order, |
The subdirectories to be searched, and their search order, |
is specified by the ``_subdir'' line in the |
is specified by the |
.Nm man |
.Dq _subdir |
|
line in the |
|
.Nm |
configuration file. |
configuration file. |
.It Fl m Ar path |
.It Fl m Ar path |
Augment the list of standard directories which |
Augment the list of standard directories which |
.Nm man |
.Nm |
searches for manual pages. |
searches for manual pages. |
The supplied |
The supplied |
.Ar path |
.Ar path |
must be a colon (``:'') separated list of directories. |
must be a colon |
|
.Pq Ql \&: |
|
separated list of directories. |
These directories will be searched before the standard directories or |
These directories will be searched before the standard directories or |
the directories specified using the |
the directories specified using the |
.Fl M |
.Fl M |
|
|
.Ev MANPATH |
.Ev MANPATH |
environment variable. |
environment variable. |
The subdirectories to be searched, and their search order, |
The subdirectories to be searched, and their search order, |
is specified by the ``_subdir'' line in the |
is specified by the |
.Nm man |
.Dq _subdir |
|
line in the |
|
.Nm |
configuration file. |
configuration file. |
.It Fl s Ar section |
.It Fl s Ar section |
Another way of specifying the section, for compatibility with |
Another way of specifying the section, for compatibility with |
.Nm man |
.Nm |
on other operating systems. |
on other operating systems. |
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Specifies the machine-dependent subsection. This overrides the |
Specifies the machine-dependent subsection. This overrides the |
.Ev MACHINE |
.Ev MACHINE |
environment variable. See the ``ENVIRONMENT'' section below. |
environment variable. See the |
|
.Sx ENVIRONMENT |
|
section below. |
.It Fl w |
.It Fl w |
List the pathnames of the manual pages which |
List the pathnames of the manual pages which |
.Nm man |
.Nm |
would display for the specified |
would display for the specified |
.Ar section |
.Ar section |
and |
and |
|
|
The optional |
The optional |
.Ar section |
.Ar section |
argument restricts the directories that |
argument restricts the directories that |
.Nm man |
.Nm |
will search. |
will search. |
The |
The |
.Nm man |
.Nm |
configuration file (see |
configuration file (see |
.Xr man.conf 5 ) |
.Xr man.conf 5 ) |
specifies the possible |
specifies the possible |
|
|
values that are currently available. |
values that are currently available. |
If only a single argument is specified or if the first argument is |
If only a single argument is specified or if the first argument is |
not a valid section, |
not a valid section, |
.Nm man |
.Nm |
assumes that the argument is the name of a manual page to be displayed. |
assumes that the argument is the name of a manual page to be displayed. |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Bl -tag -width MANPATHX |
.Bl -tag -width MANPATHX |
.It Ev MACHINE |
.It Ev MACHINE |
As some manual pages are intended only for specific architectures, |
As some manual pages are intended only for specific architectures, |
.Nm man |
.Nm |
searches any subdirectories, |
searches any subdirectories, |
with the same name as the current architecture, |
with the same name as the current architecture, |
in every directory which it searches. |
in every directory which it searches. |
|
|
to the name of a specific architecture. |
to the name of a specific architecture. |
.It Ev MANPATH |
.It Ev MANPATH |
The standard search path used by |
The standard search path used by |
.Nm man |
.Nm |
may be overridden by specifying a path in the |
may be overridden by specifying a path in the |
.Ev MANPATH |
.Ev MANPATH |
environment |
environment |
variable. |
variable. |
The format of the path is a colon (``:'') separated list of directories. |
The format of the path is a colon |
|
.Pq Ql \&: |
|
separated list of directories. |
The subdirectories to be searched as well as their search order |
The subdirectories to be searched as well as their search order |
is specified by the ``_subdir'' line in the |
is specified by the |
.Nm man |
.Dq _subdir |
|
line in the |
|
.Nm |
configuration file. |
configuration file. |
.It Ev PAGER |
.It Ev PAGER |
Any value of the environment variable |
Any value of the environment variable |