summaryrefslogtreecommitdiff
path: root/doc/dlt-convert.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/dlt-convert.1.md')
-rw-r--r--doc/dlt-convert.1.md95
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/dlt-convert.1.md b/doc/dlt-convert.1.md
new file mode 100644
index 0000000..c0df353
--- /dev/null
+++ b/doc/dlt-convert.1.md
@@ -0,0 +1,95 @@
+% DLT-CONVERT(1)
+
+# NAME
+
+**dlt-convert** - Convert DLT Logging files into ASCII
+
+# SYNOPSIS
+
+**dlt-convert** \[**-h**\] \[**-a**\] \[**-x**\] \[**-m**\] \[**-s**\] \[**-o** filename\] \[**-v**\] \[**-c**\] \[**-f** filterfile\] \[**-b** number\] \[**-e** number\] \[**-w**\] file1 \[file2\] \[file3\]
+
+# DESCRIPTION
+
+Read DLT files, print DLT messages as ASCII and store the messages again.
+Use Ranges and Output file to cut DLT files.
+Use two files and Output file to join DLT files.
+
+## OPTIONS
+
+-h
+
+: Display a short help text.
+
+-a
+
+: Print DLT file; payload as ASCII.
+
+-x
+
+: Print DLT file; payload as hex.
+
+-m
+
+: Print DLT file; payload as hex and ASCII.
+
+-s
+ Print DLT file; only headers.
+
+-o
+
+: Output messages in new DLT file.
+
+-v
+
+: Verbose mode.
+
+-c
+
+: Count number of messages.
+
+-f
+
+: Enable filtering of messages.
+
+-b
+
+: First messages to be handled.
+
+-e
+
+: Last message to be handled.
+
+-w
+
+: Follow dlt file while file is increasing.
+
+# EXAMPLES
+
+Convert DLT file into ASCII:
+ **dlt-convert -a mylog.dlt**
+
+Cut a specific range, e.g. from message 1 to message 3 from a file called log.dlt and store the result to a file called newlog.dlt:
+ **dlt-convert -b 1 -e 3 -o newlog.dlt log.dlt**
+
+Paste two dlt files log1.dlt and log2.dlt to a new file called newlog.dlt::
+ **dlt-convert -o newlog.dlt log1.dlt log2.dlt**
+
+# EXIT STATUS
+
+Non zero is returned in case of failure.
+
+# AUTHOR
+
+Alexander Wenzel (alexander.aw.wenzel (at) bmw (dot) de)
+
+# COPYRIGHT
+
+Copyright (C) 2015 BMW AG. 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)**