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 7f7ecfd0e59a58389527cbafd033241f020a36e2..4068e6f4ead816e7b2e9814f829efb6f4d06b8bc 100644 (file)
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,4 +1,4 @@
-.TH PULSEVIEW 1 "December 16, 2015"
+.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"


@@ -15,7 +15,7 @@ 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
 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.
+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
 .TP
 .B "\-l, \-\-loglevel"
 Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView


@@ -48,6 +48,59 @@ file.
 .TP
 .BR "\-I, \-\-input\-format " <format>
 Specifies the format of the input file to be loaded.
 .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.