README.linux

   1 ******************************************************************************
   2 * Copyright (c) 2000-2016 Ericsson Telecom AB
   3 * All rights reserved. This program and the accompanying materials
   4 * are made available under the terms of the Eclipse Public License v1.0
   5 * which accompanies this distribution, and is available at
   6 * http://www.eclipse.org/legal/epl-v10.html
   7 *  Contributors:
   8 *   Balasko, Jeno
   9 *   Baranyi, Botond
  10 *   Lelik, Elemer
  11 *   Pilisi, Gergely
  12 *   Szabados, Kristof
  13 ******************************************************************************
  14
  15 Build and install Titan on Linux
  16
  17 1.Install required libraries:
  18 (examples are given for Ubuntu 12.04/14.04; for other Linuxes, pls. use the relevant library installation method)
  19
  20 sudo apt-get install g++ expect libssl-dev libxml2-dev libncurses5-dev flex bison
  21 xutils-dev is needed by makedepend:
  22 sudo apt-get install xutils-dev
  23 The following packages may be needed for titan_eclipse/automatic_build:
  24 sudo apt-get install ant xsltproc
  25
  26 2.Clone the titan directory from git  into /home/<user_id>/titan.core
  27
  28 git clone https://github.com/eclipse/titan.core  titan.core
  29
  30 3. Configure the build
  31
  32 cd titan.core
  33
  34 For open source users: check that MakefileFOSS.cfg is present and has the following content:
  35 cat MakefileFOSS.cfg
  36
  37 # Configurations for the Free Open Source Software version
  38 LICENSING := no
  39 USAGE_STATS := no
  40
  41 If you want to use your build within teh Ericsson domain: delete MakefileFOSS.cfg
  42 This will enable licensing.
  43
  44 Several build options are possible; for details on options please read through the Makefile.cfg.
  45 Options can be overridden by the content of  a file named Makefile.personal which can be used to
  46 adapt to local installation directories, change config options etc.
  47 Below, a small number of typical scenarios are presented.
  48
  49 a) JNI  disabled, gcc compiler (default)
  50
  51 The JNI interface is used by the Eclipse Titan Executor or by the Java Executor API.
  52 If you don't need them , Titan can be compiled without JNI.
  53
  54 Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
  55 (replace paths with values relevant to your installation)
  56
  57 TTCN3_DIR := /home/<user id>/titan.core/Install
  58 OPENSSL_DIR := /usr
  59 #JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
  60 XMLDIR := /usr
  61 JNI := no
  62 GEN_PDF := no
  63
  64 b) JNI  disabled, clang compiler ver. 3.8
  65
  66 Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
  67 (replace paths with values relevant to your installation).
  68
  69 TTCN3_DIR := /home/<user id>/titan.core/Install
  70 OPENSSL_DIR := /usr
  71 #JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
  72 XMLDIR := /usr
  73 JNI := no
  74 GEN_PDF := no
  75 CXX := clang++-3.8
  76 CC := clang-3.8
  77
  78
  79 c) JNI  enabled, gcc compiler (default)
  80
  81 install JDK   into /home/<user id>/jdk
  82
  83 Create ~/titan.core/Makefile.personal to override settings in Makefile.cfg with the following content:
  84 (replace paths with values relevant to your installation).
  85
  86 TTCN3_DIR := /home/<user id>/titan.core/Install
  87 OPENSSL_DIR := /usr
  88 JDKDIR := /usr/lib/jvm/java-7-openjdk-amd64
  89 XMLDIR := /usr
  90 JNI := yes
  91 GEN_PDF := no
  92
  93
  94
  95 4. Run make
  96
  97 make
  98
  99 5. Set environment variables
 100
 101 setenv TTCN3_DIR /home/<user id>/titan.core/Install
 102 setenv PATH /home/<userid>/titan.core/Install/bin/:${PATH}
 103 setenv LD_LIBRARY_PATH /home/<userid>/titan.core/Install/lib:${LD_LIBRARY_PATH}
 104
 105 for csh
 106
 107 or
 108
 109 export TTCN3_DIR=/home/<user id>/titan.core/Install
 110 export PATH=/home/<userid>/titan.core/Install/bin/:${PATH}
 111 export LD_LIBRARY_PATH=/home/<userid>/titan.core/Install/lib:${LD_LIBRARY_PATH}
 112
 113 for bash
 114
 115 6. Run make install
 116
 117 make install
 118
 119 This will install Titan into  /home/<user id>/titan.core/Install
 120
 121
 122 7. Optionally , run function/regression tests
 123
 124 cd /home/<user id>/titan.core/function_test
 125
 126 in the following Makefiles
 127
 128 BER_EncDec/Makefile
 129 XER_EncDec/Makefile
 130 Text_EncDec/Makefile
 131 RAW_EncDec/Makefile
 132
 133 edit the value of XMLDIR to match your installation values
 134
 135 run the tests
 136
 137 make
 138
 139 ( or make |& tee outputfile if you want to save the output for verification)
 140
 141 cd /home/<user id>/titan.core/regression_test
 142 make run
 143
 144 ( or make run |& tee outputfile if you want to save the output for verification)
 145
 146 These tests might run for half an hour (regr.tests)  to two hours (func.tests)
 147
 148 8. Optionally, copy Titan into its final directory.
 149 From here on, you can continue with the Titan installation guide, see /Install/docs, to set/change environment variables etc.
 150