[NEW] Added manpage

This commit is contained in:
Nico Schottelius 2006-05-12 17:42:08 +02:00
parent d322792bd4
commit 3372d02ce5
2 changed files with 71 additions and 8 deletions

View file

@ -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)

58
doc/man/ccollect.text Normal file
View file

@ -0,0 +1,58 @@
ccollect.sh(1)
==============
Nico Schottelius <nico-linux-ccollect__@__schottelius.org>
NAME
----
ccollect - (pseudo) incremental backup with different exclude lists using hardlinks and rsync
SYNOPSIS
--------
'ccollect.sh' <interval name> [args] <sources to backup>
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 <mailto:nico-linux-ccollect__@__schottelius.org[]>
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).