]> sigrok.org Git - pulseview.git/blame - doc/pulseview.1
LogicSegment: Remove constructor requiring sigrok::Logic
[pulseview.git] / doc / pulseview.1
CommitLineData
78e14473 1.TH PULSEVIEW 1 "March 4, 2017"
94236aa4 2.SH "NAME"
e65ff35e 3PulseView \- Qt-based LA/scope/MSO GUI for sigrok
94236aa4 4.SH "SYNOPSIS"
228a5480 5.B pulseview \fR[\fBOPTIONS\fR] [\fBfile.sr\fR]
94236aa4
UH
6.SH "DESCRIPTION"
7.B PulseView
8is a cross-platform Qt-based GUI for the
9.B sigrok
10software suite for test and measurement equipment such as logic analyzers,
e65ff35e 11oscilloscopes, MSOs, and more.
94236aa4
UH
12.SH "OPTIONS"
13.B PulseView
14has very few command line options, as most configuration elements are
15available from the GUI itself.
6ce79e39
UH
16.sp
17If the optional \fBfile.sr\fR argument is supplied, PulseView tries to open
3d2d008e 18the specified file. It has to be in the "libsigrok session" format (.sr).
6ce79e39
UH
19.TP
20.B "\-l, \-\-loglevel"
21Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
22doesn't support setting the two loglevels independently. The higher the
23number, 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
94236aa4
UH
36.TP
37.B "\-h, \-?, \-\-help"
38Show a help text and exit.
39.TP
40.B "\-V, \-\-version"
41Show version information and exit.
e3c79b07
JH
42.TP
43.BR "\-i, \-\-input\-file " <filename>
44Load input from a file. If the
45.B \-\-input\-format
228a5480 46option is not supplied, PulseView attempts to load the file as a sigrok session
e3c79b07
JH
47file.
48.TP
49.BR "\-I, \-\-input\-format " <format>
50Specifies the format of the input file to be loaded.
1022c445
UH
51.SH "KEYBOARD SHORTCUTS"
52.TP
53.B "f"
54Zoom-to-fit.
55.TP
56.B "o"
57Zoom 1:1.
58.TP
59.B "s"
60Enable / disable sticky scrolling.
61.TP
051ba3b3
UH
62.B "."
63Show / hide sampling points.
64.TP
1022c445
UH
65.B "c"
66Show / hide cursors.
67.TP
c281fdc6
UH
68.B "b"
69Toggle between coloured trace backgrounds and alternating light/dark
70gray trace backgrounds.
71.TP
1022c445
UH
72.B "SPACE"
73Start / stop an acquisition.
74.TP
1022c445
UH
75.B "Arrow keys"
76Scroll up/down/left/right.
77.TP
78.B "CTRL+o"
79Open file.
80.TP
81.B "CTRL+s"
82Save as...
83.TP
84.B "CTRL+r"
85Save selected range as...
86.TP
87.B "CTRL+g"
88Group all currently selected traces into a trace group.
89.TP
90.B "CTRL+u"
91Ungroup the traces in the currently selected trace group.
92.TP
93.B "CTRL++"
94Zoom in.
95.TP
96.B "CTRL+-"
97Zoom out.
98.TP
99.B "CTRL+q"
78e14473
UH
100Quit, i.e. shutdown PulseView (closing all session tabs).
101.TP
102.B "CTRL+w"
103Close the current session tab.
94236aa4
UH
104.SH "EXIT STATUS"
105.B PulseView
106exits with 0 on success, 1 on most failures.
107.SH "SEE ALSO"
e65ff35e 108\fBsigrok\-cli\fP(1)
94236aa4 109.SH "BUGS"
e65ff35e
UH
110Please report any bugs via Bugzilla
111.RB "(" http://sigrok.org/bugzilla ")"
112or on the sigrok\-devel mailing list
94236aa4
UH
113.RB "(" sigrok\-devel@lists.souceforge.net ")."
114.SH "LICENSE"
115.B PulseView
0ec7aba5 116is covered by the GNU General Public License (GPL), version 3 or later.
94236aa4
UH
117.SH "AUTHORS"
118Please see the individual source code files.
119.PP
120This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
121It is licensed under the terms of the GNU GPL (version 2 or later).