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: releng/11.0/usr.bin/man/man.1 276258 2014-12-26 21:56:23Z joel $
.Dd September 26, 2014 .Dt MAN 1 .Os .Sh NAME .Nm man .Nd display online manual documentation pages .Sh SYNOPSIS .Nm .Op Fl adho .Op Fl t | w .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.
p The sections of the manual are: l -enum -offset indent -compact t .Fx General Commands Manual t .Fx System Calls Manual t .Fx Library Functions Manual t .Fx Kernel Interfaces Manual t .Fx File Formats Manual t .Fx Games Manual t .Fx Miscellaneous Information Manual t .Fx System Manager's Manual t .Fx Kernel Developer's Manual .El
p Options that .Nm understands: l -tag -width indent t 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. t Fl P Ar pager Use specified pager. Defaults to .Dq Li "less -sR" if color support is enabled, or .Dq Li "more -s" . Overrides the .Ev MANPAGER environment variable, which in turn overrides the .Ev PAGER environment variable. t Fl S Ar mansect Restricts manual sections searched to the specified colon delimited list. Defaults to .Dq Li 1:8:2:3:n:4:5:6:7:9:l . Overrides the .Ev MANSECT environment variable. t Fl a Display all manual pages instead of just the first found for each .Ar page argument. t Fl d Print extra debugging information. Repeat for increased verbosity. Does not display the manual page. t Fl f Emulate .Xr whatis 1 . t Fl h Display short help message and exit. t Fl k Emulate .Xr apropos 1 . t 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. t 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. t Fl p Op Cm eprtv Use the list of given preprocessors before running .Xr nroff 1 or .Xr troff 1 . Valid preprocessors arguments:
p l -tag -width indent -compact t Cm e .Xr eqn 1 t Cm p .Xr pic 1 t Cm r .Xr refer 1 t Cm t .Xr tbl 1 t Cm v .Xr vgrind 1 .El
p Overrides the .Ev MANROFFSEQ environment variable. t Fl t Send manual page source through .Xr troff 1 allowing transformation of the manual pages to other formats. t 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: .Ev LC_ALL , LC_CTYPE , or .Ev LANG . If set, .Nm will search for locale specific manual pages using the following logic:
p l -item -offset indent -compact t .Va lang Ns _ Ns Va country Ns . Ns Va charset t .Va lang Ns . Ns Va charset t .Li en Ns . Ns Va charset .El
p For example, if .Ev LC_ALL is set to .Dq Li ja_JP.eucJP , .Nm will search the following paths when considering section 1 manual pages in
p l -item -offset indent -compact t
a /usr/share/man/ja_JP.eucJP/man1 t
a /usr/share/man/ja.eucJP/man1 t
a /usr/share/man/en.eucJP/man1 t
a /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 .Dq Li i386 and .Ev MACHINE is set to .Dq Li pc98 , .Nm will search the following paths when considering section 4 manual pages in
p l -item -offset indent -compact t
a /usr/share/man/man4 .El .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 .Ql / character. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm : l -tag -width ".Ev MANROFFSEQ" t 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. t Ev MACHINE_ARCH , MACHINE Used to find platform specific manual pages. If unset, the output of .Dq Li "sysctl hw.machine_arch" and .Dq Li "sysctl hw.machine" is used respectively. See .Sx IMPLEMENTATION NOTES for details. Corresponds to the .Fl m option. t Ev MANPATH Used to find the location of the manual files. See .Xr manpath 1 for additional information. Corresponds to the .Fl M option. t 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. t Ev MANSECT Restricts manual sections searched to the specified colon delimited list. Corresponds to the .Fl S option. t 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. t Ev MANCOLOR If set, enables color support. t Ev MANPAGER Program used to display files.
p If unset, and color support is enabled, .Dq Li "less -sR" is used.
p If unset, and color support is disabled, then .Ev PAGER is used. If that has no value either, .Dq Li "more -s" is used. .El .Sh FILES l -tag -width indent -compact t Pa /etc/man.conf System configuration file. t Pa /usr/local/etc/man.d/*.conf Local configuration files. .El .Sh SEE ALSO .Xr apropos 1 , .Xr intro 1 , .Xr locale 1 , .Xr manpath 1 , .Xr nroff 1 , .Xr troff 1 , .Xr whatis 1 , .Xr intro 2 , .Xr intro 3 , .Xr intro 4 , .Xr intro 5 , .Xr man.conf 5 , .Xr intro 6 , .Xr intro 7 , .Xr intro 8 , .Xr intro 9