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