README.cygwin

   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 *   Pilisi, Gergely
  11 ******************************************************************************
  12
  13 Cygwin setup
  14     - If Cygwin is installed already, refresh your Cygwin installation
  15       Titan is always build for the newest Cygwin version available.
  16       Start the Cygwin setup utility (see below), it will refresh your
  17       installed Cygwin packages to the newest versions.
  18     - If Cygwin is not installed yet:
  19
  20    (A) Download and execute the latest cygwin installer utility,
  21        please use the 64-bit version installer:
  22        https://cygwin.com/setup-x86_64.exe
  23
  24    (B) Select Install from Internet (recommended to save local disk space)
  25
  26    (C) Choose Cygwin installation root directory (C:\cygwin is recommended)
  27        Select All Users, or Just Me.
  28
  29    (D) Select "Local Package Directory" (typically the same directory,
  30        where the setup....exe Cygwin installer utility is stored).
  31
  32    (E) Use Internet Explorer Proxy Settings (recommended).
  33
  34    (F) Select a download mirror site.
  35
  36    (G) In the package selection dialog,
  37        Note: You can select different views to find the required packages
  38        easier and/or search the packages via the search field.
  39
  40        There are 3 hierarchical levels of minimally required packages,
  41        depending on your task.
  42        Note: Cygwin installer will automatically select the packages the
  43              manually selected ones are depending on; do NOT deselect
  44              any automatically selected package!
  45         a) Test execution ONLY (command line or from Eclipse Executor):
  46                 Base: <all packages> (Default setting of the installer)
  47                 Net: openssl
  48                 Tcl: expect
  49         b) Test case development: in addition to the above select the
  50            following packages:
  51                 Devel: binutils
  52                 Devel: gcc-g++
  53                 Devel: make
  54                 Libs: libxml2-devel
  55             Net: openssl-devel (automatically installs Net:openssl
  56                                     as well, if selected)
  57         c) To compile your own Titan Cygwin binary: in addition to the
  58            above, select the following packages:
  59                 Devel: bison
  60                 Devel: ctags
  61                 Devel: cygwin32-expat
  62                 Devel: diffstat
  63                 Devel: flex
  64                 Devel: gcc-core
  65                 Editors: <any editor of your preference> (optional)
  66                 Libs: libncurses-devel
  67                 Libs: libreadline-devel
  68
  69         If, after selecting the required packages and clicking on the
  70         "Next" button, a "Resolving Dependcies" window lists further
  71         required packages, ensure that the "Select required packages
  72         (RECOMMENDED)" checkbox is checked and click the "Next" button.
  73
  74    (H) Select the Create icon on Desktop checkbox
  75
  76    (I) (Optional)
  77        Your "unix" home directory, by default is:
  78        <your cygwin installation directory>/home/<yourUserId>
  79        If you are (also) working in command line mode, it is a good
  80        practice to change this to the folder where your TTCN-3 projects
  81        are.
  82        Edit the file <your cygwin installation directory>/etc/passw:
  83        In the line:
  84        <yourUserId>:unused:<xxxxxx>:<yyyyy>:U-<yourDomain>\<yourUserId>,
  85        S-1-5-21-nnnnnn...nnnnnn:/home/<yourUserId>:/bin/bash
  86
  87        replace "/home/<yourUserId>" with the folder of your preference.
  88        Note: you can access all Windows drives from Cygwin as
  89        /cygdrive/<windowsDriveLetter>".
  90        Example: to set your "unix" home directory to the "My_Home" folder
  91        within your Windows Documents folder, you should replace
  92        "/home/<yourUserId>" by
  93        "/cygdrive/c/Users/<yourUserId>/Documents/My_Home"
  94        WARNING: The path of your "unix" home directory shall not contain
  95                 any space!
  96
  97   (J) Using the bynary Titan package: download the Titan package for from
  98     GitHub. Unpack the Titan package into a folder of your choice.
  99       Note: It is not a requirement, but is a kind of best practice to
 100             place Titan into a subfolder within your "unix" home directory.
 101       Edit the <your cygwin installation directory>/home/<yourUserId>/.bashrc
 102           file. Add these lines to it:
 103                 export PATH=${TTCN3_DIR}/bin:${PATH}
 104                 export LD_LIBRARY_PATH=${TTCN3_DIR}/lib:${LD_LIBRARY_PATH}
 105
 106   (K) Compile Titan with Cygwin:
 107          Get the latest source code from GitHub.
 108          Download and install JDK from Oracle's download site:
 109                 http://www.oracle.com/technetwork/java/javase/downloads/index.html
 110          Edit the <your cygwin installation directory>/home/<yourUserId>/.bashrc
 111          as above.
 112          Create titan/Makefile.personal with the following content:
 113                 TTCN3_DIR := /home/<user id>/git/titan/Install
 114             JDKDIR := /home/<user id>/jdk
 115             JNI := no
 116             GUI := no
 117             GEN_PDF := no
 118             DEBUG := no
 119          Compile Titan:
 120                 cd titan
 121                 make -j
 122                 make install
 123          The compiled files will be placed into the titan/Install directory.
 124
 125   (L) If you want to use graphical tools (like nedit for example), then you need to install the Cygwin/X
 126       component too. The install procedure can be found at the homepage:
 127       http://x.cygwin.com/docs/ug/cygwin-x-ug.html
 128