doc: Move all man pages to markdown files (#102)v2.18.1

All manpages have been removed, because they will be autogenerated
from markdown files using pandoc.

1 files changed, 51 insertions, 38 deletions

diff --git a/README.md b/README.md
index ca73b71..6e768a9 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,16 @@
 Build and Test status: ![build and test status](https://travis-ci.org/jardous/dlt-daemon.svg?branch=master)
 
 ## Overview
+
 This component provides a log and trace interface, based on the
-standardised protocol specified in the AUTOSAR standard 4.0 DLT.  
+standardised protocol specified in the AUTOSAR standard 4.0 DLT.
 This software can be used by GENIVI components and other applications as logging framework.
 
-DLT basically consists of 3 components:  
-- __DLT Library__: Enables DLT logging for DLT user applications and temporary storage of log messages if daemon isn't available.
-- __DLT Daemon__: Receiving log messages from DLT user applications and temporary storage of log messages if client isn't available. Transmit log messages to DLT Client and response to control messages.
-- __DLT Client__: Receiving and storage of log messages from DLT Daemon into one single trace file and sending control message
+DLT basically consists of 3 components:
+
+- **DLT Library**: Enables DLT logging for DLT user applications and temporary storage of log messages if daemon isn't available.
+- **DLT Daemon**: Receiving log messages from DLT user applications and temporary storage of log messages if client isn't available. Transmit log messages to DLT Client and response to control messages.
+- **DLT Client**: Receiving and storage of log messages from DLT Daemon into one single trace file and sending control message
 
 ![alt text](doc/images/dlt_overview.png "DLT Overview")
 
@@ -19,18 +21,18 @@ Furthermore, the repository contains several adaptors, console utilities as well
 ## Build and install
 
 The following packages need to be installed in order to be able to build and install DLT daemon:
-```
+
 - cmake
 - zlib
 - dbus
-```
 
 On Ubuntu those dependencies can be installed with the following command:
-`sudo apt-get install cmake zlib1g-dev libdbus-glib-1-dev`
+
+> sudo apt-get install cmake zlib1g-dev libdbus-glib-1-dev
 
 To build and install the DLT daemon, follow these steps:
 
-```
+```bash
 mkdir build
 cd build
 cmake ..
@@ -42,8 +44,9 @@ optional: sudo ldconfig`
 ### Configuration
 
 #### General Options
- Option | Value | Comment
- :--- | :--- | :---
+
+Option | Value | Comment
+:--- | :--- | :---
 BUILD_SHARED_LIBS | ON | Set to OFF to build static libraries
 DLT_IPC                       |"FIFO"          | Set to either "UNIX_SOCKET" or "FIFO"
 WITH_DLT_USE_IPv6             | ON             | Set to ON for IPv6 support
@@ -53,8 +56,8 @@ WITH_CHECK_CONFIG_FILE        | OFF            | Set to ON to create a configure
 CMAKE_INSTALL_PREFIX          | /usr/local
 CMAKE_BUILD_TYPE              | RelWithDebInfo
 
-
 #### Command Line Tool Options
+
  Option | Value | Comment
  :--- | :--- | :---
 WITH_DLT_ADAPTOR              | OFF             | Set to ON to build src/adaptor binaries
@@ -65,6 +68,7 @@ WITH_DLT_LOGSTORAGE_CTRL_PROP | OFF            | PROTOTYPE! Set to ON to build l
 WITH_DLT_KPI                  | OFF            | Set to ON to build src/kpi binaries
 
 #### Linux OS Integration Options
+
  Option | Value | Comment
  :--- | :--- | :---
 WITH_SYSTEMD                  | OFF            | Set to ON to run CMakeLists.txt in systemd
@@ -73,12 +77,14 @@ WITH_SYSTEMD_JOURNAL          | OFF            | Set to ON to use the systemd jo
 WITH_DLT_DBUS                 | OFF             | Set to ON to build src/dbus binaries
 
 #### Documentation Options
- Option | Value | Comment
+
+Option | Value | Comment
  :--- | :--- | :---
 WITH_DOC                      | OFF            | Set to ON to build documentation target
 WITH_MAN                      | OFF             | Set to OFF to skip building of man pages
 
 #### Test Options
+
 Option | Value | Comment
 :--- | :--- | :---
 WITH_TESTSCRIPTS              | OFF            | Set to ON to run CMakeLists.txt in test scripts
@@ -88,23 +94,25 @@ WITH_DLT_UNIT_TESTS           | OFF             | Set to ON to build unit test b
 WITH_GPROF                    | OFF            | Set \-pg to compile flag
 
 #### Experimental Features Options
+
 Option | Value | Comment
 :--- | :--- | :---
 WITH_DLT_SHM_ENABLE           | OFF            | Set to OFF to use FIFO as IPC from user to daemon
 WITH_DLT_CXX11_EXT            | OFF            | Set to ON to build C++11 extensions
 WITH_DLT_COREDUMPHANDLER      | OFF            | EXPERIMENTAL! Set to ON to build src/core_dump_handler binaries. EXPERIMENTAL
 
-
 In order to change these options, you can modify these values
 with cmake, do the appropriate changes in CmakeList.txt or via
 the commandline for cmake
 
-Change a value with: cmake -D<Variable>=<Value>, E.g.
-```
+Change a value with: cmake -D\<Variable\>=\<Value\>, E.g.
+
+```bash
 cmake .. -DWITH_SYSTEMD=ON -DWITH_SYSTEMD_JOURNAL=ON -DCMAKE_INSTALL_PREFIX=/usr
 ```
 
 ## Documentation
+
 Specific documentation can be found in the following files:
 
 - [ReleaseNotes](ReleaseNotes.md)
@@ -112,19 +120,25 @@ Specific documentation can be found in the following files:
 - [For Developers](doc/dlt_for_developers.md)
 - [Logstorage](doc/dlt_offline_logstorage.md)
 - [MultiNode](doc/dlt_multinode.md)
+- [Extended Network Trace](doc/dlt_extended_network_trace.md)
+- [DLT Filetransfer](doc/dlt_filetransfer.md)
+- [DLT KPI](doc/dlt_kpi.md)
+- [DLT Core Dump Handler](/doc/dlt_cdh.md)
 
 All text based documentation will be replaced with by Markdown-based documentation for convinient access.
 
 Old documentation (not maintained - will be removed in future releases):
+
 - DLT User Manual: doc/dlt_user_manual.txt
 - DLT Cheatsheet: doc/dlt_cheatsheet.txt
 - DLT Design Specification: doc/dlt_design_specification.txt
 - DLT Compilation of all documentation: doc/dlt_book.txt
 
 ### API Documentation
+
 The API documentation is generated with _doxygen_.
 
-```
+```bash
 mkdir build
 cd build
 cmake -DWITH_DOC=ON ..
@@ -132,24 +146,22 @@ make doc
 ```
 
 ### Manpages
-- dlt-daemon(1)
-- dlt.conf(5)
-- dlt-system(1)
-- dlt-system.conf(5)
-- dlt-convert(1)
-- dlt-sortbytimestamp(1)
-- dlt-receive(1)
-- dlt-logstorage-ctrl(1)
-- dlt-dbus (1)      TBD
-- dlt-dbus.conf (5) TBD
-- dlt-cdh (1)       TBD
-- dlt-kpi (1)       TBD
-
-The man pages are generated with _asciidoc_.
+
+- [dlt-daemon(1)](doc/dlt-daemon.1.md)
+- [dlt.conf(5)](doc/dlt.conf.5.md)
+- [dlt-system(1)](doc/dlt-system.1.md)
+- [dlt-system.conf(5)](doc/dlt-system.conf.5.md)
+- [dlt-convert(1)](doc/dlt-convert.1.md)
+- [dlt-sortbytimestamp(1)](doc/dlt-sortbytimestamp.1.md)
+- [dlt-receive(1)](doc/dlt-receive.1.md)
+- [dlt-logstorage-ctrl(1)](doc/dlt-logstorage-ctrl.1.md)
+- [dlt-passive-node-ctrl(1)](doc/dlt-passive-node-ctrl.1.md)
+
+The man pages are generated with *pandoc*.
 
 If the man pages are changed the following command must be executed.
 
-```
+```bash
 mkdir build
 cd build
 cmake -DWITH_DOC=ON ..
@@ -162,7 +174,7 @@ The generated man pages overwrite the existing ones.
 
 Start working, best practice is to commit smaller, compilable pieces during the work that makes it easier to handle later on.
 
-If you want to commit your changes, create a _Pull Request_ in Github.
+If you want to commit your changes, create a [Pull Request](https://github.com/genivi/dlt-daemon/pulls) in Github.
 
 ### Coding Rules
 
@@ -180,20 +192,21 @@ List of open issues can be found on [Github](https://github.com/GENIVI/dlt-daemo
 - For Non linux platforms [eg: QNX] IPC supported is UNIX_SOCKET. For Linux Platforms both IPC FIFO and UNIX_SOCKET are supported
 
 ## Software/Hardware
+
 Developed and tested with Ubuntu Linux 16 64-bit / Intel PC
 
 ## License
+
 Full information on the license for this software is available in the "LICENSE" file.
 Full information on the license for the cityhash code is available in "COPYING" file in src/core_dump_handler/cityhash_c.
 
-## Source Code
-- https://github.com/GENIVI/dlt-daemon
-
 ## Mailinglist
+
 https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace_lists.genivi.org
 
 ## Contact
-Christoph Lipka <clipka@de.adit-jv.com>  
-Manikandan Chockalingam <Manikandan.Chockalingam@in.bosch.com>
 
+Christoph Lipka <clipka@de.adit-jv.com>,
+Manikandan Chockalingam <Manikandan.Chockalingam@in.bosch.com>
 
+![alt text](doc/images/genivilogo.png "GENIVI")
\ No newline at end of file