doc/dlt.conf.5

   1 '\" t
   2 .\"     Title: dlt.conf
   3 .\"    Author: [see the "AUTHOR" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 10/12/2012
   6 .\"    Manual: \ \&
   7 .\"    Source: \ \&
   8 .\"  Language: English
   9 .\"
  10 .TH "DLT\&.CONF" "5" "10/12/2012" "\ \&" "\ \&"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 dlt.conf \- DLT daemon configuration file
  32 .SH "DESCRIPTION"
  33 .sp
  34 The DLT daemon is the central place where logs and traces are gathered from different applications, stored temporarily or permanently and transferred to a DLT client application, which can run directly on the GENIVI system or more likely on a external tester device\&.
  35 .sp
  36 The configuration file dlt\&.conf allows to configure the different runtime behaviour of the dlt\-daemon\&. The configuration file is loaded during startup of dlt\-daemon\&.
  37 .sp
  38 dlt\-daemon loads by default the configuration file /etc/dlt\&.conf\&. An alternative configuration file can be loaded with the option \-c\&.
  39 .SH "GENERAL OPTIONS"
  40 .PP
  41 \fBDaemonize\fR
  42 .RS 4
  43 If set to 1 DLT daemon is started in background as daemon\&. This option is only needed in System V init systems\&. In systemd based startup systems the daemon is started by spawning own process\&.
  44 .sp
  45 .if n \{\
  46 .RS 4
  47 .\}
  48 .nf
  49 Default: 0
  50 .fi
  51 .if n \{\
  52 .RE
  53 .\}
  54 .RE
  55 .PP
  56 \fBSendSerialHeader\fR
  57 .RS 4
  58 If set to 1 DLT daemon sends each DLT message to the client with prepanding the serial header "DLS0x01"\&.
  59 .sp
  60 .if n \{\
  61 .RS 4
  62 .\}
  63 .nf
  64 Default: 0
  65 .fi
  66 .if n \{\
  67 .RE
  68 .\}
  69 .RE
  70 .PP
  71 \fBSendContextRegistration\fR
  72 .RS 4
  73 If set to 1 each context which is registered from an application in the DLT daemon generates a message to inform the DLT client about the new context\&.
  74 .sp
  75 .if n \{\
  76 .RS 4
  77 .\}
  78 .nf
  79 Default: 0
  80 .fi
  81 .if n \{\
  82 .RE
  83 .\}
  84 .RE
  85 .PP
  86 \fBSendMessageTime\fR
  87 .RS 4
  88 If set to 1 DLt daemon sends each second a DLT control message to the client with the current timestamp from the system\&.
  89 .sp
  90 .if n \{\
  91 .RS 4
  92 .\}
  93 .nf
  94 Default: 0
  95 .fi
  96 .if n \{\
  97 .RE
  98 .\}
  99 .RE
 100 .PP
 101 \fBECUId\fR
 102 .RS 4
 103 This value sets the ECU Id, which is sent with each DLT message\&.
 104 .sp
 105 .if n \{\
 106 .RS 4
 107 .\}
 108 .nf
 109 Default: ECU1
 110 .fi
 111 .if n \{\
 112 .RE
 113 .\}
 114 .RE
 115 .PP
 116 \fBSharedMemorySize\fR
 117 .RS 4
 118 This value sets the size of the shared memory, which is used to exchange DLT messages between applications and daemon\&. This value is defined in bytes\&. If this value is changed the system must be rebooted to take effect\&.
 119 .sp
 120 .if n \{\
 121 .RS 4
 122 .\}
 123 .nf
 124 Default: 100000
 125 .fi
 126 .if n \{\
 127 .RE
 128 .\}
 129 .RE
 130 .PP
 131 \fBPersistanceStoragePath\fR
 132 .RS 4
 133 This is the directory path, where the DLT daemon stores its runtime configuration\&. Runtime configuration includes stored log levels, trace status and changed logging mode\&.
 134 .sp
 135 .if n \{\
 136 .RS 4
 137 .\}
 138 .nf
 139 Default: /tmp
 140 .fi
 141 .if n \{\
 142 .RE
 143 .\}
 144 .RE
 145 .SH "OFFLINE TRACE OPTIONS"
 146 .PP
 147 \fBOfflineTraceDirectory\fR
 148 .RS 4
 149 If this option is set, offline trace is enabled\&. This value sets the directory path to the offline trace memory\&. The directory must already exist\&.
 150 .sp
 151 .if n \{\
 152 .RS 4
 153 .\}
 154 .nf
 155 Default: Offline tracing is disabled\&.
 156 .fi
 157 .if n \{\
 158 .RE
 159 .\}
 160 .RE
 161 .PP
 162 \fBOfflineTraceFileSize\fR
 163 .RS 4
 164 This value defines the max size of a offline trace file, if offline trace is enabled\&. This value is defined in bytes\&. If the files size of the current used log file is exceeded, a new log file is created\&.
 165 .sp
 166 .if n \{\
 167 .RS 4
 168 .\}
 169 .nf
 170 Default: 1000000
 171 .fi
 172 .if n \{\
 173 .RE
 174 .\}
 175 .RE
 176 .PP
 177 \fBOfflineTraceMaxSize\fR
 178 .RS 4
 179 This value defines the max offline Trace memory size, if offline trace is enabled\&. This value is defined in bytes\&. If the overall offline trace size is excedded, the oldest log files are deleted, until a new trace file fits the overall offline trace max size\&.
 180 .sp
 181 .if n \{\
 182 .RS 4
 183 .\}
 184 .nf
 185 Default: 4000000
 186 .fi
 187 .if n \{\
 188 .RE
 189 .\}
 190 .RE
 191 .SH "LOCAL CONSOLE OUTPUT OPTIONS"
 192 .PP
 193 \fBPrintASCII\fR
 194 .RS 4
 195 Prints each received DLT message from the application in ASCII to the local console\&. This option should only be anabled for debugging purpose\&.
 196 .sp
 197 .if n \{\
 198 .RS 4
 199 .\}
 200 .nf
 201 Default: Function is disabled
 202 .fi
 203 .if n \{\
 204 .RE
 205 .\}
 206 .RE
 207 .PP
 208 \fBPrintHex\fR
 209 .RS 4
 210 Prints each received DLT message from the application in ASCII to the local console\&. The payload is printed in Hex\&. This option should only be anabled for debugging purpose\&.
 211 .sp
 212 .if n \{\
 213 .RS 4
 214 .\}
 215 .nf
 216 Default: Function is disabled
 217 .fi
 218 .if n \{\
 219 .RE
 220 .\}
 221 .RE
 222 .PP
 223 \fBPrintHeadersOnly\fR
 224 .RS 4
 225 Prints each received DLT message from the application in ASCII to the local console\&. Only the header is printed\&. This option should only be anabled for debugging purpose\&.
 226 .sp
 227 .if n \{\
 228 .RS 4
 229 .\}
 230 .nf
 231 Default: Function is disabled
 232 .fi
 233 .if n \{\
 234 .RE
 235 .\}
 236 .RE
 237 .SH "SERIAL CLIENT OPTIONS"
 238 .PP
 239 \fBRS232DeviceName\fR
 240 .RS 4
 241 If this value is set to a serial device name, e\&.g\&. /dev/ttyS0, a serial port is used for logging to a client\&.
 242 .sp
 243 .if n \{\
 244 .RS 4
 245 .\}
 246 .nf
 247 Default: Serial port for logging is disabled
 248 .fi
 249 .if n \{\
 250 .RE
 251 .\}
 252 .RE
 253 .PP
 254 \fBRS232Baudrate\fR
 255 .RS 4
 256 The used serial baud rate, if serial loggin is enabled\&. The RS232DeviceName must be set to enable serial logging\&.
 257 .sp
 258 .if n \{\
 259 .RS 4
 260 .\}
 261 .nf
 262 Default: 115200
 263 .fi
 264 .if n \{\
 265 .RE
 266 .\}
 267 .RE
 268 .PP
 269 \fBRS232SyncSerialHeader\fR
 270 .RS 4
 271 If serial logging is enabled, each received DLT message is checked to contain a serial header\&. If the DLT message contains no serial header, the message is ignored\&.
 272 .sp
 273 .if n \{\
 274 .RS 4
 275 .\}
 276 .nf
 277 Default: Function is disabled
 278 .fi
 279 .if n \{\
 280 .RE
 281 .\}
 282 .RE
 283 .SH "TCP CLIENT OPTIONS"
 284 .PP
 285 \fBTCPSyncSerialHeader\fR
 286 .RS 4
 287 Each received DLT message on a TCP connection is checked to contain a serial header\&. If the DLT message contains no serial header, the message is ignored\&.
 288 .RE
 289 .SH "ECU SOFTWARE VERSION INFO"
 290 .PP
 291 \fBSendECUSoftwareVersion\fR
 292 .RS 4
 293 Send periodic ECU version info\&. 0=disabled, 1=enabled\&.
 294 .sp
 295 .if n \{\
 296 .RS 4
 297 .\}
 298 .nf
 299 Default: 0
 300 .fi
 301 .if n \{\
 302 .RE
 303 .\}
 304 .RE
 305 .PP
 306 \fBPathToECUSoftwareVersion\fR
 307 .RS 4
 308 Absolute path to file storing version information \- if disabled the DLT version will be send\&.
 309 .RE
 310 .SH "EXAMPLES"
 311 .PP
 312 Start DLT daemon in background mode
 313 .RS 4
 314
 315 \fBdlt\-daemon \-d\fR
 316 .RE
 317 .PP
 318 Start DLT daemon with own configuration
 319 .RS 4
 320
 321 \fBdlt\-daemon \-c ~/my\-dlt\-configuration\&.cfg\fR
 322 .RE
 323 .SH "AUTHOR"
 324 .sp
 325 Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de)
 326 .SH "RESOURCES"
 327 .sp
 328 Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace
 329 .SH "SEE ALSO"
 330 .sp
 331 dlt\-daemon(1) dlt\-system(1)