Update README.linux

[deliverable/titan.core.git] / README.linux

Build and install Titan on Linux\r
\r
1.Install required libraries: \r
(examples are given for Ubuntu 12.04/14.04; for other Linuxes, pls. use the relevant library installation method)\r
\r
sudo apt-get install g++ expect libssl-dev libxml2-dev libncurses5-dev flex bison\r
xutils-dev is needed by makedepend:\r
sudo apt-get install xutils-dev\r
The following packages may be needed for titan_eclipse/automatic_build:\r
sudo apt-get install ant xsltproc\r
\r
2.Clone the titan directory from git  into /home/<user_id>/titan\r
\r
git clone https://github.com/eclipse/titan.core  titan\r
\r
3. Configure the build \r
\r
cd titan\r
check  that MakefileFOSS.cfg is present   and  has the following content:\r
cat MakefileFOSS.cfg\r
\r
# Configurations for the Free Open Source Software version\r
LICENSING := no\r
USAGE_STATS := no\r
\r
\r
Several build options are possible; for details on options , please read through the Makefile.cfg.\r
Options can be overridden by the content of  a file named Makefile.personal which can be used to \r
adapt to local installation directories, change config options etc.\r
Below, a small number of typical scenarios are presented.\r
\r
1) JNI  disabled\r
\r
The JNI interface is used by the Eclipse Titan Executor or by the Java Executor API.\r
If you don't need them , Titan can be compiled without JNI. \r
\r
Create ~/titan/Makefile.personal to override settings in Makefile.cfg with the following content:\r
(replace paths with values relevant to your installation)\r
\r
TTCN3_DIR := /home/<user id>/titan/Install\r
OPENSSL_DIR := /usr\r
#JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64\r
XMLDIR := /usr\r
JNI := no\r
GEN_PDF := no\r
\r
\r
\r
\r
2) JNI  enabled\r
\r
install JDK   into /home/<user id>/jdk\r
\r
Create ~/titan/Makefile.personal to override settings in Makefile.cfg with the following content:\r
(replace paths with values relevant to your installation)\r
\r
TTCN3_DIR := /home/<user id>/titan/Install\r
OPENSSL_DIR := /usr\r
JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64\r
XMLDIR := /usr\r
JNI := yes\r
GEN_PDF := no\r
\r
\r
\r
3. Run make\r
\r
make\r
\r
4. Run make install\r
\r
make install\r
\r
This will install Titan into  /home/<user id>/titan/Install\r
\r
5. Optionally , run function/regression tests\r
\r
set environment variable TTCN3_DIR to /home/<user id>/titan/Install\r
\r
(setenv  TTCN3_DIR /home/<user id>/titan/Install  for csh,\r
export TTCN3_DIR=/home/<user id>/titan/Install for bash )\r
\r
\r
\r
cd /home/<user id>/titan/function_test\r
\r
in the following Makefiles \r
\r
XER_EncDec/Makefile\r
Text_EncDec/Makefile\r
RAW_EncDec/Makefile\r
\r
edit the value of XMLDIR to match your installation values \r
\r
run the tests\r
\r
make\r
\r
( or make |& tee outputfile if you want to save the output for verification)\r
\r
cd /home/<user id>/titan/regression_test\r
make run\r
\r
( or make run |& tee outputfile if you want to save the output for verification)\r
\r
These tests might run for half an hour (regr.tests)  to two hours (func.tests)\r
\r
6. Optionally , copy Titan into its' final directory.\r
From here on, you can continue with the Titan installation guide, see /Install/docs, to set environment variables etc.\r
\r
\r
\r
\r