From: Uwe Hermann <redacted>
Date: Fri, 12 Oct 2012 20:47:45 +0000 (+0200)
Subject: Add initial manpage.
X-Git-Tag: pulseview-0.1.0~255
X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=commitdiff_plain;h=94236aa49501de386d0511a7c031048a9bae456c

Add initial manpage.
---

diff --git a/doc/pulseview.1 b/doc/pulseview.1
new file mode 100644
index 00000000..df4fc6e8
--- /dev/null
+++ b/doc/pulseview.1
@@ -0,0 +1,39 @@
+.TH PULSEVIEW 1 "October 13, 2012"
+.SH "NAME"
+PulseView \- Qt-based 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]
+.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.
+.SH "OPTIONS"
+.B PulseView
+has very few command line options, as most configuration elements are
+available from the GUI itself.
+.TP
+.B "\-h, \-?, \-\-help"
+Show a help text and exit.
+.TP
+.B "\-V, \-\-version"
+Show version information and exit.
+.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)
+.SH "BUGS"
+Please report any bugs on the sigrok\-devel mailing list
+.RB "(" sigrok\-devel@lists.souceforge.net ")."
+.SH "LICENSE"
+.B PulseView
+is covered by the GNU General Public License (GPL), version 2 or later.
+.SH "AUTHORS"
+Please see the individual source code files.
+.PP
+This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
+It is licensed under the terms of the GNU GPL (version 2 or later).