X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=doc%2Fpulseview.1;h=2d4253d5891647653be205ceb3e95940ffca9bb7;hp=71a03ea47bc2c18d206ca1c2ded2b2ab39022c1e;hb=37134086132e66d102d465a50536c31a32b2cf0c;hpb=1022c445e8c9a1133a8239db1da37bd0f9ed9699 diff --git a/doc/pulseview.1 b/doc/pulseview.1 index 71a03ea4..2d4253d5 100644 --- a/doc/pulseview.1 +++ b/doc/pulseview.1 @@ -1,8 +1,8 @@ -.TH PULSEVIEW 1 "December 16, 2015" +.TH PULSEVIEW 1 "March 30, 2018" .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. +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 " +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, \-\-no\-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 " Load input from a file. If the .B \-\-input\-format @@ -48,6 +63,14 @@ file. .TP .BR "\-I, \-\-input\-format " Specifies the format of the input file to be loaded. +.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. +.TP +.BR "\-s, \-\-log-to-stdout" +Don't log to PulseView's internal log window, but rather to stdout. .SH "KEYBOARD SHORTCUTS" .TP .B "f" @@ -57,17 +80,25 @@ Zoom-to-fit. 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 "b" +Toggle between coloured trace backgrounds and alternating light/dark +gray trace backgrounds. +.TP .B "SPACE" Start / stop an acquisition. .TP -.B "ALT" -Show / hide the menu. -.TP .B "Arrow keys" Scroll up/down/left/right. .TP @@ -93,7 +124,10 @@ Zoom in. Zoom out. .TP .B "CTRL+q" -Quit, i.e. shutdown PulseView. +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.