Add a tooltip for the "Show/hide decoder trace" icon.

[pulseview.git] / doc / pulseview.1

diff --git a/doc/pulseview.1 b/doc/pulseview.1
index 83e2f5bbcfb999d4bd31214aced3746fd4f02059..4068e6f4ead816e7b2e9814f829efb6f4d06b8bc 100644 (file)
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,8 +1,8 @@
-.TH PULSEVIEW 1 "May 1, 2013"
+.TH PULSEVIEW 1 "March 4, 2017"

 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"
 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"

-.B pulseview \fR[\fB\-h?V\fR] [\fB\-h\fR|\fB\-?\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
+.B pulseview \fR[\fBOPTIONS\fR] [\fBfile.sr\fR]

 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the
 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the


@@ -13,12 +13,94 @@ oscilloscopes, MSOs, and more.
 .B PulseView
 has very few command line options, as most configuration elements are
 available from the GUI itself.
 .B PulseView
 has very few command line options, as most configuration elements are
 available from the GUI itself.

+.sp
+If the optional \fBfile.sr\fR argument is supplied, PulseView tries to open
+the specified file. It has to be in the "libsigrok session" format (.sr).
+.TP
+.B "\-l, \-\-loglevel"
+Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
+doesn't support setting the two loglevels independently. The higher the
+number, the more debug output will be printed. Valid loglevels are:
+.sp
+\fB0\fP   None
+.br
+\fB1\fP   Error
+.br
+\fB2\fP   Warnings
+.br
+\fB3\fP   Informational
+.br
+\fB4\fP   Debug
+.br
+\fB5\fP   Spew

 .TP
 .B "\-h, \-?, \-\-help"
 Show a help text and exit.
 .TP
 .B "\-V, \-\-version"
 Show version information and exit.
 .TP
 .B "\-h, \-?, \-\-help"
 Show a help text and exit.
 .TP
 .B "\-V, \-\-version"
 Show version information and exit.

+.TP
+.BR "\-i, \-\-input\-file " <filename>
+Load input from a file. If the
+.B \-\-input\-format
+option is not supplied, PulseView attempts to load the file as a sigrok session
+file.
+.TP
+.BR "\-I, \-\-input\-format " <format>
+Specifies the format of the input file to be loaded.
+.SH "KEYBOARD SHORTCUTS"
+.TP
+.B "f"
+Zoom-to-fit.
+.TP
+.B "o"
+Zoom 1:1.
+.TP
+.B "s"
+Enable / disable sticky scrolling.
+.TP
+.B "."
+Show / hide sampling points.
+.TP
+.B "c"
+Show / hide cursors.
+.TP
+.B "b"
+Toggle between coloured trace backgrounds and alternating light/dark
+gray trace backgrounds.
+.TP
+.B "SPACE"
+Start / stop an acquisition.
+.TP
+.B "Arrow keys"
+Scroll up/down/left/right.
+.TP
+.B "CTRL+o"
+Open file.
+.TP
+.B "CTRL+s"
+Save as...
+.TP
+.B "CTRL+r"
+Save selected range as...
+.TP
+.B "CTRL+g"
+Group all currently selected traces into a trace group.
+.TP
+.B "CTRL+u"
+Ungroup the traces in the currently selected trace group.
+.TP
+.B "CTRL++"
+Zoom in.
+.TP
+.B "CTRL+-"
+Zoom out.
+.TP
+.B "CTRL+q"
+Quit, i.e. shutdown PulseView (closing all session tabs).
+.TP
+.B "CTRL+w"
+Close the current session tab.

 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.
 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.