doc/pulseview.1

   1 .TH PULSEVIEW 1 "June 6, 2017"
   2 .SH "NAME"
   3 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
   4 .SH "SYNOPSIS"
   5 .B pulseview \fR[\fBOPTIONS\fR] [\fBFILE\fR]
   6 .SH "DESCRIPTION"
   7 .B PulseView
   8 is a cross-platform Qt-based GUI for the
   9 .B sigrok
  10 software suite for test and measurement equipment such as logic analyzers,
  11 oscilloscopes, MSOs, and more.
  12 .SH "OPTIONS"
  13 .B PulseView
  14 has very few command line options, as most configuration elements are
  15 available from the GUI itself.
  16 .sp
  17 If the optional \fBFILE\fR argument is supplied, PulseView tries to open
  18 the specified file. It has to be in the "libsigrok session" format (.sr)
  19 unless -I is used to specify the input file format.
  20 .TP
  21 .B "\-l, \-\-loglevel"
  22 Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
  23 doesn't support setting the two loglevels independently. The higher the
  24 number, the more debug output will be printed. Valid loglevels are:
  25 .sp
  26 \fB0\fP   None
  27 .br
  28 \fB1\fP   Error
  29 .br
  30 \fB2\fP   Warnings
  31 .br
  32 \fB3\fP   Informational
  33 .br
  34 \fB4\fP   Debug
  35 .br
  36 \fB5\fP   Spew
  37 .TP
  38 .B "\-h, \-?, \-\-help"
  39 Show a help text and exit.
  40 .TP
  41 .B "\-V, \-\-version"
  42 Show version information and exit.
  43 .TP
  44 .BR "\-d, \-\-driver " <drivername>
  45 Specify the capture device to connect to. If the
  46 .B \-\-driver
  47 option is not supplied, PulseView attempts to re-connect to the
  48 most recently used device, or auto-detect available devices.
  49 .TP
  50 .BR "\-i, \-\-input\-file " <filename>
  51 Load input from a file. If the
  52 .B \-\-input\-format
  53 option is not supplied, PulseView attempts to load the file as a sigrok session
  54 file.
  55 .TP
  56 .BR "\-I, \-\-input\-format " <format>
  57 Specifies the format of the input file to be loaded.
  58 .TP
  59 .BR "\-c, \-\-clean"
  60 Prevents the previously used sessions to be restored from settings storage.
  61 This is useful if you want only a single session with the file given on the
  62 command line instead of restoring all previously used sessions as well.
  63 .SH "KEYBOARD SHORTCUTS"
  64 .TP
  65 .B "f"
  66 Zoom-to-fit.
  67 .TP
  68 .B "o"
  69 Zoom 1:1.
  70 .TP
  71 .B "s"
  72 Enable / disable sticky scrolling. When enabled, the right edge of the screen
  73 always shows the most recently captured data.
  74 .TP
  75 .B "."
  76 Show / hide sampling points.
  77 .TP
  78 .B "g"
  79 Show / hide analog minor grid (in addition to the vdiv grid).
  80 .TP
  81 .B "c"
  82 Show / hide cursors.
  83 .TP
  84 .B "b"
  85 Toggle between coloured trace backgrounds and alternating light/dark
  86 gray trace backgrounds.
  87 .TP
  88 .B "SPACE"
  89 Start / stop an acquisition.
  90 .TP
  91 .B "Arrow keys"
  92 Scroll up/down/left/right.
  93 .TP
  94 .B "CTRL+o"
  95 Open file.
  96 .TP
  97 .B "CTRL+s"
  98 Save as...
  99 .TP
 100 .B "CTRL+r"
 101 Save selected range as...
 102 .TP
 103 .B "CTRL+g"
 104 Group all currently selected traces into a trace group.
 105 .TP
 106 .B "CTRL+u"
 107 Ungroup the traces in the currently selected trace group.
 108 .TP
 109 .B "CTRL++"
 110 Zoom in.
 111 .TP
 112 .B "CTRL+-"
 113 Zoom out.
 114 .TP
 115 .B "CTRL+q"
 116 Quit, i.e. shutdown PulseView (closing all session tabs).
 117 .TP
 118 .B "CTRL+w"
 119 Close the current session tab.
 120 .SH "EXIT STATUS"
 121 .B PulseView
 122 exits with 0 on success, 1 on most failures.
 123 .SH "SEE ALSO"
 124 \fBsigrok\-cli\fP(1)
 125 .SH "BUGS"
 126 Please report any bugs via Bugzilla
 127 .RB "(" http://sigrok.org/bugzilla ")"
 128 or on the sigrok\-devel mailing list
 129 .RB "(" sigrok\-devel@lists.souceforge.net ")."
 130 .SH "LICENSE"
 131 .B PulseView
 132 is covered by the GNU General Public License (GPL), version 3 or later.
 133 .SH "AUTHORS"
 134 Please see the individual source code files.
 135 .PP
 136 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
 137 It is licensed under the terms of the GNU GPL (version 2 or later).