summaryrefslogtreecommitdiff
path: root/doc/dlt.conf.5
blob: 79721676258051b6f8601237d8aab3e0dc3be483 (plain)
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
.TH dlt.conf 5 "September 19, 2012" "version 2.7.1 Stable" "USER COMMANDS"
.SH NAME
dlt.conf \- DLT daemon configuration file
.SH DESCRIPTION
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.
.PP
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.
.PP
dlt-daemon loads by default the configuration file /etc/dlt.conf. An
alternative configuration file can be loaded with the option \-c.
.SH GENERAL OPTIONS
.TP
.B Verbose
If set to 1 DLT daemon is started in dubug mode, so that all internal debug
information is printed out on the console.
.IP
Default: 0
.TP
.B Daemonize
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.
.IP
Default: 0
.TP
.B SendSerialHeader
If set to 1 DLT daemon sends each DLT message to the client with
prepanding the serial header "DLS0x01".
.IP
Default: 0
.TP
.B SendContextRegistration
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.
.IP
Default: 0
.TP
.B SendMessageTime
If set to 1 DLt daemon sends each second a DLT control message to the
client with the current timestamp from the system.
.IP
Default: 0
.TP
.B ECUId
This value sets the ECU Id, which is sent with each DLT message.
.IP
Default: ECU1
.TP
.B SharedMemorySize
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.
.IP
Default: 100000
.TP
.B PersistanceStoragePath
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. 
.IP
Default: /tmp
.SH OFFLINE TRACE OPTIONS
.TP
.B OfflineTraceDirectory
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.
.IP
Default: Offline tracing is disabled.
.TP
.B OfflineTraceFileSize
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. 
.IP
Default: 1000000
.TP
.B OfflineTraceMaxSize
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.
.IP
Default: 4000000
.SH LOCAL CONSOLE OUTPUT OPTIONS
.TP
.B PrintASCII
Prints each received DLT message from the application in ASCII to the
local console.
This option should only be anabled for debugging purpose.
.IP
Default: Function is disabled
.TP
.B PrintHex
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.
.IP
Default: Function is disabled
.TP
.B PrintHeadersOnly
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.
.IP
Default: Function is disabled
.SH SERIAL CLIENT OPTIONS
.TP
.B RS232DeviceName
If this value is set to a serial device name, e.g. /dev/ttyS0, a serial
port is used for logging to a client. 
.IP
Default: Serial port for logging is disabled
.TP
.B RS232Baudrate
The used serial baud rate, if serial loggin is enabled. The
RS232DeviceName must be set to enable serial logging.
.IP
Default: 115200
.TP
.B RS232SyncSerialHeader
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.
.IP
Default: Function is disabled
.SH TCP CLIENT OPTIONS
.TP
.B TCPSyncSerialHeader
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.
.SH ECU Software version info
.TP
.B SendECUSoftwareVersion
Send periodic ECU version info. 0=disabled, 1=enabled.
.IP
Default: 0
.TP
.B PathToECUSoftwareVersion
Absolute path to file storing version information - if disabled the DLT version will be send.
.SH AUTHOR
Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
.SH SEE ALSO
dlt(1)