summaryrefslogtreecommitdiff
path: root/doc/dlt-adaptor-stdin.1.md
diff options
context:
space:
mode:
authorSaya Sugiura <ssugiura@jp.adit-jv.com>2019-07-01 11:20:04 +0900
committerSaya Sugiura <39760799+ssugiura@users.noreply.github.com>2019-07-19 14:46:29 +0900
commitb935ec7237060717a2264be366bf932358f2caec (patch)
tree1b3fba92c08b39977c9b583be9ac00ab35afbd6a /doc/dlt-adaptor-stdin.1.md
parent5de77ee6df44b219a086051d9f2faa46d724192a (diff)
downloadDLT-daemon-b935ec7237060717a2264be366bf932358f2caec.tar.gz
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 <ssugiura@jp.adit-jv.com>
Diffstat (limited to 'doc/dlt-adaptor-stdin.1.md')
-rw-r--r--doc/dlt-adaptor-stdin.1.md67
1 files changed, 67 insertions, 0 deletions
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: <https://github.com/GENIVI/dlt-daemon/issues>
+
+# SEE ALSO
+
+**dlt-daemon(1)**