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