JIG Version 1.1
JIG is a product of S Cubed
http://www.scubed.cc
jig@scubed.cc
Shareware, freely distributable (see license for details)

README.txt
September 1, 1998
Combined Windows 95 & NT and UNIX Installation Instructions

JIG is a Java integrated development environment that lets you write, manage and debug applets and applications written in Java. JIG provides views of class hierarchies, references to code, callers of methods, called methods and stack traces. The debugger implements a GUI interface over the debugger provided in the Java JDK. JIG is written entirely in Java.


CONTENTS

I.   WINDOWS 95 & NT JIG INSTALLATION AND SETUP 
II.  INSTALLING A PATCH
III. UNIX JIG INSTALLATION
IV.  RUNNING JIG ON UNIX



I. WINDOWS 95 & NT JIG INSTALLATION AND SETUP 

The JIG Browser and Debugger assume the prior installation 
of the Java JDK. Especially before any compile, debug or run
operations are attempted.  JIG is delivered with JRE 1.1.6.
Please read the JRE documentation (c:\JIG\Jre\1.1) for more 
information.

For best results, the source code provided in the Java JDK 
should be installed, and your work should be located in packages 
under the \jdkx.x.x\src directory, for example, 
c:\jdk1.1.5\src\Work. This will provide optimal source and 
hierarchical browsing from JIG.

The PATH environment variable should include any Java compilers 
that might be used in JIG.  The PATH should also include the JDK
bin directory to allow JIG to access the JDK javac, jdb, javadoc,
appletViewer and java files.

The program grep32.exe and accompanying documentation grep32.doc
have been included in your JIG home directory.  The grep utility 
is required by JIG for many of the browsing operations.

Once you have downloaded the Jig.zip archive, open the zip file 
and click on the "Install" button.  This will run the Jig setup 
program, extract and load the files from the archive, and create 
a Start Programs folder for "S Cubed" containing JIG, JIG 
Documentation and this README.txt. Follow the instructions 
through the setup process.

Once you start the JIG program, look at the Help About dialog box. 
The various Java system properties are listed there. For the 
"java.class.path" property (CLASSPATH) you will see references 
to classes included in the JDK installation if the JDK is installed 
(or references to classes in the JRE included with the JIG 
installation if the JDK is not installed). This CLASSPATH is passed 
to the java and jdb processes when invoked from the JIG File menu. 

If you need to specify an extended CLASSPATH to be passed to the 
java and jdb processes you can specify the CLASSPATH to use in its 
entirety in View Options Optional CLASSPATH.  The preferred way is to
specify an operating system environment variable for CLASSPATH and 
include it in the startup shortcut for JIG. The JIG shortcut in the 
Start Programs menu specifies a -cp (CLASSPATH) parameter to the jrew 
command. Upon installation it is set to include the JIG classes in
lib\jig.jar, and the JIG home directory (for locale file access). 
This classpath parameter could additionally reference your environment 
variable for CLASSPATH by including the environment variable for 
CLASSPATH in the "-cp" parameter,  -cp .;lib\jig.jar;%CLASSPATH%.  
Note jrew does not use the CLASSPATH environment variable directly.



II. Installing a Patch

As an alternative to reinstalling a patch-release version of
JIG, you can simply install the new jig.jar JIG class archive
file.

Download the file jigjar.zip and extract the jig.jar file 
placing it in your jig\lib directory (jig/lib on UNIX).  
The next time you start JIG it will access the new JIG classes.



III. UNIX JIG INSTALLATION

The JIG installation directory contains the files necessary to configure
JIG for personal use, along with files for documentation and startup.

The JIG installation assumes a prior installation of the Java JDK or JRE
on your platform with the respective bin directory included in your
PATH environment variable.

To perform JIG installation, follow these instructions:

1. From the directory where the jig download file is located and the 
jig directory will be located, unzip the jig.tar.gz file using gunzip,

        gunzip jig.tar.gz

2. Untar the jig.tar file in a local directory location, e.g., 

        tar xvf jig.tar

The tar file contains a 'jig' directory including documentation, 
configuration and startup files.

3. Assign the JIGHOME environment variable in your shell start up script.
For example, in your .profile you would include the line:

        export JIGHOME=/home/mydir/jig

4. Include the 'jig' directory on your path.  This enables you to start JIG
from anywhere.

        export PATH=$PATH:$JIGHOME



IV.  RUNNING JIG ON UNIX


A.  JIG Startup File

In order to run JIG using the 'jig' startup script, the JIGHOME environment
variable must have been previously assigned and included in your PATH.

Type jig at your command prompt:

        $ jig

A background process is started and the JIG window is presented on your 
workstation.

The jig startup script uses jre to run JIG by default.


B. Experiencing Difficulty

1. If the process appears to run but no window opens, check your DISPLAY 
environment variable for a valid IP address.  Java should also display on 
the console an internal error regarding the DISPLAY variable.

2. If the jdk bin directory is not included in your PATH you should see an
error message that the jre is not found.

3. If the JIG Browser does not start and a "file not found" exception occurs
where one of the properties files, such as the jig.properties file, is being
looked for in your home directory, then the JIGHOME environment variable 
has not been defined.

4. If the message "jig: not found" appears when invoking the jig
startup script from a directory other than that defined by JIGHOME, then
JIGHOME has not been included in your PATH.

5. Special parameters have been added to the jig.ini file to correct 
problems found in the behavior of JIG under certain circumstances related 
to platform or version of Java. If your are running JIG under UNIX you should 
carefully consider the following parameters. 


a. If experiencing a problem where the JIG Browser class and method list 
boxes display fewer rows than the packages list box set the following parameter 
in the jig.ini file as indicated,


system0=short list


b. If experiencing a problem where some methods do not appear to be parsed 
correctly by the Browser editor, in particular, method header comments are 
displaying with a previous method, setting the following parameter will 
correct that behavior. This correction does have a side effect which is 
discussed below.


system1=ordinary slash


The side effect of this fix occurs because setting the parameter causes the 
source code parser to no longer ignore comments but rather to parse them. 
The Browser can then display most class files correctly, however, since comments 
are being parsed, certain constructs appearing in comments cause problems 
for the parser, e.g., 


actionPerformed</code>


this construct causes a problem because the slash is not an ordinary character; or, 


class (thread)


this construct looks like the beginning of a class definition. 


c. If experiencing a problem where a highlighted selection in the Browser 
editor or work space is not being read correctly by JIG you can set a 
system parameter to alter JIG's behavior and probably correct the problem. 
For example, you highlight the first occurrence of the word "TextField" in 
source where the word appears more than once and do an Edit Find next 
operation, but the cursor does not advance, other occurrences of the word 
are not found. Set the following parameter in the jig.ini file as indicated,


system2=adjust selection




