diff options
Diffstat (limited to 'doc/dlt-system.conf.5')
| -rw-r--r-- | doc/dlt-system.conf.5 | 526 |
1 files changed, 0 insertions, 526 deletions
diff --git a/doc/dlt-system.conf.5 b/doc/dlt-system.conf.5 deleted file mode 100644 index 500c5ef..0000000 --- a/doc/dlt-system.conf.5 +++ /dev/null @@ -1,526 +0,0 @@ -'\" t -.\" Title: dlt-system.conf -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 02/23/2016 -.\" Manual: \ \& -.\" Source: \ \& -.\" Language: English -.\" -.TH "DLT\-SYSTEM\&.CONF" "5" "02/23/2016" "\ \&" "\ \&" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -dlt-system.conf \- DLT system process configuration file -.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\&. -.sp -The configuration file dlt\-system\&.conf allows to configure the different runtime behaviour of dlt\-system\&. The configuration file is loaded during startup of dlt\-system\&. -.sp -dlt\-system loads by default the configuration file /etc/dlt\-system\&.conf\&. An alternative configuration file can be loaded with the option \-c\&. -.SH "GENERAL OPTIONS" -.PP -\fBApplicationId\fR -.RS 4 -The application Id used for the dlt\-system process\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: SYS -.fi -.if n \{\ -.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 -.RS 4 -If this option is set to 1, the syslog adapter feature is enabled\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBSyslogContextId\fR -.RS 4 -This value defines context id of the syslog adapter\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: SYSL -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBSyslogPort\fR -.RS 4 -This value defines the UDP port opened for receiving log messages from syslog\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 47111 -.fi -.if n \{\ -.RE -.\} -.RE -.SH "SYSTEMD JOURNAL ADAPTER OPTIONS" -.PP -\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 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBJournalContextId\fR -.RS 4 -The Context Id of the journal adapter\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: JOUR -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBJournalCurrentBoot\fR -.RS 4 -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: 1 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBJournalFollow\fR -.RS 4 -Show only the last 10 entries and follow\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBJournalMapLogLevels\fR -.RS 4 -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: 1 -.fi -.if n \{\ -.RE -.\} -.RE -.RE -.SH "FILETRANSFER OPTIONS" -.PP -\fBFiletransferEnable\fR -.RS 4 -Enable the Filetransfer feature\&. - -0 = disabled, 1 = enabled -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBFiletransferContextId\fR -.RS 4 -The Context Id of the filetransfer\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: FILE -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBFiletransferTimeStartup\fR -.RS 4 -Time in seconds after startup of dlt\-system when first file is transfered\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBFiletransferTimeDelay\fR -.RS 4 -Time in seconds to wait between deletion of transferred file and start of next file transfer\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 10 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBFiletransferTimeoutBetweenLogs\fR -.RS 4 -Time in seconds to wait between two file transfer logs of a single file to DLT\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 10 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBFiletransferDirectory\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\&. -.RE -.PP -\fBFiletransferCompression\fR -.RS 4 -See FiletransferDirectory option for explanation\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -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 -.\} -.RE -.SH "LOG FILES OPTIONS" -.PP -\fBLogFileEnable\fR -.RS 4 -If this option is set to 1, the log files feature is enabled\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\fBLogFileFilename\fR -.RS 4 -This value sets the full filename path to the file, which should be logged\&. -.RE -.PP -\fBLogFileMode\fR -.RS 4 -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 -.RS 4 -This value is used in mode 3 and defines the number of seconds, after which the defined file is logged\&. -.RE -.PP -\fBLogFileContextId\fR -.RS 4 -This value defines the context id, which is used for logging the file\&. -.RE -.SH "LOG PROCESSES OPTIONS" -.PP -\fBLogProcessesEnable\fR -.RS 4 -Enable the logging of processes\&. - -0 = disabled, 1 = enabled -.sp -.if n \{\ -.RS 4 -.\} -.nf -Default: 0 -.fi -.if n \{\ -.RE -.\} -.RE -.PP -\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 -.RS 4 -This value defines the name of the process to be logged, as used in the file stat of each process\&. If the value is defined as *, all processes are logged\&. -.RE -.PP -\fBLogProcessFilename\fR -.RS 4 -This value sets the relative filename path to the file, which should be logged\&. The path is relative to the procfilesystem folder of the process\&. -.RE -.PP -\fBLogProcessMode\fR -.RS 4 -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 -Alexander Wenzel (alexander\&.aw\&.wenzel (at) bmw\&.de) -.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\-system(1) dlt\-daemon(1) |