
SLATXT ,SLTC, SLPRP
 
This directory includes the source and makefile required to build
3 programs that facilitate exploring the routines of the SLATEC
library ( or any library using the SLATEC prologue conventions )
The code is ANSI C; it should run on any UNIX platform with an
ANSI C compiler. It has been tested on the Sun Sparc under 
SunOS 4.1.3 , IBM RS6000 under AIX 3.2, the DEC 5000 under 
Ultrix 4.2a , and the HP9000 under hp-ux 9.01.

--------------------------------------------------------------------

INSTALLATION

1. Obtain xgen if you don't have it; compile it
   xgen can be obtained by anonymous ftp from ftp.cecer.army.mil
   in /grass/other/xgen1.2

   If you are compiling xgen for the HP9000 look at the file
   xgen.tips enclosed with this package.

2. Examine slatecm script ; set $r to directory containing xgen
   set $s to directory containing colors,sltc.xgen files
   Alter PATH so your X11 directory is on it.
   If you do not use AFS delete lines  12-18 if you do make sure
   AFS bin directory is on PATH
   Look at colors file; replace directory at top #define by directory
    your SLATEC documents [guide,toc,etc] are in

3. Concatenate all the SLATEC files you wish in the database into
   a single file. Note that for SLATEC this file will be 
   15-30% larger than the documentation file required by SLADOC.

4. Look at sldoc.h ; alter filename defines at bottom to correspond to
   where you will put the data files.
   set NRTN to a number larger than the number of files in your
   library [but less than 32000]

   Set the make macros for filenames at the top of omakefile to the same 
   values you used in sldoc.h

   create the OS specific makefile for your system with:

   /lib/cpp -P omakefile makefile

5. use makefile to compile programs and build database files with:

   make dtbs
   make all

6. try out slatecm and slatxt.

---------------------------------------------------------------------
SLPRP

This builds a file of keyword phrases and two files of indexes into 
the documentation/ sourcefile. There are a number of limits built into 
these data structures [see sldoc.h], but at least for SLATEC they are
generous. So if the program is used for SLATEC none should need to
be altered.

Limits on number of keyword phrases, gams classifications, and
 SLATEC routines called per routine.
----------------------------------
Note that maximum number of SLATEC routines called by a single 
routine is 49 [DFNCK] in present library. Maximum keys and gams per
routine in library are much less.

#define MXKEY  63
#define MXGAMS 63
#define MXCALL 63

Limit on total number of phrases, gams, routines called: 32764
In SLATEC 4. this is less than 14 000.

Limit on size of source file : 64M
This can be readily changed by increasing size of a.rstart in
sldoc.h

Limit on length of routine names : 8
#define RTNLN 8
SLATEC limit is 6; this limit of 8 can be enlarged by
altering RTNLN .

Limit on length of category name : 12
#define GAMLN 12

For the GAMS classification scheme which is used by the SLATEC
Common Mathematical Library, the maximum length is 10.

---------------------------------------------------------------------
SLTC

This database program is designed to be used with the files
produced by SLPRP . It uses the same header file sldoc.h as
well as several of the same functions as SLPRP.

Although it can be used separately it is designed to be used
from an xgen script, sltc.xgen. xgen in turn is run from the
shell script slatecm [slatec-motif]
Xgen is a Motif X-Windows program which provides a GUI based
on script file specifications.

Xgen can be obtained by anonymous ftp from ftp.cecer.army.mil
in /grass/other/xgen1.2

If you are compiling xgen for the HP9000 look at the file
xgen.tips included here.

---------------------------------------------------------------------
SLATXT

This database program uses the same files as SLTC. It is designed
to resemble SLADOC and SLADOC's predeccesor which was distributed
with SLATEC 3.2 .

---------------------------------------------------------------------

NOTES

This packages handles .F files as well as .f files
SLPRP assumes files with #s in the 1st column are .F files.


---David M. Woodcock
   Computer Aided Engineering Network
   Laboratory for Scientific Computation
   University of Michigan
---------------------------------------------------------------------

SLADOC authored by
 Boland, W. Robert, C-8, Los Alamos National Laboratory
 Bacon, Barbara A., C-10, Los Alamos National Laboratory
 Available from netlib@ornl.gov

Xgen was developed by Kurt Buehler, while at the Center for Advanced 
Decision Support for Water and Environmental Systems (CADSWES), 
University of Colorado at Boulder and at the Indiana Water Resources 
Research Center (IWRRC), Purdue University for the U.S. Army 
Construction Engineering Research Laboratory in support of the 
Geographical Resources Analysis Support System (GRASS) software. 
---------------------------------------------------------------------
