Reinstate a piece of code accidentally removed in r9214, where Windows
[u/mdw/putty] / doc / Makefile
index f61b7c5..89b4be9 100644 (file)
@@ -1,17 +1,75 @@
-CHAPTERS = blurb intro gs using config pscp plink pubkey pageant faq
+all: man index.html
+
+# Decide on the versionid policy.
+#
+# If the user has passed in $(VERSION) on the command line (`make
+# VERSION="Release 0.56"'), we use that as an explicit version
+# string. Otherwise, we use `svnversion' to examine the checked-out
+# documentation source, and if that returns a single revision
+# number then we invent a version string reflecting just that
+# number. Failing _that_, we resort to versionids.but which shows a
+# $Id for each individual file.
+#
+# So here, we define VERSION using svnversion if it isn't already
+# defined ...
+ifndef VERSION
+SVNVERSION=$(shell test -d .svn && svnversion .)
+BADCHARS=$(findstring :,$(SVNVERSION))$(findstring S,$(SVNVERSION))
+ifeq ($(BADCHARS),)
+ifneq ($(SVNVERSION),)
+ifneq ($(SVNVERSION),exported)
+VERSION=Built from revision $(patsubst M,,$(SVNVERSION))
+endif
+endif
+endif
+endif
+# ... and now, we condition our build behaviour on whether or not
+# VERSION _is_ defined.
+ifdef VERSION
+VERSIONIDS=vstr
+vstr.but: FORCE
+       echo \\versionid $(VERSION) > vstr.but
+FORCE:;
+else
+VERSIONIDS=vids
+endif
+
+CHAPTERS := $(SITE) blurb intro gs using config pscp psftp plink pubkey
+CHAPTERS += pageant errors faq feedback licence udp pgpkeys sshnames
+CHAPTERS += index $(VERSIONIDS)
 
 INPUTS = $(patsubst %,%.but,$(CHAPTERS))
 
 # This is temporary. Hack it locally or something.
-BUTTRESS = $(HOME)/src/buttress/build/buttress
-
-Contents.html: $(INPUTS)
-       $(HOME)/src/buttress/build/buttress $(INPUTS)
-       rm -f index.html
-       ln -s Contents.html index.html
-       mv output.txt puttydoc.txt
-       mv output.hlp putty.hlp
-       mv output.cnt putty.cnt
-
-clean:
-       rm -f *.html *.txt *.hlp *.cnt
+HALIBUT = halibut
+
+index.html: $(INPUTS)
+       $(HALIBUT) --text --html --winhelp $(INPUTS)
+
+# During formal builds it's useful to be able to build this one alone.
+putty.hlp: $(INPUTS)
+       $(HALIBUT) --winhelp $(INPUTS)
+
+putty.info: $(INPUTS)
+       $(HALIBUT) --info $(INPUTS)
+
+chm: putty.hhp
+putty.hhp: $(INPUTS) chm.but
+       $(HALIBUT) --html $(INPUTS) chm.but
+
+MKMAN = $(HALIBUT) --man=$@ mancfg.but $<
+MANPAGES = putty.1 puttygen.1 plink.1 pscp.1 psftp.1 puttytel.1 pterm.1
+man: $(MANPAGES)
+
+putty.1: man-putt.but mancfg.but; $(MKMAN)
+puttygen.1: man-pg.but mancfg.but; $(MKMAN)
+plink.1: man-pl.but mancfg.but; $(MKMAN)
+pscp.1: man-pscp.but mancfg.but; $(MKMAN)
+psftp.1: man-psft.but mancfg.but; $(MKMAN)
+puttytel.1: man-ptel.but mancfg.but; $(MKMAN)
+pterm.1: man-pter.but mancfg.but; $(MKMAN)
+
+mostlyclean:
+       rm -f *.html *.txt *.hlp *.cnt *.1 *.info vstr.but *.hh[pck]
+clean: mostlyclean
+       rm -f *.chm