aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Schink <swo-dev@marcschink.de>2014-12-26 12:43:20 +0100
committerMarc Schink <swo-dev@marcschink.de>2015-05-05 22:19:27 +0200
commitb07364db0eb9c830cab29f3f2f34aa08514139c5 (patch)
treec9b85412a8ef2da59f38ff2c22ef5ed73b6af2cf
parent4049acdec4e205fb539595b2bcc77a1da5ed084d (diff)
Add initial man page.
-rw-r--r--Makefile.am2
-rw-r--r--man/swodec.199
2 files changed, 101 insertions, 0 deletions
diff --git a/Makefile.am b/Makefile.am
index 15aaf41..950529e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -19,3 +19,5 @@
ACLOCAL_AMFLAGS = -I m4
SUBDIRS = src
+
+dist_man_MANS = man/swodec.1
diff --git a/man/swodec.1 b/man/swodec.1
new file mode 100644
index 0000000..5fdf03c
--- /dev/null
+++ b/man/swodec.1
@@ -0,0 +1,99 @@
+.TH swodec 1 "May 05, 2015"
+.SH NAME
+swodec \- decode SWO trace data
+
+.SH SYNOPSIS
+.B swodec [OPTIONS]
+
+.SH DESCRIPTION
+.B swodec
+is a command-line utility to decode SWO trace data.
+
+.SH OPTIONS
+.TP
+.B \-h, \-\-help
+Show a help text and exit.
+
+.TP
+.BR "\-i, \-\-input\-file " <filename>
+Load trace data from a file instead of using standard input.
+
+.TP
+.BR "\-f, \-\-filter " <list>
+A comma-separated list of packet types to filter for. The following packet types
+are available:
+
+.RS
+.RS
+.TP
+.B sync
+Synchronization
+.TP
+.B of
+Overflow
+.TP
+.B lts
+Local timestamp
+.TP
+.B gts
+Global timestamp. This is a shortcut for \fBgts1\fP and \fBgts2\fP.
+.TP
+.B gts1
+Global timestamp (GTS1)
+.TP
+.B gts2
+Global timestamp (GTS2)
+.TP
+.B ext
+Extension
+.TP
+.B inst
+Instrumentation
+.TP
+.B hw
+Hardware source
+.TP
+.B unknown
+Unknown data
+.RE
+.RE
+
+.RS
+If a tilde (~) precedes the list the machting sense is inverted.
+.RE
+
+.TP
+.BR "\-\-filter-inst " <list>
+A comma-separated list of instrumentation source addresses to filter for. If a
+tilde (~) precedes the list the machting sense is inverted. Each address must be
+in the range from \fB0\fP to \fB31\fP.
+
+.TP
+.B \-\-dump-inst
+Dump the payload of instrumentation packets. All other packet types are filtered
+out.
+
+.TP
+.B \-\-dwt
+Decode hardware source packets as Data Watchpoint and Trace (DWT) packets.
+
+.SH EXAMPLES
+
+In order to decode trace data from a file (e.g. trace.bin), run the following
+command:
+
+.RB " $ " "swodec \-\-input\-file trace.bin"
+
+If you want to filter for instrumentation and hardware source packets only, use:
+
+.RB " $ " "swodec \-\-input-file trace.bin \-\-filter inst,hw"
+
+To decode hardware source packets as Data Watchpoint and Trace (DWT) packets,
+apply the \fB\-\-dwt\fP option:
+
+.RB " $ " "swodec \-\-input-file trace.bin \-\-filter inst,hw \-\-dwt"
+
+If you are interested in all packets except for unknown data and
+synchronization, the simplest way is to invert the sense of matching:
+
+.RB " $ " "swodec \-\-input-file trace.bin \-\-filter ~unknown,sync \-\-dwt"