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

  man pages->Linux man pages -> catman (8)              



NAME    [Toc]    [Back]

       catman - create or update the pre-formatted manual pages

SYNOPSIS    [Toc]    [Back]

       catman [-dhV] [-M path] [section] ...

DESCRIPTION    [Toc]    [Back]

       catman  is  used  to  create  an up to date set of pre-formatted manual
       pages known as cat pages.  Cat pages are generally much faster to  display
  than  the original manual pages, but require extra storage space.
       The decision to support cat pages is that of the  local	administrator,
       who must provide suitable directories to contain them.

       The  options  available	to  catman are the manual page hierarchies and
       sections to pre-format.	The default hierarchies are those specified as
       system  hierarchies  in	the man_db configuration file, and the default
       sections are either the colon-delimited	contents  of  the  environment
       variable  $MANSECT or the standard set compiled into man if $MANSECT is
       undefined.  Supplying catman with a set of whitespace-delimited section
       names will override both of the above.

       catman makes use of the index database cache associated with each hierarchy
 to determine which files need to be formatted.

OPTIONS    [Toc]    [Back]

       -d, --debug
	      Print debugging information.

       -M path, --manpath=path
	      Specify  an  alternate  colon-delimited  manual  page  hierarchy
	      search  path.  By default, this is all paths indicated as system
	      hierarchies in the man_db configuration file.

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

       -V, --version
	      Display version information.

ENVIRONMENT    [Toc]    [Back]

	      If $MANSECT is set, its value is a colon-delimited list of  sections
  and  it  is  used	to  determine which manual sections to
	      search and in what order.

       MANPATH    [Toc]    [Back]
	      If $MANPATH is set, its value is interpreted as the colon-delimited
 manual page hierarchy search path to use.

FILES    [Toc]    [Back]

	      man_db configuration file.

	      A traditional global index database cache.

	      An alternate or FSSTND compliant global index database cache.

SEE ALSO    [Toc]    [Back]

       man(1), manpath(5), mandb(8).

AUTHOR    [Toc]    [Back]

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

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