docs/Makefile

   1 #################################################################
   2 # Makefile.in 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,$(DOCBOOKDIR)/%.xml,$(wildcard */index.xml))
  11 MANPAGES = $(wildcard $(MANPAGEDIR)/*.?.xml)
  12
  13 # Lists of files to process
  14 LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf
  15 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES))
  16
  17 ifndef OUTPUTDIR
  18 Makefile.settings: Makefile.settings.in configure
  19         @echo Makefile.settings not present, trying to run configure...
  20         @./configure
  21
  22 configure: configure.in
  23         @echo configure not present, trying to generate
  24         @autoreconf
  25 endif
  26
  27 help:
  28         @echo "Supported make targets:"
  29         @echo " release - Build the docs needed for a Samba release"
  30         @echo " all - Build all docs that can be build using the utilities found by configure"
  31         @echo " everything - Build all of the above"
  32         @echo " pdf,tex,dvi,ps,manpages,txt,pearson,fo,htmlhelp - Build specific output format"
  33         @echo " html - Build multi-file HTML version of HOWTO Collection, Guide and Dev-Guide"
  34         @echo " html-single - Build single-file HTML version of HOWTO Collection, Guide and Dev-Guide"
  35         @echo " htmlman - Build HTML version of manpages"
  36         @echo " undocumented - Output list of undocumented smb.conf options"
  37         @echo " samples - Extract examples"
  38         @echo " files - Extract other files"
  39
  40
  41
  42 Samba-Guide/index.xml: $(subst Samba-Guide/index.xml,,$(wildcard Samba-Guide/*.xml))
  43 Samba-HOWTO-Collection/index.xml: $(subst Samba-HOWTO-Collection/index.xml,,$(wildcard Samba-HOWTO-Collection/*.xml)) Samba-HOWTO-Collection-attributions.xml
  44 Samba-Developers-Guide/index.xml: $(subst Samba-Developers-Guide/index.xml,,$(wildcard Samba-Developers-Guide/*.xml)) Samba-Developers-Guide-attributions.xml
  45
  46 # Pseudo targets
  47 all: $(TARGETS)
  48 everything: manpages pdf html-single html htmlman txt ps fo htmlhelp pearson verify
  49 release: manpages htmlman html pdf
  50
  51 # Output format targets
  52 pdf: $(patsubst $(DOCBOOKDIR)/%.xml,$(PDFDIR)/%.pdf,$(MAIN_DOCS))
  53 dvi: $(patsubst $(DOCBOOKDIR)/%.xml,$(DVIDIR)/%.dvi,$(MAIN_DOCS))
  54 ps: $(patsubst $(DOCBOOKDIR)/%.xml,$(PSDIR)/%.ps,$(MAIN_DOCS))
  55 txt: $(patsubst $(DOCBOOKDIR)/%.xml,$(TXTDIR)/%.txt,$(MAIN_DOCS))
  56 txt-chunks: $(patsubst $(DOCBOOKDIR)/%.xml,$(TXTDIR)/%/,$(MAIN_DOCS))
  57 fo: $(patsubst $(DOCBOOKDIR)/%.xml,$(FODIR)/%.fo,$(MAIN_DOCS))
  58 tex: $(patsubst $(DOCBOOKDIR)/%.xml,%.tex,$(MAIN_DOCS))
  59 manpages: $(patsubst $(MANPAGEDIR)/%.xml,$(MANDIR)/%,$(MANPAGES))
  60 pearson: $(PEARSONDIR)/Samba-HOWTO-Collection.xml
  61 pearson-verify: $(PEARSONDIR)/Samba-HOWTO-Collection.report.html
  62 plucker: $(patsubst $(DOCBOOKDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MAIN_DOCS))
  63 htmlman: $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/%.html,$(MANPAGES)) $(HTMLDIR)/manpages.html
  64 html-single: $(patsubst $(DOCBOOKDIR)/%.xml,$(HTMLDIR)/%.html,$(MAIN_DOCS))
  65 html: $(patsubst $(DOCBOOKDIR)/%.xml,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
  66 htmlhelp: $(patsubst $(DOCBOOKDIR)/%.xml,$(HTMLHELPDIR)/%,$(MAIN_DOCS))
  67
  68 # Intermediate docbook docs
  69
  70 $(DOCBOOKDIR)/%.xml: %/index.xml xslt/expand-sambadoc.xsl
  71         mkdir -p $(@D)
  72         $(XSLTPROC) --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
  73
  74 $(DOCBOOKDIR)/%.xml: $(MANPAGEDIR)/%.xml xslt/expand-sambadoc.xsl
  75         mkdir -p $(@D)
  76         $(XSLTPROC) --xinclude --stringparam latex.imagebasedir "$*/" --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
  77
  78 $(DOCBOOKDIR)/manpages.xml: $(MANPAGES) xslt/manpage-summary.xsl
  79         mkdir -p $(@D)
  80         echo "<article><variablelist>" > $@
  81         for I in $(MANPAGES); do $(XSLTPROC) xslt/manpage-summary.xsl $$I >> $@; done
  82         echo "</variablelist></article>" >> $@
  83
  84 # HTML docs
  85
  86 $(HTMLDIR)/index.html: htmldocs.html
  87         mkdir -p $(@D)
  88         cp $< $@
  89
  90 $(HTMLDIR)/%/index.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/%/samba.css  xslt/html-chunk.xsl
  91         mkdir -p $(@D)
  92         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/$*/" xslt/html-chunk.xsl $<
  93         -mkdir $(@D)/images
  94         $(COPY_IMAGES) html $(DOCBOOKDIR)/$*.xml $* $(@D)
  95
  96 # Single large HTML files
  97 $(OUTPUTDIR)/%/samba.css: xslt/html/samba.css
  98         mkdir -p $(@D)
  99         cp $< $@
 100
 101 $(HTMLDIR)/%.html: $(DOCBOOKDIR)/%.xml $(HTMLDIR)/samba.css xslt/html.xsl
 102         mkdir -p $(@D)/images
 103         $(COPY_IMAGES) html $(DOCBOOKDIR)/$*.xml $* $(@D)
 104         $(XSLTPROC) --output $@ xslt/html.xsl $<
 105
 106 %-attributions.xml:
 107         echo "<para/>" > $@
 108         $(XSLTPROC) --xinclude xslt/generate-attributions.xsl $*/index.xml > $@
 109
 110 clobber: clean
 111         rm Makefile.settings settings.xsl config.status config.log configure
 112
 113 clean:
 114         rm -rf $(OUTPUTDIR)/* $(DOCBOOKDIR)
 115         rm -f *.xml
 116         rm -f xslt/figures/*pdf
 117         rm -f $(SMBDOTCONFDOC)/parameters.*.xml
 118         rm -f $(patsubst $(DOCBOOKDIR)/%.xml,%.*,$(MAIN_DOCS))
 119
 120 # Text files
 121 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
 122         mkdir -p $(@D)
 123         $(HTML2TEXT) -nobs -style pretty -o $@ $<
 124
 125 $(TXTDIR)/%/: $(HTMLDIR)/%/index.html
 126         $(MAKE) `echo $(HTMLDIR)/$*/*.html | $(PERL) -p -e 's|$(HTMLDIR)|$(TXTDIR)|g;s/\.html/\.txt/g;'`
 127
 128 # Tex files
 129 %.tex: $(DOCBOOKDIR)/%.xml xslt/latex.xsl
 130         mkdir -p $(@D)
 131         $(XSLTPROC) --output $@ xslt/latex.xsl $<
 132
 133 latexfigures: $(LATEX_FIGURES)
 134
 135 $(PDFDIR)/%.pdf: %.pdf
 136         mkdir -p $(@D)
 137         cp $< $@
 138
 139 %.idx: %.tex latexfigures
 140         -$(PDFLATEX) $<
 141
 142 %.ind: %.idx
 143         $(MAKEINDEX) $<
 144
 145 # Adobe PDF files
 146 %.pdf: %.tex %.ind latexfigures
 147         $(MAKE) $(shell $(XSLTPROC) --stringparam prepend "" --stringparam append ".png" --stringparam role latex xslt/find-image-dependencies.xsl $(DOCBOOKDIR)/$*.xml)
 148         -$(PDFLATEX) $<
 149         $(THUMBPDF) $*.pdf
 150         -$(PDFLATEX) $<
 151
 152 # DVI files
 153 $(DVIDIR)/%.dvi: %.dvi
 154         mkdir -p $(@D)
 155         cp $< $@
 156
 157 %.dvi: %.tex %.idx
 158         $(MAKE) $(shell $(XSLTPROC) --stringparam prepend "" --stringparam append ".eps" --stringparam role latex xslt/find-image-dependencies.xsl $(DOCBOOKDIR)/$*.xml)
 159         -$(LATEX) $<
 160
 161 %.png: %.dia
 162         $(DIA) -e $@ $<
 163
 164 %.eps: %.png
 165         $(PNGTOPNM) $< | $(PNMTOPS) > $@
 166
 167 # PostScript files
 168 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
 169         mkdir -p $(@D)
 170         $(DVIPS) -o $@ $<
 171
 172 xslt/figures/%.pdf: xslt/figures/%.eps
 173         $(EPSTOPDF) $<
 174
 175 # Fo
 176 $(FODIR)/%.fo: $(DOCBOOKDIR)/%.xml
 177         mkdir -p $(@D)
 178         $(XSLTPROC) --output $@ http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl $<
 179
 180 $(HTMLHELPDIR)/%: $(DOCBOOKDIR)/%.xml
 181         -mkdir -p $@/images
 182         $(COPY_IMAGES) html $(DOCBOOKDIR)/$*.xml $* $@
 183         $(XSLTPROC) --stringparam htmlhelp.chm $*.chm --stringparam manifest.in.base.dir "$@/" --stringparam base.dir "$@/" http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
 184
 185 # Plucker docs
 186 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
 187         mkdir -p $(@D)
 188         $(PLUCKERBUILD) -v -M1 --stayonhost  --noimages --zlib-compression -H file:$< -f $* -p $(PLUCKERDIR)
 189
 190 # Manpages
 191 $(MANPAGEDIR)/smb.conf.5.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/parameters.global.xml
 192
 193 $(SMBDOTCONFDOC)/parameters.all.xml: $(shell find $(SMBDOTCONFDOC) -type f -name '*.xml' -mindepth 2 | sort -t/ -k3 | xargs) $(SMBDOTCONFDOC)/generate-file-list.sh
 194         $(SMBDOTCONFDOC)/generate-file-list.sh $(SMBDOTCONFDOC) > $@
 195
 196 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 197         $(XSLTPROC) --xinclude --param smb.context "'G'" --output $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 198
 199 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 200         $(XSLTPROC) --xinclude --param smb.context "'S'" --output $(SMBDOTCONFDOC)/parameters.service.xml $(SMBDOTCONFDOC)/generate-context.xsl $<
 201
 202 $(MANDIR)/%: $(DOCBOOKDIR)/%.xml xslt/man.xsl
 203         mkdir -p $(@D)
 204         $(XSLTPROC) --output $@ xslt/man.xsl $<
 205
 206 # Individual smb.conf parameters
 207 smb.conf-chunks: $(patsubst $(SMBDOTCONFDOC)/%.xml,$(HTMLDIR)/smb.conf/%.html,$(wildcard $(SMBDOTCONFDOC)/*/*.xml))
 208
 209 $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
 210         mkdir -p $(@D)
 211         $(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
 212
 213 # Pearson compatible XML
 214
 215 $(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
 216         mkdir -p $(@D)
 217         $(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
 218
 219 $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
 220         mkdir -p $(@D)
 221         $(XMLLINT) --valid --noout --htmlout $< 2> $@
 222
 223 # Validation verification
 224
 225 $(VALIDATEDIR)/%.report.html: $(DOCBOOKDIR)/%.xml
 226         mkdir -p $(@D)
 227         $(XMLLINT) --valid --noout --htmlout $< 2> $@
 228
 229 verify: $(VALIDATEDIR)/Samba-HOWTO-Collection.report.html $(VALIDATEDIR)/Samba-Developers-Guide.report.html $(VALIDATEDIR)/Samba-Guide.report.html
 230
 231 # Find undocumented parameters
 232
 233 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml scripts/find_missing_doc.pl scripts/find_missing_manpages.pl
 234         @$(PERL) scripts/find_missing_doc.pl $(SRCDIR)
 235         @$(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
 236
 237 # Examples and the like
 238
 239 files: $(HOWTODIR)/index.xml xslt/extract-smbfiles.xsl
 240         $(XSLTPROC) xslt/extract-smbfiles.xsl $< > /dev/null
 241
 242 samples: $(DOCBOOKDIR)/Samba-HOWTO-Collection.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
 243         mkdir -p $(EXAMPLESDIR)
 244         $(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
 245         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
 246
 247 # Archiving
 248 archive: pdf
 249         mkdir -p $(ARCHIVEDIR)
 250         cp $(PDFDIR)/Samba-HOWTO-Collection.pdf $(ARCHIVEDIR)/TOSHARG-`date +%Y%m%d%H%M%S`.pdf
 251         cp $(PDFDIR)/Samba-Guide.pdf $(ARCHIVEDIR)/S3bE-`date +%Y%m%d%H%M%S`.pdf
 252
 253 # XSL scripts
 254 xslt/html.xsl: xslt/html-common.xsl settings.xsl
 255 xslt/html-chunk.xsl: xslt/html-common.xsl settings.xsl
 256 xslt/latex.xsl: settings.xsl
 257 xslt/expand-sambadoc.xsl: settings.xsl
 258 xslt/generate-attributions.xsl:
 259 xslt/man.xsl:
 260 xslt/pearson.xsl:
 261
 262 .SECONDARY: