From 958bfe4e2d9a5dbedbdce9fd7223f66e2edefe79 Mon Sep 17 00:00:00 2001 From: Sebastian Harl Date: Wed, 8 Feb 2012 19:26:17 +0100 Subject: [PATCH] fb.txt: Added manpage; built using asciidoc and xsltproc. --- .gitignore | 1 + Makefile.am | 2 +- README | 3 +++ configure.ac | 2 +- doc/Makefile.am | 10 +++++++++ doc/fb.txt | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 72 insertions(+), 2 deletions(-) create mode 100644 doc/Makefile.am create mode 100644 doc/fb.txt diff --git a/.gitignore b/.gitignore index 2c5f4c4..dba4dec 100644 --- 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 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 a809b77..0d36ece 100644 --- 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 f5fe02e..715639b 100644 --- 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 < +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 . + +COPYRIGHT +--------- +Copyright (C) 2012 Sebastian "tokkee" Harl + +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 : + -- 2.30.2