This is a short README file for the man-utils package. This package
contains programs and scripts that make viewing, creating and using
manual pages under A/UX easier. Included in this package are:

    README	 : This file
    auxman	 : A shell script to install and gzip man pages
    getname	 : supporting program for 'mkwhatis'
    gfind	 : GNUfind. For 'mkwhatis'
    gzcat	 : GNUzcat. For 'man' and 'mkwhatis'
    gzip	 : GNUzip. For 'auxman'
    less	 : The 'less' program. For 'man'
    man		 : A replacement for /usr/bin/man
    mkwhatis	 : Rebuilds /usr/lib/whatis
    mkwhatis.1.Z : manpage for 'mkwhatis'

===
MAN
===
This is a replacement for the 'man' script found in /usr/bin under A/UX.
This package uses 'less' and 'gzcat' which adds some nice features to
the script. To use, install it under /usr/bin, then install 'less' and 'gzcat'
someplace (maybe /usr/local/bin) and then edit 'man' to reflect where those
programs are.

Enjoy!

======
AUXMAN
======
A shell script that installs and gzips man pages for A/UX.

========
MKWHATIS
========
If you are like me, you've added a lot of extra programs to A/UX. You've
also added the 'man' pages for these programs somewhere in /usr/catman.
This is good, since you can run 'man' and get the info you need. However,
'whatis' and 'apropos' know _nothing_ about these new programs! What's
needed is a way to update the /usr/lib/whatis database to reflect these new
entries.

That's what 'mkwhatis' does.

'mkwhatis' is a ksh-script that runs through all the files under /usr/catman
and then feeds the man-page entries to 'getname.' 'getname' is the real
workhorse since it needs to "decode" the information found in the man
pages. Finally, a new version of /usr/lib/whatis (called /usr/lib/whatis.new)
is created. If it looks good, 'cp' it over to /usr/lib/whatis.

Both 'mkwhatis' and 'getname' were originally written by Bob Denny. I've
smoothed a few things over and fixed a few bugs. Two nice additions are that
'mkwhatis' no longer requires on hard-wired info about the man-page directories
and that GNUzip is used to decompress|unpack|unzip the man pages. Make sure
that 'zcat' is called with the '-f' option!

You will need to use GNUfind and GNUzcat, which are provided. Install them
in some convenient place (/usr/local/bin maybe) and then edit 'mkwhatis'
to correctly point to them.

Enjoy!

--
    Jim Jagielski               |  "That is no ordinary rabbit... 'tis the
    jim@jagubox.gsfc.nasa.gov   |   most foul, cruel and bad-tempered
    NASA/GSFC, Code 734.4       |   rodent you ever set eyes on"
    Greenbelt, MD 20771         |                   Tim the Enchanter
