1 #################################################################
2 # Makefile for Samba Documentation
4 # James Moore <jmoore@php.net>
5 # Gerald Carter <jerry@samba.org>
6 # Jelmer Vernooij <jelmer@samba.org>
7 include Makefile.settings
10 MAIN_DOCS = $(patsubst %/index.xml,%,$(wildcard */index.xml))
11 MANPAGES3 = $(wildcard $(MANPAGEDIR3)/*.?.xml)
12 export TEXINPUTS=xslt/latex:.:
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))
18 DATETIME := $(shell date +%Y%m%d%H%M%S)
21 Makefile.settings: configure
22 @echo Makefile.settings not present, trying to run configure...
25 configure: configure.in
26 @echo configure not present, trying to generate
31 @echo "Supported make targets:"
32 @echo " release - Build the docs needed for a Samba release"
33 @echo " all - Build all docs that can be build using the utilities found by configure"
34 @echo " everything - Build all of the above"
35 @echo " pdf,tex,dvi,ps,manpages3,txt,pearson,fo,htmlhelp - Build specific output format"
36 @echo " html - Build multi-file HTML versions"
37 @echo " html-single - Build single-file HTML versions"
38 @echo " htmlman3 - Build HTML version of manpages"
39 @echo " undocumented - Output list of undocumented smb.conf options"
40 @echo " samples - Extract examples"
42 $(DOCBOOKDIR)/Samba3-ByExample.xml: $(filter-out Samba3-ByExample/index.xml,$(wildcard Samba3-ByExample/*.xml))
43 $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(filter-out Samba3-HOWTO/index.xml,$(wildcard Samba3-HOWTO/*.xml)) Samba3-HOWTO-attributions.xml
44 Samba3-HOWTO/manpages.xml: $(MANPAGEDIR3)/smb.conf.5.xml
45 $(DOCBOOKDIR)/Samba3-Developers-Guide.xml: $(filter-out Samba3-Developers-Guide/index.xml,$(wildcard Samba3-Developers-Guide/*.xml)) Samba3-Developers-Guide-attributions.xml
46 $(DOCBOOKDIR)/Samba4-HOWTO.xml: $(filter-out Samba4-HOWTO/index.xml,$(wildcard Samba4-HOWTO/*.xml)) Samba4-HOWTO-attributions.xml
50 everything: manpages3 pdf html-single html htmlman3 txt ps fo htmlhelp pearson
51 release: manpages3 htmlman3 html pdf
53 # Output format targets
54 pdf: $(patsubst %,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
55 dvi: $(patsubst %,$(DVIDIR)/%.dvi,$(MAIN_DOCS))
56 ps: $(patsubst %,$(PSDIR)/%.ps,$(MAIN_DOCS))
57 txt: $(patsubst %,$(TXTDIR)/%.txt,$(MAIN_DOCS))
58 txt-chunks: $(addsuffix -txt-chunks,$(MAIN_DOCS))
59 fo: $(patsubst %,$(FODIR)/%.fo,$(MAIN_DOCS))
60 fo-pdf: $(patsubst %,$(FOPDFDIR)/%.pdf,$(MAIN_DOCS))
61 tex: $(addsuffix .tex,$(MAIN_DOCS))
62 texi: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
63 texiinfo: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
64 manpages3: $(patsubst $(MANPAGEDIR3)/%.xml,$(OUTPUTDIR)/manpages-3/%,$(MANPAGES3))
65 pearson: $(PEARSONDIR)/Samba3-HOWTO.xml
66 pearson-verify: $(PEARSONDIR)/Samba3-HOWTO.report.html
67 plucker: $(patsubst %,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
68 htmlman3: $(patsubst $(MANPAGEDIR3)/%.xml,$(HTMLDIR)/manpages-3/%.html,$(MANPAGES3)) $(HTMLDIR)/manpages-3/index.html
69 html-single: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
70 html: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
71 htmlhelp: $(addprefix $(HTMLHELPDIR)/,$(MAIN_DOCS))
72 validate: $(addsuffix -validate,$(MAIN_DOCS))
74 # Intermediate docbook docs
76 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
78 $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
80 $(DOCBOOKDIR)/manpages-3/%.xml: $(MANPAGEDIR3)/%.xml xslt/expand-sambadoc.xsl
82 $(XSLTPROC) --xinclude --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
84 $(DOCBOOKDIR)/manpages-3/index.xml: $(MANPAGES3) xslt/manpage-summary.xsl
86 echo "<article><variablelist>" > $@
87 $(XSLTPROC) xslt/manpage-summary.xsl $(MANPAGES3) >> $@
88 echo "</variablelist></article>" >> $@
92 $(HTMLDIR)/index.html: htmldocs.html
96 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css xslt/html-chunk.xsl %-images-html-chunks
98 $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
100 # Single large HTML files
101 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
105 $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS)): $(HTMLDIR)/%.html: %-images-html-single
107 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl
108 $(XSLTPROC) --output $@ xslt/html.xsl $<
112 $(XSLTPROC) --xinclude -o $@ xslt/generate-attributions.xsl $*/index.xml
115 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
117 $(HTML2TEXT) -nobs -style pretty -o $@ $<
120 %.tex: %/index.xml xslt/latex.xsl
122 $(XSLTPROC) --stringparam latex.imagebasedir "$*/" --xinclude --output $@ xslt/latex.xsl $<
124 latexfigures: $(LATEX_FIGURES)
126 $(PDFDIR)/%.pdf: %.pdf
130 %.idx: %.tex latexfigures
137 %.d: $(DOCBOOKDIR)/%.xml xslt/generate-dependencies.xsl
140 --stringparam txtbasedir "$(TXTDIR)/$*/" \
141 --stringparam target "$*" \
142 -o $@ xslt/generate-dependencies.xsl $<
143 @echo "$*-images-latex-png: \$$(addsuffix .png, \$$($*-images-latex))" >> $@
145 @echo "$*-images-latex-eps: \$$(addsuffix .eps, \$$($*-images-latex))" >> $@
147 @echo "\$$(HTMLDIR)/%: $*/%" >> $@
148 @echo " mkdir -p \$$(@D)" >> $@
149 @echo " cp \$$< \$$@" >> $@
151 @echo "\$$(HTMLDIR)/$*/%: $*/%" >> $@
152 @echo " mkdir -p \$$(@D)" >> $@
153 @echo " cp \$$< \$$@" >> $@
155 @echo "\$$(HTMLHELPDIR)/$*/%: $*/%" >> $@
156 @echo " mkdir -p \$$(@D)" >> $@
157 @echo " cp \$$< \$$@" >> $@
159 @echo "$*-images-html-single: \$$(addprefix \$$(HTMLDIR)/, \$$($*-images-html))" >> $@
160 @echo "$*-images-html-chunks: \$$(addprefix \$$(HTMLDIR)/$*/, \$$($*-images-html))" >> $@
161 @echo "$*-images-htmlhelp: \$$(addprefix \$$(HTMLHELPDIR)/$*/, \$$($*-images-html))" >> $@
164 ifneq ($(MAKECMDGOALS),clobber)
165 include $(addsuffix .d,$(MAIN_DOCS))
170 %.pdf: %.tex %.ind latexfigures %-images-latex-png
172 $(THUMBPDF) --quiet $*.pdf
176 $(DVIDIR)/%.dvi: %.dvi
180 %.dvi: %.tex %.idx %-images-latex-eps
187 $(PNGTOPNM) $< | $(PNMTOPS) > $@
190 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
194 xslt/figures/%.pdf: xslt/figures/%.eps
198 $(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
200 $(XSLTPROC) --output $@ xslt/fo.xsl $<
203 $(FOPDFDIR)/%.pdf: $(FODIR)/%.fo
205 JAVA_OPTS=-Xmx250m $(FOP) -q -d $< -pdf $@
207 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml %-images-htmlhelp
208 $(XSLTPROC) --stringparam htmlhelp.chm $*.chm \
209 --stringparam manifest.in.base.dir "$@/" \
210 --stringparam base.dir "$@/" \
211 http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
214 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
216 $(PLUCKERBUILD) -v -V 2 --stayonhost --zlib-compression -f $* -p $(PLUCKERDIR) file:$<
219 $(TEXINFODIR)/%.texi: $(DOCBOOKDIR)/%.xml
221 cd $(@D) && $(DB2TEXI) $(shell pwd)/$<
223 $(TEXINFODIR)/%.info: $(TEXINFODIR)/%.texi
224 $(MAKEINFO) --no-validate --force -o $@ "$<"
227 $(MANPAGEDIR3)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
229 $(SMBDOTCONFDOC)/parameters.all.xml: $(wildcard $(SMBDOTCONFDOC)/*/*.xml) $(SMBDOTCONFDOC)/generate-file-list.sh
230 $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
232 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
233 $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
235 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
236 $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
238 $(OUTPUTDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
240 $(XSLTPROC) --output $@ xslt/man.xsl $<
242 # Individual smb.conf parameters
243 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
245 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
247 $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
249 # Pearson compatible XML
250 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
252 $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
254 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
256 -$(XMLLINT) --valid --noout $< 2> $@
258 # Validation verification
259 %-validate: %/index.xml
260 cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
262 # Find undocumented parameters
263 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
264 @$(PERL) scripts/find_missing_doc.pl $(SRCDIR)
265 @$(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
267 samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
268 mkdir -p $(EXAMPLESDIR)
269 $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
270 for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
274 mkdir -p $(ARCHIVEDIR)
275 cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
276 cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
279 xslt/html.xsl: xslt/html-common.xsl
280 xslt/html-chunk.xsl: xslt/html-common.xsl
282 xslt/expand-sambadoc.xsl:
283 xslt/generate-attributions.xsl:
288 rm Makefile.settings config.status config.log configure
291 rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
292 rm -f *.xml *.d *.tpt *.tex *.loc *.toc *.lof *.glo *.idx *.aux
294 rm -f *-images-latex-* latexfigures
295 rm -f xslt/figures/*pdf
296 rm -f $(SMBDOTCONFDOC)/parameters.*.xml
297 rm -f $(addsuffix .*,$(MAIN_DOCS))
299 # Always keep intermediate files if we can
301 .PHONY: clean clobber archive release everything all $(TARGETS) latexfigures