Session: Fix issue #67 by improving error handling

[pulseview.git] / doc / pulseview.1

diff --git a/doc/pulseview.1 b/doc/pulseview.1
index 834247b7022677b1057f2c6c71a7fa2ea56afdee..749f6daba85c696ac3790bc685228388804d654a 100644 (file)
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,4 +1,4 @@
-.TH PULSEVIEW 1 "March 30, 2018"
+.TH PULSEVIEW 1 "March 31, 2020"
 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"
@@ -47,7 +47,7 @@ Specify the capture device to connect to. If the
 option is not supplied, PulseView attempts to re-connect to the
 most recently used device, or auto-detect available devices.
 .TP
-.BR "\-D, \-\-no\-scan "
+.BR "\-D, \-\-dont\-scan "
 Usually PulseView automatically scans all drivers to find suitable
 devices during program startup. This option disables the auto-scan.
 Users can either specify the
@@ -64,6 +64,10 @@ file.
 .BR "\-I, \-\-input\-format " <format>
 Specifies the format of the input file to be loaded.
 .TP
+.BR "\-s, \-\-settings " <filename>
+Load PulseView session setup to use with the input file. The setup file must be
+in the "PulseView session setup" format (.pvs).
+.TP
 .BR "\-c, \-\-clean"
 Prevents the previously used sessions to be restored from settings storage.
 This is useful if you want only a single session with the file given on the
@@ -73,9 +77,6 @@ command line instead of restoring all previously used sessions as well.
 .B "f"
 Zoom-to-fit.
 .TP
-.B "o"
-Zoom 1:1.
-.TP
 .B "s"
 Enable / disable sticky scrolling. When enabled, the right edge of the screen
 always shows the most recently captured data.
@@ -89,6 +90,9 @@ Show / hide analog minor grid (in addition to the vdiv grid).
 .B "c"
 Show / hide cursors.
 .TP
+.B "d"
+Show / hide protocol decoder selector.
+.TP
 .B "b"
 Toggle between coloured trace backgrounds and alternating light/dark
 gray trace backgrounds.
@@ -96,8 +100,20 @@ gray trace backgrounds.
 .B "SPACE"
 Start / stop an acquisition.
 .TP
-.B "Arrow keys"
-Scroll up/down/left/right.
+.B "Left/right arrow keys"
+Scroll left/right.
+.TP
+.B "+/-"
+Zoom in/out.
+.TP
+.B "Up/down arrow keys"
+Zoom in/out.
+.TP
+.B "Home/End"
+Jump to the start/end of the sample data.
+.TP
+.B "1/2"
+Attach left/right side of the cursors to the mouse.
 .TP
 .B "CTRL+o"
 Open file.
@@ -114,17 +130,17 @@ Group all currently selected traces into a trace group.
 .B "CTRL+u"
 Ungroup the traces in the currently selected trace group.
 .TP
-.B "CTRL++"
-Zoom in.
-.TP
-.B "CTRL+-"
-Zoom out.
+.B "CTRL+up/down arrow keys"
+Scroll down/up.
 .TP
 .B "CTRL+q"
 Quit, i.e. shutdown PulseView (closing all session tabs).
 .TP
 .B "CTRL+w"
 Close the current session tab.
+.TP
+.B "SHIFT+mouse wheel"
+Scroll horizontally instead of zooming in/out.
 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.