GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
MAN(1) FreeBSD General Commands Manual MAN(1)

man
display online manual documentation pages

man [
-adho
] [
-t | -w
] [
-M manpath
] [
-P pager
] [
-S mansect
] [
-m arch[
:machine
]
] [
-p [
eprtv
]
] [
mansect
] page ...

man -f keyword ...

man -k keyword ...

The man utility finds and displays online manual documentation pages. If mansect is provided, man restricts the search to the specific section of the manual.
The sections of the manual are:
  1. FreeBSD General Commands Manual
  2. FreeBSD System Calls Manual
  3. FreeBSD Library Functions Manual
  4. FreeBSD Kernel Interfaces Manual
  5. FreeBSD File Formats Manual
  6. FreeBSD Games Manual
  7. FreeBSD Miscellaneous Information Manual
  8. FreeBSD System Manager's Manual
  9. FreeBSD Kernel Developer's Manual
Options that man understands:
manpath
Forces a specific colon separated manual path instead of the default search path. See manpath(1). Overrides the MANPATH environment variable.
pager
Use specified pager. Defaults to “less -sR” if color support is enabled, or “less -s”. Overrides the MANPAGER environment variable, which in turn overrides the PAGER environment variable.
mansect
Restricts manual sections searched to the specified colon delimited list. Defaults to “1:8:2:3:n:4:5:6:7:9:l”. Overrides the MANSECT environment variable.
Display all manual pages instead of just the first found for each page argument.
Print extra debugging information. Repeat for increased verbosity. Does not display the manual page.
Emulate whatis(1).
Display short help message and exit.
Emulate apropos(1).
arch[
:machine
]
Override the default architecture and machine settings allowing lookup of other platform specific manual pages. See IMPLEMENTATION NOTES for how this option changes the default behavior. Overrides the MACHINE_ARCH and MACHINE environment variables.
Force use of non-localized manual pages. See IMPLEMENTATION NOTES for how locale specific searches work. Overrides the LC_ALL, LC_CTYPE, and LANG environment variables.
[
eprtv
]
Use the list of given preprocessors before running nroff(1) or troff(1). Valid preprocessors arguments:
eqn(1)
pic(1)
refer(1)
tbl(1)
vgrind(1)
Overrides the MANROFFSEQ environment variable.
Send manual page source through troff(1) allowing transformation of the manual pages to other formats.
Display the location of the manual page instead of the contents of the manual page.

The man utility supports manual pages in different locales. The search behavior is dictated by the first of three environment variables with a nonempty string: LC_ALL, LC_CTYPE, or LANG. If set, man will search for locale specific manual pages using the following logic:
  • lang_country.charset
  • lang.charset
  • .charset
For example, if LC_ALL is set to “ja_JP.eucJP”, man will search the following paths when considering section 1 manual pages in /usr/share/man:
  • /usr/share/man/ja_JP.eucJP/man1
  • /usr/share/man/ja.eucJP/man1
  • /usr/share/man/en.eucJP/man1
  • /usr/share/man/man1

The man utility supports platform specific manual pages. The search behavior is dictated by the -m option or the MACHINE_ARCH and MACHINE environment variables. For example, if MACHINE_ARCH is set to “aarch64” and MACHINE is set to “arm64”, man will search the following paths when considering section 4 manual pages in /usr/share/man:
  • /usr/share/man/man4/aarch64
  • /usr/share/man/man4/arm64
  • /usr/share/man/man4

The man utility also supports displaying a specific manual page if passed a path to the file as long as it contains a ‘/’ character.

The following environment variables affect the execution of man:
, LC_CTYPE, LANG
Used to find locale specific manual pages. Valid values can be found by running the locale(1) command. See IMPLEMENTATION NOTES for details. Influenced by the -o option.
, MACHINE
Used to find platform specific manual pages. If unset, the output of “sysctl hw.machine_arch” and “sysctl hw.machine” is used respectively. See IMPLEMENTATION NOTES for details. Corresponds to the -m option.
The standard search path used by man(1) may be changed by specifying a path in the MANPATH environment variable. Invalid paths, or paths without manual databases, are ignored. Overridden by -M. If 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.
Used to determine the preprocessors for the manual source before running nroff(1) or troff(1). If unset, defaults to tbl(1). Corresponds to the -p option.
Restricts manual sections searched to the specified colon delimited list. Corresponds to the -S option.
If set to a numeric value, used as the width manpages should be displayed. Otherwise, if set to a special value “tty”, and output is to a terminal, the pages may be displayed over the whole width of the screen.
If set, enables color support.
Program used to display files.
If unset, and color support is enabled, “less -sR” is used.
If unset, and color support is disabled, then PAGER is used. If that has no value either, “less -s” is used.

/etc/man.conf
System configuration file.
/usr/local/etc/man.d/*.conf
Local configuration files.

The man utility exits 0 on success, and >0 if an error occurs.

apropos(1), intro(1), mandoc(1), manpath(1), whatis(1), intro(2), intro(3), intro(4), intro(5), man.conf(5), intro(6), intro(7), mdoc(7), intro(8), intro(9)
August 8, 2018 FreeBSD 12.0-RELEASE

Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.