GDLT-38, Change License from LGPL to MPL in information files.
[profile/ivi/dlt-daemon.git] / README.txt
1 DLT  - Automotive Diagnostic Log and Trace
2
3 Version: 2.5.1
4
5 This component provides a standardised log and trace interface, based on the
6 standardised protocol specified in the AUTOSAR standard 4.0 DLT.
7 This component can be used by GENIVI components and other applications as
8 logging facility providing
9 - the DLT shared library
10 - the DLT daemon
11 - the DLT daemon adaptors
12 - the DLT client console utilities
13 - the DLT test applications
14
15 The DLT daemon is the central component in GENIVI, which gathers all 
16 logs and traces from the DLT user applications. The logs and traces 
17 are stored optionally directly in a file in the ECU. The DLT daemon 
18 forwards all logs and traces to a connected DLT client.
19 The DLT client can send control messages to the daemon, e.g. to set 
20 individual log levels of applications and contexts or get the list of 
21 applications and contexts registered in the DLT daemon.
22
23
24 Homepage
25 --------
26 https://collab.genivi.org/wiki/display/geniviproj/Automotive+DLT+%28Diagnostic+Log+and+Trace%29
27
28
29 License
30 -------
31 Full information on the license for this software
32 is available in the "LICENSE.txt" file. 
33 The full MPL license is in "MPL.txt."
34
35
36 Contact
37 -------
38 Alexander Wenzel (Alexander.AW.Wenzel@bmw.de)
39 Christian Muck (christian.muck@bmw.de)
40
41
42 Compiling in Linux:
43 -------------------
44 - mkdir build
45 - cd build
46 - cmake ..
47 - make
48 - optional: sudo make install
49 - optional: sudo ldconfig
50
51
52 Compile options with default values
53 -----------------------------------
54 - WITH_DLT_SHM_ENABLE =        OFF
55 - WITH_CHECK_CONFIG_FILE =     OFF
56 - WITH_DOC =                   OFF
57 - WITH_TESTSCRIPTS =           OFF
58 - WITH_SYSTEMD =               OFF
59 - WITH_GPROF =                 OFF
60 - WITH_MAN =                   ON
61 - WITH_DLTTEST =               OFF
62 - BUILD_SHARED_LIBS =          ON
63 - CMAKE_INSTALL_PREFIX =       /usr/local
64 - CMAKE_BUILD_TYPE =           RelWithDebInfo
65
66
67 In order to change these options, you can modify this values
68 with ccmake, do the appropriate changes in CmakeList.txt or via 
69 the commandline for cmake
70 - Change a value with: cmake -D<Variable>=<Value>
71 - Example: cmake -DCMAKE_INSTALL_PREFIX=/usr
72
73
74 Man pages
75 ---------
76 With the compile option "WITH_MAN=ON" (default value) the man 
77 pages will generated. After the call "sudo make install" (see 
78 "Compilin in Linux") they are installed at <CMAKE_INSTALL_PREFIX>/share/man. 
79
80 To get more informations, call e.g.
81 - man dlt-daemon
82 - man dlt.conf
83 - man dlt-convert
84 - man dlt-receive
85 - man dlt-system
86 - man dlt-system.conf
87
88
89 Create doxygen documentation
90 ----------------------------
91 - mkdir build
92 - cd build
93 - cmake -DWITH_DOC=ON ..
94 - make 
95 - (only DLT doc - optional )make doc
96 - (only DLT-Filetransfer - optional )make doc-filetransfer
97
98 You find the documentation know as HTML, RTF or LaTex in <project-root>/build/doc