diff options
author | Lassi Marttala <lassi.lm.marttala@partner.bmw.com> | 2012-03-02 11:03:16 +0100 |
---|---|---|
committer | Lassi Marttala <lassi.lm.marttala@partner.bmw.com> | 2012-03-02 11:03:16 +0100 |
commit | f6754bd20376209bc56047363ff94fcd44f16b51 (patch) | |
tree | aabb5e8a96287292861ca1ad939f4c6f550e512e /doc | |
parent | 5b36dadb143b873cbf4591e8ff4b572aa26c5c3c (diff) | |
download | DLT-daemon-f6754bd20376209bc56047363ff94fcd44f16b51.tar.gz |
[GDLT-53]
Improve the man page generation.
Upgrade the versions within man files.
Move man page generation into build/doc dir
Diffstat (limited to 'doc')
-rwxr-xr-x | doc/CMakeLists.txt | 114 | ||||
-rw-r--r-- | doc/dlt-convert.1 | 2 | ||||
-rw-r--r-- | doc/dlt-daemon.1 | 2 | ||||
-rw-r--r-- | doc/dlt-receive.1 | 2 | ||||
-rw-r--r-- | doc/dlt-system.1 | 2 | ||||
-rw-r--r-- | doc/dlt-system.conf.5 | 2 | ||||
-rw-r--r-- | doc/dlt.conf.5 | 2 |
7 files changed, 71 insertions, 55 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 6c566d2..f018a7d 100755 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -52,52 +52,68 @@ if(WITH_DOC) ) endif(WITH_DOC) -# Compress the man pages and install to proper place -FIND_PROGRAM(GZIP_TOOL - NAMES gzip - PATHS /bin - /usr/bin - /usr/local/bin) - -if(NOT GZIP_TOOL) - MESSAGE(FATAL_ERROR "Could not find gzip for man page compression.") -endif(NOT GZIP_TOOL) - -set(MAN_SRC ${CMAKE_CURRENT_SOURCE_DIR}/dlt.conf.5 - ${CMAKE_CURRENT_SOURCE_DIR}/dlt-system.conf.5 - ${CMAKE_CURRENT_SOURCE_DIR}/dlt-convert.1 - ${CMAKE_CURRENT_SOURCE_DIR}/dlt-daemon.1 - ${CMAKE_CURRENT_SOURCE_DIR}/dlt-receive.1 - ${CMAKE_CURRENT_SOURCE_DIR}/dlt-system.1) -set(MAN_SRC_GZ dlt.conf.5.gz dlt-system.conf.5.gz dlt-convert.1.gz dlt-daemon.1.gz dlt-receive.1.gz dlt-system.1.gz) - -foreach(MAN ${MAN_SRC}) - ADD_CUSTOM_COMMAND(OUTPUT ${MAN}.gz - COMMAND ${GZIP_TOOL} -c ${MAN} > ${MAN}.gz - DEPENDS ${MAN} - COMMENT "Compressing ${MAN}.gz") -endforeach(MAN) - -# If user has not set the base dir for man pages, use a default location -if(MAN_INSTALL_DIR) -else() - if(WIN32) - set(MAN_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/man) - else() - set(MAN_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/share/man) - endif() -endif() - -add_library(man_pages STATIC dummy.c ${MAN_SRC_GZ}) - -install(FILES dlt.conf.5.gz - dlt-system.conf.5.gz - DESTINATION ${MAN_INSTALL_DIR}/man5 -) - -install(FILES dlt-convert.1.gz - dlt-daemon.1.gz - dlt-receive.1.gz - dlt-system.1.gz - DESTINATION ${MAN_INSTALL_DIR}/man1 -) +if(WITH_MAN) + # Compress the man pages and install to proper place + FIND_PROGRAM(GZIP_TOOL + NAMES gzip + PATHS /bin + /usr/bin + /usr/local/bin) + + if(NOT GZIP_TOOL) + MESSAGE(FATAL_ERROR "Could not find gzip for man page compression.") + endif(NOT GZIP_TOOL) + + set(MAN_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}) + set(MAN_BUILD_DIR ${CMAKE_BINARY_DIR}/doc) + + set(MAN_SRC ${MAN_SRC_DIR}/dlt.conf.5 + ${MAN_SRC_DIR}/dlt-system.conf.5 + ${MAN_SRC_DIR}/dlt-convert.1 + ${MAN_SRC_DIR}/dlt-daemon.1 + ${MAN_SRC_DIR}/dlt-receive.1 + ${MAN_SRC_DIR}/dlt-system.1) + set(MAN_BUILD_SRC + ${MAN_BUILD_DIR}/dlt.conf.5 + ${MAN_BUILD_DIR}/dlt-system.conf.5 + ${MAN_BUILD_DIR}/dlt-convert.1 + ${MAN_BUILD_DIR}/dlt-daemon.1 + ${MAN_BUILD_DIR}/dlt-receive.1 + ${MAN_BUILD_DIR}/dlt-system.1) + set(MAN_BUILD_GZ + ${MAN_BUILD_DIR}/dlt.conf.5.gz + ${MAN_BUILD_DIR}/dlt-system.conf.5.gz + ${MAN_BUILD_DIR}/dlt-convert.1.gz + ${MAN_BUILD_DIR}/dlt-daemon.1.gz + ${MAN_BUILD_DIR}/dlt-receive.1.gz + ${MAN_BUILD_DIR}/dlt-system.1.gz) + + foreach(MAN ${MAN_SRC}) + file(COPY ${MAN} DESTINATION ${MAN_BUILD_DIR}) + endforeach(MAN) + + add_custom_target(compress_man ALL + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt.conf.5 > ${MAN_BUILD_DIR}/dlt.conf.5.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-system.conf.5 > ${MAN_BUILD_DIR}/dlt-system.conf.5.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-convert.1 > ${MAN_BUILD_DIR}/dlt-convert.1.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-daemon.1 > ${MAN_BUILD_DIR}/dlt-daemon.1.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-receive.1 > ${MAN_BUILD_DIR}/dlt-receive.1.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-system.1 > ${MAN_BUILD_DIR}/dlt-system.1.gz) + + # If user has not set the base dir for man pages, use a default location + set(MAN_INSTALL_DIR ${CMAKE_INSTALL_PREFIX}/share/man) + + add_library(man_pages STATIC dummy.c ${MAN_SRC_GZ}) + + install(FILES ${MAN_BUILD_DIR}/dlt.conf.5.gz + ${MAN_BUILD_DIR}/dlt-system.conf.5.gz + DESTINATION ${MAN_INSTALL_DIR}/man5 + ) + + install(FILES ${MAN_BUILD_DIR}/dlt-convert.1.gz + ${MAN_BUILD_DIR}/dlt-daemon.1.gz + ${MAN_BUILD_DIR}/dlt-receive.1.gz + ${MAN_BUILD_DIR}/dlt-system.1.gz + DESTINATION ${MAN_INSTALL_DIR}/man1 + ) +endif(WITH_MAN)
\ No newline at end of file diff --git a/doc/dlt-convert.1 b/doc/dlt-convert.1 index 052b908..bcf6aa0 100644 --- a/doc/dlt-convert.1 +++ b/doc/dlt-convert.1 @@ -1,4 +1,4 @@ -.TH dlt-convert 1 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt-convert 1 "March 2, 2012" "version 2.5.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 b2a604d..7d3d375 100644 --- a/doc/dlt-daemon.1 +++ b/doc/dlt-daemon.1 @@ -1,4 +1,4 @@ -.TH dlt-daemon 1 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt-daemon 1 "March 2, 2012" "version 2.5.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 de3d6f9..3669f79 100644 --- a/doc/dlt-receive.1 +++ b/doc/dlt-receive.1 @@ -1,4 +1,4 @@ -.TH dlt-receive 1 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt-receive 1 "March 2, 2012" "version 2.5.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 6221498..a9914c1 100644 --- a/doc/dlt-system.1 +++ b/doc/dlt-system.1 @@ -1,4 +1,4 @@ -.TH dlt-system 1 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt-system 1 "March 2, 2012" "version 2.5.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 a3b2476..3db0d18 100644 --- a/doc/dlt-system.conf.5 +++ b/doc/dlt-system.conf.5 @@ -1,4 +1,4 @@ -.TH dlt-system.conf 5 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt-system.conf 5 "March 2, 2012" "version 2.5.0" "USER COMMANDS" .SH NAME dlt-system.conf \- DLT system process configuration file .SH DESCRIPTION diff --git a/doc/dlt.conf.5 b/doc/dlt.conf.5 index 43cc602..965aa39 100644 --- a/doc/dlt.conf.5 +++ b/doc/dlt.conf.5 @@ -1,4 +1,4 @@ -.TH dlt.conf 5 "October 31, 2011" "version 2.4.0" "USER COMMANDS" +.TH dlt.conf 5 "March 2, 2012" "version 2.5.0" "USER COMMANDS" .SH NAME dlt.conf \- DLT daemon configuration file .SH DESCRIPTION |