X-Git-Url: https://git.exim.org/users/heiko/exim.git/blobdiff_plain/9b3719888275859f10e5a8c6e87a92899abc0d95..8d3dc2397dd769bf4654b0678be8d2acf0956ddd:/doc/doc-docbook/Makefile?ds=sidebyside diff --git a/doc/doc-docbook/Makefile b/doc/doc-docbook/Makefile index 0495b582e..ee97257b6 100644 --- a/doc/doc-docbook/Makefile +++ b/doc/doc-docbook/Makefile @@ -1,13 +1,21 @@ -# $Cambridge: exim/doc/doc-docbook/Makefile,v 1.7 2006/02/01 11:01:01 ph10 Exp $ - # Make file for Exim documentation from xfpt source. 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 "** One other possible targets 'exim.8', 'spec.utf8'". exit 1 +############################# EVERYTHING ############################### +# +# Generate all the documentation files... +# +## removed info files as I cannot generate them - spec.info filter.info +## removed html files as superceded by new website code +everything: spec.pdf spec.ps spec.txt \ + filter.pdf filter.ps filter.txt \ + exim.8 + ############################## MAN PAGE ################################ exim.8: spec.xml x2man @@ -15,54 +23,82 @@ 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 $$tmp $@ ############################### FILTER ################################# -filter.xml: filter.xfpt - xfpt filter.xfpt - -filter-fo.xml: filter.xml Pre-xml - ./Pre-xml -bookinfo filter-fo.xml +filter.xml: local_params filter.xfpt + xfpt filter.xfpt -filter-html.xml: filter.xml Pre-xml - ./Pre-xml -html filter-html.xml +filter-pr.xml: filter.xml Pre-xml + ./Pre-xml -bookinfo filter-pr.xml -filter-txt.xml: filter.xml Pre-xml - ./Pre-xml -ascii -html -quoteliteral filter-txt.xml +filter-txt.xml: filter.xml Pre-xml + ./Pre-xml -ascii -html -quoteliteral filter-txt.xml filter-info.xml: filter.xml Pre-xml - ./Pre-xml -ascii -html filter-info.xml + ./Pre-xml -ascii -html filter-info.xml -filter.fo: filter-fo.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl - /bin/rm -rf filter.fo filter-fo.fo - xmlto -x MyStyle-filter-fo.xsl fo filter-fo.xml - /bin/mv -f filter-fo.fo filter.fo +filter.fo: filter-pr.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl + /bin/rm -rf filter.fo filter-pr.fo + xmlto -x MyStyle-filter-fo.xsl fo filter-pr.xml + /bin/mv -f filter-pr.fo filter.fo # Do not use pdf2ps from the PDF version; better PS is generated directly. -filter.ps: filter.fo - fop filter.fo -ps filter-tmp.ps - mv filter-tmp.ps filter.ps +### +### PS/PDF generation using fop +### + +fop-filter.ps: filter.fo + fop filter.fo -ps filter-tmp.ps + mv filter-tmp.ps filter.ps # Do not use ps2pdf from the PS version; better PDF is generated directly. It # contains cross links etc. -filter.pdf: filter.fo - fop filter.fo -pdf filter-tmp.pdf - mv filter-tmp.pdf filter.pdf +fop-filter.pdf: filter.fo PageLabelPDF + fop filter.fo -pdf filter-tmp.pdf + ./PageLabelPDF 2 filter.pdf + +### +### PS/PDF generation using SDoP +### + +sdop-filter.ps: filter-pr.xml + sdop -o filter.ps filter-pr.xml + +sdop-filter.pdf: filter.ps + ps2pdf filter.ps filter.pdf + +### +### PS/PDF default setting +### + +filter.ps: sdop-filter.ps + +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 @@ -71,7 +107,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 @@ -80,32 +116,32 @@ filter.info: filter-info.xml ################################ SPEC ################################## -spec.xml: spec.xfpt - xfpt spec.xfpt +spec.xml: spec.xfpt local_params + xfpt $< -spec-fo.xml: spec.xml Pre-xml - ./Pre-xml -optbreak spec-fo.xml +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 +spec-txt.xml: spec.xml Pre-xml + ./Pre-xml -ascii -html -noindex -quoteliteral \ + spec-txt.xml spec-info.xml: spec.xml Pre-xml - ./Pre-xml -ascii -html -noindex spec-info.xml + ./Pre-xml -ascii -html -noindex spec-info.xml + +spec.fo: spec-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \ + MyTitleStyle.xsl + /bin/rm -rf spec.fo spec-pr.fo + xmlto -x MyStyle-spec-fo.xsl fo spec-pr.xml + /bin/mv -f spec-pr.fo spec.fo -spec.fo: spec-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \ - MyTitleStyle.xsl - /bin/rm -rf spec.fo spec-fo.fo - xmlto -x MyStyle-spec-fo.xsl fo spec-fo.xml - /bin/mv -f spec-fo.fo spec.fo +### +### PS/PDF generation using fop +### # Do not use pdf2ps from the PDF version; better PS is generated directly. -spec.ps: spec.fo +fop-spec.ps: spec.fo FOP_OPTS=-Xmx512m fop spec.fo -ps spec-tmp.ps mv spec-tmp.ps spec.ps @@ -113,21 +149,47 @@ spec.ps: spec.fo # contains cross links etc. We post-process it to add page label information # so that the page identifiers shown by acroread are the correct page numbers. -spec.pdf: spec.fo PageLabelPDF +fop-spec.pdf: spec.fo PageLabelPDF FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf - ./PageLabelPDF spec.pdf + ./PageLabelPDF 12 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 +### +### PS/PDF generation using SDoP +### + +sdop-spec.ps: spec-pr.xml + sdop -o spec.ps spec-pr.xml + +sdop-spec.pdf: spec.ps + ps2pdf spec.ps spec.pdf + +### +### PS/PDF default setting +### + +spec.ps: sdop-spec.ps + +spec.pdf: sdop-spec.pdf + +### +### + +spec-txt.html: spec-txt.xml \ + MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl + xmlto -x MyStyle-txt-html.xsl html-nochunks $< + +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 $< | ./Tidytxt -utf8 >$@ + +spec.txt: spec-txt.html Tidytxt + command -v w3m >/dev/null + LC_ALL=C w3m -dump $< | ./Tidytxt >$@ + ./SanityTestText spec.txt -spec.txt: spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ - MyStyle.xsl - /bin/rm -rf spec-txt.html - xmlto -x MyStyle-txt-html.xsl html-nochunks spec-txt.xml - w3m -dump spec-txt.html | ./Tidytxt >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 @@ -135,10 +197,9 @@ spec.txt: spec-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ spec.info: spec-info.xml docbook2texi spec-info.xml - perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \ - spec.texinfo + ./TidyInfo spec.texinfo /bin/rm -rf the_exim_mta.texi - makeinfo -o spec.info spec.texinfo + makeinfo -o spec.info --no-split spec.texinfo ######################################################################## @@ -150,8 +211,8 @@ spec.info: spec-info.xml test.xml: test.xfpt xfpt test.xfpt -test-fo.xml: test.xml Pre-xml - ./Pre-xml test-fo.xml +test-pr.xml: test.xml Pre-xml + ./Pre-xml test-pr.xml test-html.xml: test.xml Pre-xml ./Pre-xml -html -oneindex test-html.xml @@ -163,35 +224,56 @@ test-txt.xml: test.xml Pre-xml test-info.xml: test.xml Pre-xml ./Pre-xml -ascii -html -noindex test-info.xml -test.fo: test-fo.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \ +test.fo: test-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \ MyTitleStyle.xsl - /bin/rm -rf test.fo test-fo.fo - xmlto -x MyStyle-spec-fo.xsl fo test-fo.xml - /bin/mv -f test-fo.fo test.fo + /bin/rm -rf test.fo test-pr.fo + xmlto -x MyStyle-spec-fo.xsl fo test-pr.xml + /bin/mv -f test-pr.fo test.fo + +### +### PS/PDF generation using fop +### # Do not use pdf2ps from the PDF version; better PS is generated directly. -test.ps: test.fo +fop-test.ps: test.fo fop test.fo -ps test-tmp.ps mv test-tmp.ps test.ps # Do not use ps2pdf from the PS version; better PDF is generated directly. It # contains cross links etc. -test.pdf: test.fo +fop-test.pdf: test.fo fop test.fo -pdf test-tmp.pdf mv test-tmp.pdf 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 +### +### PS/PDF generation using SDoP +### + +sdop-test.ps: test-pr.xml + sdop -o test.ps test-pr.xml + +sdop-test.pdf: test.ps + ps2pdf test.ps test.pdf + +### +### PS/PDF default setting +### + +test.ps: sdop-test.ps + +test.pdf: sdop-test.pdf + +### +### + 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 @@ -200,19 +282,31 @@ test.txt: test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \ test.info: test-info.xml docbook2texi test-info.xml - perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \ - test.texinfo + ./TidyInfo test.texinfo /bin/rm -rf short_title.texi makeinfo -o test.info test.texinfo ######################################################################## +############################## 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