X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/595028e435015508f214f06456874a8882bfd54e..48d6f3b6c68a33a4ff11650f9f0de858cb5fc256:/doc/doc-docbook/Makefile diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile index 8e485ab2d..fb3db4b96 100644 --- a/doc/doc-docbook/Makefile +++ b/doc/doc-docbook/Makefile @@ -1,12 +1,24 @@ -# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.11 2007/08/29 13:37:28 ph10 Exp $ - # Make file for Exim documentation from xfpt source. +# Copyright (c) The Exim Maintainers 2020 - 2021 +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 +## 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 ################################ @@ -15,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-pr.xml -filter-html.xml: filter.xml Pre-xml - ./Pre-xml -html filter-html.xml - filter-txt.xml: filter.xml Pre-xml ./Pre-xml -ascii -html -quoteliteral filter-txt.xml @@ -76,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 @@ -96,7 +111,7 @@ filter.txt: filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ filter.info: filter-info.xml docbook2texi filter-info.xml perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \ - filter.texinfo + filter.texinfo /bin/rm -rf exim_filtering.texi makeinfo -o filter.info filter.texinfo @@ -105,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-pr.xml -spec-html.xml: spec.xml Pre-xml - ./Pre-xml -html -oneindex \ - spec-html.xml - spec-txt.xml: spec.xml Pre-xml ./Pre-xml -ascii -html -noindex -quoteliteral \ spec-txt.xml @@ -167,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 @@ -257,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 @@ -282,11 +293,24 @@ test.info: test-info.xml ######################################################################## +############################## OS FIXUP ################################ + +# Yes, we've advanced so far in text processing that we now have to +# hardcode in complete paths and so become dependent upon exactly where +# files were installed for xsl:import. Which of course varies by OS. + +os-fixup: + ./OS-Fixups + +######################################################################## + + ################################ CLEAN ################################# 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