MAN(1) | User Commands | MAN(1) |
man
—
man |
[- ] [-adFlrt ]
[-T macro-package]
[-M path]
[-s section]
name ... |
man |
[-M path]
[-s section]
-k keyword
... |
man |
[-M path]
[-s section]
-f file ... |
man |
[-M path]
-w |
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
keyword (-k
), or by the name of
an associated file (-f
). If no manual page is located,
man
prints an error message.
man
command recognizes the type of markup and
processes the file accordingly.
man
command reformats a page whenever it is
requested.
If the standard output is not a terminal, or if the
-
flag is given, man
pipes
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.
-a
MANPATH
search path. Manual pages are displayed in
the order found.-d
man
.-f
file ...-F
-k
keyword ...-w
option.-l
-M
pathman
searches for name in the
standard location, and then /usr/local/man. When
used with the -k
, -f
, or
-w
options, the -M
option
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 MANPATH
environment variable.-r
-s
sectionman
to
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,
local
, new
,
old
, public
.
section can also be a letter. To specify multiple
sections, separate each section with a comma. This option overrides the
MANPATH
environment variable and the
man.cf file. See
Search Path below for an explanation
of how man
conducts its search.-t
-T
macro-package-w
whatis
database.man
is described below:
man
-s
.
Each section contains descriptions apropos to a particular reference category,
with subsections refining these distinctions. See the intro
manual pages for an explanation of the classification used in this release.
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 MANPATH
,
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
/sbin, /usr/ucb,
/usr/xpg4/bin, and others. If the file argument
contains a “/” character, the dirname
portion of the argument is used in place of PATH
elements to construct the search path.
Within the manual page directories, man
confines its search to the sections specified in the following order:
-s
optionMANPATH
environment variableMANPATH
environment variableman
searches each directory
in the manual page path, and displays the first matching manual page found.
The man.cf file has the following format:
MANSECTS=section[,section]...
Lines beginning with ‘#
’ and
blank lines are considered comments, and are ignored. Each directory
specified in MANPATH
can contain a manual page
configuration file, specifying the default search order for that
directory.
.so
man*/sourcefile
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.
When the second or any subsequent line starts with
.so, man
ignores it;
troff(1) or
nroff(1) processes the request in the
usual manner.
man
: LANG
,
LC_ALL
, LC_CTYPE
,
LC_MESSAGES
, and NLSPATH
.
MANPATH
-M
and -s
flags, in turn, override these values.MANWIDTH
PAGER
more
-s
’ is used. See
more(1).man
utility exits 0 on success,
and >0 if an error occurs.
% man -t -s 2 pipe
Note that mandoc(1) can be used to obtain the PostScript content directly.
% man pipe.2 | col -x -b >
pipe.text
-f
and -k
options use the
whatis
database, which is created with the
-w
option.
May 13, 2017 | OmniOS |