man — find and
display reference manual pages
man command displays information from
the reference manuals. It displays complete manual pages that you select by
name, or one-line summaries selected either by
-k), or by the name
of an associated file (
-f). If no manual page is
man prints an error message.
The online Reference Manual page directories are conventionally
located in /usr/share/man. Each directory
corresponds to a section of the manual. Since these directories are
optionally installed, they might not reside on your host. You might have to
mount /usr/share/man from a host on which they do
man command reformats a page whenever it
If the standard output is not a terminal, or if the
- flag is given,
its output through cat(1). Otherwise,
man pipes its output through a pager such as
more(1) to handle paging and underlining
on the screen.
The following options are supported:
MANPATHsearch path. Manual pages are displayed in the order found.
mansearches for name in the standard location, and then /usr/local/man. When used with the
-Moption must appear first. Each directory in the path is assumed to contain subdirectories of the form man*, one for each section. This option overrides the
manto search. The directories searched for name are limited to those specified by section. section can be a numerical digit, perhaps followed by one or more letters to match the desired section of the manual, for example,
3head. Also, section can be a word, for example,
public. section can also be a letter. To specify multiple sections, separate each section with a comma. This option overrides the
MANPATHenvironment variable and the man.cf file. See Search Path below for an explanation of how
manconducts its search.
The following operand is supported:
The usage of
man is described below:
Entries in the reference manuals are organized into
A section name consists of a major section name, typically a single digit,
optionally followed by a subsection name, typically one or more letters. An
unadorned major section name, for example, "9", does not act as an
abbreviation for the subsections of that name, such as "9e",
"9f", or "9s". That is, each subsection must be searched
section contains descriptions apropos to a particular reference category,
with subsections refining these distinctions. See the
manual pages for an explanation of the classification used in this
Before searching for a given name,
man constructs a list of candidate directories and
sections. It searches for name in the directories
specified by the
MANPATH environment variable.
In the absence of
man constructs its search path based upon the
PATH environment variable, primarily by substituting
man for the last component of the
PATH element. Special provisions are added to
account for unique characteristics of directories such as
/usr/xpg4/bin, and others. If the file argument
contains a "/" character, the
of the argument is used in place of
PATH elements to
construct the search path.
Within the manual page directories,
confines its search to the sections specified in the following order:
mansearches each directory in the manual page path, and displays the first matching manual page found.
The man.cf file has the following format:
Lines beginning with ‘
blank lines are considered comments, and are ignored. Each directory
MANPATH can contain a manual page
configuration file, specifying the default search order for that
If the first line of the manual page is a reference to another manual page entry fitting the pattern:
man processes the indicated file in place
of the current one. The reference must be expressed as a path name relative
to the root of the manual page directory subtree.
See environ(7) for
descriptions of the following environment variables that affect the
-sflags, in turn, override these values.
-s’ is used. See more(1).
man utility exits 0 on success,
and >0 if an error occurs.
The following example spools the pipe(2) man page in PostScript to the default printer:
% man -t -s 2 pipe
Note that mandoc(1) can be used to obtain the PostScript content directly.
The following example creates the pipe(2) man page in ASCII text:
% man pipe.2 | col -x -b > pipe.text
options use the
whatis database, which is created
The manual is supposed to be reproducible either on a phototypesetter or on an ASCII terminal. However, on a terminal some information (indicated by font changes, for instance) is lost.
|May 13, 2017||OmniOS|