2010-10-01 03:59:18 +00:00
|
|
|
.\"-
|
|
|
|
|
.\" Copyright (c) 2010 Gordon Tetlow
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2021-01-09 17:22:08 +00:00
|
|
|
.Dd January 9, 2021
|
2010-10-01 03:59:18 +00:00
|
|
|
.Dt MAN 1
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm man
|
|
|
|
|
.Nd display online manual documentation pages
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.Nm
|
|
|
|
|
.Op Fl adho
|
2011-08-04 08:50:33 +00:00
|
|
|
.Op Fl t | w
|
2010-10-01 03:59:18 +00:00
|
|
|
.Op Fl M Ar manpath
|
|
|
|
|
.Op Fl P Ar pager
|
|
|
|
|
.Op Fl S Ar mansect
|
|
|
|
|
.Op Fl m Ar arch Ns Op : Ns Ar machine
|
|
|
|
|
.Op Fl p Op Ar eprtv
|
|
|
|
|
.Op Ar mansect
|
|
|
|
|
.Ar page ...
|
|
|
|
|
.Nm
|
|
|
|
|
.Fl f
|
|
|
|
|
.Ar keyword ...
|
|
|
|
|
.Nm
|
|
|
|
|
.Fl k
|
|
|
|
|
.Ar keyword ...
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
utility finds and displays online manual documentation pages.
|
|
|
|
|
If
|
|
|
|
|
.Ar mansect
|
|
|
|
|
is provided,
|
|
|
|
|
.Nm
|
|
|
|
|
restricts the search to the specific section of the manual.
|
|
|
|
|
.Pp
|
2014-09-25 21:34:57 +00:00
|
|
|
The sections of the manual are:
|
|
|
|
|
.Bl -enum -offset indent -compact
|
|
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
General Commands Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
System Calls Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
Library Functions Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
Kernel Interfaces Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
File Formats Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
Games Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
Miscellaneous Information Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
System Manager's Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.It
|
2014-11-19 18:19:21 +00:00
|
|
|
.Fx
|
|
|
|
|
Kernel Developer's Manual
|
2014-09-25 21:34:57 +00:00
|
|
|
.El
|
|
|
|
|
.Pp
|
2010-10-01 03:59:18 +00:00
|
|
|
Options that
|
|
|
|
|
.Nm
|
|
|
|
|
understands:
|
|
|
|
|
.Bl -tag -width indent
|
|
|
|
|
.It Fl M Ar manpath
|
|
|
|
|
Forces a specific colon separated manual path instead of the default
|
|
|
|
|
search path.
|
|
|
|
|
See
|
|
|
|
|
.Xr manpath 1 .
|
|
|
|
|
Overrides the
|
|
|
|
|
.Ev MANPATH
|
|
|
|
|
environment variable.
|
|
|
|
|
.It Fl P Ar pager
|
|
|
|
|
Use specified pager.
|
|
|
|
|
Defaults to
|
2011-08-04 08:50:33 +00:00
|
|
|
.Dq Li "less -sR"
|
When MANCOLOR environment variable is set, enable ANSI color escapes
in grotty(1). This makes it possible to view colorized manpages in
color.
When MANPAGER environment variable is set, use it instead of PAGER.
Why another environment variable, one might ask? With color output
enabled, both a terminal and a pager should support the ANSI color
escapes. On a supporting terminal, less(1) with option -R would be
such a pager, while "more -s" (the current default pager for man(1))
will show garbage. It means a different default pager is needed when
color output is enabled, but many people have PAGER set customary,
and it's unlikely to support ANSI color escapes, so introducing yet
another variable (MANPAGER) seemed like a good option to me:
- if MANPAGER is set, use that unconditionally;
- if you disable color support (it is by default), and don't set
MANPAGER, you get an old behavior: -P pager, $PAGER, "more -s",
in that order;
- if you enable color support (by setting MANCOLOR), and don't set
MANPAGER, we ignore PAGER which is unlikely to support ANSI color
escapes, and you get: -P pager, "less -Rs", in that order;
- you might have good reasons for different man(1) and general
purpose pagers;
- later versions of GNU man(1) support MANPAGER.
2011-06-03 14:34:38 +00:00
|
|
|
if color support is enabled, or
|
2018-08-08 19:24:20 +00:00
|
|
|
.Dq Li "less -s" .
|
2010-10-01 03:59:18 +00:00
|
|
|
Overrides the
|
When MANCOLOR environment variable is set, enable ANSI color escapes
in grotty(1). This makes it possible to view colorized manpages in
color.
When MANPAGER environment variable is set, use it instead of PAGER.
Why another environment variable, one might ask? With color output
enabled, both a terminal and a pager should support the ANSI color
escapes. On a supporting terminal, less(1) with option -R would be
such a pager, while "more -s" (the current default pager for man(1))
will show garbage. It means a different default pager is needed when
color output is enabled, but many people have PAGER set customary,
and it's unlikely to support ANSI color escapes, so introducing yet
another variable (MANPAGER) seemed like a good option to me:
- if MANPAGER is set, use that unconditionally;
- if you disable color support (it is by default), and don't set
MANPAGER, you get an old behavior: -P pager, $PAGER, "more -s",
in that order;
- if you enable color support (by setting MANCOLOR), and don't set
MANPAGER, we ignore PAGER which is unlikely to support ANSI color
escapes, and you get: -P pager, "less -Rs", in that order;
- you might have good reasons for different man(1) and general
purpose pagers;
- later versions of GNU man(1) support MANPAGER.
2011-06-03 14:34:38 +00:00
|
|
|
.Ev MANPAGER
|
|
|
|
|
environment variable, which in turn overrides the
|
2010-10-01 03:59:18 +00:00
|
|
|
.Ev PAGER
|
|
|
|
|
environment variable.
|
|
|
|
|
.It Fl S Ar mansect
|
|
|
|
|
Restricts manual sections searched to the specified colon delimited list.
|
|
|
|
|
Defaults to
|
2020-10-28 16:54:37 +00:00
|
|
|
.Dq Li 1:8:2:3:3lua:n:4:5:6:7:9:l .
|
2010-10-01 03:59:18 +00:00
|
|
|
Overrides the
|
|
|
|
|
.Ev MANSECT
|
|
|
|
|
environment variable.
|
|
|
|
|
.It Fl a
|
|
|
|
|
Display all manual pages instead of just the first found for each
|
|
|
|
|
.Ar page
|
|
|
|
|
argument.
|
|
|
|
|
.It Fl d
|
|
|
|
|
Print extra debugging information.
|
|
|
|
|
Repeat for increased verbosity.
|
|
|
|
|
Does not display the manual page.
|
|
|
|
|
.It Fl f
|
|
|
|
|
Emulate
|
|
|
|
|
.Xr whatis 1 .
|
|
|
|
|
.It Fl h
|
|
|
|
|
Display short help message and exit.
|
|
|
|
|
.It Fl k
|
|
|
|
|
Emulate
|
|
|
|
|
.Xr apropos 1 .
|
|
|
|
|
.It Fl m Ar arch Ns Op : Ns Ar machine
|
|
|
|
|
Override the default architecture and machine settings allowing lookup of
|
|
|
|
|
other platform specific manual pages.
|
|
|
|
|
See
|
|
|
|
|
.Sx IMPLEMENTATION NOTES
|
|
|
|
|
for how this option changes the default behavior.
|
|
|
|
|
Overrides the
|
|
|
|
|
.Ev MACHINE_ARCH
|
|
|
|
|
and
|
|
|
|
|
.Ev MACHINE
|
|
|
|
|
environment variables.
|
|
|
|
|
.It Fl o
|
|
|
|
|
Force use of non-localized manual pages.
|
|
|
|
|
See
|
|
|
|
|
.Sx IMPLEMENTATION NOTES
|
|
|
|
|
for how locale specific searches work.
|
|
|
|
|
Overrides the
|
|
|
|
|
.Ev LC_ALL , LC_CTYPE ,
|
|
|
|
|
and
|
|
|
|
|
.Ev LANG
|
|
|
|
|
environment variables.
|
2011-08-04 08:50:33 +00:00
|
|
|
.It Fl p Op Cm eprtv
|
2010-10-01 03:59:18 +00:00
|
|
|
Use the list of given preprocessors before running
|
|
|
|
|
.Xr nroff 1
|
|
|
|
|
or
|
|
|
|
|
.Xr troff 1 .
|
|
|
|
|
Valid preprocessors arguments:
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
2010-10-01 03:59:18 +00:00
|
|
|
.Bl -tag -width indent -compact
|
|
|
|
|
.It Cm e
|
|
|
|
|
.Xr eqn 1
|
|
|
|
|
.It Cm p
|
|
|
|
|
.Xr pic 1
|
|
|
|
|
.It Cm r
|
|
|
|
|
.Xr refer 1
|
|
|
|
|
.It Cm t
|
|
|
|
|
.Xr tbl 1
|
|
|
|
|
.It Cm v
|
|
|
|
|
.Xr vgrind 1
|
|
|
|
|
.El
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
2010-10-01 03:59:18 +00:00
|
|
|
Overrides the
|
|
|
|
|
.Ev MANROFFSEQ
|
|
|
|
|
environment variable.
|
|
|
|
|
.It Fl t
|
|
|
|
|
Send manual page source through
|
|
|
|
|
.Xr troff 1
|
|
|
|
|
allowing transformation of the manual pages to other formats.
|
|
|
|
|
.It Fl w
|
|
|
|
|
Display the location of the manual page instead of the contents of
|
|
|
|
|
the manual page.
|
|
|
|
|
.El
|
|
|
|
|
.Sh IMPLEMENTATION NOTES
|
|
|
|
|
.Ss Locale Specific Searches
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
utility supports manual pages in different locales.
|
|
|
|
|
The search behavior is dictated by the first of three
|
|
|
|
|
environment variables with a nonempty string:
|
2011-08-04 08:50:33 +00:00
|
|
|
.Ev LC_ALL , LC_CTYPE ,
|
2010-10-01 03:59:18 +00:00
|
|
|
or
|
|
|
|
|
.Ev LANG .
|
|
|
|
|
If set,
|
|
|
|
|
.Nm
|
|
|
|
|
will search for locale specific manual pages using the following logic:
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
|
|
|
|
.Bl -item -offset indent -compact
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
2011-08-04 08:50:33 +00:00
|
|
|
.Va lang Ns _ Ns Va country Ns . Ns Va charset
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
2011-08-04 08:50:33 +00:00
|
|
|
.Va lang Ns . Ns Va charset
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
2011-08-04 08:50:33 +00:00
|
|
|
.Li en Ns . Ns Va charset
|
2010-10-01 03:59:18 +00:00
|
|
|
.El
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
2010-10-01 03:59:18 +00:00
|
|
|
For example, if
|
|
|
|
|
.Ev LC_ALL
|
|
|
|
|
is set to
|
2011-08-04 08:50:33 +00:00
|
|
|
.Dq Li ja_JP.eucJP ,
|
2010-10-01 03:59:18 +00:00
|
|
|
.Nm
|
|
|
|
|
will search the following paths when considering section 1 manual pages in
|
|
|
|
|
.Pa /usr/share/man :
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
|
|
|
|
.Bl -item -offset indent -compact
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
|
|
|
|
.Pa /usr/share/man/ja_JP.eucJP/man1
|
|
|
|
|
.It
|
|
|
|
|
.Pa /usr/share/man/ja.eucJP/man1
|
|
|
|
|
.It
|
|
|
|
|
.Pa /usr/share/man/en.eucJP/man1
|
|
|
|
|
.It
|
|
|
|
|
.Pa /usr/share/man/man1
|
|
|
|
|
.El
|
|
|
|
|
.Ss Platform Specific Searches
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
utility supports platform specific manual pages.
|
|
|
|
|
The search behavior is dictated by the
|
|
|
|
|
.Fl m
|
|
|
|
|
option or the
|
|
|
|
|
.Ev MACHINE_ARCH
|
|
|
|
|
and
|
|
|
|
|
.Ev MACHINE
|
|
|
|
|
environment variables.
|
|
|
|
|
For example, if
|
|
|
|
|
.Ev MACHINE_ARCH
|
|
|
|
|
is set to
|
2017-01-29 00:24:34 +00:00
|
|
|
.Dq Li aarch64
|
2010-10-01 03:59:18 +00:00
|
|
|
and
|
|
|
|
|
.Ev MACHINE
|
|
|
|
|
is set to
|
2017-01-29 00:24:34 +00:00
|
|
|
.Dq Li arm64 ,
|
2010-10-01 03:59:18 +00:00
|
|
|
.Nm
|
|
|
|
|
will search the following paths when considering section 4 manual pages in
|
|
|
|
|
.Pa /usr/share/man :
|
2011-08-04 08:50:33 +00:00
|
|
|
.Pp
|
|
|
|
|
.Bl -item -offset indent -compact
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
2017-01-29 00:24:34 +00:00
|
|
|
.Pa /usr/share/man/man4/aarch64
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
2017-01-29 00:24:34 +00:00
|
|
|
.Pa /usr/share/man/man4/arm64
|
2010-10-01 03:59:18 +00:00
|
|
|
.It
|
|
|
|
|
.Pa /usr/share/man/man4
|
|
|
|
|
.El
|
2010-10-07 06:34:47 +00:00
|
|
|
.Ss Displaying Specific Manual Files
|
|
|
|
|
The
|
|
|
|
|
.Nm
|
|
|
|
|
utility also supports displaying a specific manual page if passed a path
|
|
|
|
|
to the file as long as it contains a
|
2011-08-04 08:50:33 +00:00
|
|
|
.Ql /
|
2010-10-07 06:34:47 +00:00
|
|
|
character.
|
2010-10-01 03:59:18 +00:00
|
|
|
.Sh ENVIRONMENT
|
|
|
|
|
The following environment variables affect the execution of
|
|
|
|
|
.Nm :
|
2011-08-04 08:50:33 +00:00
|
|
|
.Bl -tag -width ".Ev MANROFFSEQ"
|
2010-10-01 03:59:18 +00:00
|
|
|
.It Ev LC_ALL , LC_CTYPE , LANG
|
|
|
|
|
Used to find locale specific manual pages.
|
|
|
|
|
Valid values can be found by running the
|
|
|
|
|
.Xr locale 1
|
|
|
|
|
command.
|
|
|
|
|
See
|
|
|
|
|
.Sx IMPLEMENTATION NOTES
|
|
|
|
|
for details.
|
|
|
|
|
Influenced by the
|
|
|
|
|
.Fl o
|
|
|
|
|
option.
|
|
|
|
|
.It Ev MACHINE_ARCH , MACHINE
|
|
|
|
|
Used to find platform specific manual pages.
|
|
|
|
|
If unset, the output of
|
2011-08-04 08:50:33 +00:00
|
|
|
.Dq Li "sysctl hw.machine_arch"
|
2010-10-01 03:59:18 +00:00
|
|
|
and
|
2011-08-04 08:50:33 +00:00
|
|
|
.Dq Li "sysctl hw.machine"
|
2010-10-01 03:59:18 +00:00
|
|
|
is used respectively.
|
|
|
|
|
See
|
|
|
|
|
.Sx IMPLEMENTATION NOTES
|
|
|
|
|
for details.
|
|
|
|
|
Corresponds to the
|
|
|
|
|
.Fl m
|
|
|
|
|
option.
|
|
|
|
|
.It Ev MANPATH
|
2017-03-11 06:24:49 +00:00
|
|
|
The standard search path used by
|
|
|
|
|
.Xr man 1
|
|
|
|
|
may be changed by specifying a path in the
|
|
|
|
|
.Ev MANPATH
|
|
|
|
|
environment variable.
|
|
|
|
|
Invalid paths, or paths without manual databases, are ignored.
|
|
|
|
|
Overridden by
|
|
|
|
|
.Fl M .
|
|
|
|
|
If
|
|
|
|
|
.Ev MANPATH
|
|
|
|
|
begins with a colon, it is appended to the default list;
|
|
|
|
|
if it ends with a colon, it is prepended to the default list;
|
|
|
|
|
or if it contains two adjacent colons,
|
|
|
|
|
the standard search path is inserted between the colons.
|
|
|
|
|
If none of these conditions are met, it overrides the
|
|
|
|
|
standard search path.
|
2010-10-01 03:59:18 +00:00
|
|
|
.It Ev MANROFFSEQ
|
|
|
|
|
Used to determine the preprocessors for the manual source before running
|
|
|
|
|
.Xr nroff 1
|
|
|
|
|
or
|
|
|
|
|
.Xr troff 1 .
|
|
|
|
|
If unset, defaults to
|
|
|
|
|
.Xr tbl 1 .
|
|
|
|
|
Corresponds to the
|
|
|
|
|
.Fl p
|
|
|
|
|
option.
|
|
|
|
|
.It Ev MANSECT
|
|
|
|
|
Restricts manual sections searched to the specified colon delimited list.
|
|
|
|
|
Corresponds to the
|
|
|
|
|
.Fl S
|
|
|
|
|
option.
|
2011-06-03 05:16:33 +00:00
|
|
|
.It Ev MANWIDTH
|
|
|
|
|
If set to a numeric value, used as the width manpages should be displayed.
|
|
|
|
|
Otherwise, if set to a special value
|
|
|
|
|
.Dq Li tty ,
|
|
|
|
|
and output is to a terminal,
|
|
|
|
|
the pages may be displayed over the whole width of the screen.
|
When MANCOLOR environment variable is set, enable ANSI color escapes
in grotty(1). This makes it possible to view colorized manpages in
color.
When MANPAGER environment variable is set, use it instead of PAGER.
Why another environment variable, one might ask? With color output
enabled, both a terminal and a pager should support the ANSI color
escapes. On a supporting terminal, less(1) with option -R would be
such a pager, while "more -s" (the current default pager for man(1))
will show garbage. It means a different default pager is needed when
color output is enabled, but many people have PAGER set customary,
and it's unlikely to support ANSI color escapes, so introducing yet
another variable (MANPAGER) seemed like a good option to me:
- if MANPAGER is set, use that unconditionally;
- if you disable color support (it is by default), and don't set
MANPAGER, you get an old behavior: -P pager, $PAGER, "more -s",
in that order;
- if you enable color support (by setting MANCOLOR), and don't set
MANPAGER, we ignore PAGER which is unlikely to support ANSI color
escapes, and you get: -P pager, "less -Rs", in that order;
- you might have good reasons for different man(1) and general
purpose pagers;
- later versions of GNU man(1) support MANPAGER.
2011-06-03 14:34:38 +00:00
|
|
|
.It Ev MANCOLOR
|
|
|
|
|
If set, enables color support.
|
|
|
|
|
.It Ev MANPAGER
|
2010-10-01 03:59:18 +00:00
|
|
|
Program used to display files.
|
When MANCOLOR environment variable is set, enable ANSI color escapes
in grotty(1). This makes it possible to view colorized manpages in
color.
When MANPAGER environment variable is set, use it instead of PAGER.
Why another environment variable, one might ask? With color output
enabled, both a terminal and a pager should support the ANSI color
escapes. On a supporting terminal, less(1) with option -R would be
such a pager, while "more -s" (the current default pager for man(1))
will show garbage. It means a different default pager is needed when
color output is enabled, but many people have PAGER set customary,
and it's unlikely to support ANSI color escapes, so introducing yet
another variable (MANPAGER) seemed like a good option to me:
- if MANPAGER is set, use that unconditionally;
- if you disable color support (it is by default), and don't set
MANPAGER, you get an old behavior: -P pager, $PAGER, "more -s",
in that order;
- if you enable color support (by setting MANCOLOR), and don't set
MANPAGER, we ignore PAGER which is unlikely to support ANSI color
escapes, and you get: -P pager, "less -Rs", in that order;
- you might have good reasons for different man(1) and general
purpose pagers;
- later versions of GNU man(1) support MANPAGER.
2011-06-03 14:34:38 +00:00
|
|
|
.Pp
|
|
|
|
|
If unset, and color support is enabled,
|
2011-08-04 08:50:33 +00:00
|
|
|
.Dq Li "less -sR"
|
When MANCOLOR environment variable is set, enable ANSI color escapes
in grotty(1). This makes it possible to view colorized manpages in
color.
When MANPAGER environment variable is set, use it instead of PAGER.
Why another environment variable, one might ask? With color output
enabled, both a terminal and a pager should support the ANSI color
escapes. On a supporting terminal, less(1) with option -R would be
such a pager, while "more -s" (the current default pager for man(1))
will show garbage. It means a different default pager is needed when
color output is enabled, but many people have PAGER set customary,
and it's unlikely to support ANSI color escapes, so introducing yet
another variable (MANPAGER) seemed like a good option to me:
- if MANPAGER is set, use that unconditionally;
- if you disable color support (it is by default), and don't set
MANPAGER, you get an old behavior: -P pager, $PAGER, "more -s",
in that order;
- if you enable color support (by setting MANCOLOR), and don't set
MANPAGER, we ignore PAGER which is unlikely to support ANSI color
escapes, and you get: -P pager, "less -Rs", in that order;
- you might have good reasons for different man(1) and general
purpose pagers;
- later versions of GNU man(1) support MANPAGER.
2011-06-03 14:34:38 +00:00
|
|
|
is used.
|
|
|
|
|
.Pp
|
|
|
|
|
If unset, and color support is disabled, then
|
|
|
|
|
.Ev PAGER
|
|
|
|
|
is used.
|
|
|
|
|
If that has no value either,
|
2018-08-08 19:24:20 +00:00
|
|
|
.Dq Li "less -s"
|
2010-10-01 03:59:18 +00:00
|
|
|
is used.
|
|
|
|
|
.El
|
|
|
|
|
.Sh FILES
|
|
|
|
|
.Bl -tag -width indent -compact
|
|
|
|
|
.It Pa /etc/man.conf
|
|
|
|
|
System configuration file.
|
|
|
|
|
.It Pa /usr/local/etc/man.d/*.conf
|
|
|
|
|
Local configuration files.
|
|
|
|
|
.El
|
2017-12-31 00:35:11 +00:00
|
|
|
.Sh EXIT STATUS
|
|
|
|
|
.Ex -std
|
2021-01-09 16:55:21 +00:00
|
|
|
.Sh EXAMPLES
|
|
|
|
|
Show the manual page for
|
|
|
|
|
.Xr stat 2 :
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
$ man 2 stat
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
|
|
|
|
Show all manual pages for
|
|
|
|
|
.Ql stat .
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
$ man -a stat
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
|
|
|
|
List manual pages which match the regular expression either in the title or in
|
|
|
|
|
the body:
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
$ man -k '\e<copy\e>.*archive'
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
|
|
|
|
Show the manual page for
|
|
|
|
|
.Xr ls 1
|
|
|
|
|
and use
|
|
|
|
|
.Xr cat 1
|
|
|
|
|
as pager:
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
$ man -P cat ls
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
|
|
|
|
Show the location of the
|
|
|
|
|
.Xr ls 1
|
|
|
|
|
manual page:
|
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
|
$ man -w ls
|
|
|
|
|
.Ed
|
|
|
|
|
.Pp
|
2010-10-01 03:59:18 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr apropos 1 ,
|
2011-08-04 08:50:33 +00:00
|
|
|
.Xr intro 1 ,
|
2018-04-25 15:39:36 +00:00
|
|
|
.Xr mandoc 1 ,
|
2014-12-26 21:56:23 +00:00
|
|
|
.Xr manpath 1 ,
|
|
|
|
|
.Xr whatis 1 ,
|
2014-09-25 21:34:57 +00:00
|
|
|
.Xr intro 2 ,
|
|
|
|
|
.Xr intro 3 ,
|
2020-10-24 17:08:59 +00:00
|
|
|
.Xr intro 3lua ,
|
2014-09-25 21:34:57 +00:00
|
|
|
.Xr intro 4 ,
|
|
|
|
|
.Xr intro 5 ,
|
2014-12-26 21:56:23 +00:00
|
|
|
.Xr man.conf 5 ,
|
2014-09-25 21:34:57 +00:00
|
|
|
.Xr intro 6 ,
|
|
|
|
|
.Xr intro 7 ,
|
2018-04-25 15:39:36 +00:00
|
|
|
.Xr mdoc 7 ,
|
2014-09-25 21:34:57 +00:00
|
|
|
.Xr intro 8 ,
|
2014-12-26 21:56:23 +00:00
|
|
|
.Xr intro 9
|
