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