docs/Makefile.in

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