
                 --------------------------------------------
                  Welcome to Xelfi 0.91 Unregistered Version
                 --------------------------------------------

  This README file contains information about Xelfi, especially 
  installation and running issues.

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

 -----------------
 TABLE OF CONTENTS
 -----------------

	1. Installation
	  1.1 System Requirements
	  1.2 Installing "xelfi" Package
	  1.3 Installing "sun.tools" Package

	2. Running Xelfi
	  2.1 Windows 95/NT
	  2.2 OS/2
	  2.3 Unixes (Linux, Solaris, HPUX,...)
	  2.4 Running manually

	3. Troubleshooting

	4. How to Get Further Help

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

 ---------------
 1. INSTALLATION
 ---------------

   This text should help you with the Xelfi installation.
   Please read it before you start.

 1.1 System Requirements
 -----------------------

   Hardware Requirements
   ---------------------
   Minimal Configuration: (Intel processors)

  	- PC with 486 DX processor,
	- 8-16 MB of RAM (depends on OS),
	- screen resolution 800x600 pixels, mouse

   Recommended Configuration: (Intel processors)
        - PC with Pentium processor,
	- 16-32 MB of RAM(depends on OS),
	- screen resolution 1024x768 pixels, mouse 

   Note: Whole Xelfi is written in Java. The most important parts
	 of your computer for all bigger Java applications and 
	 applets are processor and amount of memory. 
	 Xelfi is not an exception.

   Software Requirements
   ---------------------
	- Java Virtual Machine which meets the standard of JDK 1.0.2 or 
	  JDK 1.1.1 correctly installed
	- Operating System with long file support
	- Application that handle zip file with long filename support
	  (for example Winzip on win95/NT, zip/unzip on Unixes...)
	- Possible TCP/IP support


 1.2 Installing Xelfi Package
 ----------------------------
   First step in the installation is installing "xelfi" package.	
   Xelfi system itself is written in Java. It means, that Xelfi 
   itself is a set of java classes, which are grouped in packages.
   All Xelfi are situated in one package called "xelfi" 
   with many subpackages.
   The package is compressed in the file called "Xelfi091_JDK???.zip".
   The ??? chars may differ depending on your platform.

   Perform these steps to install xelfi package:

   a) Choose a directory where you want Xelfi IDE to be installed.
      We will call this directory <Xelfi RootDir> directory.

   b) Unzip the file "Xelfi091_JDK???.zip" with your unzipping
      utility (!must support zip with long filenames!) into 
      previously chosen <Xelfi RootDir> directory.		
   	
   Checkpoint:
   Your directory structure should now look like this:

	<Xelfi RootDir>
	  |-- licence
	  |-- xelfi
	       |-- awt
	       |-- browser
	       |-- compiler
	       |-- debugger 
               |-- design
	         ...
                 ...

   And the files in <Xelfi RootDir>:
	
	xelfi.cmd	- OS/2 starter script
	xelfi.sh	- Unix starter script
	xelfiJDK.bat	- win 95/NT starter script
	xelfiMS.bat	- win 95/NT starter script for Microsoft's VM
	xrunner.exe	- win 95/NT starter exe
	readme.txt    	- this readme file


 1.3 Installing "sun.tools" Package
 -------------------------------------
   Now we have installed "xelfi' package in our <Xelfi RootDir> 
   directory. What remains is to install "sun.tools" package.
   Xelfi needs sun.tools package to run properly. 
   Without sun.tools, you WILL STILL be able to run Xelfi,
   but you will not be able to do internal compile and debug 
   from the Xelfi IDE.

   1) Find out if you have sun.tools already installed.
      If you use some JDK (1.0.2 or 1.1.1),
      then YOU will HAVE the sun.tools package ALREADY INSTALLED,
      because it is already included in the JDK.
      You are lucky and you can skip this step directly to 
      "Installing TCP-IP support".
      It is true for all ports of JDK we know, not depending on 
      the platform
      (all Sun's JDKs(Win 95/NT, Solaris, Macintosh), 
       IBM OS/2 JDK, Symantec JDK, Linux JDK, HPUX JDK....)

   2) Only if 1) is not true (for example if you use Microsoft's Java SDK), 
      you will have to install sun.tools manually.

      Perform these steps to install sun.tools package manually:
	
      a) Download some JDK (for example Sun's JDK 1.0.2)
	 It is available for free download for example 
	 at http://www.javasoft.com.

      b) Extract file "classes.zip" from JDK zip file.
	 (it should be stored in "lib" directory in zip file)
	 Sun tools package is zipped in file "classes.zip" together 
	 with other classes. Store the "classes.zip" file to some 
	 directory and leave it in zipped form. 
	 We will call this directory <SunTools Dir> directory.

      c) Extract file "javac.properties" from JDK zip file
	 (it should be also in "lib" dir  in zip file)
	 and copy this file into your java-home directory.
	 (for example for Microsoft VM it is 
	 "...\<Windows home dir>\java\lib").
	 
      d) Update your CLASSPATH environment variable
	 Add full path to the "classes.zip" file to the end of your 
	 CLASSPATH environment variable.
	 On Win, the command could be:
		set CLASSPATH=%CLASSPATH%;<SunTools Dir>\classes.zip
	 On unixes:
		export CLASSPATH=$CLASSPATH:<SunTools Dir>/classes.zip
	 etc...

 1.4 Installing TCP/IP Support
 -----------------------------
   TCP/IP support is not needed only if you want to use Xelfi IDE debugger.
   You have to install the TCP/IP support on your computer to make Xelfi
   debugger running. Xelfi debugger needs TCP/IP support installed in the 
   same way as JDK's command line debugger jdb. If you would try to start
   both debuggers without TCP/IP installed, you will get
   "UnknownHostException" error.

   If your computer is not connected to the network you may have problems 
   with IP address and netmask. 
   We tested this configuration succesfully:

	    IP = 1.1.1.1
	    MASK = 255.0.0.0

 ------
 Now, you should have Xelfi IDE fully installed and you can 
 learn how to run it.

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

 ----------------
 2. RUNNING XELFI
 ----------------
   There are two main possibilities how to run Xelfi.

	a) Use one of our starter scripts, 
	   which are located in <Xelfi RootDir> directory
	   (See sections 2.1, 2.2, 2.3)

	b) Run Xelfi manually, e.g. without starter scripts
	   (See section 2.4)

	
 2.1 Windows 95/NT
 -----------------
   To help you run Xelfi on Win 95/NT, we prepared some 
   starter tools. In the <Xelfi RootDir> directory you should have 
   these files (among others):
   	
   xelfiJDK.bat - DOS batch file that starts Xelfi 
		  using "java" Java JDK interpreter
		  (use with JDKs)
		  
   xelfiMS.bat - DOS batch file that starts Xelfi 
		 using "jview" Microsoft's Java interpreter
		 (use with MS Java SDK)

   xrunner.exe - Small Win32 application that actually starts Xelfi.
		 It is called both by xelfiJDK.bat and xelfiMS.bat	
     syntax:
	xrunner.exe <"java_interpreter_path">
     (for example xrunner.exe "c:\java\ms-sdk\bin\jview")


   To run Xelfi IDE:
	a) Run xelfiJDK.bat or xelfiMS.bat depending on your Java kit. 
	   Note that you must have java interpreter accessible 
	   through the PATH system environment to use these batches.

	--OR--

	b) Create a shortcut to the xrunner.exe (containing necessary
	   parameter) and run this shortcut.


 2.2 OS/2
 --------
   To run Xelfi IDE on OS/2, simply change the directory to the 
   <Xelfi RootDir> directory and run OS/2 starter script "xelfi.cmd"


 2.3 Unixes (Linux, Solaris, HPUX,...)
 -------------------------------------
   To run Xelfi IDE on Unix machines, simply change the directory 
   to the <Xelfi RootDir> directory and run 
   Unix starter script "xelfi.sh"


 2.4 Running without starter scripts
 -----------------------------------
   There's always possibility to run Xelfi directly, 
   without starter scripts. To run Xelfi directly, 
   you will have to run main Xelfi java class 
   (xelfi\Xelfi.class) using your java interpreter.

   Perform these steps to run Xelfi directly:
	
	a) Set the CLASSPATH correctly
	   Your CLASSPATH have to contain <Xelfi RootDir> directory.
	   (See installation section if you don't know what is 
	    <Xelfi RootDir> directory).
    	   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 Win (and OS/2), the command could be:
		set CLASSPATH=%CLASSPATH%;<Xelfi RootDir>
           On unixes:
		export CLASSPATH=$CLASSPATH:<Xelfi RootDir>

	   Note:
	     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 add the <Xelfi RootDir> directory
	     to the CLASSPATH string.

	b) Run your java interpreter with argument 'xelfi.Xelfi'
	   (examples: 
			java xelfi.Xelfi  
			jview xelfi.Xelfi            )
           After a while, Xelfi should appear.		

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

 ------------------
 3. Troubleshooting
 ------------------
   This section will try to help you if something goes wrong.

   Symptom:	Directory structure differs from the one specified 
	    	in the installation section.

   Possible   	- Your zip handling utility cannot recognize long filenames
   reasons:	- Your copy of Xelfi zip file is damaged

   Possible	- Obtain zip handling utility with long filename support
   solutions:	- Test Xelfi zip file and if it is wrong, 
		  you will have to download it again.
   ------------
		
   Symptom: 	Starter script says it can not find xelfi.Xelfi class

   Possible	- You didn't run starter script from <Xelfi RootDir> dir
   reasons:	- File <Xelfi RootDir>/xelfi/Xelfi.class doesn't exist
	
   Possible	- Run starter script from <Xelfi RootDir> directory
   solutions:	   (it's the directory where starter scripts are)
		- Check if file <Xelfi RootDir>/xelfi/Xelfi.class exist.
		  If not, try to reinstall xelfi package to the 
		  same <Xelfi RootDir> directory.
   ------------

   Symptom: 	Starter script says "unknown command" or "bad command"
                or show dialog with message that it cannot run java interpreter

   Possible	- Starter script cannot run java interpreter
   reasons:	  (probably because it isn't in the PATH)
	
   Possible	- Add path to the java interpreter to your system PATH setting
   solutions:	- Check if you have your JDK properly installed
   ------------

   (win 95/NT)	
   Symptom: 	xrunner.exe shows message saying "wrong usage"...

   Possible	- xrunner.exe must be runned with exactly one parameter,
   reasons:	  which specifies path to the java interpreter
	
   Possible	- Don't run xrunner.exe by doubleclicking on it in Explorer.
   solutions:	  Create a shortcut and set it to 
		  xrunner.exe "<java_interpreter_path>" instead.
		  Note, <java_interpreter_path> must be bordered by quotes!
   ------------

   Symptom:	When I type "java xelfi.Xelfi", it says 
		"Can not find class xelfi.Xelfi" or something like that...

   Possible	- CLASSPATH doesn't contain <Xelfi RootDir> directory
   reasons:	- file <Xelfi RootDir>/xelfi/Xelfi.class doesn't exist
	
   Possible	- add <Xelfi RootDir> directory to the CLASSPATH
   solutions:	- Check if file <Xelfi RootDir>/xelfi/Xelfi.class exist.
		  If not, try to reinstall xelfi package to the 
		  same <Xelfi RootDir> directory.


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

 --------------------------
 4. How to Get Further Help
 --------------------------
 
   If you have any problems with installation, running or you need further
   help, don't hesitate and use our tech support:

   Mail us to:

	xelfi-question@xelfi.cz         - our Xelfi e-mail "Cold Line"
	xelfi-bug@xelfi.cz		- submit bug in Xelfi you have found
	xelfi-web@xelfi.cz		- if you have comments to our website
	xelfi@xelfi.cz			- other
	
   Xelfi mailing list:
   -------------------
     See our website http://www.xelfi.cz for informations about our 
     Xelfi mailing list (xelfi-l@xelfi.cz) 

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

 ---------------------------
 5. Registration Advantages:
 ---------------------------
   Register Xelfi IDE and become our registered user! 
   You will have free access to non-public Xelfi versions,
   You will not be limited to 30 day testing period,
   ....and more!
   Please, see http://www.xelfi.cz for detailed information 
   concerning registration.

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

  We would like to thank you for your interest.
  We hope you will like Xelfi!

  Xelfi Development Team,
  Xelfi Technologies, Prague
	
