MAN(1) | General Commands Manual | MAN(1) |
man
— display the
on-line manual pages (aka
“man
pages”)
man |
[-acw |-h ]
[-C file]
[-M path]
[-m path]
[-S srch]
[[-s ] section]
name ... |
man |
[-C file]
-f command
... |
man |
[-C file]
-k keyword
... |
man |
-p |
The man
utility displays the manual pages
named on the command line. Its options are as follows:
-a
-C
file-c
-f
command-h
-k
keyword-M
pathman
searches for man pages. The supplied
path must be a colon (“:”) separated
list of directories. This search path may also be set using the
environment variable MANPATH
. The subdirectories
to be searched, and their search order, is specified by the
“_subdir” line in the man
configuration file.-m
pathman
searches for man pages. The supplied path must be a
colon (“:”) separated list of directories. These directories
will be searched before the standard directories or the directories
specified using the -M
option or the
MANPATH
environment variable. The subdirectories
to be searched, and their search order, is specified by the
“_subdir” line in the man
configuration file.-p
-s
sectionman
will search to
the specified section. The
man
configuration file (see
man.conf(5)) specifies the
possible section values that are currently
available.-S
srch-w
man
would display for the specified section and
name combination.If the
‘
’ option is
not specified, there is more than one argument, the
‘-s
’ option is
not used, and the first argument is a valid section, then that argument will
be used as if specified by the
‘-k
’
option.-s
If name is given with a full path (beginning
with ‘/
’) or a
relative path that begins with
‘./
’ or
‘../
’, then
man
interprets it as a file specification, so that
you can do man
./foo.5
or
even man
/cd/foo/bar.1.gz
.
If name contains
‘/
’ but does
not match one of the above cases, then the search path is used; this allows
you to request machine-specific man pages, such as
man
vax/boot
.
MACHINE
man
searches any subdirectories, with the same
name as the current architecture, in every directory which it searches.
Machine-specific areas are checked before general areas. The current
machine type may be overridden by setting the environment variable
MACHINE
to the name of a specific architecture.
Machine-specific man pages may also be requested by prepending the
relevant subdirectory name to the page name, separated by
‘/
’. (See
also the “_⟨machine⟩” line in the
man.conf(5) configuration
file, which defines additional supplemental paths related to a specific
machine type.)MANPATH
man
may be
overridden by specifying a path in the MANPATH
environment variable. The format of the path is a colon
(“:”) separated list of directories. The subdirectories to
be searched as well as their search order is specified by the
“_subdir” line in the
man.conf(5) configuration
file.PAGER
PAGER
environment variable is null or not set, the
standard pagination program
more(1) will be used.apropos(1), whatis(1), whereis(1), man.conf(5), mdoc(7), mdoc.samples(7)
man
conforms to X/Open
Commands and Utilities Issue 5 (“XCU5”).
The on-line man pages are, by necessity, forgiving toward stupid display devices, causing a few man pages to be not as nicely formatted as their typeset counterparts.
November 29, 2024 | NetBSD 10.99 |