Imported Upstream version 2.6.0

2011-01-26 10:35:08 +01:00 · 2011-01-26 10:35:08 +01:00 · 459aaf9392
commit 459aaf9392
parent 26fb71b504
510 changed files with 40508 additions and 18859 deletions
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@ -1,13 +1,108 @@
-# nothing to build here, but still need a Makefile to define which
-# files to distribute
+SHARED_DEPS = nut-names.txt asciidoc.conf

-EXTRA_DIST = acpi.txt big-servers.txt chroot.txt		\
- commands.txt config-files.txt configure.txt contact-closure.txt	\
- data-room.txt design.txt developers.txt FAQ hid-subdrivers.txt		\
- ideas.txt macros.txt megatec.txt new-drivers.txt new-names.txt \
- nut-hal.txt osd-notify.txt	\
- pager.txt powersaving.txt protocol.txt README shutdown.txt snmp.txt	\
- sock-protocol.txt ssl.txt upssched.txt cables/apc-rs500-serial.txt	\
+IMAGE_FILES = images/asciidoc.png \
+	images/eaton-logo.png \
+	images/nut_layering.png \
+	images/note.png \
+	images/warning.png \
+	images/blue-arrow.png \
+	images/simple.png \
+	images/advanced.png \
+	images/bigbox.png \
+	images/bizarre.png \
+	images/old-cgi.png
+
+USER_MANUAL_DEPS = acknowledgements.txt cables.txt config-notes.txt	\
+ configure.txt download.txt documentation.txt features.txt history.txt	\
+ outlets.txt scheduling.txt security.txt support.txt user-manual.txt \
+ stable-hcl.txt
+
+DEVELOPER_GUIDE_DEPS = contact-closure.txt design.txt developers.txt	\
+ developer-guide.txt hid-subdrivers.txt macros.txt \
+ new-clients.txt new-drivers.txt net-protocol.txt sock-protocol.txt
+
+CABLES_DEPS = cables/apc-rs500-serial.txt	\
 cables/apc.txt cables/ge-imv-victron.txt cables/imv.txt		\
 cables/mgeups.txt cables/powerware.txt cables/repotec.txt		\
 cables/sms.txt
+
+CABLES_IMAGES = images/cables/73-0724.png images/cables/940-0024C.jpg \
+ images/cables/belkin-f6cx-rkm-xu-cable.jpg images/cables/Lansafecable.jpg \
+ images/cables/mac-940-0024C.png images/cables/mge-66049.png \
+ images/cables/mge-db9-rj12.jpg images/cables/mge-db9-rj45.jpg \
+ images/cables/SOLA-330.png
+
+EXTRA_DIST = $(SHARED_DEPS) $(USER_MANUAL_DEPS) $(DEVELOPER_GUIDE_DEPS) \
+ $(CABLES_DEPS) FAQ.txt nut-hal.txt nut-qa.txt packager-guide.txt snmp.txt \
+ $(IMAGE_FILES) $(CABLES_IMAGES) docinfo.xml
+
+ASCIIDOC_HTML_SINGLE = user-manual.html \
+	developer-guide.html \
+	packager-guide.html \
+	FAQ.html
+
+ASCIIDOC_HTML_CHUNKED = user-manual.chunked \
+	developer-guide.chunked \
+	packager-guide.chunked \
+	FAQ.html
+
+ASCIIDOC_PDF = user-manual.pdf \
+	developer-guide.pdf \
+	packager-guide.pdf \
+	FAQ.pdf
+
+# Force build in ./ and man/ before website 
+SUBDIRS = . man website
+SUFFIXES = .txt .html .pdf
+
+all: doc
+
+doc: @DOC_BUILD_LIST@
+
+pdf: $(ASCIIDOC_PDF)
+# also build the HTML manpages with these targets
+html-single: $(ASCIIDOC_HTML_SINGLE)
+html-chunked: $(ASCIIDOC_HTML_CHUNKED)
+
+if HAVE_ASCIIDOC
+website: html-chunked pdf
+else !HAVE_ASCIIDOC
+website:
+	@echo "Not building website documentation since 'asciidoc' was not found."
+endif !HAVE_ASCIIDOC
+
+clean-local:
+	rm -rf *.pdf *.html *.chunked docbook-xsl.css
+
+### TODO: automatic dependency generation
+FULL_USER_MANUAL_DEPS = $(USER_MANUAL_DEPS)  $(SHARED_DEPS) ../README \
+	../INSTALL cables.txt ../UPGRADING ../TODO
+FULL_DEVELOPER_GUIDE_DEPS = $(DEVELOPER_GUIDE_DEPS)  $(SHARED_DEPS) \
+	../scripts/augeas/README
+
+user-manual.html user-manual.chunked user-manual.pdf: $(FULL_USER_MANUAL_DEPS)
+developer-guide.html developer-guide.chunked developer-guide.pdf: $(FULL_DEVELOPER_GUIDE_DEPS)
+packager-guide.html packager-guide.chunked packager-guide.pdf: packager-guide.txt asciidoc.conf
+
+# Note: without the "-v", asciidoc (circa 8.6.2) sometimes hangs when
+# generating the chunked HTML. In this case, export the environment
+# variable ASCIIDOC_VERBOSE to "-v", ie:
+#   $ ASCIIDOC_VERBOSE=-v make
+A2X_COMMON_OPTS = $(ASCIIDOC_VERBOSE) --attribute icons \
+    --attribute localdate=`TZ=UTC date +%Y-%m-%d` \
+    --attribute localtime=`TZ=UTC date +%H:%M:%S` \
+    --attribute iconsdir=$(srcdir)/images \
+    --attribute=badges \
+    --attribute=external_title \
+    -a toc -a numbered --destination-dir=.
+
+.txt.html:
+	$(A2X) $(A2X_COMMON_OPTS) --attribute=xhtml11_format --format=xhtml $<
+
+.txt.chunked:
+	$(A2X) $(A2X_COMMON_OPTS) --attribute=chunked_format --format=chunked $<
+
+.txt.pdf: docinfo.xml
+	$(A2X) $(A2X_COMMON_OPTS) --attribute=pdf_format --format=pdf -a docinfo1 $<
+
+.PHONY: html html-single pdf website