Settings: About: alpha-sort list of protocol decoders
[pulseview.git] / doc / pulseview.1
1 .TH PULSEVIEW 1 "March 4, 2017"
2 .SH "NAME"
3 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
4 .SH "SYNOPSIS"
5 .B pulseview \fR[\fBOPTIONS\fR] [\fBfile.sr\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.sr\fR argument is supplied, PulseView tries to open
18 the specified file. It has to be in the "libsigrok session" format (.sr).
19 .TP
20 .B "\-l, \-\-loglevel"
21 Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
22 doesn't support setting the two loglevels independently. The higher the
23 number, the more debug output will be printed. Valid loglevels are:
24 .sp
25 \fB0\fP   None
26 .br
27 \fB1\fP   Error
28 .br
29 \fB2\fP   Warnings
30 .br
31 \fB3\fP   Informational
32 .br
33 \fB4\fP   Debug
34 .br
35 \fB5\fP   Spew
36 .TP
37 .B "\-h, \-?, \-\-help"
38 Show a help text and exit.
39 .TP
40 .B "\-V, \-\-version"
41 Show version information and exit.
42 .TP
43 .BR "\-i, \-\-input\-file " <filename>
44 Load input from a file. If the
45 .B \-\-input\-format
46 option is not supplied, PulseView attempts to load the file as a sigrok session
47 file.
48 .TP
49 .BR "\-I, \-\-input\-format " <format>
50 Specifies the format of the input file to be loaded.
51 .SH "KEYBOARD SHORTCUTS"
52 .TP
53 .B "f"
54 Zoom-to-fit.
55 .TP
56 .B "o"
57 Zoom 1:1.
58 .TP
59 .B "s"
60 Enable / disable sticky scrolling.
61 .TP
62 .B "."
63 Show / hide sampling points.
64 .TP
65 .B "g"
66 Show / hide analog minor grid (in addition to the vdiv grid).
67 .TP
68 .B "c"
69 Show / hide cursors.
70 .TP
71 .B "b"
72 Toggle between coloured trace backgrounds and alternating light/dark
73 gray trace backgrounds.
74 .TP
75 .B "SPACE"
76 Start / stop an acquisition.
77 .TP
78 .B "Arrow keys"
79 Scroll up/down/left/right.
80 .TP
81 .B "CTRL+o"
82 Open file.
83 .TP
84 .B "CTRL+s"
85 Save as...
86 .TP
87 .B "CTRL+r"
88 Save selected range as...
89 .TP
90 .B "CTRL+g"
91 Group all currently selected traces into a trace group.
92 .TP
93 .B "CTRL+u"
94 Ungroup the traces in the currently selected trace group.
95 .TP
96 .B "CTRL++"
97 Zoom in.
98 .TP
99 .B "CTRL+-"
100 Zoom out.
101 .TP
102 .B "CTRL+q"
103 Quit, i.e. shutdown PulseView (closing all session tabs).
104 .TP
105 .B "CTRL+w"
106 Close the current session tab.
107 .SH "EXIT STATUS"
108 .B PulseView
109 exits with 0 on success, 1 on most failures.
110 .SH "SEE ALSO"
111 \fBsigrok\-cli\fP(1)
112 .SH "BUGS"
113 Please report any bugs via Bugzilla
114 .RB "(" http://sigrok.org/bugzilla ")"
115 or on the sigrok\-devel mailing list
116 .RB "(" sigrok\-devel@lists.souceforge.net ")."
117 .SH "LICENSE"
118 .B PulseView
119 is covered by the GNU General Public License (GPL), version 3 or later.
120 .SH "AUTHORS"
121 Please see the individual source code files.
122 .PP
123 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
124 It is licensed under the terms of the GNU GPL (version 2 or later).