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 # 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 DVIPS = @DVIPS@
  18 CVS2CL = @CVS2CL@
  19 PNGTOPNM = @PNGTOPNM@
  20 EPSTOPNM = @EPSTOPNM@
  21 PNMTOPNG = @PNMTOPNG@
  22 PNMTOPS = @PNMTOPS@
  23 XMLTO = @XMLTO@
  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 = @srcdir@
  38 MANDIR = $(OUTPUTDIR)/manpages
  39 EPSTOPDF = @EPSTOPDF@
  40 MANPAGEDIR = $(TOPDIR)/manpages
  41 HOWTODIR = $(TOPDIR)/howto
  42 MAKEINDEX = @MAKEINDEX@
  43 IMAGEPROJDIR = $(HOWTODIR)/imagefiles
  44 GUIDEDOC = $(TOPDIR)/guide
  45 EXAMPLESDIR = $(TOPDIR)/examples
  46 DEVDOCDIR = $(TOPDIR)/devel
  47 SMBDOTCONFDOC = $(TOPDIR)/smbdotconf
  48 PSDIR = $(OUTPUTDIR)
  49 PDFDIR = $(OUTPUTDIR)
  50 DVIDIR = $(OUTPUTDIR)
  51 TXTDIR = $(OUTPUTDIR)/textdocs
  52 HTMLDIR=$(OUTPUTDIR)/htmldocs
  53 PLUCKERDIR=$(OUTPUTDIR)/plucker
  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_SOURCES = $(wildcard $(MANPAGEDIR)/*.?.xml)
  58 MANPAGES = $(patsubst $(MANPAGEDIR)/%.xml,$(MANDIR)/%,$(MANPAGES_SOURCES)) $(MANDIR)/smb.conf.5
  59 MANPAGES_HTML = $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/%.html,$(MANPAGES_SOURCES)) $(HTMLDIR)/smb.conf.5.html
  60 MANPAGES_PLUCKER = $(patsubst $(MANPAGEDIR)/%.xml,$(PLUCKERDIR)/%.pdb,$(MANPAGES_SOURCES)) $(PLUCKERDIR)/smb.conf.5.pdb
  61
  62 HOWTODIR_IMAGES_PNG = $(wildcard $(IMAGEPROJDIR)/*.png)
  63 HOWTODIR_IMAGES_EPS=$(patsubst %.png,%.eps,$(wildcard $(IMAGEPROJDIR)/*.png))
  64 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
  65 DEVDOCDIR_DEPS = $(DEVDOCDIR)/*.xml $(DEVDOCDIR)/attributions.xml
  66
  67 all:
  68         @echo "Supported make targets:"
  69         @echo "release - Build the docs needed for a Samba release"
  70         @echo "pdf - Build PDF version of book"
  71         @echo "tex - Build Latex version of book"
  72         @echo "dvi - Build Device Independant File of book"
  73         @echo "ps - Build PostScript version of book"
  74         @echo "manpages - Build manpages"
  75         @echo "txt - Build plain text version of HOWTO Collection and Developers Guide"
  76         @echo -n "html-single - Build single file HTML version of HOWTO Collection"
  77         @echo " and developers guide"
  78         @echo "html - Build HTML version of HOWTO Collection and Developers Guide"
  79         @echo "htmlman - Build html version of manpages"
  80         @echo "plucker - Build HOWTO, Developers Guide, man pages in Plucker format for PDA"
  81         @echo "undocumented - Output list of undocumented smb.conf options"
  82         @echo "samples - Extract examples"
  83         @echo "files - Extract other files"
  84         @echo "everything - Build all of the above"
  85
  86 everything: manpages pdf html-single html htmlman txt ps
  87
  88 release: manpages htmlman html html-single pdf guide
  89
  90 # Global rules
  91
  92 pdf: $(PDFDIR) $(PDFDIR)/Samba-HOWTO-Collection.pdf $(PDFDIR)/Samba-Developers-Guide.pdf
  93
  94 dvi: $(DVIDIR) $(DVIDIR)/Samba-HOWTO-Collection.dvi $(DVIDIR)/Samba-Developers-Guide.dvi
  95
  96 ps: $(PSDIR) $(PSDIR)/Samba-HOWTO-Collection.ps $(PSDIR)/Samba-Developers-Guide.ps
  97
  98 txt: $(TXTDIR) $(TXTDIR)/Samba-HOWTO-Collection.txt $(TXTDIR)/Samba-Developers-Guide.txt
  99
 100 htmlman: $(HTMLDIR) $(MANPAGES_HTML) CSS
 101
 102 html-single: $(HTMLDIR) CSS $(HTMLDIR)/Samba-HOWTO-Collection.html  $(HTMLDIR)/Samba-Developers-Guide.html
 103         @if [ ! -d $(HTMLDIR)/images/ ]; then \
 104                 mkdir $(HTMLDIR)/images/; \
 105         fi \
 106         && cp -p $(HOWTODIR)/imagefiles/*png $(HTMLDIR)/images/
 107
 108 html: $(HTMLDIR) CSS Samba-HOWTO-Collection.xml $(HTMLDIR)/Samba-Developers-Guide.html
 109         $(XSLTPROC) -o "$(HTMLDIR)/" xslt/html-chunk.xsl Samba-HOWTO-Collection.xml
 110         @if [ ! -d $(HTMLDIR)/images/ ]; then \
 111                 mkdir $(HTMLDIR)/images/; \
 112         fi \
 113         && cp -p $(HOWTODIR)/imagefiles/*png $(HTMLDIR)/images/
 114
 115 manpages: $(MANDIR) $(MANPAGES)
 116
 117 tex: Samba-HOWTO-Collection.tex Samba-Developers-Guide.tex gpl.tex
 118
 119 plucker: html-single htmlman $(PLUCKERDIR) $(MANPAGES_PLUCKER) $(PLUCKERDIR)/Samba-Developers-Guide.pdb $(PLUCKERDIR)/Samba-HOWTO-Collection.pdb
 120
 121 Samba-HOWTO-Collection.xml: $(HOWTODIR)/index.xml $(HOWTODIR_DEPS)
 122         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 123
 124 Samba-Guide.xml: $(GUIDEDOC)/guide-main.xml
 125         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 126
 127 Samba-Developers-Guide.xml: $(DEVDOCDIR)/index.xml $(DEVDOCDIR_DEPS)
 128         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 129
 130 $(HOWTODIR)/attributions.xml: $(HOWTODIR)/index.xml
 131         @echo > $@ # Make sure we don't get recursive dependencies, etc!
 132         $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $<
 133
 134 $(DEVDOCDIR)/attributions.xml: $(DEVDOCDIR)/index.xml
 135         @echo > $@ # Make sure we don't get recursive dependencies, etc!
 136         $(XSLTPROC) --output $@ xslt/generate-attributions.xsl $<
 137
 138 clean:
 139         rm -f *.xml $(MANPAGES) $(TXTDIR)/*.txt $(PSDIR)/*.ps \
 140             $(PDFDIR)/*.pdf $(HTMLDIR)/*html $(HTMLDIR)/samba.css
 141         rm -f xslt/figures/*pdf
 142         rm -f $(SMBDOTCONFDOC)/parameters.*.xml $(DVIDIR)/*.dvi
 143         rm -f samba-doc.* index.* $(HOWTODIR)/changelog.xml $(HOWTODIR)/attributions.xml $(DEVDOCDIR)/attributions.xml
 144         rm -f Samba-HOWTO-Collection.*
 145         rm -f Samba-Developers-Guide.*
 146         rm -f Samba-Guide.*
 147         rm -f $(IMAGEPROJDIR)/*.eps $(MANPAGEDIR)/smb.conf.5.xml
 148         rm -f $(PLUCKERDIR)/*.pdb
 149
 150 # Text files
 151 $(TXTDIR):
 152         mkdir $(TXTDIR)
 153
 154 $(TXTDIR)/%.txt: %.xml
 155         $(XMLTO) txt -o $(TXTDIR) $< > $@
 156
 157 # Tex files
 158 %.tex: %.xml
 159         $(XSLTPROC) --output $@ xslt/latex.xsl $<
 160
 161 gpl.tex:
 162         $(WGET) http://www.gnu.org/licenses/gpl.tex
 163
 164 latexfigures: $(LATEX_FIGURES)
 165
 166 # Adobe PDF files
 167 $(PDFDIR)/%.pdf: %.tex latexfigures gpl.tex
 168         -$(PDFLATEX) $<
 169         $(MAKEINDEX) `echo $< | sed -e 's/.tex//'`
 170         -$(PDFLATEX) $<
 171         -$(PDFLATEX) $<
 172         mv $(patsubst %.tex,%.pdf,$<) $@
 173
 174 epsimages: $(HOWTODIR_IMAGES_EPS)
 175
 176 # DVI files
 177 $(DVIDIR)/%.dvi: %.tex epsimages gpl.tex
 178         -$(LATEX) $<
 179         $(MAKEINDEX) `echo $< | sed -e 's/.tex//'`
 180         -$(LATEX) $<
 181         -$(LATEX) $<
 182         mv $(patsubst %.tex,%.dvi,$<) $@
 183
 184 %.eps: %.png
 185         $(PNGTOPNM) $< | $(PNMTOPS) > $@
 186
 187 # PostScript files
 188 $(PSDIR)/%.ps: $(DVIDIR)/%.dvi
 189         $(DVIPS) -o $@ $<
 190
 191 xslt/figures/%.pdf: xslt/figures/%.eps
 192         $(EPSTOPDF) $<
 193
 194 # Single large HTML files
 195
 196 $(HTMLDIR):
 197         mkdir $(HTMLDIR)
 198         mkdir $(HTMLDIR)/images
 199
 200 $(PLUCKERDIR):
 201         mkdir $(PLUCKERDIR)
 202
 203 CSS: $(HTMLDIR) xslt/html/samba.css
 204         cp xslt/html/samba.css $(HTMLDIR)/
 205
 206 $(HTMLDIR)/Samba-HOWTO-Collection.html: Samba-HOWTO-Collection.xml $(HOWTODIR_DEPS) $(HOWTODIR_IMAGES_PNG)
 207         $(XSLTPROC) --output $@ xslt/html.xsl $<
 208
 209 $(HTMLDIR)/Samba-Developers-Guide.html: Samba-Developers-Guide.xml $(DEVDOCDIR_DEPS)
 210         $(XSLTPROC) --output $@ xslt/html.xsl $<
 211
 212 $(HTMLDIR)/%.html: %.xml
 213         $(XSLTPROC) --output $@ xslt/html.xsl $<
 214
 215 $(PLUCKERDIR)/%.pdb: $(HTMLDIR)/%.html
 216         $(PLUCKERBUILD) -v -M1 --stayonhost  --noimages --zlib-compression -H file:$< -f $(patsubst $(PLUCKERDIR)/%.pdb,%,$@) -p $(PLUCKERDIR)
 217
 218 %.xml: $(MANPAGEDIR)/%.xml
 219         $(XSLTPROC) --stringparam noreference 1 --output $@ xslt/expand-sambadoc.xsl $<
 220
 221 # Manpages
 222 $(SMBDOTCONFDOC)/parameters.all.xml: $(SMBDOTCONFDOC)/generate-file-list.sh
 223         @cd $(SMBDOTCONFDOC) && \
 224         /bin/sh generate-file-list.sh >parameters.all.xml && \
 225         cd $(OUTPUTDIR)
 226
 227 $(SMBDOTCONFDOC)/parameters.global.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 228         @cd $(SMBDOTCONFDOC) && \
 229         $(XSLTPROC) --xinclude \
 230         --param smb.context "'G'" \
 231         --output parameters.global.xml \
 232         generate-context.xsl parameters.all.xml && \
 233         cd $(OUTPUTDIR)
 234
 235 $(SMBDOTCONFDOC)/parameters.service.xml: $(SMBDOTCONFDOC)/parameters.all.xml $(SMBDOTCONFDOC)/generate-context.xsl
 236         @cd $(SMBDOTCONFDOC) && \
 237         $(XSLTPROC) --xinclude \
 238         --param smb.context "'S'" \
 239         --output parameters.service.xml \
 240         generate-context.xsl parameters.all.xml && \
 241         cd $(OUTPUTDIR)
 242
 243 smb.conf.5.xml: $(SMBDOTCONFDOC)/smb.conf.5.xml $(SMBDOTCONFDOC)/parameters.all.xml \
 244                 $(SMBDOTCONFDOC)/parameters.global.xml $(SMBDOTCONFDOC)/parameters.service.xml
 245         $(XSLTPROC) --stringparam noreference 1 --xinclude --output $@ xslt/expand-sambadoc.xsl $<
 246
 247 $(MANDIR):
 248         mkdir $(MANDIR)
 249
 250 $(MANDIR)/%: %.xml
 251         $(XSLTPROC) --output $@ xslt/man.xsl $<
 252
 253 # Find undocumented parameters
 254
 255 undocumented: $(SMBDOTCONFDOC)/parameters.all.xml
 256         $(PERL) scripts/find_missing_doc.pl ../..
 257
 258 # Examples and the like
 259
 260 $(EXAMPLESDIR):
 261         mkdir $(EXAMPLESDIR)
 262
 263 files: $(HOWTODIR)/index.xml $(HOWTODIR)/attributions.xml $(EXAMPLESDIR)
 264         $(XSLTPROC) xslt/extract-smbfiles.xsl $< > /dev/null
 265
 266 samples: $(EXAMPLESDIR) Samba-HOWTO-Collection.xml
 267         $(XSLTPROC) xslt/extract-examples.xsl Samba-HOWTO-Collection.xml > /dev/null 2> examples/README
 268         for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
 269
 270 howto: $(PDFDIR)/Samba-HOWTO-Collection.pdf
 271 guide: $(PDFDIR)/Samba-Guide.pdf
 272
 273 %/changelog.xml: % $(wildcard %/CVS/*)
 274         $(CVS2CL) --stdout --xml $< | $(XSLTPROC) --output $@ xslt/genchangelog.xsl -
 275
 276 $(ARCHIVEDIR):
 277         mkdir $(ARCHIVEDIR)
 278
 279 archive: $(ARCHIVEDIR) guide howto
 280         cp $(PDFDIR)/Samba-HOWTO-Collection.pdf $(ARCHIVEDIR)/TOSHARG-`date +%Y%m%d`.pdf
 281         cp $(PDFDIR)/Samba-Guide.pdf $(ARCHIVEDIR)/S3bE-`date +%Y%m%d`.pdf