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