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

  man pages->Linux man pages -> manpath (1)              
Title
Content
Arch
Section
 

manpath(1)

Contents


NAME    [Toc]    [Back]

       manpath - determine search path for manual pages

SYNOPSIS    [Toc]    [Back]

       manpath [-qgdc] [-m system[,...]]

DESCRIPTION    [Toc]    [Back]

       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    [Toc]    [Back]

       -q, --quiet
	      Do not issue warnings.

       -d, --debug
	      Produce 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
  manual  page  hierarchies,  the  system  name man must be
	      included in the argument string.	This option will override  the
	      $SYSTEM environment variable.

       -h, --help
	      Print a help message and exit.

       -V, --version
	      Display version and author information.

ENVIRONMENT    [Toc]    [Back]

       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    [Toc]    [Back]

       /etc/manpath.config  System configuration file.

SEE ALSO    [Toc]    [Back]

      
      
       apropos(1), whatis(1), man(1).

AUTHOR    [Toc]    [Back]

       Wilf. (G.Wilford@ee.surrey.ac.uk).
       Fabrizio Polacco (fpolacco@debian.org).



2.3.20			       07 September 2001		    manpath(1)
[ Back ]
 Similar pages
Name OS Title
manpath FreeBSD determine user's search path for man pages
manctl FreeBSD manipulating manual pages
getNAME FreeBSD get name sections from manual pages
fixman HP-UX fix manual pages for faster viewing with man(1)
man OpenBSD display the on-line manual pages
catman Linux create or update the pre-formatted manual pages
man FreeBSD format and display the on-line manual pages
c2man Linux generate manual pages from C source code
sdoc FreeBSD guide to adding security considerations sections to manual pages
apropos Linux search the manual page names and descriptions
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service