Added manual pages.

6 files changed, 482 insertions, 0 deletions

diff --git a/doc/dlt-convert.1 b/doc/dlt-convert.1
new file mode 100644
index 0000000..42a8a9d
--- /dev/null
+++ b/doc/dlt-convert.1
@@ -0,0 +1,63 @@
+.TH dlt-convert 1  "October 31, 2011" "version 2.4.0" "USER COMMANDS"
+.SH NAME
+dlt-convert \- Convert DLT Logging files into ASCII
+.SH SYNOPSIS
+.B dlt-convert
+[\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-c] [\-b number]
+[\-e number] [\-w] file1 [file2] [file3]
+.SH DESCRIPTION
+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. 
+.SH OPTIONS
+.TP
+\-h
+Display a short help text.
+.TP
+\-a
+Print DLT file; payload as ASCII.
+.TP
+\-x
+Print DLT file; payload as hex.
+.TP
+\-m
+Print DLT file; payload as hex and ASCII.
+.TP
+\-s
+Print DLT file; only headers.
+.TP
+\-o
+Output messages in new DLT file.
+.TP
+\-v
+Verbose mode.
+.TP
+\-c
+Count number of messages.
+.TP
+\-b
+First messages to be handled.
+.TP
+\-e
+Last message to be handled.
+.TP
+\-w
+Follow dlt file while file is increasing.
+.SH EXAMPLES
+.TP
+Convert DLT file into ASCII:
+.B dlt-convert
+\-a mylog.dlt
+.PP
+.TP
+Join two log files:
+.B dlt-convert
+\-o newlog.dlt mylog1.dlt mylog2.dlt
+.PP
+.SH EXIT STATUS
+Non zero is returned in case of failure.
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt-daemon(1)
+
diff --git a/doc/dlt-daemon.1 b/doc/dlt-daemon.1
new file mode 100644
index 0000000..b2a604d
--- /dev/null
+++ b/doc/dlt-daemon.1
@@ -0,0 +1,46 @@
+.TH dlt-daemon 1  "October 31, 2011" "version 2.4.0" "USER COMMANDS"
+.SH NAME
+dlt-daemon \- DLT daemon for logging and tracing purpose
+.SH SYNOPSIS
+.B dlt-daemon
+[\-h] [\-d] [\-v] [\-c filename]
+.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
+dlt-daemon loads by default the configuration file /etc/dlt.conf. 
+See dlt.conf(1).
+.SH OPTIONS
+.TP
+\-h
+Display a short help text.
+.TP
+\-d
+Daemonize, needed in System V init systems.
+.TP
+\-v
+Display debug information from the running DLT daemon.
+.TP
+\-c
+Load an alternative configuration file. By default the configuration
+file /etc/dlt.conf is loaded.
+.SH EXAMPLES
+.TP
+Start DLT daemon in background mode:
+.B dlt-daemon
+\-d
+.PP
+.TP
+Start DLT daemon for debugging purpose with own configuration:
+.B dlt-daemon
+\-c ~/my-dlt-configuration.cfg \-v
+.PP
+.SH EXIT STATUS
+Non zero is returned in case of failure.
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt.conf(5)
+dlt-system(1)
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1
new file mode 100644
index 0000000..0e47f55
--- /dev/null
+++ b/doc/dlt-receive.1
@@ -0,0 +1,57 @@
+.TH dlt-receive 1  "October 31, 2011" "version 2.4.0" "USER COMMANDS"
+.SH NAME
+dlt-receive \- Console based client for DLT Logging
+.SH SYNOPSIS
+.B dlt-receive
+[\-h] [\-a] [\-x] [\-m] [\-s][\-o filename] [\-v] [\-y]
+[\-b baudrate] [\-e ecuid]hostname/serial_device_name
+.SH DESCRIPTION
+Receive DLT messages from DLT daemon and print or store the messages.
+.SH OPTIONS
+.TP
+\-h
+Display a short help text.
+.TP
+\-a
+Print DLT file; payload as ASCII.
+.TP
+\-x
+Print DLT file; payload as hex.
+.TP
+\-m
+Print DLT file; payload as hex and ASCII.
+.TP
+\-s
+Print DLT file; only headers.
+.TP
+\-o
+Output messages in new DLT file.
+.TP
+\-v
+Verbose mode.
+.TP
+\-y
+Serial device mode.
+.TP
+\-b
+Serial device baudrate (Default: 115200).
+.TP
+\-e
+Set ECU ID (Default: RECV).
+.SH EXAMPLES
+.TP
+Convert DLT file into ASCII:
+.B dlt-convert
+\-a mylog.dlt
+.PP
+.TP
+Join two log files:
+.B dlt-convert
+\-o newlog.dlt mylog1.dlt mylog2.dlt
+.PP
+.SH EXIT STATUS
+Non zero is returned in case of failure.
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt-daemon(1)
diff --git a/doc/dlt-system.1 b/doc/dlt-system.1
new file mode 100644
index 0000000..6221498
--- /dev/null
+++ b/doc/dlt-system.1
@@ -0,0 +1,37 @@
+.TH dlt-system 1  "October 31, 2011" "version 2.4.0" "USER COMMANDS"
+.SH NAME
+dlt-system \- DLT system logging process
+.SH SYNOPSIS
+.B dlt-system
+[\-h] [\-c filename]
+.SH DESCRIPTION
+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. 
+.PP
+dlt-system loads by default the configuration file /etc/dlt-system.conf. 
+See dlt-system.conf(1).
+.SH OPTIONS
+.TP
+\-h
+Display a short help text.
+.TP
+\-c
+Load an alternative configuration file. By default the configuration
+file /etc/dlt.conf is loaded.
+.SH EXAMPLES
+.TP
+Start DLT system with own configuration:
+.B dlt-system
+\-c ~/my-configuration.cfg \-v
+.PP
+.SH EXIT STATUS
+Non zero is returned in case of failure.
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt-system.conf(5)
+dlt-daemon(1)
+
diff --git a/doc/dlt-system.conf.5 b/doc/dlt-system.conf.5
new file mode 100644
index 0000000..d09a9c1
--- /dev/null
+++ b/doc/dlt-system.conf.5
@@ -0,0 +1,134 @@
+.TH dlt-system.conf 5  "October 31, 2011" "version 2.4.0" "USER COMMANDS"
+.SH NAME
+dlt-system.conf \- DLT system process configuration file
+.SH DESCRIPTION
+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. 
+.PP
+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.
+.PP
+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
+.TP
+.B ApplicationId
+The application Id used for the dlt-system process.
+.IP
+Default: SYS
+.SH SYSLOG ADAPTER OPTIONS
+.TP
+.B SyslogEnable
+If this option is set to 1, the syslog adapter feature is enabled.
+.IP
+Default: 0.
+.TP
+.B SyslogContextId
+This value defines context id of the syslog adapter. 
+.IP
+Default: SYSL
+.TP
+.B SyslogPort
+This value defines the UDP port opened for receiving log messages from
+syslog.
+.IP
+Default: 47111
+.SH FILETRANSFER OPTIONS
+.TP
+.B FiletransferEnable
+If this option is set to 1, the filetransfer feature is enabled.
+.IP
+Default: 0.
+.TP
+.B FiletransferDirectory1
+This is path to the first directory, which is scanned for new files to
+be transfered. If new files are found, these files are transfered to the
+client and then deleted after a configurable time.
+.IP
+Default: /tmp/filetransfer
+.TP
+.B FiletransferDirectory2
+This is path to the second directory, which is scanned for new files to
+be transfered. If new files are found, these files are transfered to the
+client and then deleted after a configurable time.
+.IP
+Default: /tmp/filetransfer2
+.TP
+.B SyslogContextId
+This value defines context id of the syslog adapter. 
+.IP
+Default: SYSL
+.TP
+.B FiletransferTimeStartup
+This value defines the amount of time in seconds after start of
+dlt-system, when dlt-system starts to send the first file.
+.IP
+Default: 30
+.TP
+.B FiletransferTimeDelay
+This value defines the amount of time after which a sent file is deleted
+and the next file is strated to be transmitted.
+.IP
+Default: 10
+.SH LOG FILES OPTIONS
+.TP
+.B LogFileEnable
+If this option is set to 1, the log files feature is enabled.
+.IP
+Default: 0.
+.TP
+.B LogFileFilename
+This value sets the full filename path to the file, which should be logged. 
+.TP
+.B LogFileMode
+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.
+.TP
+.B LogFileTimeDelay
+This value is used in mode 3 and defines the number of seconds, after
+which the defined file is logged.
+.TP
+.B LogFileContextId
+This value defines the context id, which is used for logging the file.
+.SH LOG PROCESSES OPTIONS
+.TP
+.B LogProcessesEnable
+If this option is set to 1, the log processes feature is enabled.
+.IP
+Default: 0.
+.TP
+.B LogProcessesContextId
+This value defines the context id, which is used for logging processes
+files.
+.TP
+.B LogProcessName
+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.
+.TP
+.B LogProcessFilename
+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. 
+.TP
+.B LogProcessMode
+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.
+.TP
+.B LogProcessTimeDelay
+This value is used in mode 3 and defines the number of seconds, after
+which the defined procfilesystem file is logged.
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt-system(1)
diff --git a/doc/dlt.conf.5 b/doc/dlt.conf.5
new file mode 100644
index 0000000..43cc602
--- /dev/null
+++ b/doc/dlt.conf.5
@@ -0,0 +1,145 @@
+.TH dlt.conf 5  "October 31, 2011" "version 2.4.0" "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.
+.IP
+Default:
+.SH AUTHOR
+Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
+.SH SEE ALSO
+dlt(1)