catman(8) [netbsd man page]
CATMAN(8) BSD System Manager's Manual CATMAN(8) NAME
catman -- format cat pages from man pages SYNOPSIS
catman [-knpsw] [-m directory] [sections] catman [-knpsw] [-M directory] [sections] DESCRIPTION
catman creates formatted versions of the on-line manual pages from their nroff(1) source. Manual pages whose formatted versions are missing or out of date are regenerated. If manual pages are regenerated, catman also regenerates the whatis database. The optional sections argument is one word, and contains the section numbers of all the sections to be checked. For example, if sections is ``13f8'', the manual pages in sections 1, 3f, and 8 will be checked and regenerated. If no sections argument is provided, catman will try to operate on all of the known manual sections. The options are as follows: -k Ignore errors from nroff when building manpages. -n Do not create the whatis database. -p Display the commands that would have been executed, but do not actually execute them. -s Perform work silently; do not echo commands as they are executed. This flag is ignored if -p is specified. -w Only create the whatis database. -m directory Add directory to the set of directories to be updated. -M directory Update manual pages in directory. SEE ALSO
apropos(1), man(1), whatis(1) BUGS
Currently does not handle hard links. BSD
July 30, 1993 BSD
Check Out this Related Man Page
CATMAN(8) Manual pager utils CATMAN(8) NAME
catman - create or update the pre-formatted manual pages SYNOPSIS
catman [-d?V] [-M path] [-C file] [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 dis- play than the original manual pages, but require extra storage space. The decision to support cat pages is that of the local administra- tor, 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 sec- tion 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 hierar- chies in the man-db configuration file. -C file, --config-file=file Use this user configuration file rather than the default of ~/.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 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/man_db.conf 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). Colin Watson (cjwatson@debian.org). 2.6.3 2012-09-17 CATMAN(8)