[deliverable/titan.core.git] / compiler2 / ttcn3_makefilegen.1

.TH ttcn3_makefilegen 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
.SH NAME
ttcn3_makefilegen \- Makefile Generator
.SH SYNOPSIS
.B ttcn3_makefilegen
.RB "[\| " \-acdEfglMpRsw " \|]"
.RB "[\| " \-e
.IR " ETS_name" " \|]"
.RB "[\| " \-o
.IR " dir|file" " \|]"
.RB "[\| " \-O
.IR " file" " \|]"
.RB "[\| " \-z
.IR " file" " \|] ..."
TTCN3_module[.ttcn] ... ASN1_module[.asn] ... Testport_name[.cc] ...
.br
or
.br
.B ttcn3_makefilegen
.B \-v
.SH DESCRIPTION
This manual page is a quick reference for the Makefile Generator
of the TTCN-3 Test Executor. It only summarizes the meaning of
all command line options. For more details please consult the
.B Programmer's Technical Reference for TITAN TTCN-3 Test Executor.
.SH OPTIONS
The following options are supported (in alphabetical order):
.TP 10
.B \-a
Refer to files using
.I absolute
path names in the generated Makefile. By default the Makefile uses relative
path names to access files located outside the current working directory of
the compiler. Files from the current working directory are always referenced
using only the file name without any directory.
.TP
.B \-c
Generate a Makefile that is capable of using pre-compiled C++ and object files
from
.I central
directories in order to save disk space and compilation time.
.TP
.B \-d
.I Dump
the internal data structures used for Makefile generation. This option
is mainly useful for debugging.
.TP
.BI \-e " ETS_name"
Sets the name of the target binary program (i.e. the executable test
suite) to
.I ETS_name
in the generated Makefile. If this option is omitted, the name of the
first TTCN-3 module will be used as default.
.TP
.B \-E
Instructs the variant attribute parser to display warnings instead of errors
for unrecognized/erroneous attributes.
.TP
.B \-f
Forces the Makefile Generator to
.I overwrite
the output files even if they exist or are unchanged.
.TP
.B \-g
Generates a Makefile that can be used with
.I GNU make
only. The resulting Makefile will be smaller and less redundant. It
exploits the pattern substitution features of GNU make, which may cause
syntax errors with other versions of make.
.TP
.BI \-I " path"
Adds the path to the list of search paths.
.I path
must be an
absolute path. Used with the 
.B -t
option when the referenced projects
can not be found at the projectRelativeURI location. In that case the
tool will try to find the referenced TPD file using the search paths.
The first TPD file found is taken. If the tpdName attribute is present in
 ReferencedProject then the value of tpdName will be used as a TPD name
during search. However if the tpdName attribute is missing then the value
of the name attribute is taken with the .tpd suffix and used during the
search.
.TP
.BI \-o " dir|file"
Write the Makefile to the given directory or file.
The current working directory is the default otherwise.
If the given argument is an existing directory, the generated
.I Makefile
will be placed into that directory. Otherwise the given argument is assumed to be the name of the generated
.I Makefile.
.TP
.BI \-O " file"
Add
.I file
to the list of
.I other files
in the generated Makefile without analyzing the file's contents and suffix.
This option can be used to temporarily exclude some TTCN-3, ASN.1 or C++ files
from the build process, but add them to the archive created by the command
.I make archive.
.TP
.B \-l
Enable dynamic linking. All files of the project will be compiled with
.I -fPIC
and for each (static) object, a new shared object will be created. Then, these
shared objects will be linked to the final executable instead of the (static)
objects. It can be used to speed up the linking phase, in the price of somewhat lower
performance and increased memory usage. It's recommended to use this flag only in the
development phase of the project. This option is not supported on Windows.
.TP
.B \-M
Allows the use of the value
.B omit
in template lists and complemented template lists (legacy behavior).
If set, an omitted field will match a template list, if the value
.B omit
appears in the list, and it will match a complemented template list, if
.B omit
is not in the list (the
.B ifpresent
attribute can still be used for matching omitted fields). This also affects the
.B ispresent
operation and the
.B present
template restriction accordingly.
.TP
.B \-p
Generate Makefile with
.I TTCN-3 preprocessing.
All the TTCN-3 source files with the
.I ttcnpp
extension will be preprocessed using the C preprocessor.
.TP
.B \-R
Use function test runtime (TITAN_RUNTIME_2). Generates a Makefile that
compiles and links the source code using the function test runtime.
.TP
.B \-s
Generates a Makefile, which links the executable test suite with the
.I single mode
version of the base library. If this switch is omitted the executable is
built for parallel mode by default.
.TP
.B \-v
Prints
.I version
and license key information and exits.
.TP 10
.B \-w
Suppresses all
.I warning
messages.
.TP
.BI \-z " file"
Enables code coverage and profiling in the TTCN-3 files listed in the
.I file
argument. The TTCN-3 files in the list must be separated by new lines and must
also appear among the makefile generator's arguments (this switch is ignored if the
.B \-t
option is present).

.SH ENVIRONMENT VARIABLES
.TP
.SM
TTCN3_DIR
The installation directory where the uncompressed binary package of
TTCN-3 Test Executor can be found.
.TP
.SM
TTCN3_LICENSE_FILE
It shall point to the
.I file
.RB ( NB:
.I not
to its directory) that contains the personalized license key for the
current user or host.
.SH BUGS
.LP
For trouble reporting use the tool
.BR "MTTSMS" "."
For TR writers guide please visit the web page:
.I http://ttcn.ericsson.se.
.SH SEE ALSO
.TP
.SM
Ericsson document 2/198 17-CRL 113 200 Uen:
.B Programmer's Technical Reference for TITAN TTCN-3 Test Executor
.SH AUTHOR
This manpage is written by Janos Zoltan Szabo, Ericsson Telecom AB
.br
Copyright (c) 2000-2015 Ericsson Telecom AB
.br
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
.br
http://www.eclipse.org/legal/epl-v10.html
Commit	Line	Data
970ed795 EL	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
feade998	6	.RB "[\\| " \-acdEfglMpRsw " \\|]"
970ed795 EL	7	.RB "[\\| " \-e
	8	.IR " ETS_name" " \\|]"
	9	.RB "[\\| " \-o
	10	.IR " dir\|file" " \\|]"
	11	.RB "[\\| " \-O
3abe9331	12	.IR " file" " \\|]"
3abe9331	13	.RB "[\\| " \-z
970ed795 EL	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
feade998	55	.B \-E
	56	Instructs the variant attribute parser to display warnings instead of errors
	57	for unrecognized/erroneous attributes.
	58	.TP
970ed795 EL	59	.B \-f
	60	Forces the Makefile Generator to
	61	.I overwrite
	62	the output files even if they exist or are unchanged.
	63	.TP
	64	.B \-g
	65	Generates a Makefile that can be used with
	66	.I GNU make
	67	only. The resulting Makefile will be smaller and less redundant. It
	68	exploits the pattern substitution features of GNU make, which may cause
	69	syntax errors with other versions of make.
	70	.TP
feade998	71	.BI \-I " path"
	72	Adds the path to the list of search paths.
	73	.I path
	74	must be an
	75	absolute path. Used with the
	76	.B -t
	77	option when the referenced projects
	78	can not be found at the projectRelativeURI location. In that case the
	79	tool will try to find the referenced TPD file using the search paths.
	80	The first TPD file found is taken. If the tpdName attribute is present in
	81	ReferencedProject then the value of tpdName will be used as a TPD name
	82	during search. However if the tpdName attribute is missing then the value
	83	of the name attribute is taken with the .tpd suffix and used during the
	84	search.
	85	.TP
970ed795 EL	86	.BI \-o " dir\|file"
	87	Write the Makefile to the given directory or file.
	88	The current working directory is the default otherwise.
	89	If the given argument is an existing directory, the generated
	90	.I Makefile
	91	will be placed into that directory. Otherwise the given argument is assumed to be the name of the generated
	92	.I Makefile.
	93	.TP
	94	.BI \-O " file"
	95	Add
	96	.I file
	97	to the list of
	98	.I other files
	99	in the generated Makefile without analyzing the file's contents and suffix.
	100	This option can be used to temporarily exclude some TTCN-3, ASN.1 or C++ files
	101	from the build process, but add them to the archive created by the command
	102	.I make archive.
	103	.TP
	104	.B \-l
	105	Enable dynamic linking. All files of the project will be compiled with
	106	.I -fPIC
	107	and for each (static) object, a new shared object will be created. Then, these
	108	shared objects will be linked to the final executable instead of the (static)
	109	objects. It can be used to speed up the linking phase, in the price of somewhat lower
	110	performance and increased memory usage. It's recommended to use this flag only in the
	111	development phase of the project. This option is not supported on Windows.
	112	.TP
3abe9331	113	.B \-M
	114	Allows the use of the value
	115	.B omit
	116	in template lists and complemented template lists (legacy behavior).
	117	If set, an omitted field will match a template list, if the value
	118	.B omit
	119	appears in the list, and it will match a complemented template list, if
	120	.B omit
	121	is not in the list (the
	122	.B ifpresent
	123	attribute can still be used for matching omitted fields). This also affects the
	124	.B ispresent
	125	operation and the
	126	.B present
	127	template restriction accordingly.
	128	.TP
970ed795 EL	129	.B \-p
	130	Generate Makefile with
	131	.I TTCN-3 preprocessing.
	132	All the TTCN-3 source files with the
	133	.I ttcnpp
	134	extension will be preprocessed using the C preprocessor.
	135	.TP
	136	.B \-R
	137	Use function test runtime (TITAN_RUNTIME_2). Generates a Makefile that
	138	compiles and links the source code using the function test runtime.
	139	.TP
	140	.B \-s
	141	Generates a Makefile, which links the executable test suite with the
	142	.I single mode
	143	version of the base library. If this switch is omitted the executable is
	144	built for parallel mode by default.
	145	.TP
	146	.B \-v
	147	Prints
	148	.I version
	149	and license key information and exits.
	150	.TP 10
	151	.B \-w
	152	Suppresses all
	153	.I warning
	154	messages.
3abe9331	155	.TP
	156	.BI \-z " file"
	157	Enables code coverage and profiling in the TTCN-3 files listed in the
	158	.I file
	159	argument. The TTCN-3 files in the list must be separated by new lines and must
	160	also appear among the makefile generator's arguments (this switch is ignored if the
	161	.B \-t
	162	option is present).
970ed795 EL	163
	164	.SH ENVIRONMENT VARIABLES
	165	.TP
	166	.SM
	167	TTCN3_DIR
	168	The installation directory where the uncompressed binary package of
	169	TTCN-3 Test Executor can be found.
	170	.TP
	171	.SM
	172	TTCN3_LICENSE_FILE
	173	It shall point to the
	174	.I file
	175	.RB ( NB:
	176	.I not
	177	to its directory) that contains the personalized license key for the
	178	current user or host.
	179	.SH BUGS
	180	.LP
	181	For trouble reporting use the tool
	182	.BR "MTTSMS" "."
	183	For TR writers guide please visit the web page:
	184	.I http://ttcn.ericsson.se.
	185	.SH SEE ALSO
	186	.TP
	187	.SM
	188	Ericsson document 2/198 17-CRL 113 200 Uen:
	189	.B Programmer's Technical Reference for TITAN TTCN-3 Test Executor
	190	.SH AUTHOR
	191	This manpage is written by Janos Zoltan Szabo, Ericsson Telecom AB
	192	.br
3abe9331	193	Copyright (c) 2000-2015 Ericsson Telecom AB
970ed795 EL	194	.br
	195	All rights reserved. This program and the accompanying materials
	196	are made available under the terms of the Eclipse Public License v1.0
	197	which accompanies this distribution, and is available at
	198	.br
	199	http://www.eclipse.org/legal/epl-v10.html