Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

manpath(1) [freebsd man page]

MANPATH(1)						    BSD General Commands Manual 						MANPATH(1)

NAME
manpath -- display search path for manual pages SYNOPSIS
manpath [-Ldq] DESCRIPTION
The manpath utility determines the user's manual search path from the user's PATH, and local configuration files. This result is echoed to the standard output. -L Output manual locales list instead of the manual path. -d Print extra debugging information. -q Suppresses warning messages. IMPLEMENTATION NOTES
The manpath utility constructs the manual path from two sources: 1. From each component of the user's PATH for the first of: - pathname/man - pathname/MAN - If pathname ends with /bin: pathname/../man Note: Special logic exists to make /bin and /usr/bin look in /usr/share/man for manual files. 2. The configuration files listed in the FILES section for MANPATH entries. The information from these locations is then concatenated together. If the -L flag is set, the manpath utility will search the configuration files listed in the FILES section for MANLOCALE entries. ENVIRONMENT
The following environment variables affect the execution of manpath: MANLOCALES If set with the -L flag, causes the utility to display a warning and the value, overriding any other configuration found on the system. MANPATH If set, causes the utility to display a warning and the value, overriding any other configuration found on the system. PATH Influences the manual path as described in the IMPLEMENTATION NOTES. FILES
/etc/man.conf System configuration file. /usr/local/etc/man.d/*.conf Local configuration files. SEE ALSO
apropos(1), man(1), whatis(1), man.conf(5) BSD
September 1, 2010 BSD

Check Out this Related Man Page

MANPATH(1)							Manual pager utils							MANPATH(1)

NAME
manpath - determine search path for manual pages SYNOPSIS
manpath [-qgdchV] [-m system[,...]] [-C file] DESCRIPTION
If $MANPATH is set, manpath will simply display its contents and issue a warning. If not, manpath will determine a suitable manual page hierarchy search path and display the results. The colon-delimited path is determined using information gained from the man-db configuration file - (/etc/manpath.config) and the user's environment. OPTIONS
-q, --quiet Do not issue warnings. -d, --debug Print debugging information. -c, --catpath Produce a catpath as opposed to a manpath. Once the manpath is determined, each path element is converted to its relative catpath. -g, --global Produce a manpath consisting of all paths named as `global' within the man-db configuration file. -m system[,...], --systems=system[,...] If this system has access to other operating system's manual hierarchies, this option can be used to include them in the output of manpath. To include NewOS's manual page hierarchies use the option -m NewOS. The system specified can be a combination of comma delimited operating system names. To include the native operating system's man- ual page hierarchies, the system name man must be included in the argument string. This option will override the $SYSTEM environ- ment variable. -C file, --config-file=file Use this user configuration file rather than the default of ~/.manpath. -h, --help Print a help message and exit. -V, --version Display version information. ENVIRONMENT
MANPATH If $MANPATH is set, manpath displays its value rather than determining it on the fly. If $MANPATH is prefixed by a colon, then the value of the variable is appended to the list determined from the content of the configuration files. If the colon comes at the end of the value in the variable, then the determined list is appended to the content of the variable. If the value of the variable contains a double colon (::), then the determined list is inserted in the middle of the value, between the two colons. SYSTEM If $SYSTEM is set, it will have the same effect as if it had been specified as the argument to the -m option. FILES
/etc/manpath.config man-db configuration file. SEE ALSO
apropos(1), whatis(1), man(1). AUTHOR
Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org). Colin Watson (cjwatson@debian.org). 2.6.0.2 2011-04-13 MANPATH(1)
Man Page