Installing on Windows

  1. Make sure you have a Java Development Kit 1.4 or later installed. If you do not have a recent JDK, download one from If you do not know which version you have, then check. For example, if you installed 1.4.1:

    C:\Windows>java -version
    java version "1.4.1_01"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.1_01-b01)
    Java HotSpot(TM) Client VM (build 1.4.1_01-b01, mixed mode)
  2. Do not begin the installation before reading this:

    Avoid installing in a folder with a name longer than 8 characters. This software relies on environment variables rather than the Windows registry. If you use long folder names, you have to figure out how to translate them when setting the environment variables. For example, C:\Program Files\RefEntry may become C:\Progra~1\RefEntry.

    The only pack you must install is the servlet .war file. This is the case so you do not have to reinstall Ant, HttpUnit, or Tomcat if you have it already.

    If you want to use the servlet .war file, you must have a servlet container such as Tomcat. So if you are missing a servlet container, install the Tomcat pack at least.

    If you want to do any development, such as write your own RefEntry documents and build a servlet, then you need Ant and HttpUnit. Unless you have Ant and HttpUnit already installed, take these packs as well.

    If you are reading this file, you may have already decided to install the documentation. Fine.

  3. Double-click the self-extracting installer, refentry-installer.jar.

    Follow the instructions based on what you decided to install.

  4. If you are using Windows 95 or 98, copy the install-dir\ant folder to a location with a very short path name such as C:\ant.

    Ant uses a startup script that suffers from DOS-related limitations.

  5. Adjust and set the environment variables from install-dir\refentry.bat. How you do this depends on your version of Windows.

    Windows shell cannot handle long file and folder names. You must therefore declare environment variables using the 8+3 MS-DOS names. In other words, if you install the software in C:\Program Files\RefEntry, then you must translate this into something like C:\Progra~1\RefEntry in refentry.bat and in autoexec.bat.

    When using Windows 2000, you can set environment variables for your account, and Windows puts them in the registry. Set the environment variables you need from Control Panel > System > Advanced > Environment Variables, based on the packs you installed.

    When using Windows 95 or 98, you can call a script from C:\autoexec.bat which sets the environment at startup. You can also add the environment variables you need, based on the pack you installed, directly to autoexec.bat. If you use ANT_HOME, note that it must be a very short path name on Windows 95 or 98.

  6. At this point, if you are using Windows 95 or 98, you must reboot.

  7. Copy install-dir\refentry.war file to the install-dir\tomcat\webapps folder.

  8. Start Tomcat.

    With Windows 95 and 98, you must increase the memory available in the command shell to be able to start Tomcat. To increase the memory available, click the Properties icon, then in the MS-DOS Prompt Properties window, select the Memory tab and set Initial environment to 4096. Next, click OK, and type exit to leave the MS-DOS Prompt command shell. Restart the MS-DOS Prompt command shell for the change to take effect.


    This starts the Tomcat servlet container in the background.

  9. Browse http://localhost:8080/refentry and you should see the default page of the RefEntry servlet.

If you want to stop Tomcat, the command is: %CATALINA_HOME%\bin\shutdown