
VRwave 0.9 Binary Distribution (Unix/X11)
=========================================


This file contains instructions for installing the binary version of
VRwave (class files and shared libraries) for Unix/X11.



Setup
-----

1. Set environment variable VRWAVE_HOME to the directory which was
created on unpacking the archive (vrwave-0.8). The directory should
contain the vrwave wrapper script and the platform specific .so files
under a lib/$CPU subdir (see below).

For a quick test you may cd into that directory and call:

   [csh/tcsh]  setenv VRWAVE_HOME `pwd`
[sh/ksh/bash]  VRWAVE_HOME=`pwd` ; export VRWAVE_HOME


2. Set environment variable CPU to your machine type:

   $CPU value   machine       graphics  JDK version
   ----------   -----------------------------------
   SGI_GNU      SGI           OpenGL    1.0.2
   SGI_J112     SGI           OpenGL    1.1.2
   SGI_MESA     SGI/rem.dpy.  Mesa      1.0.2
   SUN5_GNU     Sun Solaris   Mesa      1.0.2
   SUN5_J113    Sun Solaris   Mesa      1.1.3
   ALPHA_GNU    Dec Alpha     Mesa      1.0.2
   ALPHA_OGL    Dec Alpha     OpenGL    1.0.2
   HPUX10_cc    HP-UX         Mesa      1.0.3
   LINUX_ELF    Linux/ELF     Mesa      1.0.2
   LINUX_J113   Linux/ELF     Mesa      1.1.3


If you plan to use VRwave frequently, set VRWAVE_HOME and CPU in your
shell rc-file/profile (and include VRWAVE_HOME in the PATH). If you
dislike setting CPU as suggested, consider modifying the vrwave script
to set it appropriately (case `uname` ...), or replace it with a name
less likely used by other programs, e.g. CPU_VRW.

If you dislike adding $VRWAVE_HOME to your PATH you may copy (or link)
it to any location contained in your PATH and set also VRWAVE_HOME in
the script itself.

Your java environment should be up and working (java must be in your
PATH, and you may need to set CLASSPATH for java to find its own class
files).

The .class files were generated with JDK 1.0.2. JDK 1.1.1 will run
them too, but need different versions of the VRwave shared library
(like for SUN5_J111). See also "Supported Platforms" in file README.

Java will read the classes directly from the archive
classes/vrwave.zip - do *not* unzip this file.



Program Start
-------------

Now just call vrwave (or $VRWAVE_HOME/vrwave).

It will care for including $VRWAVE_HOME/classes/vrwave.zip in your
CLASSPATH and $VRWAVE_HOME/lib/$CPU in the LD_LIBRARY_PATH, no matter
from which directory you call it or which other application calls it.

You may give the name of a VRML 2.0 file to open on the command line of
vrwave. A few sample files can be found in $VRWAVE_HOME/examples.

See file help/install.html for setting up VRwave as helper application
of your webbrowser.



Applet version
--------------

VRwave can also be run in the Java VM of Java-enabled web browsers
(e.g. netscape). VRwave's Java classes and shared libraries must be
available on the local file system (set your CLASSPATH and
LD_LIBRARY_PATH appropriately).

Try out script "samplens" for a demo.

Note: the applet version (script samplens) will not work with VRwave
shared libraries (.so files) compiled with other JDK versions than
1.0.2. Also be sure to have CPU set accordingly.



Plug-In version
---------------

Please refer to file help/install.html for installation instructions
of the VRwave netscape plug-in.



enjoy,

Michael Pichler                 Sep 30, 1997
