doc/dlt.conf.5

   1 .TH dlt.conf 5  "March 2, 2012" "version 2.5.1" "USER COMMANDS"
   2 .SH NAME
   3 dlt.conf \- DLT daemon configuration file
   4 .SH DESCRIPTION
   5 The DLT daemon is the central place where logs and traces are gathered
   6 from different applications, stored temporarily or permanently and
   7 transferred to a DLT client application, which can run directly on the
   8 GENIVI system or more likely on a external tester device.
   9 .PP
  10 The configuration file dlt.conf allows to configure the different
  11 runtime behaviour of the dlt-daemon. The configuration file is loaded
  12 during startup of dlt-daemon.
  13 .PP
  14 dlt-daemon loads by default the configuration file /etc/dlt.conf. An
  15 alternative configuration file can be loaded with the option \-c.
  16 .SH GENERAL OPTIONS
  17 .TP
  18 .B Verbose
  19 If set to 1 DLT daemon is started in dubug mode, so that all internal debug
  20 information is printed out on the console.
  21 .IP
  22 Default: 0
  23 .TP
  24 .B Daemonize
  25 If set to 1 DLT daemon is started in background as daemon. This option
  26 is only needed in System V init systems. In systemd based startup
  27 systems the daemon is started by spawning own process.
  28 .IP
  29 Default: 0
  30 .TP
  31 .B SendSerialHeader
  32 If set to 1 DLT daemon sends each DLT message to the client with
  33 prepanding the serial header "DLS0x01".
  34 .IP
  35 Default: 0
  36 .TP
  37 .B SendContextRegistration
  38 If set to 1 each context which is registered from an application in the
  39 DLT daemon generates a message to inform the DLT client about the new
  40 context.
  41 .IP
  42 Default: 0
  43 .TP
  44 .B SendMessageTime
  45 If set to 1 DLt daemon sends each second a DLT control message to the
  46 client with the current timestamp from the system.
  47 .IP
  48 Default: 0
  49 .TP
  50 .B ECUId
  51 This value sets the ECU Id, which is sent with each DLT message.
  52 .IP
  53 Default: ECU1
  54 .TP
  55 .B SharedMemorySize
  56 This value sets the size of the shared memory, which is used to exchange
  57 DLT messages between applications and daemon. This value is defined in
  58 bytes. If this value is changed the system must be rebooted to take
  59 effect.
  60 .IP
  61 Default: 100000
  62 .TP
  63 .B PersistanceStoragePath
  64 This is the directory path, where the DLT daemon stores its runtime
  65 configuration. Runtime configuration includes stored log levels, trace
  66 status and changed logging mode.
  67 .IP
  68 Default: /tmp
  69 .SH OFFLINE TRACE OPTIONS
  70 .TP
  71 .B OfflineTraceDirectory
  72 If this option is set, offline trace is enabled. This value sets the
  73 directory path to the offline trace memory. The directory must already
  74 exist.
  75 .IP
  76 Default: Offline tracing is disabled.
  77 .TP
  78 .B OfflineTraceFileSize
  79 This value defines the max size of a offline trace file, if offline trace
  80 is enabled. This value is defined in bytes. If the files size of the
  81 current used log file is exceeded, a new log file is created.
  82 .IP
  83 Default: 1000000
  84 .TP
  85 .B OfflineTraceMaxSize
  86 This value defines the max offline Trace memory size, if offline trace
  87 is enabled. This value is defined in bytes. If the overall offline trace
  88 size is excedded, the oldest log files are deleted, until a new trace
  89 file fits the overall offline trace max size.
  90 .IP
  91 Default: 4000000
  92 .SH LOCAL CONSOLE OUTPUT OPTIONS
  93 .TP
  94 .B PrintASCII
  95 Prints each received DLT message from the application in ASCII to the
  96 local console.
  97 This option should only be anabled for debugging purpose.
  98 .IP
  99 Default: Function is disabled
 100 .TP
 101 .B PrintHex
 102 Prints each received DLT message from the application in ASCII to the
 103 local console. The payload is printed in Hex.
 104 This option should only be anabled for debugging purpose.
 105 .IP
 106 Default: Function is disabled
 107 .TP
 108 .B PrintHeadersOnly
 109 Prints each received DLT message from the application in ASCII to the
 110 local console. Only the header is printed.
 111 This option should only be anabled for debugging purpose.
 112 .IP
 113 Default: Function is disabled
 114 .SH SERIAL CLIENT OPTIONS
 115 .TP
 116 .B RS232DeviceName
 117 If this value is set to a serial device name, e.g. /dev/ttyS0, a serial
 118 port is used for logging to a client.
 119 .IP
 120 Default: Serial port for logging is disabled
 121 .TP
 122 .B RS232Baudrate
 123 The used serial baud rate, if serial loggin is enabled. The
 124 RS232DeviceName must be set to enable serial logging.
 125 .IP
 126 Default: 115200
 127 .TP
 128 .B RS232SyncSerialHeader
 129 If serial logging is enabled, each received DLT message is checked to
 130 contain a serial header. If the DLT message contains no serial header,
 131 the message is ignored.
 132 .IP
 133 Default: Function is disabled
 134 .SH TCP CLIENT OPTIONS
 135 .TP
 136 .B TCPSyncSerialHeader
 137 Each received DLT message on a TCP connection is checked to contain a
 138 serial header. If the DLT message contains no serial header, the message
 139 is ignored.
 140 .IP
 141 Default:
 142 .SH AUTHOR
 143 Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
 144 .SH SEE ALSO
 145 dlt(1)