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