Docs: add warning note on ${listnamed:} operator
[users/heiko/exim.git] / doc / doc-docbook / Makefile
index 68a93b58bb5ecc4edaa87953baf0b0197ee08506..bc7a9b0ae73e98e8df68e0934c5119a5b78833c2 100644 (file)
@@ -1,20 +1,23 @@
-# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.14 2010/05/28 15:38:18 nm4 Exp $
-
 # Make file for Exim documentation from xfpt source.
+# Copyright (c) The Exim Maintainers 2020
+export LC_ALL=C
 
 notarget:;    @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"
-             @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'html', 'txt', or 'info'."
-             @echo "** One other possible target is 'exim.8'".
+             @echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'txt', or 'info'."
+             @echo "** One other possible targets 'exim.8', 'spec.utf8'".
              exit 1
 
+# html used to be supported, but is not here since 50023e0551 (2010).
+# The website build script seems to handle it.
 
 ############################# EVERYTHING ###############################
 #
 # Generate all the documentation files...
 #
 ## removed info files as I cannot generate them -  spec.info filter.info
-everything:            spec.pdf        spec.ps         spec.html       spec.txt \
-                               filter.pdf      filter.ps       filter.html filter.txt \
+## removed html files as superseded by new website code
+everything:            spec.pdf        spec.ps         spec.txt \
+                               filter.pdf      filter.ps filter.txt \
                                exim.8
 
 ############################## MAN PAGE ################################
@@ -24,18 +27,26 @@ exim.8:       spec.xml x2man
 
 ########################################################################
 
+# .PHONY doesn't work here, because it forces a rebuild of all dependent
+# targets, always. It sets the internal timestamp of its target to
+# now().
+# But it may happen that local_params does not change
+FORCE:
+local_params: FORCE GenLocalParams
+       @set -e; \
+       trap 'rm -f $$tmp' EXIT; \
+       tmp=`mktemp`; \
+       ./GenLocalParams $$tmp; \
+       cmp -s $@ $$tmp || mv -f $$tmp $@
 
 ############################### FILTER #################################
 
-filter.xml:      filter.xfpt
+filter.xml:      local_params filter.xfpt
                 xfpt filter.xfpt
 
 filter-pr.xml:   filter.xml Pre-xml
                 ./Pre-xml -bookinfo <filter.xml >filter-pr.xml
 
-filter-html.xml: filter.xml Pre-xml
-                ./Pre-xml -html <filter.xml >filter-html.xml
-
 filter-txt.xml:  filter.xml Pre-xml
                 ./Pre-xml -ascii -html -quoteliteral <filter.xml >filter-txt.xml
 
@@ -85,18 +96,13 @@ filter.pdf: sdop-filter.pdf
 ###
 ###
 
-filter.html:  filter-html.xml TidyHTML-filter MyStyle-nochunk-html.xsl \
-                MyStyle-html.xsl MyStyle.xsl
-             /bin/rm -rf filter.html filter-html.html
-             xmlto -x MyStyle-nochunk-html.xsl html-nochunks filter-html.xml
-             /bin/mv -f filter-html.html filter.html
-             ./TidyHTML-filter
-
 filter.txt:   filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf filter-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml
-             w3m -dump filter-txt.html | ./Tidytxt >filter.txt
+             command -v w3m >/dev/null
+             LC_ALL=C w3m -dump filter-txt.html | ./Tidytxt >filter.txt
+             ./SanityTestText filter.txt
 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
@@ -114,16 +120,12 @@ filter.info:  filter-info.xml
 
 ################################ SPEC ##################################
 
-spec.xml:      spec.xfpt
+spec.xml:      spec.xfpt local_params
               xfpt spec.xfpt
 
 spec-pr.xml:   spec.xml Pre-xml
               ./Pre-xml -optbreak <spec.xml >spec-pr.xml
 
-spec-html.xml: spec.xml Pre-xml
-              ./Pre-xml -html -oneindex \
-                <spec.xml >spec-html.xml
-
 spec-txt.xml:  spec.xml Pre-xml
               ./Pre-xml -ascii -html -noindex -quoteliteral \
                 <spec.xml >spec-txt.xml
@@ -176,17 +178,22 @@ spec.pdf: sdop-spec.pdf
 ###
 ###
 
-spec.html:    spec-html.xml TidyHTML-spec MyStyle-chunk-html.xsl \
-                MyStyle-html.xsl MyStyle.xsl
-             /bin/rm -rf spec_html
-             xmlto -x MyStyle-chunk-html.xsl -o spec_html html spec-html.xml
-             ./TidyHTML-spec
-
-spec.txt:     spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
-                MyStyle.xsl
-             /bin/rm -rf spec-txt.html
+spec-txt.html:     spec-txt.xml \
+               MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl
              xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml
-             w3m -dump spec-txt.html | ./Tidytxt >spec.txt
+
+spec.utf8:     spec-txt.html Tidytxt
+               @grep -iq 'LC_CTYPE=.*utf-\?8' local_params || { \
+                       echo 'your current locale does not support UTF-8' >&2; \
+                       false; }
+               command -v w3m >/dev/null
+               w3m -dump spec-txt.html | ./Tidytxt -utf8 >$@
+
+spec.txt: spec-txt.html Tidytxt
+             command -v w3m >/dev/null
+             LC_ALL=C w3m -dump spec-txt.html | ./Tidytxt >$@
+             ./SanityTestText spec.txt
+
 
 # I have not found a way of making docbook2texi write its output anywhere
 # other than the file name that it makes up. The --to-stdout option does not
@@ -266,16 +273,11 @@ test.pdf: sdop-test.pdf
 ###
 
 
-test.html:    test-html.xml MyStyle-nochunk-html.xsl MyStyle-html.xsl \
-                MyStyle.xsl
-             /bin/rm -rf test.html test-html.html
-             xmlto -x MyStyle-nochunk-html.xsl html-nochunks test-html.xml
-             /bin/mv -f test-html.html test.html
-
 test.txt:     test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
                 MyStyle.xsl
              /bin/rm -rf test-txt.html
              xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml
+             command -v w3m >/dev/null
              w3m -dump test-txt.html | Tidytxt >test.txt
 
 # I have not found a way of making docbook2texi write its output anywhere
@@ -307,7 +309,8 @@ os-fixup:
 
 clean:; /bin/rm -rf exim.8 \
              filter*.xml spec*.xml test*.xml \
-             *.fo *.html *.pdf *.ps \
+             *.fo *.pdf *.ps \
+             filter*.html spec*.html test*.html \
              filter*.txt spec*.txt test*.txt \
              *.info* *.texinfo *.texi