]> sigrok.org Git - pulseview.git/blame_incremental - doc/pulseview.1
manpage: Document all keyboard shortcuts.
[pulseview.git] / doc / pulseview.1
... / ...
CommitLineData
1.TH PULSEVIEW 1 "December 16, 2015"
2.SH "NAME"
3PulseView \- 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
8is a cross-platform Qt-based GUI for the
9.B sigrok
10software suite for test and measurement equipment such as logic analyzers,
11oscilloscopes, MSOs, and more.
12.SH "OPTIONS"
13.B PulseView
14has very few command line options, as most configuration elements are
15available from the GUI itself.
16.sp
17If the optional \fBfile.sr\fR argument is supplied, PulseView tries to open
18the specified file. It has to be in the "libsigrok session" format.
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
36.TP
37.B "\-h, \-?, \-\-help"
38Show a help text and exit.
39.TP
40.B "\-V, \-\-version"
41Show version information and exit.
42.TP
43.BR "\-i, \-\-input\-file " <filename>
44Load input from a file. If the
45.B \-\-input\-format
46option is not supplied, PulseView attempts to load the file as a sigrok session
47file.
48.TP
49.BR "\-I, \-\-input\-format " <format>
50Specifies the format of the input file to be loaded.
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
62.B "c"
63Show / hide cursors.
64.TP
65.B "SPACE"
66Start / stop an acquisition.
67.TP
68.B "ALT"
69Show / hide the menu.
70.TP
71.B "Arrow keys"
72Scroll up/down/left/right.
73.TP
74.B "CTRL+o"
75Open file.
76.TP
77.B "CTRL+s"
78Save as...
79.TP
80.B "CTRL+r"
81Save selected range as...
82.TP
83.B "CTRL+g"
84Group all currently selected traces into a trace group.
85.TP
86.B "CTRL+u"
87Ungroup the traces in the currently selected trace group.
88.TP
89.B "CTRL++"
90Zoom in.
91.TP
92.B "CTRL+-"
93Zoom out.
94.TP
95.B "CTRL+q"
96Quit, i.e. shutdown PulseView.
97.SH "EXIT STATUS"
98.B PulseView
99exits with 0 on success, 1 on most failures.
100.SH "SEE ALSO"
101\fBsigrok\-cli\fP(1)
102.SH "BUGS"
103Please report any bugs via Bugzilla
104.RB "(" http://sigrok.org/bugzilla ")"
105or on the sigrok\-devel mailing list
106.RB "(" sigrok\-devel@lists.souceforge.net ")."
107.SH "LICENSE"
108.B PulseView
109is covered by the GNU General Public License (GPL), version 3 or later.
110.SH "AUTHORS"
111Please see the individual source code files.
112.PP
113This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
114It is licensed under the terms of the GNU GPL (version 2 or later).