diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/Makefile | 66 | ||||
-rw-r--r-- | documentation/generate_except_xml.pl | 39 |
2 files changed, 66 insertions, 39 deletions
diff --git a/documentation/Makefile b/documentation/Makefile new file mode 100644 index 00000000..aefa3ee2 --- /dev/null +++ b/documentation/Makefile @@ -0,0 +1,66 @@ + + +# Process DocBook to HTML + +DBPROC=/usr/bin/xsltproc +BOOKXSL=bb-book.xsl +NOCHUNKBOOKXSL=bb-nochunk-book.xsl +MANXSL=bb-man.xsl +HTMLPREFIX=box-html +VPATH= adminguide +.SUFFIXES: .html .xml + +all: docs + +docs: instguide adminguide manpages + mkdir -p $(HTMLPREFIX)/images + cp html/images/*.png $(HTMLPREFIX)/images/. + cp html/*.css $(HTMLPREFIX)/. + +adminguide: $(HTMLPREFIX)/adminguide/index.html + +$(HTMLPREFIX)/adminguide/index.html: adminguide.xml ExceptionCodes.xml $(BOOKXSL) + # docname=`echo $@ | sed -e 's/\/index.html//'` + $(DBPROC) -o $(HTMLPREFIX)/adminguide/ $(BOOKXSL) adminguide.xml + +instguide: $(HTMLPREFIX)/instguide/index.html + +$(HTMLPREFIX)/instguide/index.html: instguide.xml $(BOOKXSL) + $(DBPROC) -o $(HTMLPREFIX)/instguide/ $(BOOKXSL) instguide.xml + +ExceptionCodes.xml: ../../ExceptionCodes.txt + perl ./generate_except_xml.pl + +manpages: man-dirs man-nroff man-html + +man-dirs: man-pages/.there $(HTMLPREFIX)/man-html/.there + +$(HTMLPREFIX)/man-html/.there: + if [ ! -d man-html ]; then mkdir -p $(HTMLPREFIX)/man-html; touch $(HTMLPREFIX)/man-html/.there; fi + +man-pages/.there: + if [ ! -d man-pages ]; then mkdir man-pages; touch man-pages/.there; fi + +man-nroff: bbackupquery.1 bbackupctl.1 bbstoreaccounts.1 bbstored-config.1 raidfile-config.1 bbstored-certs.1 + +man-html: bbackupquery.html bbackupctl.html bbstoreaccounts.html bbstored-config.html raidfile-config.html bbstored-certs.html + +%.html: %.xml + $(DBPROC) -o $@ $(NOCHUNKBOOKXSL) $< + mv $@ $(HTMLPREFIX)/man-html/. + +%.1: %.xml + $(DBPROC) -o $@ $(MANXSL) $< + mv $@ man-pages/. + gzip -f -9 man-pages/$@ + +dockit: clean docs + tar zcf documentation-kit-0.10.tar.gz $(HTMLPREFIX)/ + +clean: + if [ -d ./$(HTMLPREFIX) ]; then rm -rf $(HTMLPREFIX) ; fi + if [ -d ./man-pages ]; then rm -rf ./man-pages/; fi + if [ -f ExceptionCodes.xml ]; then rm ExceptionCodes.xml; fi + if [ -f documentation-kit-0.10.tar.gz ]; then rm documentation-kit-0.10.tar.gz; fi + + diff --git a/documentation/generate_except_xml.pl b/documentation/generate_except_xml.pl index af45a34f..9046d5cf 100644 --- a/documentation/generate_except_xml.pl +++ b/documentation/generate_except_xml.pl @@ -1,43 +1,4 @@ #!/usr/bin/perl -w -# distribution boxbackup-0.11rc2 (svn version: 2072) -# -# Copyright (c) 2003 - 2008 -# Ben Summers and contributors. All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# 1. Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# 2. Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# 3. All use of this software and associated advertising materials must -# display the following acknowledgment: -# This product includes software developed by Ben Summers. -# 4. The names of the Authors may not be used to endorse or promote -# products derived from this software without specific prior written -# permission. -# -# [Where legally impermissible the Authors do not disclaim liability for -# direct physical injury or death caused solely by defects in the software -# unless it is modified by a third party.] -# -# THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR -# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -# DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, -# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) -# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, -# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN -# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -# POSSIBILITY OF SUCH DAMAGE. -# -# -# use strict; open (EXCEPT, "<../../ExceptionCodes.txt") or die "Can't open ../../ExceptionCodes.txt: $!\n"; |