README.linux

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