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 # Please see http://www.samba.org/samba/cvs.html
   9 # for information on getting the latest
  10 # source and documentation source files.
  11 #
  12 #
  13
  14 # Programs
  15 WGET = @WGET@
  16 XSLTPROC = @XSLTPROC@
  17 XMLLINT = @XMLLINT@
  18 DVIPS = @DVIPS@
  19 PNGTOPNM = @PNGTOPNM@
  20 EPSTOPNM = @EPSTOPNM@
  21 PNMTOPNG = @PNMTOPNG@
  22 PNMTOPS = @PNMTOPS@
  23 HTML2TEXT = @HTML2TEXT@
  24 PLUCKERBUILD = @PLUCKERBUILD@
  25 PDFLATEX = TEXINPUTS=xslt/latex:.: @PDFLATEX@
  26 LATEX = TEXINPUTS=xslt/latex:.: @LATEX@
  27 RM = @RM@
  28 ifndef DEBUG_LATEX
  29 PDFLATEX += --interaction nonstopmode
  30 LATEX += --interaction nonstopmode
  31 endif
  32
  33 # Paths
  34 TOPDIR = $(shell pwd)
  35 OUTPUTDIR = $(TOPDIR)/output
  36 ARCHIVEDIR = $(OUTPUTDIR)/archive
  37 SRCDIR = @SAMBASOURCEDIR@
  38 MANDIR = $(OUTPUTDIR)/manpages
  39 EPSTOPDF = @EPSTOPDF@
  40 MANPAGEDIR = $(TOPDIR)/manpages
  41 HOWTODIR = $(TOPDIR)/howto
  42 GUIDEDOC = $(TOPDIR)/guide
  43 DEVDOCDIR = $(TOPDIR)/devel
  44 MAKEINDEX = @MAKEINDEX@
  45 IMAGEPROJDIR = $(HOWTODIR)/imagefiles
  46 IMAGEGUIDEDIR = $(GUIDEDOC)/images
  47 EXAMPLESDIR = $(TOPDIR)/examples
  48 SMBDOTCONFDOC = $(TOPDIR)/smbdotconf
  49 PSDIR = $(OUTPUTDIR)
  50 PDFDIR = $(OUTPUTDIR)
  51 DVIDIR = $(OUTPUTDIR)
  52 VALIDATEDIR = $(OUTPUTDIR)/validate
  53 TXTDIR = $(OUTPUTDIR)/textdocs
  54 HTMLDIR=$(OUTPUTDIR)/htmldocs
  55 PLUCKERDIR=$(OUTPUTDIR)/plucker
  56
  57 # Lists of files to process
  58 LATEX_FIGURES = xslt/figures/caution.pdf xslt/figures/important.pdf xslt/figures/note.pdf xslt/figures/tip.pdf xslt/figures/warning.pdf
  59 MANPAGES_SOURCES = $(wildcard $(MANPAGEDIR)/*.?.xml)
  60 MANPAGES = $(patsubst $(MANPAGEDIR)/%.xml,$(MANDIR)/%,$(MANPAGES_SOURCES)) $(MANDIR)/smb.conf.5
  61 MANPAGES_HTML = $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/%.html,$(MANPAGES_SOURCES)) $(HTMLDIR)/smb.conf.5.html
  62 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES_SOURCES)) $(PLUCKERDIR)/smb.conf.5.pdb
  63
  64 HOWTODIR_IMAGES_PNG = $(wildcard $(IMAGEPROJDIR)/*.png)
  65 GUIDEDOC_IMAGES_PNG = $(wildcard $(IMAGEGUIDEDIR)/*.png)
  66 HOWTODIR_IMAGES_EPS=$(patsubst %.png,%.eps,$(wildcard $(IMAGEPROJDIR)/*.png))
  67 HOWTODIR_DEPS = $(HOWTODIR)/*.xml $(HOWTODIR)/attributions.xml $(MANPAGEDIR)/*.xml $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml
  68 DEVDOCDIR_DEPS = $(DEVDOCDIR)/*.xml $(DEVDOCDIR)/attributions.xml
  69
  70 help:
  71         @echo "Supported make targets:"
  72         @echo "release - Build the docs needed for a Samba release"
  73         @echo "pdf - Build PDF version of book"
  74         @echo "tex - Build Latex version of book"
  75         @echo "dvi - Build Device Independant File of book"
  76         @echo "ps - Build PostScript version of book"
  77         @echo "manpages - Build manpages"
  78         @echo "txt - Build plain text version of HOWTO Collection and Developers Guide"
  79         @echo -n "html-single - Build single file HTML version of HOWTO Collection"
  80         @echo " and developers guide"
  81         @echo "html - Build HTML version of HOWTO Collection and Developers Guide"
  82         @echo "htmlman - Build html version of manpages"
  83         @echo "plucker - Build HOWTO, Developers Guide, man pages in Plucker format for PDA"
  84         @echo "undocumented - Output list of undocumented smb.conf options"
  85         @echo "samples - Extract examples"
  86         @echo "files - Extract other files"
  87         @echo "all - Build all docs that can be build using the utilities found by configure"
  88         @echo "everything - Build all of the above"
  89
  90 all: @TARGETS@
  91
  92 everything: manpages pdf html-single html htmlman txt ps
  93
  94 release: manpages htmlman html pdf guide
  95
  96 # Global rules
  97
  98 pdf: $(PDFDIR) $(PDFDIR)/Samba-HOWTO-Collection.pdf $(PDFDIR)/Samba-Developers-Guide.pdf
  99
 100 dvi: $(DVIDIR) $(DVIDIR)/Samba-HOWTO-Collection.dvi $(DVIDIR)/Samba-Developers-Guide.dvi
 101
 102 ps: $(PSDIR) $(PSDIR)/Samba-HOWTO-Collection.ps $(PSDIR)/Samba-Developers-Guide.ps
 103
 104 txt: $(TXTDIR) $(TXTDIR)/Samba-HOWTO-Collection.txt $(TXTDIR)/Samba-Developers-Guide.txt
 105
 106 htmlman: $(HTMLDIR) $(MANPAGES_HTML) $(HTMLDIR)/samba.css
 107
 108 html-single: $(HTMLDIR) $(HTMLDIR)/samba.css $(HTMLDIR)/Samba-HOWTO-Collection.html  $(HTMLDIR)/Samba-Developers-Guide.html $(HTMLDIR)/Samba-Guide.html
 109         cp -p $(GUIDEDOC_IMAGES_PNG) $(HOWTODIR_IMAGES_PNG) $(HTMLDIR)/images/
 110
 111 html: $(HTMLDIR)/howto $(HTMLDIR)/guide $(HTMLDIR)/devel
 112
 113 $(HTMLDIR)/howto: $(HTMLDIR) $(HTMLDIR)/howto/samba.css Samba-HOWTO-Collection.xml
 114         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/howto/" xslt/html-chunk.xsl Samba-HOWTO-Collection.xml
 115         -mkdir $(HTMLDIR)/howto/images
 116         cp -R $(HOWTODIR_IMAGES_PNG) $(HTMLDIR)/howto/images
 117
 118 $(HTMLDIR)/devel: $(HTMLDIR) $(HTMLDIR)/devel/samba.css Samba-Developers-Guide.xml
 119         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/devel/" xslt/html-chunk.xsl Samba-Developers-Guide.xml
 120
 121 $(HTMLDIR)/guide: $(HTMLDIR) $(HTMLDIR)/guide/samba.css Samba-Guide.xml
 122         $(XSLTPROC) --stringparam base.dir "$(HTMLDIR)/guide/" xslt/html-chunk.xsl Samba-Guide.xml
 123         -mkdir $(HTMLDIR)/guide/images
 124         cp -R $(GUIDEDOC_IMAGES_PNG) $(HTMLDIR)/guide/images
 125
 126 manpages: $(MANDIR) $(MANPAGES)
 127
 128 tex: Samba-HOWTO-Collection.tex Samba-Developers-Guide.tex gpl.tex
 129
 130 plucker: html-single htmlman $(PLUCKERDIR) $(MANPAGES_PLUCKER) $(PLUCKERDIR)/Samba-Developers-Guide.pdb $(PLUCKERDIR)/Samba-HOWTO-Collection.pdb
 131
 132 Samba-HOWTO-Collection.xml: $(HOWTODIR)/index.xml $(HOWTODIR_DEPS)
 133         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 134
 135 Samba-Guide.xml: $(GUIDEDOC)/guide-main.xml
 136         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 137
 138 Samba-Developers-Guide.xml: $(DEVDOCDIR)/index.xml $(DEVDOCDIR_DEPS)
 139         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 140
 141 $(HOWTODIR)/attributions.xml: $(HOWTODIR)/index.xml
 142         @echo > $@ # Make sure we don't get recursive dependencies, etc!
 143         $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $<
 144
 145 $(DEVDOCDIR)/attributions.xml: $(DEVDOCDIR)/index.xml
 146         @echo > $@ # Make sure we don't get recursive dependencies, etc!
 147         $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $<
 148
 149 clean:
 150         rm -rf $(OUTPUTDIR)/*
 151         rm -f *.xml $(MANPAGES) $(TXTDIR)/*.txt $(PSDIR)/*.ps \
 152             $(PDFDIR)/*.pdf $(HTMLDIR)/*html $(HTMLDIR)/samba.css
 153         rm -f xslt/figures/*pdf
 154         rm -f $(SMBDOTCONFDOC)/parameters.*.xml $(DVIDIR)/*.dvi
 155         rm -f samba-doc.* index.* $(HOWTODIR)/changelog.xml $(HOWTODIR)/attributions.xml $(DEVDOCDIR)/attributions.xml
 156         rm -f Samba-HOWTO-Collection.*
 157         rm -f Samba-Developers-Guide.*
 158         rm -f Samba-Guide.*
 159         rm -f $(IMAGEPROJDIR)/*.eps $(MANPAGEDIR)/smb.conf.5.xml
 160         rm -f $(PLUCKERDIR)/*.pdb
 161
 162 # Text files
 163 $(TXTDIR):
 164         mkdir $(TXTDIR)
 165
 166 $(TXTDIR)/%.txt: $(HTMLDIR)/%.html
 167         $(HTML2TEXT) -nobs -style pretty -o $@ $<
 168
 169 # Tex files
 170 %.tex: %.xml
 171         $(XSLTPROC) --output $@ xslt/latex.xsl $<
 172
 173 gpl.tex:
 174         $(WGET) http://www.gnu.org/licenses/gpl.tex
 175
 176 latexfigures: $(LATEX_FIGURES)
 177
 178 # Adobe PDF files
 179 $(PDFDIR)/%.pdf: %.tex latexfigures gpl.tex
 180         -$(PDFLATEX) $<
 181         $(MAKEINDEX) `echo $< | sed -e 's/.tex//'`
 182         -$(PDFLATEX) $<
 183         -$(PDFLATEX) $<
 184         mv $(patsubst %.tex,%.pdf,$<) $@
 185
 186 epsimages: $(HOWTODIR_IMAGES_EPS)
 187
 188 # DVI files
 189 $(DVIDIR)/%.dvi: %.tex epsimages gpl.tex
 190         -$(LATEX) $<
 191         $(MAKEINDEX) `echo $< | sed -e 's/.tex//'`
 192         -$(LATEX) $<
 193         -$(LATEX) $<
 194         mv $(patsubst %.tex,%.dvi,$<) $@
 195
 196 %.eps: %.png
 197         $(PNGTOPNM) $< | $(PNMTOPS) > $@
 198
 199 # PostScript files
 200 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
 201         $(DVIPS) -o $@ $<
 202
 203 xslt/figures/%.pdf: xslt/figures/%.eps
 204         $(EPSTOPDF) $<
 205
 206 # Single large HTML files
 207
 208 $(HTMLDIR):
 209         mkdir $(HTMLDIR)
 210         mkdir $(HTMLDIR)/howto
 211         mkdir $(HTMLDIR)/guide
 212         mkdir $(HTMLDIR)/devel
 213         mkdir $(HTMLDIR)/images
 214
 215 $(PLUCKERDIR):
 216         mkdir $(PLUCKERDIR)
 217
 218 %/samba.css: xslt/html/samba.css
 219         if [ ! -d `dirname $@` ]; then mkdir -p `dirname $@`; fi
 220         cp $< $@
 221
 222 $(HTMLDIR)/Samba-HOWTO-Collection.html: Samba-HOWTO-Collection.xml $(HOWTODIR_DEPS) $(HOWTODIR_IMAGES_PNG)
 223         $(XSLTPROC) --output $@ xslt/html.xsl $<
 224
 225 $(HTMLDIR)/Samba-Guide.html: Samba-Guide.xml $(GUIDEDOC_IMAGES_PNG)
 226         $(XSLTPROC) --output $@ xslt/html.xsl $<
 227
 228 $(HTMLDIR)/Samba-Developers-Guide.html: Samba-Developers-Guide.xml $(DEVDOCDIR_DEPS)
 229         $(XSLTPROC) --output $@ xslt/html.xsl $<
 230
 231 $(HTMLDIR)/%.html: %.xml
 232         $(XSLTPROC) --output $@ xslt/html.xsl $<
 233
 234 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
 235         $(PLUCKERBUILD) -v -M1 --stayonhost  --noimages --zlib-compression -H file:$< -f $(patsubst $(PLUCKERDIR)/%.pdb,%,$@) -p $(PLUCKERDIR)
 236
 237 %.xml: $(MANPAGEDIR)/%.xml
 238         $(XSLTPROC) --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
 239
 240 # Manpages
 241 $(SMBDOTCONFDOC)/parameters.all.xml: $(SMBDOTCONFDOC)/generate-file-list.sh
 242         @cd $(SMBDOTCONFDOC) && \
 243         /bin/sh generate-file-list.sh >parameters.all.xml && \
 244         cd $(OUTPUTDIR)
 245
 246 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 247         @cd $(SMBDOTCONFDOC) && \
 248         $(XSLTPROC) --xinclude \
 249         --param smb.context "'G'" \
 250         --output parameters.global.xml \
 251         generate-context.xsl parameters.all.xml && \
 252         cd $(OUTPUTDIR)
 253
 254 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 255         @cd $(SMBDOTCONFDOC) && \
 256         $(XSLTPROC) --xinclude \
 257         --param smb.context "'S'" \
 258         --output parameters.service.xml \
 259         generate-context.xsl parameters.all.xml && \
 260         cd $(OUTPUTDIR)
 261
 262 smb.conf.5.xml: $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml \
 263                 $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml
 264         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 265
 266 $(MANDIR):
 267         mkdir $(MANDIR)
 268
 269 $(MANDIR)/%: %.xml
 270         $(XSLTPROC) --output $@ xslt/man.xsl $<
 271
 272 $(VALIDATEDIR):
 273         mkdir $@
 274
 275 $(VALIDATEDIR)/%.report.html: %.xml
 276         $(XMLLINT) --valid --noout --htmlout $< 2> $@
 277
 278 verify: $(VALIDATEDIR) $(VALIDATEDIR)/Samba-HOWTO-Collection.report.html $(VALIDATEDIR)/Samba-Developers-Guide.report.html $(VALIDATEDIR)/Samba-Guide.report.html
 279
 280 # Find undocumented parameters
 281
 282 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml
 283         @$(PERL) scripts/find_missing_doc.pl $(SRCDIR)
 284         @$(PERL) scripts/find_missing_manpages.pl $(SRCDIR)
 285
 286 # Examples and the like
 287
 288 $(EXAMPLESDIR):
 289         mkdir $(EXAMPLESDIR)
 290
 291 files: $(HOWTODIR)/index.xml $(HOWTODIR)/attributions.xml $(EXAMPLESDIR)
 292         $(XSLTPROC) xslt/extract-smbfiles.xsl $< > /dev/null
 293
 294 samples: $(EXAMPLESDIR) Samba-HOWTO-Collection.xml
 295         $(XSLTPROC) xslt/extract-examples.xsl Samba-HOWTO-Collection.xml > /dev/null 2> examples/README
 296         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
 297
 298 howto: $(PDFDIR)/Samba-HOWTO-Collection.pdf
 299 guide: $(PDFDIR)/Samba-Guide.pdf
 300
 301 %/changelog.xml: % $(wildcard %/CVS/*)
 302         touch $@
 303         # FIXME
 304
 305 $(ARCHIVEDIR):
 306         mkdir $(ARCHIVEDIR)
 307
 308 archive: $(ARCHIVEDIR) guide howto
 309         cp $(PDFDIR)/Samba-HOWTO-Collection.pdf $(ARCHIVEDIR)/TOSHARG-`date +%Y%m%d`.pdf
 310         cp $(PDFDIR)/Samba-Guide.pdf $(ARCHIVEDIR)/S3bE-`date +%Y%m%d`.pdf