X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=doc%2Fpulseview.1;h=9663fdf94f3ba5387c66e31d87468b457c15f484;hb=852a25198bc051a57179961cb9d7836212a62184;hp=4068e6f4ead816e7b2e9814f829efb6f4d06b8bc;hpb=051ba3b399abbd83fea8b7ef6f8876884ac0786c;p=pulseview.git

diff --git a/doc/pulseview.1 b/doc/pulseview.1
index 4068e6f4..9663fdf9 100644
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,8 +1,8 @@
-.TH PULSEVIEW 1 "March 4, 2017"
+.TH PULSEVIEW 1 "March 31, 2020"
 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"
-.B pulseview \fR[\fBOPTIONS\fR] [\fBfile.sr\fR]
+.B pulseview \fR[\fBOPTIONS\fR] [\fBFILE\fR]
 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the
@@ -14,8 +14,9 @@ oscilloscopes, MSOs, and more.
 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).
+If the optional \fBFILE\fR argument is supplied, PulseView tries to open
+the specified file. It has to be in the "libsigrok session" format (.sr)
+unless -I is used to specify the input file format.
 .TP
 .B "\-l, \-\-loglevel"
 Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
@@ -40,6 +41,20 @@ Show a help text and exit.
 .B "\-V, \-\-version"
 Show version information and exit.
 .TP
+.BR "\-d, \-\-driver " <drivername>
+Specify the capture device to connect to. If the
+.B \-\-driver
+option is not supplied, PulseView attempts to re-connect to the
+most recently used device, or auto-detect available devices.
+.TP
+.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
+.B \-\-driver
+option to pick a device at startup, or interactively scan for devices
+after PulseView has finished starting up.
+.TP
 .BR "\-i, \-\-input\-file " <filename>
 Load input from a file. If the
 .B \-\-input\-format
@@ -48,23 +63,36 @@ file.
 .TP
 .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
+command line instead of restoring all previously used sessions as well.
 .SH "KEYBOARD SHORTCUTS"
 .TP
 .B "f"
 Zoom-to-fit.
 .TP
-.B "o"
-Zoom 1:1.
-.TP
 .B "s"
-Enable / disable sticky scrolling.
+Enable / disable sticky scrolling. When enabled, the right edge of the screen
+always shows the most recently captured data.
 .TP
 .B "."
 Show / hide sampling points.
 .TP
+.B "g"
+Show / hide analog minor grid (in addition to the vdiv grid).
+.TP
 .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.
@@ -72,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.
@@ -90,11 +130,8 @@ 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).