This file describes the installation procedure of the TOVE code
release 1/98.


============
Requirements
============

This code release has been compiled and tested on following platform:

  Hardware:
  ---------
  * Standard Intel Pentium-based workstation, 64MB main memory
    and >100MB free disk space
  * ENI multimode fiber ATM Network Interface Card ENI-155-P-MF
  * VTT FSR (GSMP version)
  * Sound Blaster 16 (for demonstration using ATM-vat)

  Software:
  ---------
  * Linux 2.0.29 + RedHat 4.2 release (Biltmore) + Linux-ATM patch v0.31
  * gcc/g++ 2.7.2.1
  * VTT gsmpd
  * ATM-vat 4.0b2-atm0.2 (src/testing/vat)

==========================
Setting up the environment
==========================

The top level directory of the source tree contains Makefile and 
Rules.Make file, source files for the TOVE switch controller binary 
(tovemain.cpp) and all the subdirectories containing modules of
the signalling software. Check file INDEX for a complete listing of
files in the release.

One must have environment variable TOVESRC set to point to the top-
level directory of the source tree before compilation is possible.
This can be done in (t)csh shells with setenv command:

     tove % setenv TOVESRC ~/src

provided that the source is copied into your home directory and
the name of the top-level directory is src. Because the Tove
makefiles won't work unless this environment variable is correctly
set, it is absolutely necessary for the compilation.

After this you might want to examine Makefile and Rules.Make to
verify that complier options etc are in order. Rules.Make contains
general make rules and definitions (eg complier options) that are
used in every module. Note that RTTI is needed for the Tove code
to compile, so don't remove -frtti from compiler options. If you
are running short of disk space or for some other reason don't
want to include debugging information, exclude '-g' flag from
compiler options. This reduces the size of the binaries quite
significantly, but you can't use a debugger any more.

Top-level Makefile has signalling binary as the targets (tovestich)
and has the rules necessary for compiling the whole software with 
one make command.

As the last step of setting up the environment you must give

     tove % make deepdep

command to set the dependencies correctly in all Makefiles. Other
make rules include 'deepclean', which removes all object and target
files in all subdirectories.

NOTE: Linux ATM package must be installed before TOVE software
compiles. Instructions on installing ATM package are included
in the Linux ATM distribution package (see file USAGE).


=====================
Building the binaries
=====================

After you have set up the environment as described above, you can
build the signalling binary. The TOVE switch controller executable is
compiled with a simple

     tove % make

command, as it is the default target of the top-level Makefile. First
the source files on the top-level are compiled, then Makefiles of all
subdirectories are executed and finally the executable is linked
together. 

================
Testing software
================

If the compilation was completed successfully, you should now see one
binary in your top-level directory (toveswitch). To test signalling you
must have Linux ATM signalling daemon (atmsigd) compiled with UNI 3.1 
support (see more information on Linux ATM signalling daemon in
USAGE file in atm-0.31 package for Linux).

First there must be CORBA naming service (OmniBroker) running in some
computer within same IP network as TOVE software is going to be run. 

OmniBroker naming service is started with command

	tove % ./nsserv --ior > Naming.ior & 

See OmniBroker documents for more information. If naming service is 
running in different computer than TOVE software, IOR file must be 
copied to the TOVE software machine.

Also FSR with gsmpd software (or may be other GSMP controlled switch) 
must be started before running TOVE software.

TOVE software is started with command   

	tove % ./toveswitch -ORBnaming `cat /PATH/Naming.ior`

Use your own PATH for Naming.ior file.
If an error occures (segmentation fault) you should check are you compiled
naming and lib directories under OB-1.0/ directory with RTTI flag !!
(see instructions in README.Omnibroker file)

Ports can be configured with different program, see src/switch/README.
VAT (Visual Audio Tool) for ATM can be used to test software, see 
src/testing/vat/README.ATM and src/testing/vat/OHJE.TOVE files for more
information (last one is written in finnish).

There are several additional modules under construction in this directory
tree that are not used with TOVE software in this version.

================
More information
================

If you encounter any problems with above installation or testing
procedures, please send email to tove@oes.kareltek.fi.
Comments and success reports are also welcome.