summaryrefslogtreecommitdiff
path: root/doc/dlt-logstorage-ctrl.1.md
diff options
context:
space:
mode:
authorChristoph Lipka <clipka@users.noreply.github.com>2019-02-12 10:32:13 +0100
committerGitHub <noreply@github.com>2019-02-12 10:32:13 +0100
commit1713e3913722d1222c968ca53326865d23a2b0ab (patch)
tree477489d98c7694fd8937debadb2fcf61b2f7fa3e /doc/dlt-logstorage-ctrl.1.md
parent4c4cc967ad46abae60f2f9bf5e47b65e8bcbb4b1 (diff)
downloadDLT-daemon-1713e3913722d1222c968ca53326865d23a2b0ab.tar.gz
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.
Diffstat (limited to 'doc/dlt-logstorage-ctrl.1.md')
-rw-r--r--doc/dlt-logstorage-ctrl.1.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/dlt-logstorage-ctrl.1.md b/doc/dlt-logstorage-ctrl.1.md
new file mode 100644
index 0000000..1e80fb8
--- /dev/null
+++ b/doc/dlt-logstorage-ctrl.1.md
@@ -0,0 +1,70 @@
+% DLT-LOGSTORAGE-CTRL(1)
+
+# NAME
+
+**dlt-logstorage-ctrl** - Trigger DLT Daemon to start/stop using an offline logstorage device
+
+# SYNOPSIS
+
+**dlt-logstorage-ctrl** \[**-h**\] \[**-c** ctype\] \[**-p** path\] \[**-e** ecu\] \[**-p\<prop\>**\] \[**-t** timeout\] \[**-v**\]
+
+# DESCRIPTION
+
+Send a trigger to DLT Daemon to connect/disconnect a certain offline logstorage device
+
+# OPTIONS
+
+-h
+
+: Display a short help text.
+
+-c
+
+: Specify connection type: connect = 1, disconnect = 0.
+
+-d
+
+: Run as daemon: prop = use proprietary handler
+
+-p
+
+: Mount point path.
+
+-e
+
+: Specify the ECU ID. Default is: ECU1.
+
+-t
+
+: Specify connection timeout. Default is: 10s.
+
+# EXAMPLES
+
+Activate the offline logstorage device mounted on /mnt/dltlog
+ **dlt-logstorage-ctrl -c 1 -p /mnt/dltlog**
+
+Deactivate the offline logstorage device mounted on /mnt/dltlog
+ **dlt-logstorage-ctrl -c 0 -p /mnt/dltlog**
+
+Run logstorage control application as daemon listen to udev events
+ **dlt-logstorage-ctrl -d**
+
+# EXIT STATUS
+
+Non zero is returned in case of failure.
+
+# AUTHOR
+
+Christoph Lipka (clipka (at) jp.adit-jv (dot) com), Syed Hameed (shameed (at) jp.adit-jv (dot) com)
+
+# COPYRIGHT
+
+Copyright (C) 2015 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)**