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