]> sigrok.org Git - pulseview.git/blame - doc/pulseview.1
Tests: Add required files to CMakeLists.txt
[pulseview.git] / doc / pulseview.1
CommitLineData
6ce79e39 1.TH PULSEVIEW 1 "May 4, 2013"
94236aa4 2.SH "NAME"
e65ff35e 3PulseView \- Qt-based LA/scope/MSO GUI for sigrok
94236aa4 4.SH "SYNOPSIS"
6ce79e39 5.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]
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
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
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
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.
94236aa4
UH
51.SH "EXIT STATUS"
52.B PulseView
53exits with 0 on success, 1 on most failures.
54.SH "SEE ALSO"
e65ff35e 55\fBsigrok\-cli\fP(1)
94236aa4 56.SH "BUGS"
e65ff35e
UH
57Please report any bugs via Bugzilla
58.RB "(" http://sigrok.org/bugzilla ")"
59or on the sigrok\-devel mailing list
94236aa4
UH
60.RB "(" sigrok\-devel@lists.souceforge.net ")."
61.SH "LICENSE"
62.B PulseView
0ec7aba5 63is covered by the GNU General Public License (GPL), version 3 or later.
94236aa4
UH
64.SH "AUTHORS"
65Please see the individual source code files.
66.PP
67This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
68It is licensed under the terms of the GNU GPL (version 2 or later).