1. Getting the Files
====================

You can download the SONIC distribution for your system from
http://lat.inf.tu-dresden.de/systems/sonic.htm. Please, unpack the
distribution archive according to the file format of your choice.

 unpack the distribution archive :
 # tar -xjf sonic.tar.bz2
 or
 # tar -xzf sonic.tar.gz
 or
 # unzip sonic.zip
 or use the tool of your choice


2. Installing SONIC
===================

SONIC comes with an installation script that performs most of steps
for the installation process. The script it proceeds in two
steps. First, it installs the SONIC server in an own directory. In a
second step, it installs the GUI plugin in OilEd's directory.

 switch to the distribution directory ...
 # cd sonic/
 ... and start the installation script
 # ./install-sonic-cmucl.sh
 or
 # ./install-sonic-acl.sh


a) Installing the SONIC server

If the automatic installation is successful, you should see something
like:

[1/2] Installing SONIC server

* Creating the Sonic directory
* Copying the distribution files


However, if something goes wrong you are prompted that the
installation script was not able to create the prefix- directory. Then
you manually have to:

 create the installation directory, ...
 # mkdir -p <INSTALLDIR>
 ... and copy the starter script and the lisp image
 # cp start-sonic-cmucl.sh sonic.x86f <INSTALLDIR>
 or
 # cp start-sonic-acl.sh sonic.dxl <INSTALLDIR>

After that, the installation script checks, if the lisp executable is
in your path.

b) Installing the plugin

In the second step SONIC's plugin is installed in OilEd's library
directory and registered in OilEd's configuration file. If this
succeeds, you should see something like :

 [2/2] Installing the Plugin
 
 * Copying Plugin
 * Backing up config.xml to config.xml.old
 * Registering the Sonic Plugin
 
Unfortunately, things can go wrong in this step. If this happens, you
are prompted.

If the directory to OilEd or OilEd's library path does not exist, or
is not writeable, the script cannot install or register the plugin and
exits. In this case ...

 ... copy the plugin file ...
 # cp SonicPlugin.jar <PATH-TO-OILED>/lib/
 .. and register the plugin, like instructed below.

If config.xml does not exist or is not writeable, the script is not
able to register the plugin. In this case edit OilEd's configuration
file config.xml with your favourite editor, and add the following two
lines

 <plugin class="LCSPluginPanel"/>
 <plugin class="ApproxPluginPanel"/>

to the plugin section.


3. Running SONIC
================

SONIC requires that the RACER server runs locally on your system.
Therefore, please start RACER and make sure it is able to connect to
the HTTP port 8080. When RACER is started, you should see something
like :

  ...
  [2004-11-11 23:29:18]  HTTP service enabled for: http://127.0.0.1:8080/
  [2004-11-11 23:29:18]  TCP service enabled on port 8088

In the next step, start the SONIC server. 

 # cd <PATH-TO-YOUR-SONIC-INSTALLATION>
 # ./start-sonic-cmucl.sh
 or
 # ./start-sonic-al.sh

Now, after starting OilEd you should see two new panels, called "LCS"
and "Approximation".

Please make sure that OilEd uses a HTTP connection to Racer. Therefore
open the preference dialog in OilEd and edit the preferences on the
connection tab accordingly.

If you see more than two instances of a panel, this may be due to that
SONIC has been registered more than once. In this case, take your
editor of choice, open the file <PATH-TO-OILED>/config.xml, and remove
the redundant entries of

 <plugin class="LCSPluginPanel"/>
 or
 <plugin class="ApproxPluginPanel"/>

from the plugin in <PATH-TO-OILED>/config.xmlsection.