X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=doc%2Fpulseview.1;h=936fe8ac6d453384a96c1dedbea1a9f3d75e3174;hp=b830f08cdae9f01104f539da497046876d4fa9fa;hb=63ebd7fe196b3418f1a06e73642aa964cacbed93;hpb=6ce79e397fcfde29d34fef651a14c9e7ce99cb06 diff --git a/doc/pulseview.1 b/doc/pulseview.1 index b830f08c..936fe8ac 100644 --- a/doc/pulseview.1 +++ b/doc/pulseview.1 @@ -1,8 +1,8 @@ -.TH PULSEVIEW 1 "May 4, 2013" +.TH PULSEVIEW 1 "March 4, 2017" .SH "NAME" PulseView \- Qt-based LA/scope/MSO GUI for sigrok .SH "SYNOPSIS" -.B pulseview \fR[\fB\-lh?V\fR] [\fB\-l\fR|\fB\-\-loglevel\fR] [\fB\-h\fR|\fB\-?\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fBfile.sr\fR] +.B pulseview \fR[\fBOPTIONS\fR] [\fBfile.sr\fR] .SH "DESCRIPTION" .B PulseView is a cross-platform Qt-based GUI for the @@ -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 -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 @@ -39,6 +39,71 @@ Show a help text and exit. .TP .B "\-V, \-\-version" Show version information and exit. +.TP +.BR "\-i, \-\-input\-file " +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 " +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 "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 "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.