JSTOOLS VERSION 4.1/4.4 INSTALLATION INSTRUCTIONS

This directory contains version 4.1/4.4 of the jstools distribution.

Please send bug reports and comments to me, <js@aq.org>.  I am
interested in comments on the documentation as well as the code itself.

IMPORTANT: The production scripts in this version have been tested under
Tk 4.1 and 4.0, and very lightly under 3.6 and 4.2.  Some functionality 
will be missing under Tk 3.6, but I've tried to make sure things still 
run.

The jstools suite doesn't yet run on non-Unix platforms, although 
I hope to remove the Unix dependencies at some point.

INSTALLATION

To install jstools, just run the jinstall wish script in this directory,
fill in the fields properly (help is available within the script), and
click on the `Install' button.  If "./jinstall" doesn't work for you,
try "wish4.1 ./jinstall", "wish4.0 ./jinstall" or "wish -f ./jinstall".

If you don't have wish or the X Window System available when you're
installing jstools, or if you just prefer to do things the hard way, you
can (recursively) copy ./lib to a library directory for the jstools
package (/usr/local/lib/jstools is a reasonable choice).  Then, if you
haven't chosen to put the libraries in /usr/local/lib/jstools, you
should change "/usr/local/lib/jstools" to whatever directory you chose
in the scripts in ./bin, and also (if necessary) change the path to the
wish interpreter in their first lines.  If you want to install the
"works-in-progress" in the "w-in-p" directory, do the same thing with
them.  (Note that jperson and jrtgrep are tclsh scripts rather than wish
scripts.)

TESTING

To test jstools from this directory, you can add <here>/bin to your PATH
environment variable, and set the environment variable JSTOOLS_LIB to
<here>/lib .  (If you're just installing jstools for your own use, in
your own directory, you can just leave it where you unpacked it, set
JSTOOLS_LIB and PATH appropriately in your .cshrc or .profile, and leave
it at that.)

(If your wish and tclsh interpreters aren't /usr/local/bin/wish4.1 
and /usr/local/bin/tclsh7.5 respectively, you'll need to change the 
paths to them at the top of the scripts in <here>/bin and <here>/w-in-p 
for the above to work.  Alternatively, you could follow the installation 
procedure above, and just install into a temporary directory.)

DOCUMENTATION

Documentation is included in jdoc format; it gets installed when you 
copy ./lib (or it gets found under $JSTOOLS_LIB).  You can type "jdoc" 
to get a list of (cryptically-named) topics to choose from, or you 
can type "jdoc jstools" and/or "jdoc jslibraries" to get an overview; 
those documents contain links to the rest of the documentation.

The jdoc documents are used by each application's `Help' menu.

I'm now also distributing the documentation in HTML format, converted
from jdoc format by the procedures in lib/jtagconvert.tcl, which now
have some support for hypertext links.  You should be warned that some
of the formatting (whitespace in particular) is lost, and _internal_
hypertext links within a single document are also lost, so it's better
to use jdoc.  I hope to improve the HTML generation in future versions.

Jay Sekora
<js@aq.org>
1996.10.29