*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> manpath (5)              



NAME    [Toc]    [Back]

       manpath - format of the /etc/manpath.config file

DESCRIPTION    [Toc]    [Back]

       The  manpath configuration file is used by the manual page utilities to
       assess users' manpaths at run time, to indicate which manual page hierarchies
	(manpaths)  are  to  be  treated  as system hierarchies and to
       assign them directories to be used for storing cat files.

       If the environment variable $MANPATH is already	set,  the  information
       contained within /etc/manpath.config will not override it.

FORMAT    [Toc]    [Back]

       The following field types are currently recognised:

       # comment
	      Blank  lines or those beginning with a # will be treated as comments
 and ignored.

       MANDATORY_MANPATH manpath_element
	      Lines of this form indicate manpaths  that  every  automatically
	      generated  $MANPATH should contain.  This will typically include

       MANPATH_MAP path_element manpath_element
	      Lines of this form set up $PATH to $MANPATH mappings.  For  each
	      path_element  found in the user's $PATH, manpath_element will be
	      added to the $MANPATH.

       MANDB_MAP manpath_element [ catpath_element ]
	      Lines of this form indicate which manpaths are to be treated  as
	      system  manpaths, and optionally where their cat files should be
	      stored.  This field type is particularly important if man  is  a
	      setuid  program,	as  (when  in  the  system  configuration file
	      /etc/manpath.config rather than the per-user configuration  file
	      .manpath)  it  indicates which manual page hierarchies to access
	      as the setuid user and which as the invoking user.

	      The system manual page  hierarchies  are	usually  those	stored
	      under  /usr such as /usr/man, /usr/local/man and /usr/X11R6/man.

	      If cat pages from a particular manpath_element  are  not	to  be
	      stored  or  are  to  be stored in the traditional location, cat-
	      path_element may be omitted.

	      Traditional cat placement would  be  impossible  for  read  only
	      mounted manual page hierarchies and because of this it is possible
 to specify any valid directory hierarchy for their  storage.
	      To  observe  the Linux FSSTND the keyword `FSSTND can be used in
	      place of an actual directory.

	      Unfortunately, it is necessary to specify all  system  man  tree
	      paths,  including  alternate  operating  system  paths  such  as
	      /usr/man/sun   and   any	  NLS	 locale    paths    such    as

	      As  the information is parsed line by line in the order written,
	      it is necessary for any  manpath	that  is  a  sub-hierarchy  of
	      another  hierarchy  to  be  listed first, otherwise an incorrect
	      match will be made.  An  example	is  that  /usr/man/de_DE.88591
	      must come before /usr/man.

       DEFINE key value
	      Lines of this form define miscellaneous configuration variables;
	      see the default configuration file for those variables  used  by
	      the manual pager utilities.  They include default paths to various
 programs (such as grep and tbl), and default sets  of  arguments
 to those programs.

BUGS    [Toc]    [Back]

       Unless  the rules above are followed and observed precisely, the manual
       pager utilities will not function as desired.   The  rules  are	overly

2.3.20			       07 September 2001		    manpath(5)
[ Back ]
 Similar pages
Name OS Title
isdnd.rc FreeBSD isdn4bsd ISDN connection management daemon config file format
syseventIrix IRIX Sysmon Config File converter
rtadvd.conf FreeBSD config file for router advertisement daemon
rtadvd.conf OpenBSD config file for router advertisement daemon
CPAN::FirstTime IRIX Utility for CPAN::Config file Initialization
dhcpdb2conf HP-UX convert DHCP client database to config file parameters
DxfToIv IRIX converts an Autodesk Data Exchange File format (.DXF) file to Open Inventor 2.0 format
dh_installlogrotate Linux install logrotate config files
files.conf OpenBSD rules base for the config utility
wlconfig FreeBSD read/write wavelan config parameters
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service