manpage: Minor fixes and updates.

[pulseview.git] / doc / pulseview.1

diff --git a/doc/pulseview.1 b/doc/pulseview.1
index 2e3de16f708bf86d6eb32fa5db82988b4b21c8eb..7f7ecfd0e59a58389527cbafd033241f020a36e2 100644 (file)
--- a/doc/pulseview.1
+++ b/doc/pulseview.1
@@ -1,33 +1,62 @@
-.TH PULSEVIEW 1 "October 13, 2012"
+.TH PULSEVIEW 1 "December 16, 2015"

 .SH "NAME"
 .SH "NAME"

-PulseView \- Qt-based GUI for sigrok
+PulseView \- Qt-based LA/scope/MSO GUI for sigrok

 .SH "SYNOPSIS"
 .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[\fBOPTIONS\fR] [\fBfile.sr\fR]

 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the
 .B sigrok
 software suite for test and measurement equipment such as logic analyzers,
 .SH "DESCRIPTION"
 .B PulseView
 is a cross-platform Qt-based GUI for the
 .B sigrok
 software suite for test and measurement equipment such as logic analyzers,

-oscilloscopes, multimeters, and more.
+oscilloscopes, MSOs, and more.

 .SH "OPTIONS"
 .B PulseView
 has very few command line options, as most configuration elements are
 available from the GUI itself.
 .SH "OPTIONS"
 .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 "SEE ALSO"
 .SH "EXIT STATUS"
 .B PulseView
 exits with 0 on success, 1 on most failures.
 .SH "SEE ALSO"

-\fBsigrok\-cli\fP(1),
-\fBsigrok\-gtk\fP(1),
-\fBsigrok\-qt\fP(1)
+\fBsigrok\-cli\fP(1)

 .SH "BUGS"
 .SH "BUGS"

-Please report any bugs on the sigrok\-devel mailing list
+Please report any bugs via Bugzilla
+.RB "(" http://sigrok.org/bugzilla ")"
+or on the sigrok\-devel mailing list

 .RB "(" sigrok\-devel@lists.souceforge.net ")."
 .SH "LICENSE"
 .B PulseView
 .RB "(" sigrok\-devel@lists.souceforge.net ")."
 .SH "LICENSE"
 .B PulseView