NAME
dogman.csh - UNIX C shell script to create formatted manual
pages and the windex database file
SYNOPSIS
dogman.csh <options> [directory]
OPTIONS
By default, dogman.csh will create the windex file, and add
the missing entries for the current directory. Additional
options can be added as:
-u only update the missing windex file entries
-c execute catman only
-h print this help message
directory : the directory to work on
DESCRIPTION
To enable the "man -k" or "appropos" to work, the windex
database file must be present in the proper man directory,
which is usually accomplished via catman(1M). One problem
is that if a man page such as "foo" is referring man page
"bar" through the standard ".so manx/bar.x" approach, and
"foo" is not listed in the function name section on the man
page of "bar", catman(1M) won't create the entry of "foo" in
the windex file.
dogman.csh solves the problem by first carrying out
catman(1M), then adding up all the missed entries. As
recommended by catman(1M), the original catxx directories
are removed first for consistency concern. The user can use
catman(1M) and "dogman.csh -u" separately to expedite the
process.
It is recommended to use addman.csh after changing or adding
any man pages to both verify and enhance the usability of
the man pages.
EXAMPLES
dogman.csh -u
The above command updates the missing windex file entries,
without running catman(1M).
FILES
$CVIPHOME/docs/Scripts/dogman.csh
DIAGNOSTICS
At the end of the command, dogman.csh will display the total
number of man page entries added to the windex file. If any-
thing goes wrong, it will also display the number of man
pages can't be added to the windex file.
BUGS
NONE
SEE ALSO
catman(1M), htmlman(1)
AUTHOR
Copyright (C) 1996 SIUE - by Scott E. Umbaugh and Yansheng
Wei.