repgen/ttcn3_logformat.1

   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
  52 .I ttcn3_logformat
  53 working directory. The name of this file will be identical to the name of the
  54 test case. If the same test case is executed several times after each other, the
  55 results of repeated test runs will be collected after each other. If the output
  56 file contained some data before
  57 .I ttcn3_logformat
  58 was started (e.g. the results of previous test run), the output file will be
  59 emptied and the old logs will be destroyed.
  60 .br
  61 .I ttcn3_logformat
  62 recognizes any types of timestamps that can be set in the
  63 .B [LOGGING]
  64 section of the configuration file.
  65 .sp 1
  66 .B WARNING!
  67 This option is useless when formatting the log files of PTCs, because these logs
  68 do not contain the name of the testcase that the PTC belongs to.
  69 .TP
  70 .B \-v
  71 Prints
  72 .I version
  73 and license key information and exits.
  74 .SH ENVIRONMENT VARIABLES
  75 .TP
  76 .SM
  77 TTCN3_DIR
  78 The installation directory where the uncompressed binary package of
  79 TTCN-3 Test Executor can be found.
  80 .TP
  81 .SM
  82 TTCN3_LICENSE_FILE
  83 It shall point to the
  84 .I file
  85 .RB ( NB:
  86 .I not
  87 to its directory) that contains the personalized license key for the
  88 current user or host.
  89 .SH BUGS
  90 None known at this time
  91 .LP
  92 For trouble reporting use the tool
  93 .BR "MTTSMS" "."
  94 .br
  95 For TR writers guide please visit the web page:
  96 .br
  97 .I http://ttcn.ericsson.se.
  98 .SH SEE ALSO
  99 ttcn3_logfilter(1), ttcn3_logmerge(1)
 100 .LP
 101 The
 102 .B User Documentation for the TTCN-3
 103 .B Test Executor.
 104 .SH AUTHOR
 105 This manpage is written by Csaba Koppany, Ericsson Telecom AB
 106 .br
 107 Copyright (c) 2000-2014 Ericsson Telecom AB
 108 .br
 109 All rights reserved. This program and the accompanying materials
 110 are made available under the terms of the Eclipse Public License v1.0
 111 which accompanies this distribution, and is available at
 112 .br
 113 http://www.eclipse.org/legal/epl-v10.html