NAME

catman - create the cat files for the manual

SYNOPSIS

/usr/bin/catman [ -n ] [ -p ] [ -t ] [ -w ] [ -M directory ] [ -T macro-package ]

[ sections ]

DESCRIPTION

catman creates the preformatted versions of the on-line manual from the nroff(1) input files. Each manual page is examined and those whose preformatted versions are missing or out of date are recreated. If any changes are made, catman recreates the windex database.

If there is one parameter not starting with a `-', it is taken to be a space separated list of manual sections to create. For example

catman 1 2 3

only updates manual sections 1 ,2 ,and 3 .

If an unformatted source file contains only a line of the form .so manx/yyy.x, a symbolic link is made in the catx or fmtx directory to the appropriate preformatted manual page. This feature allows easy distribution of the preformatted manual pages among a group of associated machines (for example, with rdist(1)), since it makes the directories of preformatted manual pages self-contained and independent of the unformatted entries.

OPTIONS

-n

Do not create (or recreate) the windex database.

-p

Print what would be done instead of doing it.

-t

Create troffed entries in the appropriate fmt subdirectories instead of nroffing into the cat subdirectories.

-w

Only create the windex database that is used by whatis(1) and the man (1)-f and -k options. No manual reformatting is done.

-M directory

Update manual pages located in the specified directory (/usr/share/man by default).

-T macro-package

Use macro-package in place of the standard manual page macros.

ENVIRONMENT

TROFF

The name of the formatter to use when the -t flag is given. If not set, troff(1) is used.

FILES

/usr/share/man

default manual directory location

/usr/share/man/man?/* . *

raw (nroff input) manual sections

/usr/share/man/cat?/* . *

preformatted nroffed manual pages

/usr/share/man/fmt?/* . *

preformatted troffed manual pages

/usr/share/man/windex

table of contents and keyword database

/usr/lib/makewhatis

command script to make windex database

/usr/share/lib/tmac/an

default macro package

SEE ALSO

apropos(1), man (1),nroff(1), rdist(1), rm(1), troff(1), whatis(1)

DIAGNOSTICS

man?/xxx.? (.so'ed from man?/yyy.?): No such file or directory

The file outside the parentheses is missing, and is referred to by the file inside them.

target of .so in man?/xxx.? must be relative to /usr/man
        catman only allows references to filenames that are relative to the directory
        /usr/man.

opendir:man?: No such file or directory

A harmless warning message indicating that one of the directories catman normally looks for is missing.

* . *No

:

such file or directory

A harmless warning message indicating catman came across an empty directory.

WARNINGS

If a user, who has previously run catman to install the cat? directories, upgrades the operating system, the entire cat? directory structure should be removed prior to running catman. See rm(1).

NOTES

If the -n option is specified, the /usr/share/man/windex database is not created and the apropos, whatis, man -f, and man -k commands will fail.

If the -M option is specified, the directory argument must not contain a ',' since ',' is used to delineate section numbers. See man (1).