--------------------------
 XELFI INSTALLATION GUIDE
--------------------------

This text will tell you how to install Xelfi. Please read it before you start.

The installation is based on two steps:
 - install the xelfi package
 - install sun.tools packages (if you haven't got them yet)

After the instalation you can run and enjoy the Xelfi. The main class
(the only argument for java interpreter) is xelfi.Xelfi . So, to run Xelfi
(on the JDK, for example) you will type: java xelfi.Xelfi .

1) install the xelfi package

The Xelfi classes are all situated in one package "xelfi" (with many
subpackages).The package is compressed in the file [PENDING]
Install this package. If you are expierenced with installing java packages
you can skip the next paragraph and continue with section 2.

How to install the xelfi package:
  - select the root directory for the xelfi package. If you have other java
    packages installed on your system, you can choose the same root directory.

  - unzip the xelfi classes into this directory. You will see a new
    subdirectory "xelfi" with many subdirectories and class files.

  - make sure that your CLASSPATH contains this root directory. If not add it
    there. On most systems CLASSPATH is the environment variable containing
    a list of root directories for java packages. It uses the same syntax
    as the PATH variable.
    On Unix machines don't forget to export the CLASSPATH by command "export
    CLASSPATH" before running java.
    Under Microsoft Java VM ("jview" interpreter) the preferred way to setup the
    CLASSPATH is via the registry settings. Run the "regedit" program,
    search for the CLASSPATH in HKEY_LOCAL_MACHINE -> Software - >
     -> Microsoft -> JavaVM -> Classpath, and edit it (add the root directory).

2) install sun.tools packages

Xelfi needs sun.tools packages to run properly. Without them you will not be
able to compile and debug from the Xelfi environment.

If you are using Sun JDK 1.0.2 (or other java kit based on Sun JDK
like Symantec JDK) you have the packages already installed (they come with
the JDK).

If you don't, you will have to install it to run xelfi debugger.
They are available for free download on the Internet (as a part of JDK 1.02).
Our notes for the installation:
  - install the pacakge and update your CLASSPATH - as these classes remains
    packed (zipped) after the installation the item you will add into the
    CLASSPATH will be the complete path + name of this file, like:
      <path_to_the_directory>/classes.zip

  - If you are not using JDK please copy file java.properties into your
    java-home directory after instalation (for example for Microsoft J++ it
    is "...\Win95\java\lib").

  - You have to install the TCP/IP support on your computer to make xelfi
    debugger running. But if your computer is not connected to the network you
    may have problems with IP address. The author of the Xelfi debugger tested
    on his computer (Windows NT 4.0) this configuration

    IP = 1.1.1.1
    MASK = 255.0.0.0

    If you would try to start the debugger without TCP/IP installed
    (using sun.tools.debug) you will get UnknownHostException.

Note on the xelfi debugger:
  Due to poor sun.tools.debug implementation the xelfi debugger currently
  runs well only under JDK from Suns (but on all platforms). See the xelfi
  documentation for more info. We are working to fix it.
