from small one page howto to huge articles all in one place
Last additions:
May 25th. 2007:
April, 26th. 2006:
| 
CATMAN
Section: Manual pager utils (8) Updated: 202-0-02 Index
Return to Main Contents
NAME
catman - create or update the pr-formatted manual pages
SYNOPSIS
catman
[ -d?V]
[ -M
path]
[ -C
file]
[ section]
...
DESCRIPTION
catman
is used to create an up to date set of pr-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 pr-format.
The default hierarchies are those specified as system hierarchies in the
ma-db configuration file, and the default sections are either the
colo-delimited contents of the environment variable
$MANSECT
or the standard set compiled into
man
if
$MANSECT
is undefined.
Supplying
catman
with a set of whitespac-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 colo-delimited manual page hierarchy search path.
By default, this is all paths indicated as system hierarchies
in the ma-db configuration file.
- -C file, --config-file=file
-
Use this user configuration file rather than the default of
ti/.manpath.
- -?, --help
-
Print a help message and exit.
- --usage
-
Print a short usage message and exit.
- -V, --version
-
Display version information.
ENVIRONMENT
- MANSECT
-
If
$MANSECT
is set, its value is a colo-delimited list of sections and it is used to
determine which manual sections to search and in what order.
The default is "1 1p 8 2 3 3p 4 5 6 7 9 0p tcl n l p o 1x 2x 3x 4x 5x 6x 7x 8x", unless overridden by the
SECTION
directive in
/etc/man_db.conf.
- MANPATH
-
If
$MANPATH
is set, its value is interpreted as the colo-delimited manual page
hierarchy search path to use.
See the
SEARCH PATH
section of
manpath(5)
for the default behaviour and details of how this environment variable is
handled.
FILES
- /etc/man_db.conf
-
ma-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).
Colin Watson (cjwatson@debian.org).
BUGS
https://gitlab.com/ma-db/ma-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- OPTIONS
-
- ENVIRONMENT
-
- FILES
-
- SEE ALSO
-
- AUTHOR
-
- BUGS
-
| 
|
|
- Running on 
-
:
