Updated doxygen documentation, readme, man pages and release notes

Signed-off-by: Christian Muck <christian.muck@bmw.de>

11 files changed, 111 insertions, 24 deletions

diff --git a/doc/dlt-convert.1 b/doc/dlt-convert.1
index 5ae5db9..5a29267 100644
--- a/doc/dlt-convert.1
+++ b/doc/dlt-convert.1
@@ -1,4 +1,4 @@
-.TH dlt-convert 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-convert 1 "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-convert \- Convert DLT Logging files into ASCII
 .SH SYNOPSIS
diff --git a/doc/dlt-daemon.1 b/doc/dlt-daemon.1
index 34edfc6..c971ff3 100644
--- a/doc/dlt-daemon.1
+++ b/doc/dlt-daemon.1
@@ -1,4 +1,4 @@
-.TH dlt-daemon 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-daemon 1   "April 13, 2012" "version 2.7.0"  "USER COMMANDS"
 .SH NAME
 dlt-daemon \- DLT daemon for logging and tracing purpose
 .SH SYNOPSIS
diff --git a/doc/dlt-receive.1 b/doc/dlt-receive.1
index 8d08ac4..3a96e70 100644
--- a/doc/dlt-receive.1
+++ b/doc/dlt-receive.1
@@ -1,4 +1,4 @@
-.TH dlt-receive 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-receive 1   "April 13, 2012" "version 2.7.0"  "USER COMMANDS"
 .SH NAME
 dlt-receive \- Console based client for DLT Logging
 .SH SYNOPSIS
diff --git a/doc/dlt-system.1 b/doc/dlt-system.1
index 2291b9e..1484063 100644
--- a/doc/dlt-system.1
+++ b/doc/dlt-system.1
@@ -1,4 +1,4 @@
-.TH dlt-system 1  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-system 1   "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-system \- DLT system logging process
 .SH SYNOPSIS
diff --git a/doc/dlt-system.conf.5 b/doc/dlt-system.conf.5
index c8319aa..2680a78 100644
--- a/doc/dlt-system.conf.5
+++ b/doc/dlt-system.conf.5
@@ -1,4 +1,4 @@
-.TH dlt-system.conf 5  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt-system.conf 5  "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt-system.conf \- DLT system process configuration file
 .SH DESCRIPTION
@@ -44,24 +44,40 @@ 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.
+.B FiletransferContextId
+The Context Id of the filetransfer.
 .IP
-Default: /tmp/filetransfer
+Default: File.
 .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.
+.B FiletransferTimeStartup
+Time in seconds after startup of dlt-system when first file is transfered.
 .IP
-Default: /tmp/filetransfer2
+Default: 30.
 .TP
-.B SyslogContextId
-This value defines context id of the syslog adapter. 
+.B FiletransferTimeoutBetweenLogs
+Time in ms seconds to wait between two file transfer logs of a single file to DLT.
 .IP
-Default: SYSL
+Default: 10.
+.TP
+.B FiletransferTempDir
+Temporary directory to use. File transfer will move a file to this directory while it is being compressed and sent.
+.IP
+Default: /tmp.
+.TP
+.B 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..
+.IP
+Default: /var/dlt/ft1.
+.TP
+.B 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..
+.IP
+Default: 0.
+.TP
+.B 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..
+.IP
+Default: 5.
 .TP
 .B FiletransferTimeStartup
 This value defines the amount of time in seconds after start of
diff --git a/doc/dlt.conf.5 b/doc/dlt.conf.5
index ea55116..c77fba0 100644
--- a/doc/dlt.conf.5
+++ b/doc/dlt.conf.5
@@ -1,4 +1,4 @@
-.TH dlt.conf 5  "March 2, 2012" "version 2.7.0 ALPHA" "USER COMMANDS"
+.TH dlt.conf 5 "April 13, 2012" "version 2.7.0" "USER COMMANDS"
 .SH NAME
 dlt.conf \- DLT daemon configuration file
 .SH DESCRIPTION
@@ -137,8 +137,15 @@ Default: Function is disabled
 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.
+.SH ECU Software version info
+.TP
+.B SendECUSoftwareVersion
+Send periodic ECU version info. 0=disabled, 1=enabled.
 .IP
-Default:
+Default: 0
+.TP
+.B PathToECUSoftwareVersion
+Absolute path to file storing version information - if disabled the DLT version will be send.
 .SH AUTHOR
 Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)
 .SH SEE ALSO
diff --git a/doc/doxygen.cfg.cmake b/doc/doxygen.cfg.cmake
index ded84c3..13eec96 100755
--- a/doc/doxygen.cfg.cmake
+++ b/doc/doxygen.cfg.cmake
@@ -573,7 +573,8 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT = ./../../src/ \ 
+INPUT = ./../../doc/mainpage.h \
+        ./../../src/ \ 
         ./../../include
 
 
@@ -671,7 +672,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/doc/filetransfer_doxygen.cfg.cmake b/doc/filetransfer_doxygen.cfg.cmake
index aa2a3b3..a446c05 100755
--- a/doc/filetransfer_doxygen.cfg.cmake
+++ b/doc/filetransfer_doxygen.cfg.cmake
@@ -673,7 +673,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @CMAKE_SOURCE_DIR@/doc/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
diff --git a/doc/filetransfer_mainpage.h b/doc/filetransfer_mainpage.h
index d1a2f6b..047e483 100755
--- a/doc/filetransfer_mainpage.h
+++ b/doc/filetransfer_mainpage.h
@@ -1,4 +1,35 @@
-/** \mainpage DLT Filetransfer Main documentation page
+/**
+ * @licence app begin@
+ * Copyright (C) 2012  BMW AG
+ *
+ * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, 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/.
+ *
+ *
+ * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
+ *
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+ 
+/** \mainpage 
+
+\image html genivilogo.png
+
+\par More information
+can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
+
+\par About DLT
+The DLT is a Deamon that enables diagnostic log and trace in a GENIVI headunit and is based on AUTOSAR 4.0.
+
+DLT Filetransfer Main documentation page
 
 \section Introduction Introduction
 DLT Filetransfer enables the feature to store the binary data of a file to the automotive dlt log. The file will
diff --git a/doc/images/genivilogo.png b/doc/images/genivilogo.png
new file mode 100644
index 0000000..d016ec8
--- /dev/null
+++ b/doc/images/genivilogo.png
diff --git a/doc/mainpage.h b/doc/mainpage.h
new file mode 100644
index 0000000..e6a4a00
--- /dev/null
+++ b/doc/mainpage.h
@@ -0,0 +1,32 @@
+/**
+ * @licence app begin@
+ * Copyright (C) 2012  BMW AG
+ *
+ * This file is part of GENIVI Project Dlt - Diagnostic Log and Trace console apps.
+ *
+ * Contributions are licensed to the GENIVI Alliance under one or more
+ * Contribution License Agreements.
+ *
+ * \copyright
+ * This Source Code Form is subject to the terms of the
+ * Mozilla Public License, 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/.
+ *
+ *
+ * \author Alexander Wenzel <alexander.aw.wenzel@bmw.de> BMW 2011-2012
+ *
+ * For further information see http://www.genivi.org/.
+ * @licence end@
+ */
+ 
+/*!
+\mainpage
+
+\image html genivilogo.png
+
+\par More information
+can be found at https://collab.genivi.org/wiki/display/genivi/GENIVI+Home \n
+
+\par About DLT
+The DLT is a Deamon that enables diagnostic log and trace in a GENIVI headunit and is based on AUTOSAR 4.0.
+*/