From b935ec7237060717a2264be366bf932358f2caec Mon Sep 17 00:00:00 2001 From: Saya Sugiura Date: Mon, 1 Jul 2019 11:20:04 +0900 Subject: doc: Create missing markdown documents Following documents are created: - dlt-control.1.md - dlt-adaptor-stdin.1.md - dlt-adaptor-udp.1.md Signed-off-by: Saya Sugiura --- doc/CMakeLists.txt | 31 +++++++-- doc/dlt-adaptor-stdin.1.md | 67 +++++++++++++++++++ doc/dlt-adaptor-udp.1.md | 58 ++++++++++++++++ doc/dlt-control.1.md | 161 +++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 312 insertions(+), 5 deletions(-) create mode 100644 doc/dlt-adaptor-stdin.1.md create mode 100644 doc/dlt-adaptor-udp.1.md create mode 100644 doc/dlt-control.1.md diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 5d39e8d..8008e71 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -87,8 +87,11 @@ if(WITH_MAN) ${MAN_SRC_DIR}/dlt-daemon.1.md ${MAN_SRC_DIR}/dlt-receive.1.md ${MAN_SRC_DIR}/dlt-system.1.md + ${MAN_SRC_DIR}/dlt-control.1.md ${MAN_SRC_DIR}/dlt-logstorage-ctrl.1.md - ${MAN_SRC_DIR}/dlt-passive-node-ctrl.1.md) + ${MAN_SRC_DIR}/dlt-passive-node-ctrl.1.md + ${MAN_SRC_DIR}/dlt-adaptor-stdin.1.md + ${MAN_SRC_DIR}/dlt-adaptor-udp.1.md) set(MAN_SRC ${MAN_SRC_DIR}/dlt.conf.5 @@ -98,8 +101,11 @@ if(WITH_MAN) ${MAN_SRC_DIR}/dlt-daemon.1 ${MAN_SRC_DIR}/dlt-receive.1 ${MAN_SRC_DIR}/dlt-system.1 + ${MAN_SRC_DIR}/dlt-control.1 ${MAN_SRC_DIR}/dlt-logstorage-ctrl.1 - ${MAN_SRC_DIR}/dlt-passive-node-ctrl.1) + ${MAN_SRC_DIR}/dlt-passive-node-ctrl.1 + ${MAN_SRC_DIR}/dlt-adaptor-stdin.1 + ${MAN_SRC_DIR}/dlt-adaptor-udp.1) set(MAN_BUILD_SRC ${MAN_BUILD_DIR}/dlt.conf.5 @@ -109,8 +115,11 @@ if(WITH_MAN) ${MAN_BUILD_DIR}/dlt-daemon.1 ${MAN_BUILD_DIR}/dlt-receive.1 ${MAN_BUILD_DIR}/dlt-system.1 + ${MAN_BUILD_DIR}/dlt-control.1 ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1 - ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1) + ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1 + ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1 + ${MAN_BUILD_DIR}/dlt-adaptor-udp.1) set(MAN_BUILD_GZ ${MAN_BUILD_DIR}/dlt.conf.5.gz @@ -120,8 +129,11 @@ if(WITH_MAN) ${MAN_BUILD_DIR}/dlt-daemon.1.gz ${MAN_BUILD_DIR}/dlt-receive.1.gz ${MAN_BUILD_DIR}/dlt-system.1.gz + ${MAN_BUILD_DIR}/dlt-control.1.gz ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz - ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1.gz) + ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1.gz + ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1.gz + ${MAN_BUILD_DIR}/dlt-adaptor-udp.1.gz) add_custom_target(generate_man ALL COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt.conf.5.md -o ${MAN_BUILD_DIR}/dlt.conf.5 @@ -131,8 +143,11 @@ if(WITH_MAN) COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-daemon.1.md -o ${MAN_BUILD_DIR}/dlt-daemon.1 COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-receive.1.md -o ${MAN_BUILD_DIR}/dlt-receive.1 COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-system.1.md -o ${MAN_BUILD_DIR}/dlt-system.1 + COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-control.1.md -o ${MAN_BUILD_DIR}/dlt-control.1 COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-logstorage-ctrl.1.md -o ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1 COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-passive-node-ctrl.1.md -o ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1 + COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-adaptor-stdin.1.md -o ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1 + COMMAND ${PANDOC_TOOL} -s -t man ${MAN_SRC_DIR}/dlt-adaptor-udp.1.md -o ${MAN_BUILD_DIR}/dlt-adaptor-udp.1 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 @@ -141,8 +156,11 @@ if(WITH_MAN) 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 + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-control.1 > ${MAN_BUILD_DIR}/dlt-system.1.gz COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1 > ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz - COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1 > ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1.gz) + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1 > ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1 > ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1.gz + COMMAND ${GZIP_TOOL} -c ${MAN_BUILD_DIR}/dlt-adaptor-udp.1 > ${MAN_BUILD_DIR}/dlt-adaptor-udp.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) @@ -159,8 +177,11 @@ if(WITH_MAN) ${MAN_BUILD_DIR}/dlt-daemon.1.gz ${MAN_BUILD_DIR}/dlt-receive.1.gz ${MAN_BUILD_DIR}/dlt-system.1.gz + ${MAN_BUILD_DIR}/dlt-control.1.gz ${MAN_BUILD_DIR}/dlt-logstorage-ctrl.1.gz ${MAN_BUILD_DIR}/dlt-passive-node-ctrl.1.gz + ${MAN_BUILD_DIR}/dlt-adaptor-stdin.1.gz + ${MAN_BUILD_DIR}/dlt-adaptor-udp.1.gz DESTINATION ${MAN_INSTALL_DIR}/man1 ) endif(WITH_MAN) diff --git a/doc/dlt-adaptor-stdin.1.md b/doc/dlt-adaptor-stdin.1.md new file mode 100644 index 0000000..9ac6244 --- /dev/null +++ b/doc/dlt-adaptor-stdin.1.md @@ -0,0 +1,67 @@ +% DLT-ADAPTOR-STDIN(1) + +# NAME + +**dlt-adaptor-stdin** - Forward input from stdin to DLT Daemon + +# SYNOPSIS + +**dlt-adaptor-stdin** \[**-a** apid\] \[**-c** ctid\] \[**-b**\] \[**-s**\] \[**-t** timeout\] \[**-h**\] + +# DESCRIPTION + +This is a small external program for forwarding input from stdin to DLT Daemon. + +## OPTIONS + +-a + +: Set application ID to apid (default: SINA) + +-c + +: Set context ID tp ctid (default: SINC) + +-b + +: To flush the buffered logs while unregistering app + +-s + +: Set socket to Blocking mode if unix socket is used + +-t + +: Set timeout when sending messages at exit, in ms (default: 10000 = 10sec) + +-h + +: Show help + +# EXAMPLES + +Forward all dmesg to DLT Daemon without discarding any messages + **dmesg | dlt-adaptor-stdin -b -s** + +Send DBUS messages to DLT Daemon using the program dbus-monitor + **dbus-monitor | dlt-adaptor-stdin** + +# EXIT STATUS + +Non zero is returned in case of failure. + +# AUTHOR + +Saya Sugiura (ssugiura (at) jp.adit-jv (dot) com) + +# COPYRIGHT + +Copyright (C) 2019 Advanced Driver Information Technology, Bosch and DENSO. License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. + +# BUGS + +See Github issue: + +# SEE ALSO + +**dlt-daemon(1)** diff --git a/doc/dlt-adaptor-udp.1.md b/doc/dlt-adaptor-udp.1.md new file mode 100644 index 0000000..5b92eb7 --- /dev/null +++ b/doc/dlt-adaptor-udp.1.md @@ -0,0 +1,58 @@ +% DLT-ADAPTOR-UDP(1) + +# NAME + +**dlt-adaptor-udp** - Forward received UDP messages to DLT Daemon + +# SYNOPSIS + +**dlt-adaptor-udp** \[**-a** apid\] \[**-c** ctid\] \[**-p**\] \[**-h**\] + +# DESCRIPTION + +This is a small external program for forwarding received UDP messages to DLT +Daemon. + +This also can be used for e.g. sending syslog messages to the DLT daemon. +Therefore a syslog daemon called *syslog-ng* is necessary. This syslog daemon +must be configured to send the syslog messages to a specific UDP port. For +configuration of this syslog daemon, see the documentation for *syslog-ng*. +This tools is already integrated into *dlt-system*. + +## OPTIONS + +-a + +: Set application ID to apid (default: UDPA) + +-c + +: Set context ID tp ctid (default: UDPC) + +-p + +: Set receive port number for UDP messages (default: 47111) + +-h + +: Show help + +# EXIT STATUS + +Non zero is returned in case of failure. + +# AUTHOR + +Saya Sugiura (ssugiura (at) jp.adit-jv (dot) com) + +# COPYRIGHT + +Copyright (C) 2019 Advanced Driver Information Technology, Bosch and DENSO. License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. + +# BUGS + +See Github issue: + +# SEE ALSO + +**dlt-daemon(1)** diff --git a/doc/dlt-control.1.md b/doc/dlt-control.1.md new file mode 100644 index 0000000..35d86cf --- /dev/null +++ b/doc/dlt-control.1.md @@ -0,0 +1,161 @@ +% DLT-CONTROL(1) + +# NAME + +**dlt-control** - Send control messages to DLT Daemon + +# SYNOPSIS + +**dlt-control** \[**-v**\] \[**-h**\] \[**-S**\] \[**-R**\] \[**-y**\] \[**-b** baudrate\] \[**-e** ecuid\] \[**-a** id\] \[**-c** id\] \[**-s** id\] \[**-m** message\] \[**-x** message\] \[**-t** milliseconds\] \[**-l** level\] \[**-r** tracestatus\] \[**-d** loglevel\] \[**-f** tracestatus\] \[**-i** enable\] \[**-o**\] \[**-g**\] \[**-j**\] \[**-u**\] hostname/serial\_device\_name + +# DESCRIPTION + +Send control messages to DLT Daemon. +This is useful when there is no client (e.g. DLT Viewer) available. +It supports several control messages including: +- Setting log level/trace level +- Setting default log level/default trace level +- Enable timing packets +- Store configuration +- Reset to factory default +- Get logging information + +**Note** Use -u option instead of hostname/serial\_device\_name if Unix Socket +is used. See example for detail. + +## OPTIONS + +-v + +: Verbose mode + +-h + +: Usage + +-S + +: Send message with serial header (Default: Without serial header) + +-R + +: Enable resync serial header + +-y + +: Serial device mode + +-b + +: Serial device baudrate (Default: 115200) + +-e + +: Set ECU ID (Default: RECV) + +-a + +: Control message application id + +-c + +: Control message context id + +-s + +: Control message injection service id + +-m + +: Control message injection in ASCII + +-x + +: Control message injection in Hex e.g. 'ad 01 24 ef' + +-t + +: Timeout to terminate application (Default:1000) + +-l + + Set the log level (0=off - 6=verbose, default= -1) + supported options: + -l level -a appid -c ctid + -l level -a abc* (set level for all ctxts of apps name starts with abc) + -l level -a appid (set level for all ctxts of this app) + -l level -c xyz* (set level for all ctxts whose name starts with xyz) + -l level -c ctxid (set level for the particular ctxt) + -l level (set level for all the registered contexts) + +-r + +: Set the trace status (0=off - 1=on, default=255) + supported options: + -r tracestatus -a appid -c ctid + -r tracestatus -a abc* (set status for all ctxts of apps name starts with abc) + -r tracestatus -a appid (set status for all ctxts of this app) + -r tracestatus -c xyz* (set status for all ctxts whose name starts with xyz) + -r tracestatus -c ctxid (set status for the particular ctxt) + -r tracestatus (set status for all the registered contexts) + +-d + +: Set the default log level (0=off - 5=verbose) + +-f + +: Set the default trace status (0=off - 1=on) + +-i + +: Enable timing packets (0=off - 1=on) + +-o + +: Store configuration + +-g + +: Reset to factory default + +-j + +: Get log info + +-u +: unix port + +# EXAMPLES + +Change log level of application "APP1" to DEBUG with unix port + **dlt-control -a APP1 -l 5 -u** + +Change log level of application "APP1" and context "CON1" to ERROR + **dlt-control -a APP1 -c CON1 -l 2 localhost** + +Get logging information of current running applications with unix port (IPC: Unix Socket) + **dlt-control -j -u** + +Get logging information of current running applications (IPC:FIFO) + **dlt-control -j localhost** + +# EXIT STATUS + +Non zero is returned in case of failure. + +# AUTHOR + +Saya Sugiura (ssugiura (at) jp.adit-jv (dot) com) + +# COPYRIGHT + +Copyright (C) 2019 Advanced Driver Information Technology, Bosch and DENSO. License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/. + +# BUGS + +See Github issue: + +# SEE ALSO + +**dlt-daemon(1)** -- cgit v1.2.1