HP-UX Reference (11i v1 00/12) - 1M System Administration Commands A-M (vol 3)
__________________________________________________________________________________________________________________________________________________________________________________________________
__________________________________________________________________________________________________________________________________________________________________________________________________
STANDARD Printed by: Nora Chuang [nchuang] STANDARD
/build/1111/BRICK/man1m/!!!intro.1m
________________________________________________________________
___ ___
c
catman(1M) catman(1M)
NAME
catman - create the cat files for the manual
SYNOPSIS
/usr/sbin/catman [-A alt-path][-p ][-m ][-n ][-w ][-z ][sections ]
DESCRIPTION
The catman command creates the formatted versions of the online manual from nroff(1)-compatible
source files. Each manual entry in the man∗.Z and man∗ directories is examined, and those whose for-
matted versions are missing or out-of-date are recreated. catman formats the most recent of the entries,
compresses it, and puts it into the appropriate cat∗.Z directory.
If any changes are made, catman recreates the /usr/share/lib/whatis database. By default, the
/usr/share/lib/whatis database is overwritten. If the MANPATH environment variable is set to a
non-default set of paths, the old database file is saved in /usr/share/lib/whatis.old so that, if
desired, the system administrator may merge them together.
By default, catman searches the man∗.Z and man∗ subdirectories under the following man directories:
• /usr/share/man
• /usr/contrib/man
• /usr/local/man
If MANPATH is set in the environment, the directories given in MANPATH are checked instead of the
default. See environ(5) for a description of the MANPATH environment variable.
Before running catman, remove any existing cat∗ directories. If the -z option is used, cat∗.Z
direc-
tories should be removed instead. If both
cat∗.Z and cat∗ directories exist, man(1) updates both direc-
tories and more space is used.
Any command-line parameters not starting with
- are interpreted as a list of manual sections (directories)
to search. For example:
catman 123
restricts updating to manual sections 1, 2, and 3 (directories man1, man2, and man3).
Options
catman supports the following options:
-m Create a merged /usr/share/lib/whatis
database; i.e., information on new
manual entries (added since the last time
catman was run) is merged into the
current database rather than overwriting it. Ignored if selected with the -n option.
-n Prevents creation of /usr/share/lib/whatis
.
-p Prints what would be done instead of doing it.
-w Causes only the /usr/share/lib/whatis database to be created. No manual
reformatting is done.
-z Puts the formatted entries in the cat∗ directories rather than in the cat∗.Z direc-
tories.
-A alt-path Perform actions based on the given alternate root. With this option, alt-path will be
prepended to all directory paths, including default paths, the paths defined by
MAN-
PATH
, and the path to /usr/share/lib/whatis
.
EXTERNAL INFLUENCES
Environment Variables
MANPATH defines parent directories to be used when searching man∗ and man∗.Z directories.
WARNINGS
If unformatted manual entries (those in the ../man ∗ subdirectories) have been removed since the last
time catman was run, information in the /usr/share/lib/whatis database may be lost. The -m
option may be used to override this, but may result in repeated lines in the database for the same manual
entry.
Section 1M−−122 − 1 − HP-UX Release 11i: December 2000
___
___