home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 27 / CDROM27.iso / share / wnt / jig / data1.cab / Program_Executable_Files / README.txt < prev    next >
Encoding:
Text File  |  1998-08-19  |  7.4 KB  |  209 lines
  1. JIG Version 1.1
  2. README.txt
  3. September 1, 1998
  4. Combined Windows 95 & NT and UNIX Installation Instructions
  5.  
  6.  
  7. CONTENTS
  8.  
  9. I.   WINDOWS 95 & NT JIG INSTALLATION AND SETUP 
  10. II.  INSTALLING A PATCH
  11. III. UNIX JIG INSTALLATION
  12. IV.  RUNNING JIG ON UNIX
  13.  
  14.  
  15.  
  16. I. WINDOWS 95 & NT JIG INSTALLATION AND SETUP 
  17.  
  18. The JIG Browser and Debugger assume the prior installation 
  19. of the Java JDK. Especially before any compile, debug or run
  20. operations are attempted.  JIG is delivered with JRE 1.1.6.
  21. Please read the JRE documentation (c:\JIG\Jre\1.1) for more 
  22. information.
  23.  
  24. For best results, the source code provided in the Java JDK 
  25. should be installed, and your work should be located in packages 
  26. under the \jdkx.x.x\src directory, for example, 
  27. c:\jdk1.1.5\src\Work. This will provide optimal source and 
  28. hierarchical browsing from JIG.
  29.  
  30. The PATH environment variable should include any Java compilers 
  31. that might be used in JIG.  The PATH should also include the JDK
  32. bin directory to allow JIG to access the JDK javac, jdb, javadoc,
  33. appletViewer and java files.
  34.  
  35. The program grep32.exe and accompanying documentation grep32.doc
  36. have been included in your JIG home directory.  The grep utility 
  37. is required by JIG for many of the browsing operations.
  38.  
  39. Once you have downloaded the Jig.zip archive, open the zip file 
  40. and click on the "Install" button.  This will run the Jig setup 
  41. program, extract and load the files from the archive, and create 
  42. a Start Programs folder for "S Cubed" containing JIG, JIG 
  43. Documentation and this README.txt. Follow the instructions 
  44. through the setup process.
  45.  
  46. Once you start the JIG program, look at the Help About dialog box. 
  47. The various Java system properties are listed there. For the 
  48. "java.class.path" property (CLASSPATH) you will see references 
  49. to classes included in the JDK installation if the JDK is installed 
  50. (or references to classes in the JRE included with the JIG 
  51. installation if the JDK is not installed). This CLASSPATH is passed 
  52. to the java and jdb processes when invoked from the JIG File menu. 
  53.  
  54. If you need to specify an extended CLASSPATH to be passed to the 
  55. java and jdb processes you can specify the CLASSPATH to use in its 
  56. entirety in View Options Optional CLASSPATH.  The preferred way is to
  57. specify an operating system environment variable for CLASSPATH and 
  58. include it in the startup shortcut for JIG. The JIG shortcut in the 
  59. Start Programs menu specifies a -cp (CLASSPATH) parameter to the jrew 
  60. command. Upon installation it is set to include the JIG classes in
  61. lib\jig.jar, and the JIG home directory (for locale file access). 
  62. This classpath parameter could additionally reference your environment 
  63. variable for CLASSPATH by including the environment variable for 
  64. CLASSPATH in the "-cp" parameter,  -cp .;lib\jig.jar;%CLASSPATH%.  
  65. Note jrew does not use the CLASSPATH environment variable directly.
  66.  
  67.  
  68.  
  69. II. Installing a Patch
  70.  
  71. As an alternative to reinstalling a patch-release version of
  72. JIG, you can simply install the new jig.jar JIG class archive
  73. file.
  74.  
  75. Download the file jigjar.zip and extract the jig.jar file 
  76. placing it in your jig\lib directory (jig/lib on UNIX).  
  77. The next time you start JIG it will access the new JIG classes.
  78.  
  79.  
  80.  
  81. III. UNIX JIG INSTALLATION
  82.  
  83. The JIG installation directory contains the files necessary to configure
  84. JIG for personal use, along with files for documentation and startup.
  85.  
  86. The JIG installation assumes a prior installation of the Java JDK or JRE
  87. on your platform with the respective bin directory included in your
  88. PATH environment variable.
  89.  
  90. To perform JIG installation, follow these instructions:
  91.  
  92. 1. From the directory where the jig download file is located and the 
  93. jig directory will be located, unzip the jig.tar.gz file using gunzip,
  94.  
  95.         gunzip jig.tar.gz
  96.  
  97. 2. Untar the jig.tar file in a local directory location, e.g., 
  98.  
  99.         tar xvf jig.tar
  100.  
  101. The tar file contains a 'jig' directory including documentation, 
  102. configuration and startup files.
  103.  
  104. 3. Assign the JIGHOME environment variable in your shell start up script.
  105. For example, in your .profile you would include the line:
  106.  
  107.         export JIGHOME=/home/mydir/jig
  108.  
  109. 4. Include the 'jig' directory on your path.  This enables you to start JIG
  110. from anywhere.
  111.  
  112.         export PATH=$PATH:$JIGHOME
  113.  
  114.  
  115.  
  116. IV.  RUNNING JIG ON UNIX
  117.  
  118.  
  119. A.  JIG Startup File
  120.  
  121. In order to run JIG using the 'jig' startup script, the JIGHOME environment
  122. variable must have been previously assigned and included in your PATH.
  123.  
  124. Type jig at your command prompt:
  125.  
  126.         $ jig
  127.  
  128. A background process is started and the JIG window is presented on your 
  129. workstation.
  130.  
  131. The jig startup script uses jre to run JIG by default.
  132.  
  133.  
  134. B. Experiencing Difficulty
  135.  
  136. 1. If the process appears to run but no window opens, check your DISPLAY 
  137. environment variable for a valid IP address.  Java should also display on 
  138. the console an internal error regarding the DISPLAY variable.
  139.  
  140. 2. If the jdk bin directory is not included in your PATH you should see an
  141. error message that the jre is not found.
  142.  
  143. 3. If the JIG Browser does not start and a "file not found" exception occurs
  144. where one of the properties files, such as the jig.properties file, is being
  145. looked for in your home directory, then the JIGHOME environment variable 
  146. has not been defined.
  147.  
  148. 4. If the message "jig: not found" appears when invoking the jig
  149. startup script from a directory other than that defined by JIGHOME, then
  150. JIGHOME has not been included in your PATH.
  151.  
  152. 5. Special parameters have been added to the jig.ini file to correct 
  153. problems found in the behavior of JIG under certain circumstances related 
  154. to platform or version of Java. If your are running JIG under UNIX you should 
  155. carefully consider the following parameters. 
  156.  
  157.  
  158. a. If experiencing a problem where the JIG Browser class and method list 
  159. boxes display fewer rows than the packages list box set the following parameter 
  160. in the jig.ini file as indicated,
  161.  
  162.  
  163. system0=short list
  164.  
  165.  
  166. b. If experiencing a problem where some methods do not appear to be parsed 
  167. correctly by the Browser editor, in particular, method header comments are 
  168. displaying with a previous method, setting the following parameter will 
  169. correct that behavior. This correction does have a side effect which is 
  170. discussed below.
  171.  
  172.  
  173. system1=ordinary slash
  174.  
  175.  
  176. The side effect of this fix occurs because setting the parameter causes the 
  177. source code parser to no longer ignore comments but rather to parse them. 
  178. The Browser can then display most class files correctly, however, since comments 
  179. are being parsed, certain constructs appearing in comments cause problems 
  180. for the parser, e.g., 
  181.  
  182.  
  183. actionPerformed</code>
  184.  
  185.  
  186. this construct causes a problem because the slash is not an ordinary character; or, 
  187.  
  188.  
  189. class (thread)
  190.  
  191.  
  192. this construct looks like the beginning of a class definition. 
  193.  
  194.  
  195. c. If experiencing a problem where a highlighted selection in the Browser 
  196. editor or work space is not being read correctly by JIG you can set a 
  197. system parameter to alter JIG's behavior and probably correct the problem. 
  198. For example, you highlight the first occurrence of the word "TextField" in 
  199. source where the word appears more than once and do an Edit Find next 
  200. operation, but the cursor does not advance, other occurrences of the word 
  201. are not found. Set the following parameter in the jig.ini file as indicated,
  202.  
  203.  
  204. system2=adjust selection
  205.  
  206.  
  207.  
  208.  
  209.