Fixed publishing date info.
[tprouty/samba.git] / docs-xml / Makefile
1 #################################################################
2 # Makefile for Samba Documentation
3 # Authors:      
4 #               James Moore <jmoore@php.net>
5 #               Gerald Carter <jerry@samba.org>
6 #               Jelmer Vernooij <jelmer@samba.org>
7 include Makefile.settings
8
9 # Docs to build
10 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
11 MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
12 export TEXINPUTS=xslt/latex:.:
13
14 # Lists of files to process
15 LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf
16 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR3)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES3))
17
18 DATETIME := $(shell date +%Y%m%d%H%M%S)
19
20 ifeq ($(PROFILE), Y)
21 XSLTPROC += --profile --load-trace --timing
22 endif
23
24 ifndef OUTPUTDIR
25 Makefile.settings: configure
26         @echo Makefile.settings not present, trying to run configure...
27         ./configure
28
29 configure: configure.ac
30         @echo configure not present, trying to regenerate it...
31         autoreconf
32 endif
33
34 help: 
35         @echo "Supported make targets:"
36         @echo " release - Build the docs needed for a Samba release"
37         @echo " all - Build all docs that can be build using the utilities found by configure"
38         @echo " everything - Build all of the above"
39         @echo " pdf,tex,dvi,ps,manpages3,txt,pearson,fo,htmlhelp - Build specific output format"
40         @echo " html - Build multi-file HTML versions"
41         @echo " html-single - Build single-file HTML versions"
42         @echo " htmlman3 - Build HTML version of manpages"
43         @echo " undocumented - Output list of undocumented smb.conf options"
44         @echo " samples - Extract examples"
45
46 $(DOCBOOKDIR)/Samba3-ByExample.xml: $(filter-out Samba3-ByExample/index.xml,$(wildcard Samba3-ByExample/*.xml))
47 $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(filter-out Samba3-HOWTO/index.xml,$(wildcard Samba3-HOWTO/*.xml)) Samba3-HOWTO-attributions.xml
48 Samba3-HOWTO/manpages.xml: $(MANPAGEDIR3)/smb.conf.5.xml
49 $(DOCBOOKDIR)/Samba3-Developers-Guide.xml: $(filter-out Samba3-Developers-Guide/index.xml,$(wildcard Samba3-Developers-Guide/*.xml)) Samba3-Developers-Guide-attributions.xml
50 $(DOCBOOKDIR)/Samba4-HOWTO.xml: $(filter-out Samba4-HOWTO/index.xml,$(wildcard Samba4-HOWTO/*.xml)) Samba4-HOWTO-attributions.xml
51
52 # Pseudo targets 
53 all: $(TARGETS)
54 everything: manpages3 pdf html-single html htmlman3 txt ps fo htmlhelp pearson 
55 release: manpages3 htmlman3 html pdf 
56 clean:
57         @echo "Cleaning up..." 
58         rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
59         rm -f $(patsubst %.svg,%.png,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-dia))) \
60                         $(patsubst %.svg,%.pdf,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg))) \
61                         $(patsubst %.svg,%.eps,$(foreach DOC,$(MAIN_DOCS),$($(DOC)-images-latex-svg)))
62         rm -f *-attributions.xml *.d *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux
63         rm -f *-images-html*
64         rm -f *-images-latex-* latexfigures
65         rm -f xslt/figures/*pdf
66         rm -f $(SMBDOTCONFDOC)/parameters.*.xml
67         rm -f $(addsuffix .*,$(MAIN_DOCS))
68
69 # Output format targets
70 pdf: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
71 dvi: $(patsubst %,$(DVIDIR)/%.dvi,$(MAIN_DOCS))
72 ps: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
73 txt: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
74 txt-chunks: $(addsuffix -txt-chunks,$(MAIN_DOCS))
75 fo: $(patsubst %,$(FODIR)/%.fo,$(MAIN_DOCS))
76 fo-pdf: $(patsubst %,$(FOPDFDIR)/%.pdf,$(MAIN_DOCS))
77 tex: $(addsuffix .tex,$(MAIN_DOCS))
78 texi: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
79 texiinfo: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
80 manpages3: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3))
81 pearson: $(PEARSONDIR)/Samba3-HOWTO.xml
82 pearson-verify: $(PEARSONDIR)/Samba3-HOWTO.report.html
83 plucker: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
84 htmlman3: $(patsubst $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/index.html
85 html-single: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
86 html: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
87 htmlhelp: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
88 validate: $(addsuffix -validate,$(MAIN_DOCS))
89
90 # Intermediate docbook docs
91 #
92 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
93         @echo "Converting Samba-specific tags for $*..."
94         @mkdir -p $(@D)
95         $(XSLTPROC) --stringparam latex.imagebasedir "$*/"  --stringparam noreference 0  --xinclude --output $@ xslt/expand-sambadoc.xsl $<
96
97 $(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl
98         @mkdir -p $(@D)
99         $(XSLTPROC) --xinclude --stringparam noreference 0 --output $@ xslt/expand-sambadoc.xsl $<
100
101 $(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl
102         @mkdir -p $(@D)
103         echo "<article><variablelist>" > $@
104         $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
105         @echo "</variablelist></article>" >> $@
106
107 # HTML docs
108
109 $(HTMLDIR)/index.html: htmldocs.html
110         @mkdir -p $(@D)
111         cp $< $@
112         
113 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks
114         @mkdir -p $(@D)
115         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
116
117 # Single large HTML files
118 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
119         @mkdir -p $(@D)
120         cp $< $@
121
122 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
123
124 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl 
125         $(XSLTPROC) --output $@ xslt/html.xsl $<
126
127 # Attributions
128 %-attributions.xml: 
129         @echo "Generating attributions file $@ from $*/"
130         @cp -f templates/attributions.xml $@
131         $(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml 
132
133 # Text files
134 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
135         @mkdir -p $(@D)
136         $(HTML2TEXT) -nobs -style pretty -o $@ $<
137
138 # Tex files
139 %.tex: %/index.xml xslt/latex.xsl
140         @echo "Generating $@..."
141         @mkdir -p $(@D)
142         $(XSLTPROC) $(DB2LATEX_ARGS) --stringparam latex.imagebasedir "$*/" --xinclude --output $@ xslt/latex.xsl $<
143
144 latexfigures: $(LATEX_FIGURES)
145
146 $(PDFDIR)/%.pdf: %.pdf
147         @mkdir -p $(@D)
148         cp $< $@
149
150 %.idx: %.tex latexfigures
151         -$(PDFLATEX) $<
152
153 %.ind: %.idx
154         $(MAKEINDEX) $<
155
156 # Dependency files
157 %.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
158         @echo "Generating dependency file for $*" 
159         $(XSLTPROC) \
160                 --novalid \
161                 --stringparam txtbasedir "$(TXTDIR)/$*/" \
162                 --stringparam target "$*" \
163                 -o $@ xslt/generate-dependencies.xsl $<
164         @echo "$*-images-latex-svg = \$$(wildcard \$$(addsuffix .svg, \$$($*-images-latex)))" >> $@
165         @echo "$*-images-latex-eps: \$$(addsuffix .eps, \$$($*-images-latex))" >> $@
166         @echo "$*-images-latex-pdf: \$$(patsubst %.svg, %.pdf, \$$($*-images-latex-svg))" >> $@
167         @echo "$*-images-latex-png: \$$(filter-out \$$(patsubst %.svg,%.png,\$$($*-images-latex-svg)), \$$(addsuffix .png, \$$($*-images-latex)))" >> $@
168
169         @echo >> $@
170         @echo "\$$(HTMLDIR)/%: $*/%" >> $@
171         @echo " @mkdir -p \$$(@D)" >> $@
172         @echo " @cp \$$< \$$@" >> $@
173         @echo >> $@
174         @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@
175         @echo " @mkdir -p \$$(@D)" >> $@
176         @echo " @cp \$$< \$$@" >> $@
177         @echo >> $@
178         @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@
179         @echo " @mkdir -p \$$(@D)" >> $@
180         @echo " @cp \$$< \$$@" >> $@
181         @echo >> $@
182         @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@
183         @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@
184         @echo "$*-images-htmlhelp: \$$(addprefix \$$(HTMLHELPDIR)/$*/, \$$($*-images-html))" >> $@
185
186 ifdef OUTPUTDIR 
187 ifneq ($(MAKECMDGOALS),clobber)
188 -include $(addsuffix .d,$(MAIN_DOCS))
189 endif
190 endif
191
192 # Adobe PDF files
193 %.pdf: %.tex %.ind latexfigures %-images-latex-png %-images-latex-pdf
194         -$(PDFLATEX) $<
195         -$(PDFLATEX) $<
196         -$(PDFLATEX) $<
197         -$(PDFLATEX) $<
198         $(THUMBPDF) --quiet $*.pdf
199         -$(PDFLATEX) $<
200
201 # DVI files
202 $(DVIDIR)/%.dvi: %.dvi
203         @mkdir -p $(@D)
204         cp $< $@
205
206 %.dvi: %.tex %.idx %-images-latex-eps
207         -$(LATEX) $< 
208
209 %.eps: %.svg
210         $(INKSCAPE) -z -f $< --export-eps=$@
211
212 %.png: %.svg
213         $(INKSCAPE) -z -f $< --export-png=$@
214
215 #%.pdf: %.svg
216 #       $(INKSCAPE) -z -f $< --export-pdf=$@
217
218 %.pdf: %.eps
219         $(EPSTOPDF) $<
220
221 %.eps: %.png
222         $(PNGTOPNM) $< | $(PNMTOPS) > $@
223
224 # PostScript files
225 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
226         @mkdir -p $(@D)
227         $(DVIPS) -o $@ $<
228
229 # Fo
230 $(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
231         @mkdir -p $(@D)
232         $(XSLTPROC) --output $@ xslt/fo.xsl $<
233
234 # PDF thru Fo
235 $(FOPDFDIR)/%.pdf: $(FODIR)/%.fo
236         @mkdir -p $(@D)
237         JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@
238
239 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
240         $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
241                                 --stringparam manifest.in.base.dir "$@/" \
242                                 --stringparam base.dir "$@/" \
243         http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
244
245 # Plucker docs
246 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html 
247         @mkdir -p $(@D)
248         $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$< 
249
250 # Texinfo docs
251 $(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
252         @mkdir -p $(@D)
253         cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
254
255 $(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
256         $(MAKEINFO) --no-validate --force -o $@ "$<"
257
258 # Manpages
259 $(MANPAGEDIR3)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
260
261 $(SMBDOTCONFDOC)/parameters.all.xml: $(wildcard $(SMBDOTCONFDOC)/*/*.xml) $(SMBDOTCONFDOC)/generate-file-list.sh
262         $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
263
264 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
265         @echo "Generating list of global smb.conf options" 
266         $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
267
268 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
269         @echo "Generating list of share-mode smb.conf options" 
270         $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
271
272 $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
273         @mkdir -p $(@D)
274         $(XSLTPROC) --output $@ xslt/man.xsl $<
275
276 # Individual smb.conf parameters
277 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
278         
279 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
280         @mkdir -p $(@D)
281         $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
282
283 # Pearson compatible XML
284 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
285         @mkdir -p $(@D)
286         $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
287
288 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
289         @mkdir -p $(@D)
290         -$(XMLLINT) --valid --noout $< 2> $@
291
292 # Validation verification
293 %-validate: %/index.xml
294         cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
295
296 # Find undocumented parameters
297 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
298         $(PERL) scripts/find_missing_doc.pl $(SRCDIR)
299         $(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
300
301 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
302         @mkdir -p $(EXAMPLESDIR)
303         $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
304         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
305
306 # Archiving
307 archive: pdf
308         @mkdir -p $(ARCHIVEDIR)
309         cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
310         cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
311
312 # XSL scripts
313 xslt/html.xsl: xslt/html-common.xsl 
314 xslt/html-chunk.xsl: xslt/html-common.xsl 
315 xslt/latex.xsl: 
316 xslt/expand-sambadoc.xsl: 
317 xslt/generate-attributions.xsl: 
318 xslt/man.xsl:
319 xslt/pearson.xsl:
320
321 distclean clobber: clean
322         rm Makefile.settings config.status config.log configure
323         rm -rf autom4te.cache
324
325
326 # Always keep intermediate files if we can
327 .SECONDARY:
328 .PHONY: clean clobber archive release everything all $(TARGETS) latexfigures
329