summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLutz Helwing <lutz_helwing@mentor.com>2016-02-23 17:43:19 +0100
committerLutz Helwing <lutz_helwing@mentor.com>2016-02-24 15:08:18 +0100
commitb348642c708660fcd1c7fc3137df892a68d36ba4 (patch)
tree9f91c2f1900c5c7a7ebe861987ff09d89de06f8d
parentd319ebf4d2d449d70befae0eebbdd82c19c5315f (diff)
downloadDLT-daemon-b348642c708660fcd1c7fc3137df892a68d36ba4.tar.gz
Updated man pages and READMEs
- Updated INSTALL - Updated README - Fixed ReleaseNotes.txt for asciidoc generation - Added manual for core dump handler - Updated all man pages Change-Id: I7154c14f92b3f7f6ca05c721d154a8e1aa7df1bf Signed-off-by: Lutz Helwing <lutz_helwing@mentor.com>
-rw-r--r--INSTALL106
-rw-r--r--README26
-rw-r--r--ReleaseNotes.txt2
-rw-r--r--doc/CMakeLists.txt39
-rw-r--r--doc/dlt-convert.111
-rw-r--r--doc/dlt-convert.1.txt5
-rw-r--r--doc/dlt-daemon.132
-rw-r--r--doc/dlt-daemon.1.txt29
-rw-r--r--doc/dlt-logstorage-ctrl.144
-rw-r--r--doc/dlt-receive.111
-rw-r--r--doc/dlt-receive.1.txt5
-rw-r--r--doc/dlt-system.117
-rw-r--r--doc/dlt-system.1.txt13
-rw-r--r--doc/dlt-system.conf.5258
-rw-r--r--doc/dlt-system.conf.5.txt135
-rw-r--r--doc/dlt.conf.5327
-rw-r--r--doc/dlt.conf.5.txt144
-rw-r--r--doc/dlt_book.txt50
-rw-r--r--doc/dlt_cdh.txt128
-rw-r--r--doc/dlt_kpi.txt (renamed from doc/dlt-kpi.txt)0
-rw-r--r--doc/dlt_user_manual.txt14
-rw-r--r--doc/images/dlt_core_dump_handler.pngbin0 -> 168636 bytes
22 files changed, 1140 insertions, 256 deletions
diff --git a/INSTALL b/INSTALL
index e3d4645..8e740fd 100644
--- a/INSTALL
+++ b/INSTALL
@@ -18,46 +18,46 @@ Compile options with default values
-----------------------------------
[options="header"]
|==============================================================================================
-| Option | Value | Comment
-| WITH_SYSTEMD | OFF | Set to on to run CMakeLists.txt in systemd
-| WITH_SYSTEMD_WATCHDOG | OFF | Set to ON to use the systemd watchdog in dlt-daemon
-| WITH_DLT_ADAPTOR | ON | Set ton ON to build src/adaptor binaries
-| WITH_DLT_CONSOLE | ON | Set ton ON to build src/console binaries
-| WITH_DLT_SYSTEM | ON | Set ton ON to build src/systembinaries
-| WITH_DLT_EXAMPLES | ON | Set ton ON to build src/examplesbinaries
-| WITH_DLT_TESTS | ON | Set ton ON to build src/testbinaries
-| WITH_DLT_SHM_ENABLE | OFF | Set to OFF to use FIFO as IPC from user to daemon
-| WITH_CHECK_CONFIG_FILE | OFF | Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists
-| WITH_DOC | OFF | Set to ON to build documentation target
-| WITH_TESTSCRIPTS | OFF | Set to on to run CMakeLists.txt in test scripts
-| WITH_GPROF | OFF | Set \-pg to compile flags
-| WITH_MAN | ON | Set to OFF to skip building of man pages
-| BUILD_SHARED_LIBS | ON | Set to OFF to build static libraries
-| CMAKE_INSTALL_PREFIX | /usr/local |
-| CMAKE_BUILD_TYPE | RelWithDebInfo |
+| Option | Value | Comment
+| BUILD_SHARED_LIBS | ON | Set to OFF to build static libraries
+| WITH_SYSTEMD | OFF | Set to ON to run CMakeLists.txt in systemd
+| WITH_SYSTEMD_WATCHDOG | OFF | Set to ON to use the systemd watchdog in dlt-daemon
+| WITH_SYSTEMD_JOURNAL | OFF | Set to ON to use the systemd journal in dlt-system
+| WITH_DOC | OFF | Set to ON to build documentation target
+| WITH_MAN | ON | Set to OFF to skip building of man pages
+| WITH_CHECK_CONFIG_FILE | OFF | Set to ON to create a configure file of CheckIncludeFiles and CheckFunctionExists
+| WITH_TESTSCRIPTS | OFF | Set to ON to run CMakeLists.txt in test scripts
+| WITH_GPROF | OFF | Set \-pg to compile flags
+| WITH_DLTTEST | OFF | Set to ON to build with modifications to test User-Daemon communication with corrupt messages
+| WITH_DLT_SHM_ENABLE | OFF | Set to OFF to use FIFO as IPC from user to daemon
+| WITH_DLT_ADAPTOR | ON | Set to ON to build src/adaptor binaries
+| WITH_DLT_CONSOLE | ON | Set to ON to build src/console binaries
+| WITH_DLT_EXAMPLES | ON | Set to ON to build src/examples binaries
+| WITH_DLT_SYSTEM | ON | Set to ON to build src/system binaries
+| WITH_DLT_DBUS | ON | Set to ON to build src/dbus binaries
+| WITH_DLT_TESTS | ON | Set to ON to build src/test binaries
+| WITH_DLT_CXX11_EXT | OFF | Set to ON to build C++11 extensions
+| WITH_DLT_COREDUMPHANDLER | OFF | EXPERIMENTAL! Set to ON to build src/core_dump_handler binaries. EXPERIMENTAL
+| WITH_DLT_LOGSTORAGE_CTRL_UDEV | OFF | PROTOTYPE! Set to ON to build logstorage control application with udev support
+| WITH_DLT_LOGSTORAGE_CTRL_PROP | OFF | PROTOTYPE! Set to ON to build logstorage control application with proprietary support
+| WITH_DLT_USE_IPv6 | ON | Set to ON for IPv6 support
+| WITH_DLT_KPI | ON | Set to ON to build src/kpi binaries
+| CMAKE_INSTALL_PREFIX | /usr/local |
+| CMAKE_BUILD_TYPE | RelWithDebInfo |
|==============================================================================================
-In order to change these options, you can modify this values
+In order to change these options, you can modify these values
with ccmake, do the appropriate changes in CmakeList.txt or via
the commandline for cmake
- Change a value with: cmake -D<Variable>=<Value>
-- Example: cmake -DCMAKE_INSTALL_PREFIX=/usr
+- Example: cmake -DWITH_SYSTEMD=ON -DWITH_SYSTEMD_JOURNAL=ON -DCMAKE_INSTALL_PREFIX=/usr ..
Create Man pages
----------------
-The man pages are generated with following commands.
-They are generated by default (WITH_MAN=ON).
+The man pages are generated and installed during the standard build and install.
-----
-mkdir build
-cd build
-cmake ..
-make
-sudo make install
-----
-
-You will find the man pages after installation in <CMAKE_INSTALL_PREFIX>/share/man.
+After installation they are located in <CMAKE_INSTALL_PREFIX>/share/man.
The man pages are generated with asciidoc.
If the man pages are changed the following command must be executed.
@@ -69,7 +69,7 @@ cmake -DWITH_DOC=ON ..
make doc-man
----
-The generated man pages overwrites the existing ones.
+The generated man pages overwrite the existing ones.
Create manuals documentation
----------------------------
@@ -99,16 +99,16 @@ You will find the generated documents in build/doc/DOC_DLT.
Generation of systemd unit files
--------------------------------
-DLT provides some example unit files for systemd, stored in <DLT-root>/systemd.
-In <DLT-root>/systemd/CMakeLists.txt you have to specify some values, e.g. the port for dlt-adaptor-udp.
-By default the generation of unit files with cmake is off. Please follow these steps to enable the generation:
+DLT provides cmake files to create unit files for systemd. These can be found in the systemd directory.
+In systemd/CMakeLists.txt you can modify some values, e.g. the port for dlt-adaptor-udp.
+By default the generation of unit files with cmake is disabled. Please follow these steps to enable the generation:
* Change into the root directory of DLT-daemon
* mkdir build
* cd build
* cmake -DWITH_SYSTEMD=ON ..
-You find the parsed unit files in the PROJECT_BINARY_DIR/systemd directory.
+You find the generated unit files in build/systemd. They are installed in ${CMAKE_INSTALL_PREFIX}/lib/systemd/system when make install is run.
Git configuration
-----------------
@@ -160,6 +160,40 @@ If you want to commit your changes, send them to the auto-dlt list, you can crea
git format-patch -s <remote branch>
----
-This creates a set of patches that are published via the mailing list. The patches will be discussed, merged & uploaded on the git.
+This creates a set of patches (one patch per commit) that shall be published via the mailing list. The patches will be discussed, merged & uploaded on the git.
+Please do not forget to document your changes:
+- write a manual for new components or adapt manuals to the changes you have made
+- in case you have added a new program please write a man page for it
+- if you have added something to the DLT API please remember to provide Doxygen comments
+
+Please add a header to the top of each new source file you provide:
+
+----
+/*
+ * @licence app begin@
+ * SPDX license identifier: MPL-2.0
+ *
+ * Copyright (C) 2011-2016, {COPYRIGHT_HOLDER}
+ *
+ * This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
+ *
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License (MPL), v. 2.0.
+ * If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+
+/*!
+ * \author {YOUR NAME <YOUR_EMAIL_ADDRESS>}
+ *
+ * \copyright Copyright © 2011-2016 {COPYRIGHT_HOLDER}. \n
+ * License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.
+ *
+ * \file {FILENAME}
+*/`
+----
diff --git a/README b/README
index 7d7f5ab..0fbd81e 100644
--- a/README
+++ b/README
@@ -4,9 +4,9 @@ Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
Overview
--------
-This component provides a standardised log and trace interface, based on the
+This component provides a log and trace interface, based on the
standardised protocol specified in the AUTOSAR standard 4.0 DLT.
-This component can be used by GENIVI components and other applications as
+This software can be used by GENIVI components and other applications as
logging facility providing
- the DLT shared library
@@ -14,10 +14,11 @@ logging facility providing
- the DLT daemon adaptors
- the DLT client console utilities
- the DLT test applications
+- the DLT unit tests
The DLT daemon is the central component in GENIVI, which gathers all
logs and traces from the DLT user applications. The logs and traces
-are stored optionally directly in a file in the ECU. The DLT daemon
+can optionally be directly written to a file in the ECU. The DLT daemon
forwards all logs and traces to a connected DLT client.
The DLT client can send control messages to the daemon, e.g. to set
individual log levels of applications and contexts or get the list of
@@ -29,7 +30,8 @@ Documentation
- DLT Installation: INSTALL
- DLT User Manual: doc/dlt_user_manual.txt
- DLT Cheatsheet: doc/dlt_cheatsheet.txt
-- DLT Design Specification :doc/dlt_design_specification.txt
+- DLT Design Specification: doc/dlt_design_specification.txt
+- DLT Compilation of all documentation: doc/dlt_book.txt
API Documentation
-----------------
@@ -41,8 +43,13 @@ Manpages
- dlt.conf(5)
- dlt-system(1)
- dlt-system.conf(5)
+- dlt-convert(1)
- dlt-receive(1)
-- dlt-convert(9)
+- dlt-logstorage-ctrl(1)
+- dlt-dbus (1) TBD
+- dlt-dbus.conf (5) TBD
+- dlt-cdh (1) TBD
+- dlt-kpi (1) TBD
Known issues
------------
@@ -51,12 +58,12 @@ Known issues
Software/Hardware
-----------------
-Developped and tested with Ubuntu Linux 12.04 32-bit / Intel PC
+Developed and tested with Fedora Linux 22 64-bit / Intel PC
License
-------
-Full information on the license for this software is available in the "LICENSE" file.
-Full information on the license for the cityhash code is available in "LICENSE" file in src/core_dump_handler/cityhash_c.
+Full information on the license for this software is available in the "LICENSE" file. +
+Full information on the license for the cityhash code is available in "COPYING" file in src/core_dump_handler/cityhash_c.
Source Code
-----------
@@ -75,6 +82,5 @@ https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace
Contact
-------
Alexander Wenzel <Alexander.AW.Wenzel@bmw.de> +
-Christian Muck <christian.muck@bmw.de>
-
+Lutz Helwing <Lutz_Helwing@mentor.com>
diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
index 9867948..2061d3f 100644
--- a/ReleaseNotes.txt
+++ b/ReleaseNotes.txt
@@ -10,10 +10,12 @@ Changes
-------
2.14.1
+
* MultiNode: Reconnection after connection loss
* Fix injection message handling
2.14.0
+
* Fix fork()-handler in libdlt
* Set default log-levels in dlt.conf
* Fix register context before application is registered
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 87fb339..065f8ad 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -45,7 +45,9 @@ if(WITH_DOC)
COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_book.html ${CMAKE_SOURCE_DIR}/doc/dlt_book.txt
COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_extended_network_trace.html ${CMAKE_SOURCE_DIR}/doc/dlt_extended_network_trace.txt
COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_howto_debug.html ${CMAKE_SOURCE_DIR}/doc/dlt_howto_debug.txt
- COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-kpi.html ${CMAKE_SOURCE_DIR}/doc/dlt-kpi.txt
+ COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt_offline_logstorage.html ${CMAKE_SOURCE_DIR}/doc/dlt_offline_logstorage.txt
+ COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-kpi.html ${CMAKE_SOURCE_DIR}/doc/dlt_kpi.txt
+ COMMAND asciidoc -a TOC1 -o ${CMAKE_BINARY_DIR}/doc/manuals/dlt-cdh.html ${CMAKE_SOURCE_DIR}/doc/dlt_cdh.txt
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
)
@@ -57,6 +59,7 @@ if(WITH_DOC)
COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-convert.1.txt
COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt.conf.5.txt
COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-system.conf.5.txt
+ COMMAND a2x --doctype manpage --format manpage ${CMAKE_SOURCE_DIR}/doc/dlt-logstorage-ctrl.1.txt
)
endif(WITH_DOC)
@@ -76,26 +79,30 @@ if(WITH_MAN)
set(MAN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR})
set(MAN_BUILD_DIR ${CMAKE_BINARY_DIR}/doc)
- set(MAN_SRC ${MAN_SRC_DIR}/dlt.conf.5
+ set(MAN_SRC
+ ${MAN_SRC_DIR}/dlt.conf.5
${MAN_SRC_DIR}/dlt-system.conf.5
${MAN_SRC_DIR}/dlt-convert.1
${MAN_SRC_DIR}/dlt-daemon.1
${MAN_SRC_DIR}/dlt-receive.1
- ${MAN_SRC_DIR}/dlt-system.1)
+ ${MAN_SRC_DIR}/dlt-system.1
+ ${MAN_SRC_DIR}/dlt-logstorage-ctrl.1)
set(MAN_BUILD_SRC
${MAN_BUILD_DIR}/dlt.conf.5
${MAN_BUILD_DIR}/dlt-system.conf.5
${MAN_BUILD_DIR}/dlt-convert.1
${MAN_BUILD_DIR}/dlt-daemon.1
${MAN_BUILD_DIR}/dlt-receive.1
- ${MAN_BUILD_DIR}/dlt-system.1)
+ ${MAN_BUILD_DIR}/dlt-system.1
+ ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1)
set(MAN_BUILD_GZ
${MAN_BUILD_DIR}/dlt.conf.5.gz
${MAN_BUILD_DIR}/dlt-system.conf.5.gz
${MAN_BUILD_DIR}/dlt-convert.1.gz
${MAN_BUILD_DIR}/dlt-daemon.1.gz
${MAN_BUILD_DIR}/dlt-receive.1.gz
- ${MAN_BUILD_DIR}/dlt-system.1.gz)
+ ${MAN_BUILD_DIR}/dlt-system.1.gz
+ ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz)
foreach(MAN ${MAN_SRC})
execute_process(COMMAND ${CMAKE_COMMAND} -E copy ${MAN} ${MAN_BUILD_DIR})
@@ -107,20 +114,24 @@ if(WITH_MAN)
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-convert.1 > ${MAN_BUILD_DIR}/dlt-convert.1.gz
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-daemon.1 > ${MAN_BUILD_DIR}/dlt-daemon.1.gz
COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-receive.1 > ${MAN_BUILD_DIR}/dlt-receive.1.gz
- COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-system.1 > ${MAN_BUILD_DIR}/dlt-system.1.gz)
+ COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-system.1 > ${MAN_BUILD_DIR}/dlt-system.1.gz
+ COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1 > ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz)
# If user has not set the base dir for man pages, use a default location
set(MAN_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/share/man)
- install(FILES ${MAN_BUILD_DIR}/dlt.conf.5.gz
- ${MAN_BUILD_DIR}/dlt-system.conf.5.gz
- DESTINATION ${MAN_INSTALL_DIR}/man5
+ install(FILES
+ ${MAN_BUILD_DIR}/dlt.conf.5.gz
+ ${MAN_BUILD_DIR}/dlt-system.conf.5.gz
+ DESTINATION ${MAN_INSTALL_DIR}/man5
)
- install(FILES ${MAN_BUILD_DIR}/dlt-convert.1.gz
- ${MAN_BUILD_DIR}/dlt-daemon.1.gz
- ${MAN_BUILD_DIR}/dlt-receive.1.gz
- ${MAN_BUILD_DIR}/dlt-system.1.gz
- DESTINATION ${MAN_INSTALL_DIR}/man1
+ install(FILES
+ ${MAN_BUILD_DIR}/dlt-convert.1.gz
+ ${MAN_BUILD_DIR}/dlt-daemon.1.gz
+ ${MAN_BUILD_DIR}/dlt-receive.1.gz
+ ${MAN_BUILD_DIR}/dlt-system.1.gz
+ ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz
+ DESTINATION ${MAN_INSTALL_DIR}/man1
)
endif(WITH_MAN)
diff --git a/doc/dlt-convert.1 b/doc/dlt-convert.1
index 2431d39..75f22a7 100644
--- a/doc/dlt-convert.1
+++ b/doc/dlt-convert.1
@@ -2,12 +2,12 @@
.\" Title: dlt-convert
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-CONVERT" "1" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\-CONVERT" "1" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -31,7 +31,7 @@
dlt-convert \- Convert DLT Logging files into ASCII
.SH "SYNOPSIS"
.sp
-\fBdlt\-convert\fR [\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-c] [\-b number] [\-e number] [\-w] file1 [file2] [file3]
+\fBdlt\-convert\fR [\-h] [\-a] [\-x] [\-m] [\-s] [\-o filename] [\-v] [\-c] [\-f filterfile] [\-b number] [\-e number] [\-w] file1 [file2] [file3]
.SH "DESCRIPTION"
.sp
Read DLT files, print DLT messages as ASCII and store the messages again\&. Use Ranges and Output file to cut DLT files\&. Use two files and Output file to join DLT files\&.
@@ -77,6 +77,11 @@ Verbose mode\&.
Count number of messages\&.
.RE
.PP
+\fB\-f\fR
+.RS 4
+Enable filtering of messages\&.
+.RE
+.PP
\fB\-b\fR
.RS 4
First messages to be handled\&.
diff --git a/doc/dlt-convert.1.txt b/doc/dlt-convert.1.txt
index ff2c3fa..9a09f6c 100644
--- a/doc/dlt-convert.1.txt
+++ b/doc/dlt-convert.1.txt
@@ -8,7 +8,7 @@ dlt-convert - Convert DLT Logging files into ASCII
SYNOPSIS
--------
-*dlt-convert* [-h] [-a] [-x] [-m] [-s][-o filename] [-v] [-c] [-b number] [-e number] [-w] file1 [file2] [file3]
+*dlt-convert* [-h] [-a] [-x] [-m] [-s] [-o filename] [-v] [-c] [-f filterfile] [-b number] [-e number] [-w] file1 [file2] [file3]
DESCRIPTION
-----------
@@ -42,6 +42,9 @@ OPTIONS
*-c*::
Count number of messages.
+*-f*::
+ Enable filtering of messages.
+
*-b*::
First messages to be handled.
diff --git a/doc/dlt-daemon.1 b/doc/dlt-daemon.1
index b668f9c..7fd4a34 100644
--- a/doc/dlt-daemon.1
+++ b/doc/dlt-daemon.1
@@ -2,12 +2,12 @@
.\" Title: dlt-daemon
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-DAEMON" "1" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\-DAEMON" "1" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,10 +28,10 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-dlt-daemon \- DLT daemon for logging and tracing purpose
+dlt-daemon \- Diagnostic log and trace daemon
.SH "SYNOPSIS"
.sp
-\fBdlt\-daemon\fR [\-h] [\-d] [\-c filename]
+\fBdlt\-daemon\fR [\-h] [\-d] [\-c filename] [\-t directory] [\-p port]
.SH "DESCRIPTION"
.sp
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\&.
@@ -51,6 +51,16 @@ Daemonize, needed in System V init systems\&.
.RS 4
Load an alternative configuration file\&. By default the configuration file /etc/dlt\&.conf is loaded\&.
.RE
+.PP
+\fB\-t\fR
+.RS 4
+Directory for local fifo and user\-pipes (Default: /tmp) (Applications wanting to connect to a daemon using a custom directory need to be started with the environment variable DLT_PIPE_DIR set appropriately)
+.RE
+.PP
+\fB\-p\fR
+.RS 4
+Port to monitor for incoming requests (Default: 3490) (Applications wanting to connect to a daemon using a custom port need to be started with the environment variable DLT_DAEMON_TCP_PORT set appropriately)
+.RE
.SH "EXAMPLES"
.PP
Start DLT daemon in background mode
@@ -62,6 +72,16 @@ Start DLT daemon with own configuration
.RS 4
\fBdlt\-daemon \-c ~/my\-dlt\-configuration\&.cfg\fR
.RE
+.PP
+Start DLT daemon with custom pipes directory
+.RS 4
+\fBdlt\-daemon \-t ~/dlt_pipes\fR
+.RE
+.PP
+Start DLT daemon listening on custom port 3500
+.RS 4
+\fBdlt\-daemon \-p 3500\fR
+.RE
.SH "EXIT STATUS"
.sp
Non zero is returned in case of failure\&.
@@ -70,10 +90,10 @@ Non zero is returned in case of failure\&.
Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de)
.SH "COPYRIGHT"
.sp
-Copyright \(co 2015 BMW AG\&. License MPL\-2\&.0: Mozilla Public License version 2\&.0 http://mozilla\&.org/MPL/2\&.0/\&.
+Copyright \(co 2016 BMW AG\&. License MPL\-2\&.0: Mozilla Public License version 2\&.0 http://mozilla\&.org/MPL/2\&.0/\&.
.SH "RESOURCES"
.sp
Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace
.SH "SEE ALSO"
.sp
-dlt\&.conf(5) dlt\-system(1)
+dlt\&.conf(5), dlt\-system(1)
diff --git a/doc/dlt-daemon.1.txt b/doc/dlt-daemon.1.txt
index 5b3d306..294f522 100644
--- a/doc/dlt-daemon.1.txt
+++ b/doc/dlt-daemon.1.txt
@@ -4,11 +4,11 @@ DLT-DAEMON(1)
NAME
----
-dlt-daemon - DLT daemon for logging and tracing purpose
+dlt-daemon - Diagnostic log and trace daemon
SYNOPSIS
--------
-*dlt-daemon* [-h] [-d] [-c filename]
+*dlt-daemon* [-h] [-d] [-c filename] [-t directory] [-p port]
DESCRIPTION
-----------
@@ -29,6 +29,18 @@ OPTIONS
Load an alternative configuration file. By default the configuration
file /etc/dlt.conf is loaded.
+*-t*::
+ Directory for local fifo and user-pipes (Default: /tmp)
+ (Applications wanting to connect to a daemon using a
+ custom directory need to be started with the environment
+ variable DLT_PIPE_DIR set appropriately)
+
+*-p*::
+ Port to monitor for incoming requests (Default: 3490)
+ (Applications wanting to connect to a daemon using a custom
+ port need to be started with the environment variable
+ DLT_DAEMON_TCP_PORT set appropriately)
+
EXAMPLES
--------
Start DLT daemon in background mode::
@@ -37,6 +49,12 @@ Start DLT daemon in background mode::
Start DLT daemon with own configuration::
*dlt-daemon -c ~/my-dlt-configuration.cfg*
+Start DLT daemon with custom pipes directory::
+*dlt-daemon -t ~/dlt_pipes*
+
+Start DLT daemon listening on custom port 3500::
+*dlt-daemon -p 3500*
+
EXIT STATUS
-----------
Non zero is returned in case of failure.
@@ -47,7 +65,7 @@ Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
COPYRIGHT
---------
-Copyright (C) 2015 BMW AG. License MPL-2.0: Mozilla Public License version 2.0 <http://mozilla.org/MPL/2.0/>.
+Copyright (C) 2016 BMW AG. License MPL-2.0: Mozilla Public License version 2.0 <http://mozilla.org/MPL/2.0/>.
RESOURCES
---------
@@ -56,8 +74,5 @@ Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-an
SEE ALSO
--------
-dlt.conf(5) +
-dlt-system(1)
-
-
+dlt.conf(5), dlt-system(1)
diff --git a/doc/dlt-logstorage-ctrl.1 b/doc/dlt-logstorage-ctrl.1
index 1ed3c5c..d35a6ea 100644
--- a/doc/dlt-logstorage-ctrl.1
+++ b/doc/dlt-logstorage-ctrl.1
@@ -1,12 +1,13 @@
'\" t
.\" Title: dlt-logstorage-ctrl
.\" Author: [see the "AUTHOR" section]
-.\" Date: 27/05/2015
+.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-LOGSTORAGE\-CTRL" "1" "27/05/2015" "\ \&" "\ \&"
+.TH "DLT\-LOGSTORAGE\-CTR" "1" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -33,7 +34,7 @@ dlt-logstorage-ctrl \- Trigger DLT Daemon to start/stop using an offline logstor
\fBdlt\-logstorage\-ctrl\fR [\-h] [\-c ctype] [\-d dev] [\-e ecu] [\-t timeout]
.SH "DESCRIPTION"
.sp
-Send a trigger to DLT Daemon to connect/disconnect a certain offline logstorage device.\&
+Send a trigger to DLT Daemon to connect/disconnect a certain offline logstorage device
.SH "OPTIONS"
.PP
\fB\-h\fR
@@ -48,38 +49,49 @@ Specify connection type: connect = 1, disconnect = 0\&.
.PP
\fB\-d\fR
.RS 4
-Specify the device [1 .. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES]. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES is defined in dlt_offline_logstorage.h\&
+Specify device [1 \&.\&. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES]\&.
.RE
.PP
\fB\-e\fR
.RS 4
-Specify the ECU ID. Default is: ECU1.\&
+Specify the ECU ID\&. Default is: ECU1\&.
.RE
.PP
\fB\-t\fR
.RS 4
-Specify connection timeout. Default is 10s.\&
+Specify connection timeout\&. Default is: 10s\&.
.RE
.SH "EXAMPLES"
-.PP
-Activate the offline logstorage device mounted on /tmp/dltlogs/dltlogsdev1.
+.sp
+Activate the offline logstorage device mounted on /tmp/dltlogs/dltlogsdev1
+.sp
+.if n \{\
.RS 4
-
-\fBdlt\-logstorage\-ctrl \-c 1 \-d 1\fR
+.\}
+.nf
+dlt\-logstorage\-ctrl \-c 1 \-d 1
+.fi
+.if n \{\
.RE
-.PP
+.\}
+.sp
Deactivate the offline logstorage device mounted on /tmp/dltlogs/dltlogsdev2
+.sp
+.if n \{\
.RS 4
-
-\fBdlt\-logstorage\-ctrl \-c 0 \-d 2\fR
+.\}
+.nf
+dlt\-logstorage\-ctrl \-c 0 \-d 2
+.fi
+.if n \{\
.RE
+.\}
.SH "EXIT STATUS"
.sp
-Non zero is returned in case of failure. On success, 0 is returned.\&
+Non zero is returned in case of failure\&.
.SH "AUTHOR"
.sp
-Christoph Lipka (clipka (at) jp\&.adit\-jv\&.com)
-Syed Hameed (shameed (at) jp\&.adit\-jv\&.com)
+Christoph Lipka (clipka (at) jp\&.adit\-jv\&.com) Syed Hameed (shameed (at) jp\&.adit\-jv\&.com)
.SH "RESOURCES"
.sp
Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1
index 5f1665b..a8c105e 100644
--- a/doc/dlt-receive.1
+++ b/doc/dlt-receive.1
@@ -2,12 +2,12 @@
.\" Title: dlt-receive
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-RECEIVE" "1" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\-RECEIVE" "1" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -31,7 +31,7 @@
dlt-receive \- Console based client for DLT Logging
.SH "SYNOPSIS"
.sp
-\fBdlt\-receive\fR [\-h] [\-a] [\-x] [\-m] [\-s] [\-o filename] [\-c limit] [\-v] [\-y] [\-b baudrate] [\-e ecuid] hostname/serial_device_name
+\fBdlt\-receive\fR [\-h] [\-a] [\-x] [\-m] [\-s] [\-o filename] [\-c limit] [\-v] [\-y] [\-b baudrate] [\-e ecuid] [\-f filterfile] hostname/serial_device_name
.SH "DESCRIPTION"
.sp
Receive DLT messages from DLT daemon and print or store the messages\&.
@@ -91,6 +91,11 @@ Serial device baudrate (Default: 115200)\&.
.RS 4
Set ECU ID (Default: RECV)\&.
.RE
+.PP
+\fB\-f\fR
+.RS 4
+Enable filtering of messages\&.
+.RE
.SH "EXAMPLES"
.PP
Print received message headers received from a dlt\-daemon running on localhost
diff --git a/doc/dlt-receive.1.txt b/doc/dlt-receive.1.txt
index 25a876d..30513aa 100644
--- a/doc/dlt-receive.1.txt
+++ b/doc/dlt-receive.1.txt
@@ -8,7 +8,7 @@ dlt-receive - Console based client for DLT Logging
SYNOPSIS
--------
-*dlt-receive* [-h] [-a] [-x] [-m] [-s] [-o filename] [-c limit] [-v] [-y] [-b baudrate] [-e ecuid] hostname/serial_device_name
+*dlt-receive* [-h] [-a] [-x] [-m] [-s] [-o filename] [-c limit] [-v] [-y] [-b baudrate] [-e ecuid] [-f filterfile] hostname/serial_device_name
DESCRIPTION
-----------
@@ -49,6 +49,9 @@ Serial device baudrate (Default: 115200).
*-e*::
Set ECU ID (Default: RECV).
+*-f*::
+ Enable filtering of messages.
+
EXAMPLES
--------
Print received message headers received from a dlt-daemon running on localhost::
diff --git a/doc/dlt-system.1 b/doc/dlt-system.1
index 951f366..1ee692d 100644
--- a/doc/dlt-system.1
+++ b/doc/dlt-system.1
@@ -2,12 +2,12 @@
.\" Title: dlt-system
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-SYSTEM" "1" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\-SYSTEM" "1" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -31,7 +31,7 @@
dlt-system \- DLT system logging process
.SH "SYNOPSIS"
.sp
-\fBdlt\-system\fR [\-h] [\-c filename]
+\fBdlt\-system\fR [\-h] [\-d] [\-c filename]
.SH "DESCRIPTION"
.sp
The DLT system logging process is the central application, which logs system information from the platform\&. It provides the features filetransfer, syslog adapater, logging of any kind of files and procfilesystem logger\&. The individual features can be enabled and disabled in the configuration file\&.
@@ -44,15 +44,20 @@ dlt\-system loads by default the configuration file /etc/dlt\-system\&.conf\&. S
Display a short help text\&.
.RE
.PP
+\fB\-d\fR
+.RS 4
+Daemonize, needed in System V init systems\&.
+.RE
+.PP
\fB\-c\fR
.RS 4
Load an alternative configuration file\&. By default the configuration file /etc/dlt\&.conf is loaded\&.
.RE
.SH "EXAMPLES"
.PP
-Start DLT system with own configuration
+Start DLT system with custom configuration
.RS 4
-dlt\-system \-c ~/my\-configuration\&.cfg \-v
+\fBdlt\-system \-c ~/my\-configuration\&.cfg\fR
.RE
.SH "EXIT STATUS"
.sp
@@ -68,4 +73,4 @@ Copyright \(co 2015 BMW AG\&. License MPL\-2\&.0: Mozilla Public License version
Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace
.SH "SEE ALSO"
.sp
-dlt\-system\&.conf(5) dlt\-daemon(1)
+dlt\-system\&.conf(5), dlt\-daemon(1)
diff --git a/doc/dlt-system.1.txt b/doc/dlt-system.1.txt
index 8ba573c..d68d696 100644
--- a/doc/dlt-system.1.txt
+++ b/doc/dlt-system.1.txt
@@ -8,7 +8,7 @@ dlt-system - DLT system logging process
SYNOPSIS
--------
-*dlt-system* [-h] [-c filename]
+*dlt-system* [-h] [-d] [-c filename]
DESCRIPTION
-----------
@@ -26,14 +26,17 @@ OPTIONS
*-h*::
Display a short help text.
+*-d*::
+ Daemonize, needed in System V init systems.
+
*-c*::
Load an alternative configuration file. By default the configuration
file /etc/dlt.conf is loaded.
EXAMPLES
--------
-Start DLT system with own configuration::
- dlt-system -c ~/my-configuration.cfg -v
+Start DLT system with custom configuration::
+*dlt-system -c ~/my-configuration.cfg*
EXIT STATUS
-----------
@@ -54,7 +57,5 @@ Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-an
SEE ALSO
--------
-dlt-system.conf(5) +
-dlt-daemon(1)
-
+dlt-system.conf(5), dlt-daemon(1)
diff --git a/doc/dlt-system.conf.5 b/doc/dlt-system.conf.5
index 91442ec..500c5ef 100644
--- a/doc/dlt-system.conf.5
+++ b/doc/dlt-system.conf.5
@@ -2,12 +2,12 @@
.\" Title: dlt-system.conf
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\-SYSTEM\&.CONF" "5" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\-SYSTEM\&.CONF" "5" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -52,6 +52,22 @@ Default: SYS
.RE
.\}
.RE
+.SH "SHELL OPTIONS"
+.PP
+\fBShellEnable\fR
+.RS 4
+Enable the Shell for command line injections\&.+ Be careful when you enable this feature\&. The user can send any kind of shell commands\&. The commands are executed with the rights of the dlt\-system process\&. Dlt\-system is started by default as user genivi\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
.SH "SYSLOG ADAPTER OPTIONS"
.PP
\fBSyslogEnable\fR
@@ -62,7 +78,7 @@ If this option is set to 1, the syslog adapter feature is enabled\&.
.RS 4
.\}
.nf
-Default: 0\&.
+Default: 0
.fi
.if n \{\
.RE
@@ -98,146 +114,248 @@ Default: 47111
.RE
.\}
.RE
-.SH "FILETRANSFER OPTIONS"
+.SH "SYSTEMD JOURNAL ADAPTER OPTIONS"
.PP
-\fBFiletransferEnable\fR
-.RS 4
-If this option is set to 1, the filetransfer feature is enabled\&.
+\fBJournalEnable\fR
+.RS 4
+Enable the Systemd Journal Adapter\&.
+
+This feature is only available, when dlt is compiled with the option "WITH_SYSTEMD_JOURNAL"\&.
+
+Dlt\-system is started by default as user genivi, see dlt\-system\&.service file\&. The user genivi must be added to one of the groups
+\fIadm\fR,
+\fIwheel\fR
+or
+\fIsystemd\-journal\fR
+to have access to all journal entries\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 0\&.
+Default: 0
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferContextId\fR
+\fBJournalContextId\fR
.RS 4
-The Context Id of the filetransfer\&.
+The Context Id of the journal adapter\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: File\&.
+Default: JOUR
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferTimeStartup\fR
+\fBJournalCurrentBoot\fR
.RS 4
-Time in seconds after startup of dlt\-system when first file is transfered\&.
+Show only log entries of current boot and follow\&.
+
+If JournalCurrentBoot and JournalFollow are not set all persistent journal entries will be logged
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 30\&.
+Default: 1
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferTimeoutBetweenLogs\fR
+\fBJournalFollow\fR
.RS 4
-Time in ms seconds to wait between two file transfer logs of a single file to DLT\&.
+Show only the last 10 entries and follow\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 10\&.
+Default: 0
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferTempDir\fR
+\fBJournalMapLogLevels\fR
.RS 4
-Temporary directory to use\&. File transfer will move a file to this directory while it is being compressed and sent\&.
+Map journal log levels to DLT log levels\&.
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+0 Emergency DLT_LOG_FATAL
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+1 Alert DLT_LOG_FATAL
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+2 Critical DLT_LOG_FATAL
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+3 Error DLT_LOG_ERROR
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+4 Warning DLT_LOG_WARN
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+5 Notice DLT_LOG_INFO
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+6 Informational DLT_LOG_INFO
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+7 Debug DLT_LOG_DEBUG
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: /tmp\&.
+Default: 1
.fi
.if n \{\
.RE
.\}
.RE
+.RE
+.SH "FILETRANSFER OPTIONS"
.PP
-\fBFiletransferDirectory\fR
+\fBFiletransferEnable\fR
.RS 4
-You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values\&.\&.
+Enable the Filetransfer feature\&.
+
+0 = disabled, 1 = enabled
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: /var/dlt/ft1\&.
+Default: 0
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferCompression\fR
+\fBFiletransferContextId\fR
.RS 4
-You can define multiple file transfer directories\&. Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values\&.\&.
+The Context Id of the filetransfer\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 0\&.
+Default: FILE
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferCompressionLevel\fR
+\fBFiletransferTimeStartup\fR
.RS 4
-You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values\&.\&.
+Time in seconds after startup of dlt\-system when first file is transfered\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 5\&.
+Default: 0
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferTimeStartup\fR
+\fBFiletransferTimeDelay\fR
.RS 4
-This value defines the amount of time in seconds after start of dlt\-system, when dlt\-system starts to send the first file\&.
+Time in seconds to wait between deletion of transferred file and start of next file transfer\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 30
+Default: 10
.fi
.if n \{\
.RE
.\}
.RE
.PP
-\fBFiletransferTimeDelay\fR
+\fBFiletransferTimeoutBetweenLogs\fR
.RS 4
-This value defines the amount of time after which a sent file is deleted and the next file is strated to be transmitted\&.
+Time in seconds to wait between two file transfer logs of a single file to DLT\&.
.sp
.if n \{\
.RS 4
@@ -250,15 +368,35 @@ Default: 10
.\}
.RE
.PP
-\fBFiletransferTimeoutBetweenLogs\fR
+\fBFiletransferDirectory\fR
.RS 4
-This value defines the amount of time to wait between two file transfer logs of a single file\&.
+You can define multiple file transfer directories\&. Define the directory to watch, whether to compress the file with zlib and the zlib compression level\&. For parsing purposes, FiletransferCompressionLevel must be the last one of three values\&.
+.RE
+.PP
+\fBFiletransferCompression\fR
+.RS 4
+See FiletransferDirectory option for explanation\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 10
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBFiletransferCompressionLevel\fR
+.RS 4
+See FiletransferDirectory option for explanation\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 5
.fi
.if n \{\
.RE
@@ -274,7 +412,7 @@ If this option is set to 1, the log files feature is enabled\&.
.RS 4
.\}
.nf
-Default: 0\&.
+Default: 0
.fi
.if n \{\
.RE
@@ -288,7 +426,9 @@ This value sets the full filename path to the file, which should be logged\&.
.PP
\fBLogFileMode\fR
.RS 4
-This value the defines in which operation mode this file is logged\&. Possible values are: 0 = off, 1 = startup only, 2 = regular\&. In mode 1 the file is only logged once when dlt\-system is started\&. In mode 2 the file is logged regularly every time LogFileTimeDelay timer elapses\&.
+This value defines in which operation mode the file is logged\&. In mode 1 the file is only logged once when dlt\-system is started\&. In mode 2 the file is logged regularly every time LogFileTimeDelay timer elapses\&.
+
+0 = off, 1 = startup only, 2 = regular
.RE
.PP
\fBLogFileTimeDelay\fR
@@ -304,13 +444,15 @@ This value defines the context id, which is used for logging the file\&.
.PP
\fBLogProcessesEnable\fR
.RS 4
-If this option is set to 1, the log processes feature is enabled\&.
+Enable the logging of processes\&.
+
+0 = disabled, 1 = enabled
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: 0\&.
+Default: 0
.fi
.if n \{\
.RE
@@ -320,6 +462,16 @@ Default: 0\&.
\fBLogProcessesContextId\fR
.RS 4
This value defines the context id, which is used for logging processes files\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: PROC
+.fi
+.if n \{\
+.RE
+.\}
.RE
.PP
\fBLogProcessName\fR
@@ -334,12 +486,34 @@ This value sets the relative filename path to the file, which should be logged\&
.PP
\fBLogProcessMode\fR
.RS 4
-This value the defines in which operation mode this process file is logged\&. Possible values are: 0 = off, 1 = startup only, 2 = regular\&. In mode 1 the file is only logged once when dlt\-system is started\&. In mode 2 the file is logged regularly every time LogFileTimeDelay timer elapses\&.
+This value the defines in which operation mode this process file is logged\&. In mode 1 the file is only logged once when dlt\-system is started\&. In mode 2 the file is logged regularly every time LogFileTimeDelay timer elapses\&.
+
+0 = off, 1 = startup only, 2 = regular\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
.RE
.PP
\fBLogProcessTimeDelay\fR
.RS 4
This value is used in mode 3 and defines the number of seconds, after which the defined procfilesystem file is logged\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
.RE
.SH "AUTHOR"
.sp
diff --git a/doc/dlt-system.conf.5.txt b/doc/dlt-system.conf.5.txt
index 0b73481..bb177ce 100644
--- a/doc/dlt-system.conf.5.txt
+++ b/doc/dlt-system.conf.5.txt
@@ -29,13 +29,24 @@ GENERAL OPTIONS
Default: SYS
+SHELL OPTIONS
+-------------
+
+*ShellEnable*::
+ Enable the Shell for command line injections. +
+ Be careful when you enable this feature. The user can send any kind of
+ shell commands. The commands are executed with the rights of the
+ dlt-system process. Dlt-system is started by default as user genivi.
+
+ Default: 0
+
SYSLOG ADAPTER OPTIONS
----------------------
*SyslogEnable*::
If this option is set to 1, the syslog adapter feature is enabled.
- Default: 0.
+ Default: 0
*SyslogContextId*::
This value defines context id of the syslog adapter.
@@ -48,87 +59,110 @@ SYSLOG ADAPTER OPTIONS
Default: 47111
-FILETRANSFER OPTIONS
---------------------
+SYSTEMD JOURNAL ADAPTER OPTIONS
+-------------------------------
-*FiletransferEnable*::
- If this option is set to 1, the filetransfer feature is enabled.
+*JournalEnable*::
+ Enable the Systemd Journal Adapter. +
+ This feature is only available, when dlt is compiled with
+ the option "WITH_SYSTEMD_JOURNAL". +
+ Dlt-system is started by default as user genivi, see dlt-system.service file.
+ The user genivi must be added to one of the groups 'adm', 'wheel' or
+ 'systemd-journal' to have access to all journal entries.
- Default: 0.
+ Default: 0
-*FiletransferContextId*::
- The Context Id of the filetransfer.
+*JournalContextId*::
+ The Context Id of the journal adapter.
- Default: File.
+ Default: JOUR
-*FiletransferTimeStartup*::
- Time in seconds after startup of dlt-system when first file is transfered.
+*JournalCurrentBoot*::
+ Show only log entries of current boot and follow. +
+ If JournalCurrentBoot and JournalFollow are not set all
+ persistent journal entries will be logged
- Default: 30.
+ Default: 1
-*FiletransferTimeoutBetweenLogs*::
- Time in ms seconds to wait between two file transfer logs of a single file to DLT.
+*JournalFollow*::
+ Show only the last 10 entries and follow.
- Default: 10.
+ Default: 0
-*FiletransferTempDir*::
- Temporary directory to use. File transfer will move a file to this directory while it is being compressed and sent.
+*JournalMapLogLevels*::
+ Map journal log levels to DLT log levels.
+ - 0 Emergency DLT_LOG_FATAL
+ - 1 Alert DLT_LOG_FATAL
+ - 2 Critical DLT_LOG_FATAL
+ - 3 Error DLT_LOG_ERROR
+ - 4 Warning DLT_LOG_WARN
+ - 5 Notice DLT_LOG_INFO
+ - 6 Informational DLT_LOG_INFO
+ - 7 Debug DLT_LOG_DEBUG
- Default: /tmp.
+ Default: 1
-*FiletransferDirectory*::
- You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib
- and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
- Default: /var/dlt/ft1.
+FILETRANSFER OPTIONS
+--------------------
-*FiletransferCompression*::
- You can define multiple file transfer directories. Define the directory to watch, whether to compress the file with zlib
- and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
+*FiletransferEnable*::
+ Enable the Filetransfer feature. +
+ 0 = disabled, 1 = enabled
- Default: 0.
+ Default: 0
-*FiletransferCompressionLevel*::
- You can define multiple file transfer directories Define the directory to watch, whether to compress the file with zlib
- and the zlib compression level For parsing purposes, FiletransferCompressionLevel must be the last one of three values..
+*FiletransferContextId*::
+ The Context Id of the filetransfer.
- Default: 5.
+ Default: FILE
*FiletransferTimeStartup*::
- This value defines the amount of time in seconds after start of
- dlt-system, when dlt-system starts to send the first file.
+ Time in seconds after startup of dlt-system when first file is transfered.
- Default: 30
+ Default: 0
*FiletransferTimeDelay*::
- This value defines the amount of time after which a sent file is deleted
- and the next file is strated to be transmitted.
+ Time in seconds to wait between deletion of transferred file and start of next file transfer.
Default: 10
*FiletransferTimeoutBetweenLogs*::
- This value defines the amount of time to wait between two file transfer
- logs of a single file.
+ Time in seconds to wait between two file transfer logs of a single file to DLT.
Default: 10
+*FiletransferDirectory*::
+ You can define multiple file transfer directories. Define the directory to watch, whether to compress the file with zlib
+ and the zlib compression level. For parsing purposes, FiletransferCompressionLevel must be the last one of three values.
+
+*FiletransferCompression*::
+ See FiletransferDirectory option for explanation.
+
+ Default: 0
+
+*FiletransferCompressionLevel*::
+ See FiletransferDirectory option for explanation.
+
+ Default: 5
+
LOG FILES OPTIONS
-----------------
*LogFileEnable*::
If this option is set to 1, the log files feature is enabled.
- Default: 0.
+ Default: 0
*LogFileFilename*::
This value sets the full filename path to the file, which should be logged.
*LogFileMode*::
- This value the defines in which operation mode this file is logged.
- Possible values are: 0 = off, 1 = startup only, 2 = regular.
+ This value defines in which operation mode the file is logged.
In mode 1 the file is only logged once when dlt-system is started.
In mode 2 the file is logged regularly every time LogFileTimeDelay timer
- elapses.
+ elapses. +
+ 0 = off, 1 = startup only, 2 = regular
*LogFileTimeDelay*::
This value is used in mode 3 and defines the number of seconds, after
@@ -141,14 +175,17 @@ LOG PROCESSES OPTIONS
---------------------
*LogProcessesEnable*::
- If this option is set to 1, the log processes feature is enabled.
+ Enable the logging of processes. +
+ 0 = disabled, 1 = enabled
- Default: 0.
+ Default: 0
*LogProcessesContextId*::
This value defines the context id, which is used for logging processes
files.
+ Default: PROC
+
*LogProcessName*::
This value defines the name of the process to be logged, as used in the
file stat of each process.
@@ -161,15 +198,20 @@ LOG PROCESSES OPTIONS
*LogProcessMode*::
This value the defines in which operation mode this process file is
- logged. Possible values are: 0 = off, 1 = startup only, 2 = regular.
+ logged.
In mode 1 the file is only logged once when dlt-system is started.
In mode 2 the file is logged regularly every time LogFileTimeDelay timer
- elapses.
+ elapses. +
+ 0 = off, 1 = startup only, 2 = regular.
+
+ Default: 0
*LogProcessTimeDelay*::
This value is used in mode 3 and defines the number of seconds, after
which the defined procfilesystem file is logged.
+ Default: 0
+
AUTHOR
------
Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
@@ -181,6 +223,5 @@ Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-an
SEE ALSO
--------
-dlt-system(1) +
-dlt-daemon(1)
+dlt-system(1), dlt-daemon(1)
diff --git a/doc/dlt.conf.5 b/doc/dlt.conf.5
index 41b78fe..2768992 100644
--- a/doc/dlt.conf.5
+++ b/doc/dlt.conf.5
@@ -2,12 +2,12 @@
.\" Title: dlt.conf
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 05/12/2015
+.\" Date: 02/23/2016
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "DLT\&.CONF" "5" "05/12/2015" "\ \&" "\ \&"
+.TH "DLT\&.CONF" "5" "02/23/2016" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -31,11 +31,11 @@
dlt.conf \- DLT daemon configuration file
.SH "DESCRIPTION"
.sp
-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\&.
+The DLT daemon is the central application which gathers logs and traces from different applications, stores them temporarily or permanently and transfers them to a DLT client application, which could run directly on the GENIVI system or more likely on some external tester device\&.
.sp
-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\&.
+The configuration file dlt\&.conf allows to configure the different runtime behaviour of the dlt\-daemon\&. It is loaded during startup of dlt\-daemon\&.
.sp
-dlt\-daemon loads by default the configuration file /etc/dlt\&.conf\&. An alternative configuration file can be loaded with the option \-c\&.
+By default dlt\-daemon loads the file /etc/dlt\&.conf\&. An alternative configuration file can be loaded with the option \-c\&.
.SH "GENERAL OPTIONS"
.PP
\fBDaemonize\fR
@@ -113,6 +113,21 @@ Default: ECU1
.\}
.RE
.PP
+\fBGatewayMode\fR
+.RS 4
+If set to 1 gateway mode is enabled which means this ECU serves as gateway to forward messages from others\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
\fBSharedMemorySize\fR
.RS 4
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\&.
@@ -142,6 +157,182 @@ Default: /tmp
.RE
.\}
.RE
+.PP
+\fBLoggingMode\fR
+.RS 4
+The logging console for internal logging of dlt\-daemon\&.
+
+0 = log to stdout, 1 = log to syslog, 2 = log to file (see LoggingFilename)
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBLoggingLevel\fR
+.RS 4
+The internal log level, up to which logs are written\&.
+
+LOG_EMERG = 0, LOG_ALERT = 1, LOG_CRIT = 2, LOG_ERR = 3, LOG_WARNING = 4, LOG_NOTICE = 5, LOG_INFO = 6, LOG_DEBUG = 7
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 6
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBLoggingFilename\fR
+.RS 4
+If LoggingMode is set to 2 logs are written to the file path given here\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: /tmp/dlt\&.log
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBTimeOutOnSend\fR
+.RS 4
+Socket timeout in seconds for sending to clients\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 4
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBRingbufferMinSize\fR
+.RS 4
+The minimum size of the Ringbuffer, used for storing temporary DLT messages, until client is connected\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 500000
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBRingbufferMaxSize\fR
+.RS 4
+The max size of the Ringbuffer, used for storing temporary DLT messages, until client is connected\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 10000000
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBRingbufferStepSize\fR
+.RS 4
+The step size the Ringbuffer is increased, used for storing temporary DLT messages, until client is connected\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 500000
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBContextLogLevel\fR
+.RS 4
+Initial log\-level that is sent when an application registers\&.
+
+DLT_LOG_OFF = 0, DLT_LOG_FATAL = 1, DLT_LOG_ERROR = 2, DLT_LOG_WARN = 3, DLT_LOG_INFO = 4, DLT_LOG_DEBUG = 5, DLT_LOG_VERBOSE = 6
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 4
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBContextTraceStatus\fR
+.RS 4
+Initial trace\-status that is sent when an application registers\&.
+
+DLT_TRACE_STATUS_OFF = 0, DLT_TRACE_STATUS_ON = 1
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBForceContextLogLevelAndTraceStatus\fR
+.RS 4
+Force log level and trace status of context to not exceed "ContextLogLevel" and "ContextTraceStatus"\&.
+
+If set to 1 (ON) whenever a context registers or changes the log\-level it has to be lower or equal to ContextLogLevel\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "CONTROL APPLICATION OPTIONS"
+.PP
+\fBControlSocketPath\fR
+.RS 4
+Path to control socket\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: /tmp/dlt\-ctrl\&.sock
+.fi
+.if n \{\
+.RE
+.\}
+.RE
.SH "OFFLINE TRACE OPTIONS"
.PP
\fBOfflineTraceDirectory\fR
@@ -188,6 +379,23 @@ Default: 4000000
.RE
.\}
.RE
+.PP
+\fBOfflineTraceFileNameTimestampBased\fR
+.RS 4
+Filename timestamp based or index based\&.
+
+1 = timestamp based, 0 = index based
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
.SH "LOCAL CONSOLE OUTPUT OPTIONS"
.PP
\fBPrintASCII\fR
@@ -286,11 +494,13 @@ Default: Function is disabled
.RS 4
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\&.
.RE
-.SH "ECU SOFTWARE VERSION INFO"
+.SH "ECU SOFTWARE VERSION OPTIONS"
.PP
\fBSendECUSoftwareVersion\fR
.RS 4
-Send periodic ECU version info\&. 0=disabled, 1=enabled\&.
+Periodically send ECU version info\&.
+
+0 = disabled, 1 = enabled
.sp
.if n \{\
.RS 4
@@ -307,34 +517,117 @@ Default: 0
.RS 4
Absolute path to file storing version information \- if disabled the DLT version will be send\&.
.RE
-
-.SH "Offline Logstorage OPTIONS"
+.SH "TIMEZONE INFO OPTIONS"
+.PP
+\fBSendTimezone\fR
+.RS 4
+Periodically send timezone info\&. 0 = disabled, 1 = enabled
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "OFFLINE LOGSTORAGE OPTIONS"
.PP
\fBOfflineLogstorageMaxDevices\fR
.RS 4
-Maximum devices to be used as offline logstorage devices [1 .. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES]\&.
+Maximum devices to be used as offline logstorage devices\&.
+
+0 = disabled, 1 \&.\&. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 0 (Functionality is disabled)
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBOfflineLogstorageDirPath\fR
+.RS 4
+Path to store DLT offline log storage messages\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-Default: Off, zero logstorage devices are supported.
+Default: off
.fi
.if n \{\
.RE
.\}
.RE
+.PP
+\fBOfflineLogstorageTimestamp\fR
+.RS 4
+Appends timestamp in log file name\&.
-.SH "EXAMPLES"
+0 = disabled, 1 = enabled
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
.PP
-Start DLT daemon in background mode
+\fBOfflineLogstorageDelimiter\fR
.RS 4
-\fBdlt\-daemon \-d\fR
+Appends delimiter in log file name, only punctuation characters allowed\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: _
+.fi
+.if n \{\
+.RE
+.\}
.RE
.PP
-Start DLT daemon with own configuration
+\fBOfflineLogstorageMaxCounter\fR
.RS 4
-\fBdlt\-daemon \-c ~/my\-dlt\-configuration\&.cfg\fR
+Wrap around value for log file count in file name\&.
+
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: UINT_MAX
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.PP
+\fBOfflineLogstorageCacheSize\fR
+.RS 4
+Maximal used memory for Logstorage Cache in KB\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Default: 30000 KB
+.fi
+.if n \{\
+.RE
+.\}
.RE
.SH "AUTHOR"
.sp
@@ -344,4 +637,4 @@ Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de)
Main web site: http://projects\&.genivi\&.org/diagnostic\-log\-trace Mailinglist: https://lists\&.genivi\&.org/mailman/listinfo/genivi\-diagnostic\-log\-and\-trace
.SH "SEE ALSO"
.sp
-dlt\-daemon(1) dlt\-system(1)
+dlt\-daemon(1), dlt\-system(1)
diff --git a/doc/dlt.conf.5.txt b/doc/dlt.conf.5.txt
index ebc3a69..62a69e4 100644
--- a/doc/dlt.conf.5.txt
+++ b/doc/dlt.conf.5.txt
@@ -8,16 +8,15 @@ dlt.conf - DLT daemon configuration file
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.
+The DLT daemon is the central application which gathers logs and traces
+from different applications, stores them temporarily or permanently and
+transfers them to a DLT client application, which could run directly on the
+GENIVI system or more likely on some external tester device.
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.
+runtime behaviour of the dlt-daemon. It is loaded during startup of dlt-daemon.
-dlt-daemon loads by default the configuration file /etc/dlt.conf. An
+By default dlt-daemon loads the file /etc/dlt.conf. An
alternative configuration file can be loaded with the option -c.
GENERAL OPTIONS
@@ -54,6 +53,12 @@ GENERAL OPTIONS
Default: ECU1
+*GatewayMode*::
+ If set to 1 gateway mode is enabled which means this ECU serves as gateway
+ to forward messages from others.
+
+ Default: 0
+
*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
@@ -69,6 +74,69 @@ GENERAL OPTIONS
Default: /tmp
+*LoggingMode*::
+ The logging console for internal logging of dlt-daemon. +
+ 0 = log to stdout, 1 = log to syslog, 2 = log to file (see LoggingFilename)
+
+ Default: 0
+
+*LoggingLevel*::
+ The internal log level, up to which logs are written. +
+ LOG_EMERG = 0, LOG_ALERT = 1, LOG_CRIT = 2, LOG_ERR = 3, LOG_WARNING = 4, LOG_NOTICE = 5, LOG_INFO = 6, LOG_DEBUG = 7
+
+ Default: 6
+
+*LoggingFilename*::
+ If LoggingMode is set to 2 logs are written to the file path given here.
+
+ Default: /tmp/dlt.log
+
+*TimeOutOnSend*::
+ Socket timeout in seconds for sending to clients.
+
+ Default: 4
+
+*RingbufferMinSize*::
+ The minimum size of the Ringbuffer, used for storing temporary DLT messages, until client is connected.
+
+ Default: 500000
+
+*RingbufferMaxSize*::
+ The max size of the Ringbuffer, used for storing temporary DLT messages, until client is connected.
+
+ Default: 10000000
+
+*RingbufferStepSize*::
+ The step size the Ringbuffer is increased, used for storing temporary DLT messages, until client is connected.
+
+ Default: 500000
+
+*ContextLogLevel*::
+ Initial log-level that is sent when an application registers. +
+ DLT_LOG_OFF = 0, DLT_LOG_FATAL = 1, DLT_LOG_ERROR = 2, DLT_LOG_WARN = 3, DLT_LOG_INFO = 4, DLT_LOG_DEBUG = 5, DLT_LOG_VERBOSE = 6
+
+ Default: 4
+
+*ContextTraceStatus*::
+ Initial trace-status that is sent when an application registers. +
+ DLT_TRACE_STATUS_OFF = 0, DLT_TRACE_STATUS_ON = 1
+
+ Default: 0
+
+*ForceContextLogLevelAndTraceStatus*::
+ Force log level and trace status of contexts to not exceed "ContextLogLevel" and "ContextTraceStatus". +
+ If set to 1 (ON) whenever a context registers or changes the log-level it has to be lower or equal to ContextLogLevel.
+
+ Default: 0
+
+CONTROL APPLICATION OPTIONS
+---------------------------
+
+*ControlSocketPath*::
+ Path to control socket.
+
+ Default: /tmp/dlt-ctrl.sock
+
OFFLINE TRACE OPTIONS
---------------------
@@ -94,6 +162,12 @@ OFFLINE TRACE OPTIONS
Default: 4000000
+*OfflineTraceFileNameTimestampBased*::
+ Filename timestamp based or index based. +
+ 1 = timestamp based, 0 = index based
+
+ Default: 1
+
LOCAL CONSOLE OUTPUT OPTIONS
----------------------------
@@ -148,32 +222,61 @@ TCP CLIENT OPTIONS
serial header. If the DLT message contains no serial header, the message
is ignored.
-ECU Software version info
--------------------------
+ECU SOFTWARE VERSION OPTIONS
+----------------------------
*SendECUSoftwareVersion*::
- Send periodic ECU version info. 0=disabled, 1=enabled.
+ Periodically send ECU version info. +
+ 0 = disabled, 1 = enabled
Default: 0
*PathToECUSoftwareVersion*::
Absolute path to file storing version information - if disabled the DLT version will be send.
-Offline Logstorage OPTIONS
+TIMEZONE INFO OPTIONS
+---------------------
+
+*SendTimezone*::
+ Periodically send timezone info.
+ 0 = disabled, 1 = enabled
+
+ Default: 0
+
+OFFLINE LOGSTORAGE OPTIONS
--------------------------
*OfflineLogstorageMaxDevices*::
- Maximum devices to be used as offline logstorage devices (1 .. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES).
+ Maximum devices to be used as offline logstorage devices. +
+ 0 = disabled, 1 .. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES
- Default: Off, zero logstorage devices are supported.
+ Default: 0 (Functionality is disabled)
-EXAMPLES
---------
-Start DLT daemon in background mode::
- *dlt-daemon -d*
+*OfflineLogstorageDirPath*::
+ Path to store DLT offline log storage messages.
+
+ Default: off
+
+*OfflineLogstorageTimestamp*::
+ Appends timestamp in log file name. +
+ 0 = disabled, 1 = enabled
+
+ Default: 1
+
+*OfflineLogstorageDelimiter*::
+ Appends delimiter in log file name, only punctuation characters allowed.
+
+ Default: _
+
+*OfflineLogstorageMaxCounter*::
+ Wrap around value for log file count in file name. +
+
+ Default: UINT_MAX
+
+*OfflineLogstorageCacheSize*::
+ Maximal used memory for log storage cache in KB.
-Start DLT daemon with own configuration::
- *dlt-daemon -c ~/my-dlt-configuration.cfg*
+ Default: 30000 KB
AUTHOR
------
@@ -186,6 +289,5 @@ Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-an
SEE ALSO
--------
-dlt-daemon(1) +
-dlt-system(1)
+dlt-daemon(1), dlt-system(1)
diff --git a/doc/dlt_book.txt b/doc/dlt_book.txt
index abb31c2..1c0b539 100644
--- a/doc/dlt_book.txt
+++ b/doc/dlt_book.txt
@@ -16,31 +16,53 @@
DLT Documentation
=================
Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
-0.0.1, 2012/10/12: Initial version
+0.0.2, 2016/02/23: Reworked version
+:toc:
image::images/genivi_chrome_1_transparent.png[width=128]
Purpose
-------
-This document combines all DLT documents into a single document.
+This document is a compilation of all DLT documents.
Information
-----------
-:leveloffset: 1
+:leveloffset: 2
include::../README[]
include::../INSTALL[]
-include::../ReleaseNotes.txt[]
+:leveloffset: 0
+
+Manuals
+-------
+
+:leveloffset: 2
+
+include::dlt_user_manual.txt[]
+
+include::dlt_cheatsheet.txt[]
+
+include::dlt_design_specification.txt[]
+
+include::dlt_filetransfer.txt[]
+
+include::dlt_extended_network_trace.txt[]
+
+include::dlt_offline_logstorage.txt[]
+
+include::dlt_kpi.txt[]
+
+include::dlt_cdh.txt[]
:leveloffset: 0
Manpages
--------
-:leveloffset: 1
+:leveloffset: 2
include::dlt-daemon.1.txt[]
@@ -58,19 +80,9 @@ include::dlt-logstorage-ctrl.1.txt[]
:leveloffset: 0
-Manuals
--------
+Release Notes
+-------------
-:leveloffset: 1
-
-include::dlt_user_manual.txt[]
-
-include::dlt_cheatsheet.txt[]
+:leveloffset: 2
-include::dlt_design_specification.txt[]
-
-include::dlt_filetransfer.txt[]
-
-include::dlt_extended_network_trace.txt[]
-
-include::dlt_offline_logstorage.txt[]
+include::../ReleaseNotes.txt[]
diff --git a/doc/dlt_cdh.txt b/doc/dlt_cdh.txt
new file mode 100644
index 0000000..18302ab
--- /dev/null
+++ b/doc/dlt_cdh.txt
@@ -0,0 +1,128 @@
+////
+# SPDX license identifier: MPL-2.0
+#
+# Copyright (C) 2011-2015, BMW AG
+#
+# This file is part of GENIVI Project DLT - Diagnostic Log and Trace.
+#
+# This Source Code Form is subject to the terms of the
+# Mozilla Public License (MPL), v. 2.0.
+# If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+#
+# For further information see http://www.genivi.org/.
+////
+
+DLT Core Dump Handler
+=====================
+Lutz Helwing <Lutz_Helwing@mentor.com>
+0.0.1, 23rd June 2015: Initial version
+
+image::images/genivi_chrome_1_transparent.png[width=128]
+
+
+Overview
+--------
+
+When a program crash occurs on the system the Core Dump Handler is triggered to extract relevant information from the core dump generated by the system. The handler stores this extracted information in the ECU's file system as Core Dump Handler Files. These files are transported via the link:dlt_filetransfer.html[DLT Filetransfer] mechanism. The transferred information can be combined and integrated into the developer toolchain (gdb, Release SW, etc.).
+
+image::images/dlt_core_dump_handler.png[width=600]
+
+
+Integration
+-----------
+
+To build the core dump handler
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add
+
+----
+-DWITH_DLT_COREDUMPHANDLER=ON -DTARGET_CPU_NAME={i686|x86_64}
+----
+
+options to cmake. The core dump handler code currently supports the i686 and x86_64 architecture.
+
+
+Temporary activation as replacement for default crash handler until next reboot
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+As *root* (not sudo) execute the following: +
+
+----
+echo "|/usr/local/bin/dlt-cdh %t %p %s %e" > /proc/sys/kernel/core_pattern
+----
+
+(NOTE: replace `/usr/local/bin` with the path dlt-cdh has been installed to) +
+This instructs the kernel to pipe a core dump as standard input to dlt-cdh together with the following parameters:
+
+* %t time of dump
+* %p PID of dumped process
+* %s number of signal causing dump
+* %e executable filename
+
+See
+
+----
+man core
+----
+
+for details
+
+
+Persistent activation as replacement for default crash handler
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In `/usr/lib/sysctl.d/` the file `50-coredump.conf` has to be created which is done automatically by
+
+----
+make install
+----
+
+Unfortunately - at least on Fedora systems - abrt has to be removed with
+
+----
+yum remove abrtd*
+----
+
+because it ruthlessly overwrites our change at every boot. +
+The core dump handler can be activated then without reboot by running
+
+----
+sysctl -p /usr/lib/sysctl.d/50-coredump.conf
+----
+
+
+Configuration of link:dlt_filetransfer.html[DLT Filetransfer] for usage with dlt-cdh
+------------------------------------------------------------------------------------
+
+Make sure the following is set in the "Filetransfer Manager" section of `/etc/dlt-system.conf`:
+
+----
+...
+FiletransferEnable = 1
+...
+FiletransferDirectory = /var/core
+...
+----
+
+
+Generation of core dump
+-----------------------
+
+When a crash happens the kernel invokes dlt-cdh and passes it the core dump as standard input. +
+dlt-cdh does the following tasks:
+
+* check if enough disk space available
+* create target directories if not existing:
+** /var/core
+** /var/core_tmp
+** /tmp/.core_locks
+* clean /var/core_tmp
+* retrieve context data mainly from /proc fs of the crashed process to a temporary context file in text format
+* initialise core dump
+* read ELF headers and notes to temporary core dump output file
+* move context file and core dump to /var/core
+* create id which identifies the crash
+
+After the files have been moved to /var/core the link:dlt_filetransfer.html[DLT Filetransfer] mechanism ensures that they are sent to connected clients.
diff --git a/doc/dlt-kpi.txt b/doc/dlt_kpi.txt
index 384ba7b..384ba7b 100644
--- a/doc/dlt-kpi.txt
+++ b/doc/dlt_kpi.txt
diff --git a/doc/dlt_user_manual.txt b/doc/dlt_user_manual.txt
index 9a69507..8b937b1 100644
--- a/doc/dlt_user_manual.txt
+++ b/doc/dlt_user_manual.txt
@@ -21,7 +21,7 @@ Alexander Wenzel <Alexander.AW.Wenzel@bmw.de>
image::images/genivi_chrome_1_transparent.png[width=128]
== Purpose
-This document specifies the usage of the DLT daemon.
+This document describes the usage of the DLT daemon.
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.
The DLT daemon component is based on the AUTOSAR 4.0 standard DLT.
@@ -37,12 +37,22 @@ The SW components of DLT:
* dlt-adaptor-udp
* dlt-convert
* dlt-receive
+* dlt-dbus
+* dlt-kpi
+* dlt-cdh
+
+The SW components for controlling DLT:
+
+* dlt-control
+* dlt-logstorage-ctrl
+* dlt-passive-node-ctrl
The SW components of DLT for testing:
* dlt-example-user
* dlt-example-user-func
* dlt-example-filetransfer
+* dlt-example-user-common-api
* dlt-test-filetransfer
* dlt-test-stress-user
* dlt-test-client
@@ -51,6 +61,8 @@ The SW components of DLT for testing:
* dlt-test-stress
* dlt-test-multi-process
* dlt-test-user
+* dlt-test-fork-handler
+* dlt-test-init-free
== DLT daemon
diff --git a/doc/images/dlt_core_dump_handler.png b/doc/images/dlt_core_dump_handler.png
new file mode 100644
index 0000000..01a64ae
--- /dev/null
+++ b/doc/images/dlt_core_dump_handler.png
Binary files differ