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