$Header: /d/people/sam/flexkit/gman/RCS/README,v 1.5 92/11/02 14:28:07 sam Exp $

This is a simple manual browser.  To install it on your machine you
will want to either install the prebuilt set of databases that were
constructed from manual pages that come with 4.0.5, or build a set
of database files that describe the manual pages on your machine
(or possibly cross mount a set of databes that have already been built).  

If you want databases on your machine, install either gman.db.prebuilt
or gman.db.build.  The former is the database of 4.0.5 manual pages
that I use on my machine.  Installing gman.db.build will cause the
script /usr/catman/db/build to be run and the construction of databases
that reflect the contents of /usr/catman.

For example:

% tar xf gman.tar
% su
# inst -f gman

Default location of new software is gman

If you are a first-time inst user, give the command "help beginner".

Inst Main Menu

 1. from [source]               Specify location of software to be installed
 2. list [keywords] [names]     Display information about software subsystems
 3. go                          Perform software installation and removal now
 4. install [keywords] [names]  Select subsystems to be installed
 5. remove [keywords] [names]   Select subsystems to be removed
 6. keep [keywords] [names]     Do not install or remove these subsystems
 7. step [keywords] [names]     Enter interactive mode for install/remove/keep
 8. versions [args]             Get information about installed software
 9. help [topic]                Get help in general or on a specific word
10. admin                       Go to the Administrative Commands Menu
11. quit                        Terminate software installation

Inst> l

Reading installation history database 
Reading product descriptions from gman:

    gman       Gman Document Browser Software, Version 1.0

i = installation requested              I = already installed
r = removal requested                   X = older version installed
k = no action/keep existing version     N = newer version installed

* = default subsystem at initial installation
@ = subsystem must be installed from the miniroot
+ = subsystem required for basic system functionality

Subsystems available for installation (list installable):

    Subsystem                        Description

    gman.db.build                    Gman Database Build Pseudo-Image
    gman.db.prebuilt                 Gman Prebuilt Databases for 4.0.5
  i gman.man.gman *                  Gman Manual Pages
  i gman.sw.bin *                    Gman Binary Executables

Inst> install gman.db.prebuilt
Inst> go
 ....
Inst> quit

If you do not install either pacakge gman should still be useful,
albeit not much more than the normal man command.  It will also be
significaltly slower than using it with the databases.

For your information, these files go in /usr/catman/db:

    Sections		manual section description file
    SectionIcons/*	non-standard images for button faces and
			scrolling list icons
    connectives		stop list of connective words
    manualstops		stop list for manual pages
    cat?toc.[DL]	per-section table-of-contents hashed databases
    cat?ix.[DL]		per-section keyword index hashed databases
    build		shell script to construct database files

At SGI you will find a set of these files on flake.asd:/usr/catman/db.
Elsewhere you should check with your local administrator to see if
there is an existing directory that you can mount and reference.

The file README-INDEX explains how the index building process works
and says a little about what is going on and why.  Note that building
the inverted indexes for all the manual pages can take a long time;
so it is best to build them once and then share them with NFS.

In point of fact, you can have a "db" directory for each manual
tree (e.g. /usr/man/db). 

	Sam
