summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Muck <christian.muck@bmw.de>2012-03-05 09:29:41 +0100
committerChristian Muck <christian.muck@bmw.de>2012-03-05 09:29:41 +0100
commit2586cb77cfacb6ca157a04a2a5972fc8296455f4 (patch)
treeeb7f1a2544926b37eef051c29dabe3da40cddc48
parent369e54f5df8277d49fc95d5d8025ffe927a01da8 (diff)
downloadDLT-daemon-2586cb77cfacb6ca157a04a2a5972fc8296455f4.tar.gz
Update of dlt-daemon.1, Readme.txt, Install.txt, CMAKELists and gitignore
-rw-r--r--.gitignore4
-rwxr-xr-xCMakeLists.txt1
-rw-r--r--INSTALL.txt24
-rw-r--r--README.txt54
-rwxr-xr-xdoc/CMakeLists.txt13
-rw-r--r--doc/dlt-daemon.19
-rwxr-xr-xdoc/filetransfer_doxygen.cfg.cmake2
7 files changed, 61 insertions, 46 deletions
diff --git a/.gitignore b/.gitignore
index 4e5b679..825ca18 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,9 +5,5 @@ automotive-dlt.spec
automotive-dlt.pc
config.h
include/dlt/dlt_version.h
-doc/DOC_DLT/
-doc/DOC_DLT_Filetransfer/
-doc/doxygen.cfg
-doc/filetransfer_doxygen.cfg
diff --git a/CMakeLists.txt b/CMakeLists.txt
index c9a987f..40084e1 100755
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -115,6 +115,7 @@ message( STATUS "WITH_DOC = ${WITH_DOC}" )
message( STATUS "WITH_TESTSCRIPTS = ${WITH_TESTSCRIPTS}" )
message( STATUS "WITH_SYSTEMD = ${WITH_SYSTEMD}" )
message( STATUS "WITH_GPROF = ${WITH_GPROF}" )
+message( STATUS "WITH_MAN = ${WITH_MAN}" )
message( STATUS "BUILD_SHARED_LIBS = ${BUILD_SHARED_LIBS}" )
message( STATUS "CMAKE_INSTALL_PREFIX = ${CMAKE_INSTALL_PREFIX}" )
message( STATUS "CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE}" )
diff --git a/INSTALL.txt b/INSTALL.txt
index 1ffb1e9..8f65e7c 100644
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -1,20 +1,18 @@
Instructions for installing this software
----
+-----------------------------------------
This software uses cmake as its build tool. To build and install the
DLT daemon, follow these steps;
-1. Create a build directory;
+- mkdir build
+- cd build
+- cmake ..
+- make
+- optional: sudo make install
+- optional: sudo ldconfig
-$ mkdir build
-2. Move into that directory and call cmake;
-
-$ cd build && cmake ../
-
-3. The run make and make install;
-
-$ make
-# make install
-
-Note you'll have to be root to run make install, or do 'sudo make install'.
+Please read the README.txt for
+- Compile options and default values
+- Man pages
+- Doxygen documentation \ No newline at end of file
diff --git a/README.txt b/README.txt
index 95f12e8..d976717 100644
--- a/README.txt
+++ b/README.txt
@@ -51,25 +51,47 @@ Compiling in Linux:
Compile options with default values
-----------------------------------
--- WITH_DLT_SHM_ENABLE = OFF
--- WITH_CHECK_CONFIG_FILE = OFF
--- WITH_DOC = OFF
--- WITH_TESTSCRIPTS = OFF
--- WITH_SYSTEMD = OFF
--- WITH_GPROF = OFF
--- BUILD_SHARED_LIBS = ON
--- CMAKE_INSTALL_PREFIX = /usr/local
--- CMAKE_BUILD_TYPE = RelWithDebInfo
-
-In order to change these options, you can modify this values with ccmake, do the appropriate changes in CmakeList.txt or via
+- WITH_DLT_SHM_ENABLE = OFF
+- WITH_CHECK_CONFIG_FILE = OFF
+- WITH_DOC = OFF
+- WITH_TESTSCRIPTS = OFF
+- WITH_SYSTEMD = OFF
+- WITH_GPROF = OFF
+- WITH_MAN = ON
+- BUILD_SHARED_LIBS = ON
+- CMAKE_INSTALL_PREFIX = /usr/local
+- CMAKE_BUILD_TYPE = RelWithDebInfo
+
+
+In order to change these options, you can modify this values
+with ccmake, do the appropriate changes in CmakeList.txt or via
the commandline for cmake
--- Change a value with: cmake -D<Variable>=<Value>
+- Change a value with: cmake -D<Variable>=<Value>
+- Example: cmake -DCMAKE_INSTALL_PREFIX=/usr
-Create documentation
---------------------
+Man pages
+---------
+With the compile option "WITH_MAN=ON" (default value) the man
+pages will generated. After the call "sudo make install" (see
+"Compilin in Linux") they are installed at <CMAKE_INSTALL_PREFIX>/share/man.
+
+To get more informations, call e.g.
+- man dlt-daemon
+- man dlt.conf
+- man dlt-convert
+- man dlt-receive
+- man dlt-system
+- man dlt-system.conf
+
+
+Create doxygen documentation
+----------------------------
- mkdir build
- cd build
- cmake -DWITH_DOC=ON ..
-- make doc
-- (optional)make doc-filetransfer \ No newline at end of file
+- make
+- (only DLT doc - optional )make doc
+- (only DLT-Filetransfer - optional )make doc-filetransfer
+
+You find the documentation know as HTML, RTF or LaTex in <project-root>/build/doc \ No newline at end of file
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 989f521..851e356 100755
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -38,18 +38,19 @@
if(WITH_DOC)
find_package(Doxygen)
- CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doc/doxygen.cfg.cmake ${CMAKE_SOURCE_DIR}/doc/doxygen.cfg @ONLY)
- CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg.cmake ${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg @ONLY)
+ configure_file(${CMAKE_SOURCE_DIR}/doc/doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/doxygen.cfg @ONLY)
+ configure_file(${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg.cmake ${CMAKE_BINARY_DIR}/doc/filetransfer_doxygen.cfg @ONLY)
add_custom_target (doc ALL
- COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/doxygen.cfg
- WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
+ COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/doxygen.cfg
+ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
)
add_custom_target (doc-filetransfer ALL
- COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/filetransfer_doxygen.cfg
- WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
+ COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/filetransfer_doxygen.cfg
+ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
)
+
endif(WITH_DOC)
if(WITH_MAN)
diff --git a/doc/dlt-daemon.1 b/doc/dlt-daemon.1
index 7d3d375..5776745 100644
--- a/doc/dlt-daemon.1
+++ b/doc/dlt-daemon.1
@@ -3,7 +3,7 @@
dlt-daemon \- DLT daemon for logging and tracing purpose
.SH SYNOPSIS
.B dlt-daemon
-[\-h] [\-d] [\-v] [\-c filename]
+[\-h] [\-d] [\-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
@@ -20,9 +20,6 @@ Display a short help text.
\-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.
@@ -33,9 +30,9 @@ Start DLT daemon in background mode:
\-d
.PP
.TP
-Start DLT daemon for debugging purpose with own configuration:
+Start DLT daemon with own configuration:
.B dlt-daemon
-\-c ~/my-dlt-configuration.cfg \-v
+\-c ~/my-dlt-configuration.cfg
.PP
.SH EXIT STATUS
Non zero is returned in case of failure.
diff --git a/doc/filetransfer_doxygen.cfg.cmake b/doc/filetransfer_doxygen.cfg.cmake
index c3a091a..aa2a3b3 100755
--- a/doc/filetransfer_doxygen.cfg.cmake
+++ b/doc/filetransfer_doxygen.cfg.cmake
@@ -573,7 +573,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ./filetransfer_mainpage.h \
+INPUT = ./../../doc/filetransfer_mainpage.h \
./../src/lib/dlt_filetransfer.c \
./../include/dlt_filetransfer.h \
./../src/examples/dlt-example-filetransfer.c \