tpdfview.txt: Added manpage for tpdfview(1).

The manpage is built using asciidoc and xsltproc.

diff --git a/.gitignore b/.gitignore
index 8daf6492235c0fa350fc0d95a9d5963ab608bc83..f87da5e72b499dbdfc75fcd259099cfe23dec128 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,7 @@ ltmain.sh
 *.lo
 *.o
 tpdfview
+tpdfview.1
 tpdftoc
 tpdfv_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 9959a4431706375ab20db089e0e99baa128450a7..4322a8ea876dff41a78e0148e54d95c29eb2f47a 100644 (file)
--- a/README
+++ b/README
@@ -2,8 +2,8 @@ tpdfview
 ========
 
   tpdfview (tiny PDF viewer, or tokkee's PDF viewer, choose whatever you like
-  best) displays PDF files. It was developed with presentations and
-  accompanying material in mind.
+  best) is a Portable Document Format (PDF) viewer. It was developed with
+  presentations and accompanying material in mind.
 
   This is free and open source software, licensed under the 2-clause BSD
   license. See COPYING for details.
@@ -17,6 +17,9 @@ Prerequisites
 
   * A POSIX + Single UNIX Specification compatible C library.
 
+  * asciidoc, xsltproc:
+    The AsciiDoc text document format is used to write the manpages.
+
   * libcairo:
     The 2D vector graphics library is used for the actual drawing of the PDF
     on screen.

diff --git a/configure.ac b/configure.ac
index f248564712969d8443f69b8f450cd0d6d5392e3f..ec99e903390ef841bc809b4c89498bf395685c3e 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -184,7 +184,7 @@ PKG_CHECK_MODULES([CAIRO], [cairo])
 PKG_CHECK_MODULES([GTK2], [gtk+-2.0])
 PKG_CHECK_MODULES([POPPLER_GLIB], [poppler-glib])
 
-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..7bb7de9
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,10 @@
+EXTRA_DIST = tpdfview.txt
+CLEANFILES = tpdfview.1
+
+man_MANS = tpdfview.1
+
+tpdfview.1: tpdfview.txt
+
+.txt.1:
+       a2x -d manpage -f manpage -atpdfv_version=$(PACKAGE_VERSION) $<
+

diff --git a/doc/tpdfview.txt b/doc/tpdfview.txt
new file mode 100644 (file)
index 0000000..7149638
--- /dev/null
+++ b/doc/tpdfview.txt
@@ -0,0 +1,54 @@
+TPDFVIEW(1)
+===========
+Sebastian "tokkee" Harl <sh@tokkee.org>
+version {tpdfv_version}, 2011-12-28
+:doctype: manpage
+
+NAME
+----
+tpdfview - Portable Document Format (PDF) file presenter
+
+SYNOPSIS
+--------
+*tpdfview* ['options'] 'PDF-file'
+
+DESCRIPTION
+-----------
+*tpdfview* is a Portable Document Format (PDF) viewer. It was developed with
+presentations and accompanying material in mind.
+
+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; error processing or displaying the PDF
+       file).
+
+BUGS
+----
+None known, but there are still some missing features ;-)
+
+AUTHOR
+------
+tpdfview was written by Sebastian "tokkee" Harl <sh@tokkee.org>.
+
+COPYRIGHT
+---------
+Copyright (C) 2011 Sebastian "tokkee" Harl <sh@tokkee.org>
+
+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 :
+