Add a spin box widget for timestamp values

[pulseview.git] / doc / pulseview.1

diff --git a/doc/pulseview.1 b/doc/pulseview.1
index 83e2f5bbcfb999d4bd31214aced3746fd4f02059..4b103f79fc689e5b4c7bcf104d05f1726212606d 100644 (file)
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,8 +1,8 @@
-.TH PULSEVIEW 1 "May 1, 2013"
+.TH PULSEVIEW 1 "May 4, 2013"

 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"
 .SH "NAME"
 PulseView \- Qt-based LA/scope/MSO GUI for sigrok
 .SH "SYNOPSIS"

-.B pulseview \fR[\fB\-h?V\fR] [\fB\-h\fR|\fB\-?\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR]
+.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]

 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the
 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the


@@ -13,12 +13,41 @@ oscilloscopes, MSOs, and more.
 .B PulseView
 has very few command line options, as most configuration elements are
 available from the GUI itself.
 .B PulseView
 has very few command line options, as most configuration elements are
 available from the GUI itself.

+.sp
+If the optional \fBfile.sr\fR argument is supplied, PulseView tries to open
+the specified file. It has to be in the "libsigrok session" format.
+.TP
+.B "\-l, \-\-loglevel"
+Set the libsigrok and libsigrokdecode loglevel. At the moment PulseView
+doesn't support setting the two loglevels independently. The higher the
+number, the more debug output will be printed. Valid loglevels are:
+.sp
+\fB0\fP   None
+.br
+\fB1\fP   Error
+.br
+\fB2\fP   Warnings
+.br
+\fB3\fP   Informational
+.br
+\fB4\fP   Debug
+.br
+\fB5\fP   Spew

 .TP
 .B "\-h, \-?, \-\-help"
 Show a help text and exit.
 .TP
 .B "\-V, \-\-version"
 Show version information and exit.
 .TP
 .B "\-h, \-?, \-\-help"
 Show a help text and exit.
 .TP
 .B "\-V, \-\-version"
 Show version information and exit.

+.TP
+.BR "\-i, \-\-input\-file " <filename>
+Load input from a file. If the
+.B \-\-input\-format
+option is not supplied, pulseview attempts to load the file as a sigrok session
+file.
+.TP
+.BR "\-I, \-\-input\-format " <format>
+Specifies the format of the input file to be loaded.

 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.
 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.