View Source: catman(8) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

catman
!!!catman
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
SEE ALSO
AUTHOR
----
!!NAME


catman - create or update the pre-formatted manual pages
!!SYNOPSIS


__catman__ [[__-dhV__] [[__-M__ ''path'']
[[''section''] ...
!!DESCRIPTION


__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


__-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


__MANSECT__


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__


If $__MANPATH__ is set, its value is interpreted as the
colon-delimited manual page hierarchy search path to
use.
!!FILES


''/etc/manpath.config''


man_db configuration file.


''/usr/man/index.(bt|db|dir|pag)''


A traditional global ''index'' database
cache.


''/var/catman/index.(bt|db|dir|pag)''


An alternate or FSSTND compliant global ''index''
database cache.
!!SEE ALSO


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


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

4 pages link to catman(8):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Tuesday, June 4, 2002 12:31:09 am by "perry"

Edit PageHistory Diff Info LikePages