Sync with 5.1.0
[deliverable/titan.core.git] / compiler2 / ttcn3_makefilegen.1
1 .TH ttcn3_makefilegen 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
2 .SH NAME
3 ttcn3_makefilegen \- Makefile Generator
4 .SH SYNOPSIS
5 .B ttcn3_makefilegen
6 .RB "[\| " \-acdfglpRsw " \|]"
7 .RB "[\| " \-e
8 .IR " ETS_name" " \|]"
9 .RB "[\| " \-o
10 .IR " dir|file" " \|]"
11 .RB "[\| " \-O
12 .IR " file" " \|] ..."
13 TTCN3_module[.ttcn] ... ASN1_module[.asn] ... Testport_name[.cc] ...
14 .br
15 or
16 .br
17 .B ttcn3_makefilegen
18 .B \-v
19 .SH DESCRIPTION
20 This manual page is a quick reference for the Makefile Generator
21 of the TTCN-3 Test Executor. It only summarizes the meaning of
22 all command line options. For more details please consult the
23 .B Programmer's Technical Reference for TITAN TTCN-3 Test Executor.
24 .SH OPTIONS
25 The following options are supported (in alphabetical order):
26 .TP 10
27 .B \-a
28 Refer to files using
29 .I absolute
30 path names in the generated Makefile. By default the Makefile uses relative
31 path names to access files located outside the current working directory of
32 the compiler. Files from the current working directory are always referenced
33 using only the file name without any directory.
34 .TP
35 .B \-c
36 Generate a Makefile that is capable of using pre-compiled C++ and object files
37 from
38 .I central
39 directories in order to save disk space and compilation time.
40 .TP
41 .B \-d
42 .I Dump
43 the internal data structures used for Makefile generation. This option
44 is mainly useful for debugging.
45 .TP
46 .BI \-e " ETS_name"
47 Sets the name of the target binary program (i.e. the executable test
48 suite) to
49 .I ETS_name
50 in the generated Makefile. If this option is omitted, the name of the
51 first TTCN-3 module will be used as default.
52 .TP
53 .B \-f
54 Forces the Makefile Generator to
55 .I overwrite
56 the output files even if they exist or are unchanged.
57 .TP
58 .B \-g
59 Generates a Makefile that can be used with
60 .I GNU make
61 only. The resulting Makefile will be smaller and less redundant. It
62 exploits the pattern substitution features of GNU make, which may cause
63 syntax errors with other versions of make.
64 .TP
65 .BI \-o " dir|file"
66 Write the Makefile to the given directory or file.
67 The current working directory is the default otherwise.
68 If the given argument is an existing directory, the generated
69 .I Makefile
70 will be placed into that directory. Otherwise the given argument is assumed to be the name of the generated
71 .I Makefile.
72 .TP
73 .BI \-O " file"
74 Add
75 .I file
76 to the list of
77 .I other files
78 in the generated Makefile without analyzing the file's contents and suffix.
79 This option can be used to temporarily exclude some TTCN-3, ASN.1 or C++ files
80 from the build process, but add them to the archive created by the command
81 .I make archive.
82 .TP
83 .B \-l
84 Enable dynamic linking. All files of the project will be compiled with
85 .I -fPIC
86 and for each (static) object, a new shared object will be created. Then, these
87 shared objects will be linked to the final executable instead of the (static)
88 objects. It can be used to speed up the linking phase, in the price of somewhat lower
89 performance and increased memory usage. It's recommended to use this flag only in the
90 development phase of the project. This option is not supported on Windows.
91 .TP
92 .B \-p
93 Generate Makefile with
94 .I TTCN-3 preprocessing.
95 All the TTCN-3 source files with the
96 .I ttcnpp
97 extension will be preprocessed using the C preprocessor.
98 .TP
99 .B \-R
100 Use function test runtime (TITAN_RUNTIME_2). Generates a Makefile that
101 compiles and links the source code using the function test runtime.
102 .TP
103 .B \-s
104 Generates a Makefile, which links the executable test suite with the
105 .I single mode
106 version of the base library. If this switch is omitted the executable is
107 built for parallel mode by default.
108 .TP
109 .B \-v
110 Prints
111 .I version
112 and license key information and exits.
113 .TP 10
114 .B \-w
115 Suppresses all
116 .I warning
117 messages.
118
119 .SH ENVIRONMENT VARIABLES
120 .TP
121 .SM
122 TTCN3_DIR
123 The installation directory where the uncompressed binary package of
124 TTCN-3 Test Executor can be found.
125 .TP
126 .SM
127 TTCN3_LICENSE_FILE
128 It shall point to the
129 .I file
130 .RB ( NB:
131 .I not
132 to its directory) that contains the personalized license key for the
133 current user or host.
134 .SH BUGS
135 .LP
136 For trouble reporting use the tool
137 .BR "MTTSMS" "."
138 For TR writers guide please visit the web page:
139 .I http://ttcn.ericsson.se.
140 .SH SEE ALSO
141 .TP
142 .SM
143 Ericsson document 2/198 17-CRL 113 200 Uen:
144 .B Programmer's Technical Reference for TITAN TTCN-3 Test Executor
145 .SH AUTHOR
146 This manpage is written by Janos Zoltan Szabo, Ericsson Telecom AB
147 .br
148 Copyright (c) 2000-2014 Ericsson Telecom AB
149 .br
150 All rights reserved. This program and the accompanying materials
151 are made available under the terms of the Eclipse Public License v1.0
152 which accompanies this distribution, and is available at
153 .br
154 http://www.eclipse.org/legal/epl-v10.html
This page took 0.035764 seconds and 5 git commands to generate.