From: Uwe Hermann <redacted>
Date: Sun, 15 Jan 2012 19:39:00 +0000 (+0100)
Subject: gtk: Add a simple manpage.
X-Git-Url: http://sigrok.org/gitweb/?a=commitdiff_plain;h=6ee92f404fd9df9a39a76504ea8b89ea97bf0739;p=sigrok-gtk.git

gtk: Add a simple manpage.
---

diff --git a/Makefile.am b/Makefile.am
index cd225dc..9e2eb6b 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,6 +17,8 @@
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ##
 
+SUBDIRS = doc
+
 ACLOCAL_AMFLAGS = -I autostuff
 
 bin_PROGRAMS = sigrok-gtk
diff --git a/configure.ac b/configure.ac
index 0f1b7a1..a87a65b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -78,7 +78,9 @@ AC_TYPE_SIZE_T
 # Checks for library functions.
 AC_CHECK_FUNCS([memset strtoull])
 
-AC_CONFIG_FILES([Makefile])
+AC_CONFIG_FILES([Makefile
+		 doc/Makefile
+		])
 
 AC_OUTPUT
 
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..f59530d
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,22 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+dist_man_MANS = sigrok-gtk.1
+
diff --git a/doc/sigrok-gtk.1 b/doc/sigrok-gtk.1
new file mode 100644
index 0000000..c22dd69
--- /dev/null
+++ b/doc/sigrok-gtk.1
@@ -0,0 +1,31 @@
+.TH SIGROK\-GTK 1 "January 15, 2012"
+.SH "NAME"
+sigrok\-gtk \- GTK+ based GUI for the sigrok logic analyzer software
+.SH "SYNOPSIS"
+.B sigrok\-gtk
+.SH "DESCRIPTION"
+.B sigrok\-gtk
+is a cross-platform GTK+ based GUI for the
+.B sigrok
+logic analyzer software.
+.SH "OPTIONS"
+The
+.B sigrok\-gtk
+tool currently has no command-line options.
+.SH "EXIT STATUS"
+.B sigrok\-gtk
+exits with 0 on success, 1 on most failures.
+.SH "SEE ALSO"
+\fBsigrok\-cli\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 sigrok\-gtk
+is covered by the GNU General Public License (GPL), version 3 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).