fb.txt: Added manpage; built using asciidoc and xsltproc.

diff --git a/.gitignore b/.gitignore
index 2c5f4c4543f3cb49ac529df4678dc364180e6230..dba4dec3dae715ae4588a79cdf01c90723c4dc86 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -23,5 +23,6 @@ ltmain.sh
 *.lo
 *.o
 fb
+fb.1
 fb_features.h
 

diff --git a/Makefile.am b/Makefile.am
index 688649f3f08c906762156bff156ebe0f1d7053b4..9baf3dabd11cf10887911c2408337a89636b0c03 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = src
+SUBDIRS = doc src
 
 EXTRA_DIST = autogen.sh version-gen.sh
 

diff --git a/README b/README
index a809b775b632fb2632376dc93e6d9526a161d859..0d36ece694ea737119ed61867dcc464b30c7fbef 100644 (file)
--- a/README
+++ b/README
@@ -19,6 +19,9 @@ Prerequisites
 
   * A POSIX + Single UNIX Specification compatible C library.
 
+  * asciidoc, xsltproc:
+    The AsciiDoc text document format is used to write the manpages.
+
 Configuring / Compiling / Installing
 ------------------------------------
 

diff --git a/configure.ac b/configure.ac
index f5fe02e889161dd9f97d1020b0f7de62422510fa..715639bfdcc667f5467b3391461126d28e52f44d 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -193,7 +193,7 @@ AC_SUBST([STRICT_CFLAGS])
 
 AC_CHECK_HEADERS(libgen.h)
 
-AC_CONFIG_FILES([Makefile src/Makefile])
+AC_CONFIG_FILES([Makefile doc/Makefile src/Makefile])
 AC_OUTPUT
 
 cat <<EOF;

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644 (file)
index 0000000..70a76cf
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,10 @@
+EXTRA_DIST = fb.txt
+CLEANFILES = fb.1
+
+man_MANS = fb.1
+
+fb.1: fb.txt
+
+.txt.1:
+       a2x -d manpage -f manpage -apackage_version=$(PACKAGE_VERSION) $<
+

diff --git a/doc/fb.txt b/doc/fb.txt
new file mode 100644 (file)
index 0000000..7e6516c
--- /dev/null
+++ b/doc/fb.txt
@@ -0,0 +1,56 @@
+FB(1)
+=====
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {package_version}, 2012-02-08
+:doctype: manpage
+
+NAME
+----
+fb - some very fancy tool
+
+SYNOPSIS
+--------
+*fb* ['options']
+
+DESCRIPTION
+-----------
+*fb* is a very fancy tool.
+
+OPTIONS
+-------
+*-h*::
+       Display a usage and help summary and exit.
+
+*-V*::
+       Display the version number and copyright information.
+
+EXIT CODES
+----------
+*0*::
+       Success.
+
+*1*::
+       Failure (syntax or usage error).
+
+BUGS
+----
+None known.
+
+AUTHOR
+------
+fb was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2012 Sebastian "tokkee" Harl <sh@tokkee.org>
+
+This is free software under the terms of the GNU General Public License
+version 2, see the source for copying conditions. There is NO WARRANTY; not
+even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+OR:
+This is free software under the terms of the BSD license, see the source for
+copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.
+
+// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us :
+