From c756839186e8012f7dd86d82e70e31335b21b1d9 Mon Sep 17 00:00:00 2001 From: Sebastian Harl Date: Thu, 29 Dec 2011 00:27:10 +0100 Subject: [PATCH] tpdfview.txt: Added manpage for tpdfview(1). The manpage is built using asciidoc and xsltproc. --- .gitignore | 1 + Makefile.am | 2 +- README | 7 +++++-- configure.ac | 2 +- doc/Makefile.am | 10 +++++++++ doc/tpdfview.txt | 54 ++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 72 insertions(+), 4 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/tpdfview.txt diff --git a/.gitignore b/.gitignore index 8daf649..f87da5e 100644 --- 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 688649f..9baf3da 100644 --- 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 9959a44..4322a8e 100644 --- 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 f248564..ec99e90 100644 --- 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 < +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 . + +COPYRIGHT +--------- +Copyright (C) 2011 Sebastian "tokkee" Harl + +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 : + -- 2.30.2