From 3372d02ce531d04e26675a22934fe5ec4700780d Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Fri, 12 May 2006 17:42:08 +0200 Subject: [PATCH] [NEW] Added manpage --- Makefile | 21 ++++++++++------ doc/man/ccollect.text | 58 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+), 8 deletions(-) create mode 100644 doc/man/ccollect.text diff --git a/Makefile b/Makefile index 72d5764..2c8977b 100644 --- a/Makefile +++ b/Makefile @@ -25,7 +25,8 @@ docdir=$(dir)/doc # # Asciidoc will be used to generate other formats later # -DOCS = doc/ccollect.text doc/ccollect-DE.text +MANDOCS = doc/man/ccollect.text +DOCS = $(MANDOCS) doc/ccollect.text doc/ccollect-DE.text # # End user targets @@ -51,7 +52,10 @@ install-script: %.texi: %.docbook ${DOCBOOKTOTEXI} --to-stdout $< > $@ -%.man: %.docbook +%.mandocbook: %.text + ${ASCIIDOC} -b docbook -d manpage -o $@ $< + +%.man: %.mandocbook ${DOCBOOKTOMAN} --to-stdout $< > $@ # @@ -76,23 +80,24 @@ HTMLDOCS = $(DOCS:.text=.html) TEXIDOCS = $(DOCS:.text=.texi) -MANPDOCS = $(DOCS:.text=.man) +MANPDOCS = $(MANDOCS:.text=.man) DOCBDOCS = $(DOCS:.text=.docbook) -html: ${HTMLDOCS} +html: $(HTMLDOCS) -info: ${TEXIDOCS} +info: $(TEXIDOCS) -documentation: html info +man: $(MANPDOCS) + +documentation: html info man # # Distribution # allclean: - #rm -f doc/*.docbook doc/*.html doc/*.texi - rm -f $(TEXIDOCS) $(HTMLDOCS) + rm -f $(TEXIDOCS) $(HTMLDOCS) $(MANPDOCS) $(DOCBDOCS) distclean: rm -f $(DOCBDOCS) diff --git a/doc/man/ccollect.text b/doc/man/ccollect.text new file mode 100644 index 0000000..4bf735d --- /dev/null +++ b/doc/man/ccollect.text @@ -0,0 +1,58 @@ +ccollect.sh(1) +============== +Nico Schottelius + + +NAME +---- +ccollect - (pseudo) incremental backup with different exclude lists using hardlinks and rsync + + +SYNOPSIS +-------- +'ccollect.sh' [args] + + +DESCRIPTION +----------- +ccollect is a backup utility written in the sh-scripting language. +It does not depend on a specific shell, only `/bin/sh` needs to be +bourne shell compatibel (like 'dash', 'ksh', 'zsh', 'bash', ...). + +For more information refer to the texinfo or html documentation. + + +OPTIONS +------- + +-h, --help:: + Show the help screen + +-p, --parallel:: + Parallelise backup processes + +-a, --all:: + Backup all sources specified in /etc/ccollect/sources + +-v, --verbose:: + Be very verbose (uses set -x). + +BUGS +---- +None. + + +AUTHOR +------ +Nico Schottelius + + +RESOURCES +--------- +Main web site: http://linux.schottelius.org/ccollect/[] + + +COPYING +------- +Copyright \(C) 2006 Nico Schottelius. Free use of this software is +granted under the terms of the GNU General Public License (GPL).