INSTALLATION INSTRUCTIONS FOR CINEMA-MX

The following instructions assume that Java has already been
installed. If it has not then this should be done first.


EASY INSTRUCTIONS.


There are two ways to run Cinema, one easier than the other. The easy
way will be presented first and then the harder way. Why are there two
ways? If you want to know this, then I suggest that you read the hard
way....


Windows.

1) Unpack the archive file. If you are reading this, then there is a
   fairly good chance that you have already achieved this. 

2) Move to the cinema-XX/lib directory (where XX is the version name
   whatever it is). 

3) Click on cinema.jar. You can also drag a shortcut to the desktop,
   and click on that. 

4) If you are using a command line then "java -jar
   cinema.jar" will achieve the same end. If the click and point
   technique doesn't work this is a good thing to try as it will
   probably give you error messages.


UNIX Installation

1) Unpack the archive file. If you are reading this, there is a good
   chance that you have already done this. 

2) Move into the cinema-XX/bin directory, and type "./cinema"

3) If you use a graphical launcher such as GNOME or KDE, then you can
   use the same command line, setting the directory appropriately. 

4) If you want to install system wide, I'd suggest you use the hard
   installation. Also if you want to launch Cinema from another directory. 


HARD INSTALLATION.

The hard installation isn't really the hard, and more over its
better. The reason that I've provided it is that its better. One of
the point with CINEMA is that its easily to extend. You can add new
modules if you like. But to do this you have to make these modules
available to Java, in the class path. The hard method uses a shell
script which works automatically does this. In particular any jar
files in the ~/.cinema/ext directory will be added into the class
path. 

It would be nice to get this working through Java, rather than using a
shell script. But I struggled for several days trying to extend the
classpath in a running JVM, and failed miserably. I'm sure its
possible. Anyone telling me how will to do this will recieve a nice
"thank you" email. Anyone sending me example code, will get a place in
the Acknowledgement file. 


UNIX installation.

1) Unpack the archive file in the directory where you wish to 
install. There are several obvious locations to do this, depending on
your local installation. I would use ~/bin (for a personal
installation), or one of /opt, or /usr/lib, or /usr/local/lib/ 

2) (Optional) Unpacking will leave a directory with a version number
in it. I normally put a symlink in to this directory without the
version number. It makes it easier to have several versions available
at once. 

3) Either put the bin/ directory into your system path, or symlink
the bin/cinema file into a directory in your system path. 

4) Edit the cinema file. Change the line 
CINEMA_LIB=../lib to point to the lib/ directory. Until you do this
cinema will have to be launched from the bin/ directory, which is a
pain. 

5) Thats it. 


Windows.

If you have cygwin installed (if you don't know, you haven't.)

1) Unpack the distribution file. 

2) Edit the cinema.cygwin, so that the CINEMA_LIB line points to the
lib/ directory. 

3) Symlink cinema.cygwin into your system path. 

4) Thats it. 

If you don't have cygwin installed, you can install it, or you can try
the perl file if you have perl installed. At some point I would like
to write a .bat file to do this. If you want the extensibility then I
suggest you write a .bat file, and add any jar files in by hand. You
can copy the command line from the shell script.
