[exim.git] / doc / doc-docbook / Makefile

# 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 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
	      ./x2man

########################################################################

# .PHONY doesn't work here, because it forces a rebuild of all dependend
# 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:      local_params filter.xfpt
		 xfpt filter.xfpt

filter-pr.xml:   filter.xml Pre-xml
		 ./Pre-xml -bookinfo <filter.xml >filter-pr.xml

filter-txt.xml:  filter.xml Pre-xml
		 ./Pre-xml -ascii -html -quoteliteral <filter.xml >filter-txt.xml

filter-info.xml: filter.xml Pre-xml
		 ./Pre-xml -ascii -html <filter.xml >filter-info.xml

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.

###
### 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.

fop-filter.pdf:  filter.fo PageLabelPDF
		 fop filter.fo -pdf filter-tmp.pdf
		 ./PageLabelPDF 2 <filter-tmp.pdf >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.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
	      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
# work.

filter.info:  filter-info.xml
	      docbook2texi filter-info.xml
	      perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
		<exim_filtering.texi | ./Tidytxt >filter.texinfo
	      /bin/rm -rf exim_filtering.texi
	      makeinfo -o filter.info filter.texinfo

########################################################################


################################ SPEC ##################################

spec.xml:      spec.xfpt local_params
	       xfpt $<

spec-pr.xml:   spec.xml Pre-xml
	       ./Pre-xml -optbreak <spec.xml >spec-pr.xml

spec-txt.xml:  spec.xml Pre-xml
	       ./Pre-xml -ascii -html -noindex -quoteliteral \
		 <spec.xml >spec-txt.xml

spec-info.xml: spec.xml Pre-xml
	       ./Pre-xml -ascii -html -noindex <spec.xml >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

###
### PS/PDF generation using fop
###

# Do not use pdf2ps from the PDF version; better PS is generated directly.

fop-spec.ps:  spec.fo
	      FOP_OPTS=-Xmx512m fop spec.fo -ps spec-tmp.ps
	      mv spec-tmp.ps spec.ps

# Do not use ps2pdf from the PS version; better PDF is generated directly. It
# 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.

fop-spec.pdf: spec.fo PageLabelPDF
	      FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf
	      ./PageLabelPDF 12 <spec-tmp.pdf >spec.pdf

###
### 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; }
		w3m -dump $< | ./Tidytxt -utf8 >$@

spec.txt: spec-txt.html Tidytxt
	      LC_ALL=C w3m -dump $< | ./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
# work.

spec.info:    spec-info.xml
	      docbook2texi spec-info.xml
	      ./TidyInfo <the_exim_mta.texi >spec.texinfo
	      /bin/rm -rf the_exim_mta.texi
	      makeinfo -o spec.info --no-split spec.texinfo

########################################################################


################################ TEST ##################################

# These targets (similar to the above)  are for running little tests.

test.xml:     test.xfpt
	      xfpt test.xfpt

test-pr.xml:  test.xml Pre-xml
	      ./Pre-xml <test.xml >test-pr.xml

test-html.xml: test.xml Pre-xml
	      ./Pre-xml -html -oneindex <test.xml >test-html.xml

test-txt.xml: test.xml Pre-xml
	      ./Pre-xml -ascii -html -noindex -quoteinfo \
		<test.xml >test-txt.xml

test-info.xml: test.xml Pre-xml
	      ./Pre-xml -ascii -html -noindex <test.xml >test-info.xml

test.fo:      test-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
                MyTitleStyle.xsl
	      /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.

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.

fop-test.pdf: test.fo
	      fop test.fo -pdf test-tmp.pdf
	      mv test-tmp.pdf test.pdf

###
### 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
	      w3m -dump test-txt.html | Tidytxt >test.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
# work.

test.info:    test-info.xml
	      docbook2texi test-info.xml
	      ./TidyInfo <short_title.texi >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 *.pdf *.ps \
	      filter*.html spec*.html test*.html \
	      filter*.txt spec*.txt test*.txt \
	      *.info* *.texinfo *.texi

########################################################################
Commit	Line	Data
9b371988	1	# Make file for Exim documentation from xfpt source.
168e428f PH	2
	3	notarget:; @echo "** You must specify a target, in the form x.y, where x is 'filter', 'spec',"
	4	@echo "** or 'test', and y is 'xml', 'fo', 'ps', 'pdf', 'html', 'txt', or 'info'."
263c04a6	5	@echo "** One other possible targets 'exim.8', 'spec.utf8'".
168e428f PH	6	exit 1
	7
	8
207c78ae NM	9	############################# EVERYTHING ###############################
	10	#
	11	# Generate all the documentation files...
	12	#
4a04fa7a	13	## removed info files as I cannot generate them - spec.info filter.info
50023e05 NM	14	## removed html files as superceded by new website code
	15	everything: spec.pdf spec.ps spec.txt \
	16	filter.pdf filter.ps filter.txt \
207c78ae NM	17	exim.8
207c78ae NM	18
168e428f PH	19	############################## MAN PAGE ################################
168e428f PH	20
9b371988	21	exim.8: spec.xml x2man
168e428f PH	22	./x2man
	23
	24	########################################################################
	25
263c04a6 HSHR	26	# .PHONY doesn't work here, because it forces a rebuild of all dependend
	27	# targets, always. It sets the internal timestamp of its target to
	28	# now().
	29	# But it may happen that local_params does not change
	30	FORCE:
	31	local_params: FORCE GenLocalParams
	32	@set -e; \
	33	trap 'rm -f $$tmp' EXIT; \
	34	tmp=`mktemp`; \
	35	./GenLocalParams $$tmp; \
	36	cmp -s $@ $$tmp \|\| mv $$tmp $@
168e428f PH	37
	38	############################### FILTER #################################
	39
2aee48d6	40	filter.xml: local_params filter.xfpt
f89d2485	41	xfpt filter.xfpt
168e428f	42
f89d2485 PH	43	filter-pr.xml: filter.xml Pre-xml
f89d2485 PH	44	./Pre-xml -bookinfo <filter.xml >filter-pr.xml
168e428f	45
f89d2485 PH	46	filter-txt.xml: filter.xml Pre-xml
f89d2485 PH	47	./Pre-xml -ascii -html -quoteliteral <filter.xml >filter-txt.xml
9b371988 PH	48
9b371988 PH	49	filter-info.xml: filter.xml Pre-xml
f89d2485	50	./Pre-xml -ascii -html <filter.xml >filter-info.xml
168e428f	51
f89d2485 PH	52	filter.fo: filter-pr.xml MyStyle-filter-fo.xsl MyStyle-fo.xsl MyStyle.xsl
	53	/bin/rm -rf filter.fo filter-pr.fo
	54	xmlto -x MyStyle-filter-fo.xsl fo filter-pr.xml
	55	/bin/mv -f filter-pr.fo filter.fo
168e428f	56
deca074a PH	57	# Do not use pdf2ps from the PDF version; better PS is generated directly.
deca074a PH	58
f89d2485 PH	59	###
	60	### PS/PDF generation using fop
	61	###
	62
	63	fop-filter.ps: filter.fo
	64	fop filter.fo -ps filter-tmp.ps
	65	mv filter-tmp.ps filter.ps
168e428f	66
deca074a PH	67	# Do not use ps2pdf from the PS version; better PDF is generated directly. It
deca074a PH	68	# contains cross links etc.
d1e83bff	69
f89d2485 PH	70	fop-filter.pdf: filter.fo PageLabelPDF
	71	fop filter.fo -pdf filter-tmp.pdf
	72	./PageLabelPDF 2 <filter-tmp.pdf >filter.pdf
	73
	74	###
	75	### PS/PDF generation using SDoP
	76	###
	77
	78	sdop-filter.ps: filter-pr.xml
	79	sdop -o filter.ps filter-pr.xml
	80
4aa45c31	81	sdop-filter.pdf: filter.ps
f89d2485 PH	82	ps2pdf filter.ps filter.pdf
	83
	84	###
	85	### PS/PDF default setting
	86	###
	87
	88	filter.ps: sdop-filter.ps
	89
	90	filter.pdf: sdop-filter.pdf
	91
	92	###
	93	###
168e428f	94
9b371988 PH	95	filter.txt: filter-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
9b371988 PH	96	MyStyle.xsl
168e428f PH	97	/bin/rm -rf filter-txt.html
168e428f PH	98	xmlto -x MyStyle-txt-html.xsl html-nochunks filter-txt.xml
263c04a6	99	LC_ALL=C w3m -dump filter-txt.html \| ./Tidytxt >filter.txt
b32a9711	100	./SanityTestText filter.txt
168e428f PH	101
	102	# I have not found a way of making docbook2texi write its output anywhere
	103	# other than the file name that it makes up. The --to-stdout option does not
	104	# work.
	105
9b371988 PH	106	filter.info: filter-info.xml
9b371988 PH	107	docbook2texi filter-info.xml
168e428f	108	perl -ne 's/conceptindex/cindex/;s/optionindex/findex/;print;' \
207c78ae	109	<exim_filtering.texi \| ./Tidytxt >filter.texinfo
168e428f PH	110	/bin/rm -rf exim_filtering.texi
	111	makeinfo -o filter.info filter.texinfo
	112
	113	########################################################################
	114
	115
	116	################################ SPEC ##################################
	117
263c04a6 HSHR	118	spec.xml: spec.xfpt local_params
263c04a6 HSHR	119	xfpt $<
168e428f	120
f89d2485 PH	121	spec-pr.xml: spec.xml Pre-xml
f89d2485 PH	122	./Pre-xml -optbreak <spec.xml >spec-pr.xml
168e428f	123
f89d2485 PH	124	spec-txt.xml: spec.xml Pre-xml
	125	./Pre-xml -ascii -html -noindex -quoteliteral \
	126	<spec.xml >spec-txt.xml
9b371988 PH	127
9b371988 PH	128	spec-info.xml: spec.xml Pre-xml
f89d2485 PH	129	./Pre-xml -ascii -html -noindex <spec.xml >spec-info.xml
	130
	131	spec.fo: spec-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
	132	MyTitleStyle.xsl
	133	/bin/rm -rf spec.fo spec-pr.fo
	134	xmlto -x MyStyle-spec-fo.xsl fo spec-pr.xml
	135	/bin/mv -f spec-pr.fo spec.fo
168e428f	136
f89d2485 PH	137	###
	138	### PS/PDF generation using fop
	139	###
168e428f	140
deca074a PH	141	# Do not use pdf2ps from the PDF version; better PS is generated directly.
deca074a PH	142
f89d2485	143	fop-spec.ps: spec.fo
068aaea8 PH	144	FOP_OPTS=-Xmx512m fop spec.fo -ps spec-tmp.ps
068aaea8 PH	145	mv spec-tmp.ps spec.ps
168e428f	146
deca074a	147	# Do not use ps2pdf from the PS version; better PDF is generated directly. It
9b371988 PH	148	# contains cross links etc. We post-process it to add page label information
9b371988 PH	149	# so that the page identifiers shown by acroread are the correct page numbers.
d1e83bff	150
f89d2485	151	fop-spec.pdf: spec.fo PageLabelPDF
deca074a	152	FOP_OPTS=-Xmx512m fop spec.fo -pdf spec-tmp.pdf
4f578862	153	./PageLabelPDF 12 <spec-tmp.pdf >spec.pdf
168e428f	154
f89d2485 PH	155	###
	156	### PS/PDF generation using SDoP
	157	###
	158
	159	sdop-spec.ps: spec-pr.xml
	160	sdop -o spec.ps spec-pr.xml
	161
4aa45c31	162	sdop-spec.pdf: spec.ps
f89d2485 PH	163	ps2pdf spec.ps spec.pdf
	164
	165	###
	166	### PS/PDF default setting
	167	###
	168
	169	spec.ps: sdop-spec.ps
	170
	171	spec.pdf: sdop-spec.pdf
	172
	173	###
	174	###
	175
263c04a6 HSHR	176	spec-txt.html: spec-txt.xml \
	177	MyStyle-txt-html.xsl MyStyle-html.xsl MyStyle.xsl
	178	xmlto -x MyStyle-txt-html.xsl html-nochunks $<
	179
	180	spec.utf8: spec-txt.html Tidytxt
	181	@grep -iq 'LC_CTYPE=.*utf-\?8' local_params \|\| { \
	182	echo 'your current locale does not support UTF-8' >&2; \
	183	false; }
	184	w3m -dump $< \| ./Tidytxt -utf8 >$@
	185
	186	spec.txt: spec-txt.html Tidytxt
	187	LC_ALL=C w3m -dump $< \| ./Tidytxt >$@
b32a9711	188	./SanityTestText spec.txt
168e428f	189
263c04a6	190
168e428f PH	191	# I have not found a way of making docbook2texi write its output anywhere
	192	# other than the file name that it makes up. The --to-stdout option does not
	193	# work.
	194
9b371988 PH	195	spec.info: spec-info.xml
9b371988 PH	196	docbook2texi spec-info.xml
4f578862	197	./TidyInfo <the_exim_mta.texi >spec.texinfo
168e428f	198	/bin/rm -rf the_exim_mta.texi
595028e4	199	makeinfo -o spec.info --no-split spec.texinfo
168e428f PH	200
	201	########################################################################
	202
	203
	204	################################ TEST ##################################
	205
	206	# These targets (similar to the above) are for running little tests.
	207
9b371988 PH	208	test.xml: test.xfpt
9b371988 PH	209	xfpt test.xfpt
168e428f	210
f89d2485 PH	211	test-pr.xml: test.xml Pre-xml
f89d2485 PH	212	./Pre-xml <test.xml >test-pr.xml
168e428f PH	213
168e428f PH	214	test-html.xml: test.xml Pre-xml
9b371988	215	./Pre-xml -html -oneindex <test.xml >test-html.xml
168e428f PH	216
168e428f PH	217	test-txt.xml: test.xml Pre-xml
9b371988 PH	218	./Pre-xml -ascii -html -noindex -quoteinfo \
	219	<test.xml >test-txt.xml
	220
	221	test-info.xml: test.xml Pre-xml
	222	./Pre-xml -ascii -html -noindex <test.xml >test-info.xml
168e428f	223
f89d2485	224	test.fo: test-pr.xml MyStyle-spec-fo.xsl MyStyle-fo.xsl MyStyle.xsl \
9b371988	225	MyTitleStyle.xsl
f89d2485 PH	226	/bin/rm -rf test.fo test-pr.fo
	227	xmlto -x MyStyle-spec-fo.xsl fo test-pr.xml
	228	/bin/mv -f test-pr.fo test.fo
	229
	230	###
	231	### PS/PDF generation using fop
	232	###
168e428f	233
deca074a PH	234	# Do not use pdf2ps from the PDF version; better PS is generated directly.
deca074a PH	235
f89d2485	236	fop-test.ps: test.fo
068aaea8 PH	237	fop test.fo -ps test-tmp.ps
068aaea8 PH	238	mv test-tmp.ps test.ps
168e428f	239
deca074a PH	240	# Do not use ps2pdf from the PS version; better PDF is generated directly. It
deca074a PH	241	# contains cross links etc.
d1e83bff	242
f89d2485	243	fop-test.pdf: test.fo
deca074a PH	244	fop test.fo -pdf test-tmp.pdf
deca074a PH	245	mv test-tmp.pdf test.pdf
168e428f	246
f89d2485 PH	247	###
	248	### PS/PDF generation using SDoP
	249	###
	250
	251	sdop-test.ps: test-pr.xml
	252	sdop -o test.ps test-pr.xml
	253
4aa45c31	254	sdop-test.pdf: test.ps
f89d2485 PH	255	ps2pdf test.ps test.pdf
	256
	257	###
	258	### PS/PDF default setting
	259	###
	260
	261	test.ps: sdop-test.ps
	262
	263	test.pdf: sdop-test.pdf
	264
	265	###
	266	###
	267
	268
9b371988 PH	269	test.txt: test-txt.xml Tidytxt MyStyle-txt-html.xsl MyStyle-html.xsl \
9b371988 PH	270	MyStyle.xsl
168e428f PH	271	/bin/rm -rf test-txt.html
	272	xmlto -x MyStyle-txt-html.xsl html-nochunks test-txt.xml
	273	w3m -dump test-txt.html \| Tidytxt >test.txt
	274
	275	# I have not found a way of making docbook2texi write its output anywhere
	276	# other than the file name that it makes up. The --to-stdout option does not
	277	# work.
	278
9b371988 PH	279	test.info: test-info.xml
9b371988 PH	280	docbook2texi test-info.xml
4f578862	281	./TidyInfo <short_title.texi >test.texinfo
168e428f PH	282	/bin/rm -rf short_title.texi
	283	makeinfo -o test.info test.texinfo
	284
	285	########################################################################
	286
	287
a2119650 NM	288	############################## OS FIXUP ################################
	289
	290	# Yes, we've advanced so far in text processing that we now have to
	291	# hardcode in complete paths and so become dependent upon exactly where
	292	# files were installed for xsl:import. Which of course varies by OS.
	293
	294	os-fixup:
	295	./OS-Fixups
	296
	297	########################################################################
	298
	299
168e428f PH	300	################################ CLEAN #################################
	301
	302	clean:; /bin/rm -rf exim.8 \
	303	filter.xml spec.xml test*.xml \
ca0ff207 TL	304	.fo .pdf *.ps \
ca0ff207 TL	305	filter.html spec.html test*.html \
168e428f PH	306	filter.txt spec.txt test*.txt \
	307	.info .texinfo .texi
	308
	309	########################################################################