doc/dlt-system.conf.5

   1 .TH dlt-system.conf 5  "March 2, 2012" "version 2.5.0" "USER COMMANDS"
   2 .SH NAME
   3 dlt-system.conf \- DLT system process configuration file
   4 .SH DESCRIPTION
   5 The DLT system logging process is the central application, which logs
   6 system information from the platform. It provides the features
   7 filetransfer, syslog adapater, logging of any kind of files and
   8 procfilesystem logger. The individual features can be enabled and
   9 disabled in the configuration file.
  10 .PP
  11 The configuration file dlt-system.conf allows to configure the different
  12 runtime behaviour of dlt-system. The configuration file is loaded
  13 during startup of dlt-system.
  14 .PP
  15 dlt-system loads by default the configuration file /etc/dlt-system.conf.
  16 An alternative configuration file can be loaded with the option \-c.
  17 .SH GENERAL OPTIONS
  18 .TP
  19 .B ApplicationId
  20 The application Id used for the dlt-system process.
  21 .IP
  22 Default: SYS
  23 .SH SYSLOG ADAPTER OPTIONS
  24 .TP
  25 .B SyslogEnable
  26 If this option is set to 1, the syslog adapter feature is enabled.
  27 .IP
  28 Default: 0.
  29 .TP
  30 .B SyslogContextId
  31 This value defines context id of the syslog adapter.
  32 .IP
  33 Default: SYSL
  34 .TP
  35 .B SyslogPort
  36 This value defines the UDP port opened for receiving log messages from
  37 syslog.
  38 .IP
  39 Default: 47111
  40 .SH FILETRANSFER OPTIONS
  41 .TP
  42 .B FiletransferEnable
  43 If this option is set to 1, the filetransfer feature is enabled.
  44 .IP
  45 Default: 0.
  46 .TP
  47 .B FiletransferDirectory1
  48 This is path to the first directory, which is scanned for new files to
  49 be transfered. If new files are found, these files are transfered to the
  50 client and then deleted after a configurable time.
  51 .IP
  52 Default: /tmp/filetransfer
  53 .TP
  54 .B FiletransferDirectory2
  55 This is path to the second directory, which is scanned for new files to
  56 be transfered. If new files are found, these files are transfered to the
  57 client and then deleted after a configurable time.
  58 .IP
  59 Default: /tmp/filetransfer2
  60 .TP
  61 .B SyslogContextId
  62 This value defines context id of the syslog adapter.
  63 .IP
  64 Default: SYSL
  65 .TP
  66 .B FiletransferTimeStartup
  67 This value defines the amount of time in seconds after start of
  68 dlt-system, when dlt-system starts to send the first file.
  69 .IP
  70 Default: 30
  71 .TP
  72 .B FiletransferTimeDelay
  73 This value defines the amount of time after which a sent file is deleted
  74 and the next file is strated to be transmitted.
  75 .IP
  76 Default: 10
  77 .TP
  78 .B FiletransferTimeoutBetweenLogs
  79 This value defines the amount of time to wait between two file transfer
  80 logs of a single file.
  81 .IP
  82 Default: 10
  83 .SH LOG FILES OPTIONS
  84 .TP
  85 .B LogFileEnable
  86 If this option is set to 1, the log files feature is enabled.
  87 .IP
  88 Default: 0.
  89 .TP
  90 .B LogFileFilename
  91 This value sets the full filename path to the file, which should be logged.
  92 .TP
  93 .B LogFileMode
  94 This value the defines in which operation mode this file is logged.
  95 Possible values are: 0 = off, 1 = startup only, 2 = regular.
  96 In mode 1 the file is only logged once when dlt-system is started.
  97 In mode 2 the file is logged regularly every time LogFileTimeDelay timer
  98 elapses.
  99 .TP
 100 .B LogFileTimeDelay
 101 This value is used in mode 3 and defines the number of seconds, after
 102 which the defined file is logged.
 103 .TP
 104 .B LogFileContextId
 105 This value defines the context id, which is used for logging the file.
 106 .SH LOG PROCESSES OPTIONS
 107 .TP
 108 .B LogProcessesEnable
 109 If this option is set to 1, the log processes feature is enabled.
 110 .IP
 111 Default: 0.
 112 .TP
 113 .B LogProcessesContextId
 114 This value defines the context id, which is used for logging processes
 115 files.
 116 .TP
 117 .B LogProcessName
 118 This value defines the name of the process to be logged, as used in the
 119 file stat of each process.
 120 If the value is defined as *, all processes are logged.
 121 .TP
 122 .B LogProcessFilename
 123 This value sets the relative filename path to the file, which should be
 124 logged. The path is relative to the procfilesystem folder of the
 125 process.
 126 .TP
 127 .B LogProcessMode
 128 This value the defines in which operation mode this process file is
 129 logged. Possible values are: 0 = off, 1 = startup only, 2 = regular.
 130 In mode 1 the file is only logged once when dlt-system is started.
 131 In mode 2 the file is logged regularly every time LogFileTimeDelay timer
 132 elapses.
 133 .TP
 134 .B LogProcessTimeDelay
 135 This value is used in mode 3 and defines the number of seconds, after
 136 which the defined procfilesystem file is logged.
 137 .SH AUTHOR
 138 Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
 139 .SH SEE ALSO
 140 dlt-system(1)