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

.TH ttcn3_logformat 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools" 
.SH NAME
ttcn3_logformat \- TTCN-3 log file formatter utility
.SH SYNOPSIS
.B ttcn3_logformat
.RB "[\| " \-i
.IR n " \|]"
.RB "[\| " \-o
.IR outfile " \|]"
.RB "[\| " \-s
\|] [\|
.IR file.log " \|]"
.RB "[\| " \-n " \|]"
.br
or
.br
.B ttcn3_logformat
.B \-v
.SH DESCRIPTION
This manual page is a quick reference for the TTCN-3 logformat utility of
the TTCN-3 Test Executor. The 
.B ttcn3_logformat
utility, which can be found in 
.I $TTCN3_DIR/bin,
reads the unformatted log file generated by test executor from its standard
input. It can split up the log into several files based on the lines that are
automatically logged at the beginning or end of each test case. Furthermore,
.B ttcn3_logformat
formats the sent and received messages in the log file. The structured values
are indented and each field is put into a new line according to the braces and
commas.
.SH OPTIONS
Available command line switches are:
.TP 10
.BI \-i " n"
Sets the depth of each indentation level to
.I n
characters. The default value is 4. If the sent or received PDU is too complex
and has too deeply nested fields, this number can be decreased to get more
readable output.
.TP
.BI \-o " outfile"
Places the output into file 
.IR "outfile" ". If the"
.I \-s 
flag is also set, only those parts of the log files will be written into this
file that were logged outside the test cases (i.e. in control part or on PTCs).
If this option is omitted, the formatted log will be printed to standard output.
.TP
.B \-s
If this option is set, the entries that were recorded during the execution of a 
particular test case will be saved in a separate file in
.I ttcn3_logformat
working directory. The name of this file will be identical to the name of the
test case. If the same test case is executed several times after each other, the
results of repeated test runs will be collected after each other. If the output
file contained some data before
.I ttcn3_logformat
was started (e.g. the results of previous test run), the output file will be
emptied and the old logs will be destroyed.
.br
.I ttcn3_logformat
recognizes any types of timestamps that can be set in the
.B [LOGGING]
section of the configuration file.
.sp 1
.B WARNING!
This option is useless when formatting the log files of PTCs, because these logs
do not contain the name of the testcase that the PTC belongs to.
.TP
.B \-n
If this option is set, newline and tab characters are not modified, they are
printed as \\n and \\t
.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
For trouble reporting use the tool 
.BR "MTTSMS" "."
.br
For TR writers guide please visit the web page:
.br
.I http://ttcn.ericsson.se.
.SH SEE ALSO
ttcn3_logfilter(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_logformat 1 "October 2014" "Ericsson Telecom AB" "TTCN-3 Tools"
	2	.SH NAME
	3	ttcn3_logformat \- TTCN-3 log file formatter utility
	4	.SH SYNOPSIS
	5	.B ttcn3_logformat
	6	.RB "[\\| " \-i
	7	.IR n " \\|]"
	8	.RB "[\\| " \-o
	9	.IR outfile " \\|]"
	10	.RB "[\\| " \-s
	11	\\|] [\\|
	12	.IR file.log " \\|]"
3f84031e	13	.RB "[\\| " \-n " \\|]"
970ed795 EL	14	.br
	15	or
	16	.br
	17	.B ttcn3_logformat
	18	.B \-v
	19	.SH DESCRIPTION
	20	This manual page is a quick reference for the TTCN-3 logformat utility of
	21	the TTCN-3 Test Executor. The
	22	.B ttcn3_logformat
	23	utility, which can be found in
	24	.I $TTCN3_DIR/bin,
	25	reads the unformatted log file generated by test executor from its standard
	26	input. It can split up the log into several files based on the lines that are
	27	automatically logged at the beginning or end of each test case. Furthermore,
	28	.B ttcn3_logformat
	29	formats the sent and received messages in the log file. The structured values
	30	are indented and each field is put into a new line according to the braces and
	31	commas.
	32	.SH OPTIONS
	33	Available command line switches are:
	34	.TP 10
	35	.BI \-i " n"
	36	Sets the depth of each indentation level to
	37	.I n
	38	characters. The default value is 4. If the sent or received PDU is too complex
	39	and has too deeply nested fields, this number can be decreased to get more
	40	readable output.
	41	.TP
	42	.BI \-o " outfile"
	43	Places the output into file
	44	.IR "outfile" ". If the"
	45	.I \-s
	46	flag is also set, only those parts of the log files will be written into this
	47	file that were logged outside the test cases (i.e. in control part or on PTCs).
	48	If this option is omitted, the formatted log will be printed to standard output.
	49	.TP
	50	.B \-s
	51	If this option is set, the entries that were recorded during the execution of a
	52	particular test case will be saved in a separate file in
	53	.I ttcn3_logformat
	54	working directory. The name of this file will be identical to the name of the
	55	test case. If the same test case is executed several times after each other, the
	56	results of repeated test runs will be collected after each other. If the output
	57	file contained some data before
	58	.I ttcn3_logformat
	59	was started (e.g. the results of previous test run), the output file will be
	60	emptied and the old logs will be destroyed.
	61	.br
	62	.I ttcn3_logformat
	63	recognizes any types of timestamps that can be set in the
	64	.B [LOGGING]
	65	section of the configuration file.
	66	.sp 1
	67	.B WARNING!
	68	This option is useless when formatting the log files of PTCs, because these logs
	69	do not contain the name of the testcase that the PTC belongs to.
	70	.TP
3f84031e	71	.B \-n
	72	If this option is set, newline and tab characters are not modified, they are
	73	printed as \\n and \\t
	74	.TP
970ed795 EL	75	.B \-v
	76	Prints
	77	.I version
	78	and license key information and exits.
	79	.SH ENVIRONMENT VARIABLES
	80	.TP
	81	.SM
	82	TTCN3_DIR
	83	The installation directory where the uncompressed binary package of
	84	TTCN-3 Test Executor can be found.
	85	.TP
	86	.SM
	87	TTCN3_LICENSE_FILE
	88	It shall point to the
	89	.I file
	90	.RB ( NB:
	91	.I not
	92	to its directory) that contains the personalized license key for the
	93	current user or host.
	94	.SH BUGS
	95	None known at this time
	96	.LP
	97	For trouble reporting use the tool
	98	.BR "MTTSMS" "."
	99	.br
	100	For TR writers guide please visit the web page:
	101	.br
	102	.I http://ttcn.ericsson.se.
	103	.SH SEE ALSO
	104	ttcn3_logfilter(1), ttcn3_logmerge(1)
	105	.LP
	106	The
	107	.B User Documentation for the TTCN-3
	108	.B Test Executor.
	109	.SH AUTHOR
	110	This manpage is written by Csaba Koppany, Ericsson Telecom AB
	111	.br
d44e3c4f	112	Copyright (c) 2000-2016 Ericsson Telecom AB
970ed795 EL	113	.br
	114	All rights reserved. This program and the accompanying materials
	115	are made available under the terms of the Eclipse Public License v1.0
	116	which accompanies this distribution, and is available at
	117	.br
	118	http://www.eclipse.org/legal/epl-v10.html