File: ttcn3_logformat.1

package info (click to toggle)
eclipse-titan 7.2.0-1.1
  • links: PTS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 103,144 kB
  • sloc: cpp: 264,784; ansic: 33,124; yacc: 23,073; makefile: 14,730; lex: 9,190; java: 4,849; perl: 3,783; sh: 2,298; xml: 1,378; javascript: 85; awk: 48; php: 32; python: 13
file content (118 lines) | stat: -rw-r--r-- 3,578 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.TH ttcn3_logformat 1 "May 2020" "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-2020 Ericsson Telecom AB
.br
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v2.0
which accompanies this distribution, and is available at
.br
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html