[deliverable/titan.core.git] / repgen / ttcn3_logfilter.1

.TH ttcn3_logfilter 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
.SH NAME
ttcn3_logfilter \- TTCN-3 log file filtering utility
.SH SYNOPSIS
.B ttcn3_logfilter
.RB "[\| " \-o
.IR outfile " \|]"
.RI "{ " eventtype
(+|-) } [\|
.IR input.log " \|]"
...
.br
or
.br
.B ttcn3_logfilter
.B \-v | \-h | \-l
.SH DESCRIPTION
This manual page is a quick reference for the TTCN-3 logfilter utility of
the TTCN-3 Test Executor. The 
.B ttcn3_logfilter
utility, which can be found in 
.I $TTCN3_DIR/bin,
filters the input log file given in the command line argument based on the
event types in the file, and filter parameters given in the program argument.
The output is then written to an output file if specified, or to the standard
output. The program is useful only if the variable
.B LogEventTypes
is set to
.B Yes
in section
.B [LOGGING]
of the configuration file.
.SH OPTIONS
Available command line switches are:
.TP 10
.B \-h
Prints
.I help
on how to use the utility.
.TP
.B \-l
Prints the
.I list
of supported event types.
.TP
.BI \-o " outfile"
Puts its output into 
.IR outfile "."
If the file outfile exists its contents will be overwritten. This switch is
optional, when omitted the output will be printed to standard output.
.TP
.B \-v
Prints
.I version
and license key information and exits.
.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
None known at this time
.LP
.SH SEE ALSO
ttcn3_logformat(1), ttcn3_logmerge(1)
.LP
The
.B User Documentation for the TTCN-3
.B Test Executor.
.SH AUTHOR
This manpage is written by Csaba Koppany, 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_logfilter 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
	2	.SH NAME
	3	ttcn3_logfilter \- TTCN-3 log file filtering utility
	4	.SH SYNOPSIS
	5	.B ttcn3_logfilter
	6	.RB "[\\| " \-o
	7	.IR outfile " \\|]"
	8	.RI "{ " eventtype
	9	(+\|-) } [\\|
	10	.IR input.log " \\|]"
	11	...
	12	.br
	13	or
	14	.br
	15	.B ttcn3_logfilter
	16	.B \-v \| \-h \| \-l
	17	.SH DESCRIPTION
	18	This manual page is a quick reference for the TTCN-3 logfilter utility of
	19	the TTCN-3 Test Executor. The
	20	.B ttcn3_logfilter
	21	utility, which can be found in
	22	.I $TTCN3_DIR/bin,
	23	filters the input log file given in the command line argument based on the
	24	event types in the file, and filter parameters given in the program argument.
	25	The output is then written to an output file if specified, or to the standard
	26	output. The program is useful only if the variable
	27	.B LogEventTypes
	28	is set to
	29	.B Yes
	30	in section
	31	.B [LOGGING]
	32	of the configuration file.
	33	.SH OPTIONS
	34	Available command line switches are:
	35	.TP 10
	36	.B \-h
	37	Prints
	38	.I help
	39	on how to use the utility.
	40	.TP
	41	.B \-l
	42	Prints the
	43	.I list
	44	of supported event types.
	45	.TP
	46	.BI \-o " outfile"
	47	Puts its output into
	48	.IR outfile "."
	49	If the file outfile exists its contents will be overwritten. This switch is
	50	optional, when omitted the output will be printed to standard output.
	51	.TP
	52	.B \-v
	53	Prints
	54	.I version
	55	and license key information and exits.
	56	.SH ENVIRONMENT VARIABLES
	57	.TP
	58	.SM
	59	TTCN3_DIR
	60	The installation directory where the uncompressed binary package of
	61	TTCN-3 Test Executor can be found.
	62	.TP
	63	.SM
	64	TTCN3_LICENSE_FILE
65	It shall point to the
66	.I file
67	.RB ( NB:
68	.I not
69	to its directory) that contains the personalized license key for the
70	current user or host.
71	.SH BUGS
72	None known at this time
73	.LP
74	.SH SEE ALSO
75	ttcn3_logformat(1), ttcn3_logmerge(1)
76	.LP
77	The
78	.B User Documentation for the TTCN-3
79	.B Test Executor.
80	.SH AUTHOR
81	This manpage is written by Csaba Koppany, Ericsson Telecom AB
82	.br
3abe9331	83	Copyright (c) 2000-2015 Ericsson Telecom AB
970ed795 EL	84	.br
	85	All rights reserved. This program and the accompanying materials
	86	are made available under the terms of the Eclipse Public License v1.0
	87	which accompanies this distribution, and is available at
	88	.br
	89	http://www.eclipse.org/legal/epl-v10.html