version 1.20, 2003/12/16 18:58:46 |
version 1.21, 2004/02/23 14:14:14 |
|
|
.Op Fl C Ar file |
.Op Fl C Ar file |
.Op Fl M Ar path |
.Op Fl M Ar path |
.Op Fl m Ar path |
.Op Fl m Ar path |
.Op Fl s Ar section |
|
.Op Fl S Ar subsection |
.Op Fl S Ar subsection |
|
.Op Fl s Ar section |
.Op Ar section |
.Op Ar section |
.Ar name Op Ar ... |
.Ar name Op Ar ... |
.Nm man |
.Nm man |
.Fl k Ar keyword |
.Fl f Ar command |
.Nm man |
.Nm man |
.Fl f Ar filename |
.Fl k Ar keyword |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
The |
The |
.Nm |
.Nm |
|
|
.Pp |
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl k |
.It Fl a |
|
Display all of the manual pages for a specified |
|
.Ar section |
|
and |
|
.Ar name |
|
combination. |
|
(Normally, only the first manual page found is displayed.) |
|
.It Fl C Ar file |
|
Use the specified |
|
.Ar file |
|
instead of the default configuration file. |
|
This permits users to configure their own manual environment. |
|
See |
|
.Xr man.conf 5 |
|
for a description of the contents of this file. |
|
.It Fl c |
|
Copy the manual page to the standard output instead of using |
|
.Xr more 1 |
|
to paginate it. |
|
This is done by default if the standard output is not a terminal device. |
|
.It Fl f Ar command |
|
Locate man pages matching the |
|
.Ar command |
|
in much the same way |
|
.Xr whatis 1 |
|
works. |
|
.It Fl h |
|
Display only the |
|
.Dq SYNOPSIS |
|
lines of the requested manual pages. |
|
.It Fl k Ar keyword |
Locate man pages matching |
Locate man pages matching |
.Ar keyword |
.Ar keyword |
in much the same way as |
in much the same way as |
.Xr apropos 1 |
.Xr apropos 1 |
works (in fact, it runs |
works (in fact, it runs |
.Xr apropos 1 |
.Xr apropos 1 ) . |
for you). |
|
This can be used to find which man page applies to a particular subsystem |
This can be used to find which man page applies to a particular subsystem |
you are interested in, for instance |
you are interested in. |
|
For instance: |
.Pp |
.Pp |
.Nm man Fl k Em mount |
.Dl $ man -k mount |
.Pp |
.Pp |
will list all man pages which contain your |
will list all man pages which contain |
.Ar keyword |
.Ar keyword |
in the |
in the |
.Em NAME |
.Dq NAME |
line of the man page; |
line of the man page; |
in this case a list much like this: |
in this case a list much like this: |
.Bd -literal |
.Bd -literal |
|
|
umount (8) \- unmount file systems |
umount (8) \- unmount file systems |
\&... |
\&... |
.Ed |
.Ed |
.It Fl a |
|
Display all of the manual pages for a specified |
|
.Ar section |
|
and |
|
.Ar name |
|
combination. |
|
(Normally, only the first manual page found is displayed.) |
|
.It Fl C Ar file |
|
Use the specified |
|
.Ar file |
|
instead of the default configuration file. |
|
This permits users to configure their own manual environment. |
|
See |
|
.Xr man.conf 5 |
|
for a description of the contents of this file. |
|
.It Fl c |
|
Copy the manual page to the standard output instead of using |
|
.Xr more 1 |
|
to paginate it. |
|
This is done by default if the standard output is not a terminal device. |
|
.It Fl h |
|
Display only the |
|
.Dq Tn SYNOPSIS |
|
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 |
.Nm |
|
|
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 |
are specified by the |
.Dq _subdir |
.Dq _subdir |
line in the |
line in the |
.Nm |
.Nm |
|
|
.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 |
are specified by the |
.Dq _subdir |
.Dq _subdir |
line in the |
line in the |
.Nm |
.Nm |
configuration file. |
configuration file. |
.It Fl s Ar section |
|
Another way of specifying the section, for compatibility with |
|
.Nm |
|
on other operating systems. |
|
.It Fl S Ar subsection |
.It Fl S Ar subsection |
Specifies the machine-dependent subsection. |
Specifies the machine-dependent subsection. |
This overrides the |
This overrides the |
|
|
See the |
See the |
.Sx ENVIRONMENT |
.Sx ENVIRONMENT |
section below. |
section below. |
|
.It Fl s Ar section |
|
Another way of specifying the section, for compatibility with |
|
.Nm |
|
on other operating systems. |
.It Fl w |
.It Fl w |
List the pathnames of the manual pages which |
List the pathnames of the manual pages which |
.Nm |
.Nm |
|
|
and |
and |
.Ar name |
.Ar name |
combination. |
combination. |
.It Fl f |
|
Locate man pages matching the |
|
.Ar command |
|
in much the same way |
|
.Xr whatis 1 |
|
works. |
|
.El |
.El |
.Pp |
.Pp |
The optional |
The optional |
|
|
specifies the possible |
specifies the possible |
.Ar section |
.Ar section |
values, and their search order. |
values, and their search order. |
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 |
.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. |
|
|
The format of the path is a colon |
The format of the path is a colon |
.Pq Ql \&: |
.Pq Ql \&: |
separated list of directories. |
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 |
are specified by the |
.Dq _subdir |
.Dq _subdir |
line in the |
line in the |
.Nm |
.Nm |