Merge pull request #78 from balaskoa/master
[deliverable/titan.core.git] / README.linux
index 058e2dce3d3e01032d94e7c164a20489cf621bcf..e851c5d98bfd779753ee1ec36303933980318d83 100644 (file)
@@ -1,9 +1,15 @@
 ******************************************************************************
-* Copyright (c) 2000-2015 Ericsson Telecom AB
+* Copyright (c) 2000-2016 Ericsson Telecom AB
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
+*  Contributors:
+*   Balasko, Jeno
+*   Baranyi, Botond
+*   Lelik, Elemer
+*   Pilisi, Gergely
+*   Szabados, Kristof
 ******************************************************************************
 
 Build and install Titan on Linux
@@ -17,52 +23,67 @@ sudo apt-get install xutils-dev
 The following packages may be needed for titan_eclipse/automatic_build:
 sudo apt-get install ant xsltproc
 
-2.Clone the titan directory from git  into /home/<user_id>/titan
+2.Clone the titan directory from git  into /home/<user_id>/titan.core
 
-git clone https://github.com/eclipse/titan.core  titan
+git clone https://github.com/eclipse/titan.core  titan.core
 
 3. Configure the build 
 
-cd titan
-check  that MakefileFOSS.cfg is present   and  has the following content:
+cd titan.core
+
+For open source users: check that MakefileFOSS.cfg is present and has the following content:
 cat MakefileFOSS.cfg
 
 # Configurations for the Free Open Source Software version
 LICENSING := no
 USAGE_STATS := no
 
+If you want to use your build within teh Ericsson domain: delete MakefileFOSS.cfg
+This will enable licensing.
 
-Several build options are possible; for details on options please read through the Makefile.cfg.
+Several build options are possible; for details on options please read through the Makefile.cfg.
 Options can be overridden by the content of  a file named Makefile.personal which can be used to 
 adapt to local installation directories, change config options etc.
 Below, a small number of typical scenarios are presented.
 
-1) JNI  disabled
+a) JNI  disabled, gcc compiler (default)
 
 The JNI interface is used by the Eclipse Titan Executor or by the Java Executor API.
 If you don't need them , Titan can be compiled without JNI. 
 
-Create ~/titan/Makefile.personal to override settings in Makefile.cfg with the following content:
+Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
 (replace paths with values relevant to your installation)
 
-TTCN3_DIR := /home/<user id>/titan/Install
+TTCN3_DIR := /home/<user id>/titan.core/Install
 OPENSSL_DIR := /usr
 #JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
 XMLDIR := /usr
 JNI := no
 GEN_PDF := no
 
+b) JNI  disabled, clang compiler ver. 3.8
+
+Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
+(replace paths with values relevant to your installation). 
 
+TTCN3_DIR := /home/<user id>/titan.core/Install
+OPENSSL_DIR := /usr
+#JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
+XMLDIR := /usr
+JNI := no
+GEN_PDF := no
+CXX := clang++-3.8
+CC := clang-3.8 
 
 
-2) JNI  enabled
+c) JNI  enabled, gcc compiler (default)
 
 install JDK   into /home/<user id>/jdk
 
-Create ~/titan/Makefile.personal to override settings in Makefile.cfg with the following content:
-(replace paths with values relevant to your installation)
+Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
+(replace paths with values relevant to your installation).
 
-TTCN3_DIR := /home/<user id>/titan/Install
+TTCN3_DIR := /home/<user id>/titan.core/Install
 OPENSSL_DIR := /usr
 JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
 XMLDIR := /usr
@@ -71,47 +92,40 @@ GEN_PDF := no
 
 
 
-3. Run make
+4. Run make
 
 make
 
-4. Run make install
+5. Set environment variables
 
-make install
-
-This will install Titan into  /home/<user id>/titan/Install
+setenv TTCN3_DIR /home/<user id>/titan.core/Install
+setenv PATH /home/<userid>/titan.core/Install/bin/:${PATH}
+setenv LD_LIBRARY_PATH /home/<userid>/titan.core/Install/lib:${LD_LIBRARY_PATH}
 
-Note: If make install fails with something like:
+for csh
 
-make[2]: Leaving directory '/path/to/install/titan/demo'
-/bin/sh: line 4: ttcn3_start: command not found
-kMakefile:25: recipe for target 'install' failed
-make[1]: *** [install] Error 127
-make[1]: Leaving directory '/home/user/3rdPartyApps/titan/hello'
-Makefile:53: recipe for target 'install' failed
-make: *** [install] Error 2
+or 
 
-then add /path/to/install/titan/bin/ to PATH and retry:
-
-PATH=/path/to/install/titan/bin/:${PATH} 
-make install
+export TTCN3_DIR=/home/<user id>/titan.core/Install
+export PATH=/home/<userid>/titan.core/Install/bin/:${PATH}
+export LD_LIBRARY_PATH=/home/<userid>/titan.core/Install/lib:${LD_LIBRARY_PATH}
 
+for bash
 
+6. Run make install
 
+make install
 
-5. Optionally , run function/regression tests
-
-set environment variable TTCN3_DIR to /home/<user id>/titan/Install
-
-(setenv  TTCN3_DIR /home/<user id>/titan/Install  for csh,
-export TTCN3_DIR=/home/<user id>/titan/Install for bash )
+This will install Titan into  /home/<user id>/titan.core/Install
 
 
+7. Optionally , run function/regression tests
 
-cd /home/<user id>/titan/function_test
+cd /home/<user id>/titan.core/function_test
 
 in the following Makefiles 
 
+BER_EncDec/Makefile
 XER_EncDec/Makefile
 Text_EncDec/Makefile
 RAW_EncDec/Makefile
@@ -124,13 +138,13 @@ make
 
 ( or make |& tee outputfile if you want to save the output for verification)
 
-cd /home/<user id>/titan/regression_test
+cd /home/<user id>/titan.core/regression_test
 make run
 
 ( or make run |& tee outputfile if you want to save the output for verification)
 
 These tests might run for half an hour (regr.tests)  to two hours (func.tests)
 
-6. Optionally , copy Titan into its' final directory.
-From here on, you can continue with the Titan installation guide, see /Install/docs, to set environment variables etc.
+8. Optionally, copy Titan into its final directory.
+From here on, you can continue with the Titan installation guide, see /Install/docs, to set/change environment variables etc.
 
This page took 0.025454 seconds and 5 git commands to generate.