Documentation/user/GNUmakefile

   1 depth=../..
   2
   3 LATEX_FILES =$(call src-wildcard,*.latex)
   4
   5
   6 EXTRA_DIST_FILES= $(LATEX_FILES) $(IMAGES) README.txt convert-ly.txt $(EPS_ILLUSTRATIONS)
   7
   8 IMAGES=$(call src-wildcard,*.png)
   9 EPS_ILLUSTRATIONS=context-example.eps
  10 PDF_ILLUSTRATIONS=context-example.pdf
  11
  12 OUT_PDF_IMAGES=$(IMAGES:%.png=$(outdir)/%.pdf) $(addprefix $(outdir)/,$(PDF_ILLUSTRATIONS))
  13
  14 OUT_PNG_IMAGES=$(OUT_PDF_IMAGES:%.pdf=%.png)
  15
  16 OUT_TEXI_FILES=$(ITEXI_FILES:%.itexi=$(outdir)/%.texi)\
  17  $(ITELY_FILES:%.itely=$(outdir)/%.texi)
  18 HTML_FILES = $(TELY_FILES:%.tely=$(outdir)/%-big-page.html)\
  19  $(outdir)/lilypond-internals-big-page.html
  20
  21 # todo: add latex.
  22 PDF_FILES = $(TELY_FILES:%.tely=$(outdir)/%.pdf)
  23
  24 INFO_DOCS = lilypond lilypond-internals music-glossary lilypond-program
  25 INFO_FILES = $(INFO_DOCS:%=$(outdir)/%.info)
  26
  27 STEPMAKE_TEMPLATES=tex texinfo omf documentation
  28 #TEXI2DVI_FLAGS = -E
  29 OMF_FILES += $(outdir)/lilypond-internals.html.omf
  30
  31 LOCALSTEPMAKE_TEMPLATES=lilypond ly
  32
  33
  34 TEXINPUTS=$(top-src-dir)/tex::
  35 export TEXINPUTS
  36
  37 include $(depth)/make/stepmake.make
  38
  39 info: $(INFO_FILES)
  40
  41 pathsettings:
  42         @echo export PATH=$(PATH)
  43         @echo export LILYPOND_DATADIR=$(LILYPOND_DATADIR)
  44         @echo export PYTHONPATH=$(PYTHONPATH)
  45
  46 xml: $(outdir)/lilypond/lilypond.xml $(outdir)/lilypond-internals/lilypond-internals.xml
  47
  48 # There are two modes for info: with and without images.
  49 ifeq ($(out),www)
  50
  51 # This builds all .info targets with images, in out-www.
  52 # Viewawble with a recent Emacs, doing: M-x info out-www/lilypond.info
  53
  54 # Cancel the special, non-image info generation rule that skips images:
  55 $(outdir)/%.info: $(outdir)/%.nexi
  56
  57 local-install-info: info
  58         -$(INSTALL) -d $(DESTDIR)$(package_infodir)
  59 ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr)
  60 ## Can not have absolute symlinks because some binary packages build schemes
  61 ## install files in nonstandard root.  Best we can do is to notify the
  62 ## builder or packager.
  63         @echo
  64         @echo "***************************************************************"
  65         @echo "Please add or update the LilyPond direntries, do"
  66         @echo
  67         @echo "    install-info --info-dir=$(infodir) $(outdir)/lilypond.info"
  68         @echo
  69         @echo "For images in the INFO docs to work, do: "
  70         @echo
  71         @echo "    (cd $(package_infodir) && ln -sf ../../doc/lilypond/Documentation/user/*png .)"
  72         @echo "or add something like that to the postinstall script."
  73         @echo
  74 else
  75         -$(INSTALL) -d $(DESTDIR)$(package_infodir)
  76         -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
  77         -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond-program.info
  78         install-info --info-dir=$(infodir) $(outdir)/lilypond.info
  79         (cd $(package_infodir) && ln -sf $(webdir)/Documentation/user/*png .)
  80 endif
  81
  82 local-uninstall-WWW:
  83         rm -f $(package_infodir)/*.png
  84
  85 else
  86
  87 # Cancel the default info generation rule that generates images:
  88 $(outdir)/%.info: # $(outdir)/%.texi
  89
  90 local-install-info: info
  91         -$(INSTALL) -d $(DESTDIR)$(package_infodir)
  92 ifneq ($(patsubst %/local,%,$(DESTDIR)$(prefix)),/usr)
  93 ## Can not have absolute symlinks because some binary packages build schemes
  94 ## install files in nonstandard root.  Best we can do is to notify the
  95 ## builder or packager.
  96         @echo
  97         @echo "***************************************************************"
  98         @echo "Please add or update the LilyPond direntries, do"
  99         @echo
 100         @echo "    install-info --info-dir=$(infodir) out/lilypond.info"
 101         @echo
 102         @echo "For images in the INFO docs to work, do"
 103         @echo
 104         @echo "    make out=www install-info "
 105         @echo
 106         @echo "and read the extra instructions."
 107         @echo
 108 else
 109         -$(INSTALL) -d $(DESTDIR)$(package_infodir)
 110         -install-info --remove --info-dir=$(infodir) $(outdir)/lilypond.info
 111         install-info --info-dir=$(infodir) $(outdir)/lilypond.info
 112         @echo
 113         @echo "***************************************************************"
 114         @echo "For images in the INFO docs to work, do"
 115         @echo
 116         @echo "    make out=www install-info "
 117         @echo
 118 endif
 119
 120
 121 endif
 122
 123 # All web targets, except info image symlinks and info docs are
 124 # installed in non-recursing target from TOP-SRC-DIR
 125 local-install-WWW: local-install-info
 126 local-uninstall-WWW: local-uninstall-info
 127
 128 default:
 129
 130
 131 local-help: extra-local-help
 132
 133 extra-local-help:
 134         @echo -e "\
 135   dvi         update dvi documents\n\
 136   info        update info pages\n\
 137   ps          update PostScript documents\n\
 138   xml         update Docbook xml documentation\n\
 139 "
 140
 141 # Generic rule using % twice not possible?
 142 # $(outdir)/%/%.html: $(outdir)/%.texi
 143 $(outdir)/lilypond.texi: $(outdir)/lilypond-internals.texi
 144 $(outdir)/lilypond.nexi: $(outdir)/lilypond-internals.texi
 145
 146 #
 147 # The split user manual
 148 #
 149 $(outdir)/lilypond/index.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
 150         mkdir -p $(dir $@)
 151         $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
 152         find $(outdir)/lilypond/ -name '*'.png -o -name '*'.ly | xargs rm -f
 153 # symbolic links to save space
 154         (cd $(outdir)/lilypond/ ; ln -sf ../*.png ../*.ly . )
 155
 156 #
 157 # One big page user manual
 158 #
 159 $(outdir)/lilypond-big-page.html: $(outdir)/lilypond.texi $(OUT_PNG_IMAGES)
 160         $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $<
 161
 162 #
 163 # The split program usage
 164 #
 165 $(outdir)/lilypond-program/index.html: $(outdir)/lilypond-program.texi $(OUT_PNG_IMAGES) $(OUT_EPS_IMAGES)
 166         mkdir -p $(dir $@)
 167         $(MAKEINFO) -I$(outdir) --output=$(outdir)/lilypond-program --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
 168         find $(outdir)/lilypond-program/ -name '*'.png -o -name '*'.ly | xargs rm -f
 169 # symbolic links to save space
 170         (cd $(outdir)/lilypond-program/ ; ln -sf ../*.png ../*.ly . )
 171
 172 #
 173 # One big page program usage
 174 #
 175 $(outdir)/lilypond-program-big-page.html: $(outdir)/lilypond-program.texi $(OUT_PNG_IMAGES)
 176         $(MAKEINFO) -I$(outdir) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $<
 177
 178
 179 #
 180 # The split internals reference
 181 #
 182 $(outdir)/lilypond-internals/index.html: $(outdir)/lilypond-internals.texi
 183         mkdir -p $(dir $@)
 184         $(MAKEINFO) --output=$(outdir)/lilypond-internals --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
 185
 186 #
 187 # One big page internals reference
 188 #
 189 $(outdir)/lilypond-internals-big-page.html: $(outdir)/lilypond-internals.texi
 190         $(MAKEINFO) --output=$@ --css-include=$(top-src-dir)/Documentation/texinfo.css --html --no-split -D bigpage --no-headers $<
 191
 192 #
 193 # The split glossary
 194 #
 195 $(outdir)/music-glossary/index.html: $(outdir)/music-glossary.texi
 196         mkdir -p $(dir $@)
 197         $(MAKEINFO) --output=$(outdir)/music-glossary --css-include=$(top-src-dir)/Documentation/texinfo.css --html $<
 198         find $(outdir)/music-glossary/ -name '*'.png -o -name '*'.ly | xargs rm -f
 199 # symbolic links to save space
 200         (cd $(outdir)/music-glossary/ ; ln -sf ../*.png ../*.ly . )
 201
 202 $(outdir)/lilypond.xml: $(outdir)/lilypond.texi
 203         mkdir -p $(dir $@)
 204         $(MAKEINFO) -I$(outdir) --output=$@ --docbook $<
 205
 206 $(outdir)/lilypond-internals/lilypond-internals.xml: $(outdir)/lilypond-internals.texi
 207         mkdir -p $(dir $@)
 208         $(MAKEINFO) --output=$(outdir)/lilypond-internals --docbook $<
 209
 210 $(outdir)/lilypond.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES)
 211
 212 $(outdir)/lilypond-program.pdf: $(OUT_PDF_IMAGES) $(OUT_PNG_IMAGES)
 213
 214 $(outdir)/%.png: %.png
 215         convert -depth 8 -geometry 50x50% $< $@
 216
 217 $(outdir)/%.png: %.eps
 218         gs -dTextAlphaBits=4 -dGraphicsAlphaBits=4 -q -sOutputFile=$@ -sDEVICE=png16m -dEPSCrop -dNOPAUSE -f $< -c quit
 219
 220 $(outdir)/%.pdf: %.png
 221         convert -depth 8 $< $@
 222
 223 $(outdir)/%.pdf: %.eps
 224         gs -dAutoRotatePages=/None -sDEVICE=pdfwrite -dNOPAUSE -dBATCH -sOutputFile=$@ -dEPSCrop -c .setpdfwrite -f $<
 225
 226
 227 DEEP_HTML_FILES =\
 228  $(outdir)/lilypond/index.html\
 229  $(outdir)/lilypond-internals/index.html\
 230  $(outdir)/music-glossary/index.html\
 231  $(outdir)/lilypond-program/index.html
 232
 233 # Symlinks to refer to external source documents from split and non-split HTML
 234 source-links = $(outdir)/source $(outdir)/lilypond/source $(outdir)/music-glossary/source $(outdir)/lilypond-program/source
 235
 236 $(outdir)/source:
 237         @rm -f $(@)
 238         ln -sf ../../ $(@)
 239
 240 $(outdir)/lilypond/source:
 241         @rm -f $(@)
 242         mkdir -p $(outdir)/lilypond
 243         ln -sf ../../../ $(@)
 244
 245 $(outdir)/music-glossary/source:
 246         @rm -f $(@)
 247         mkdir -p $(outdir)/music-glossary
 248         ln -sf ../../../ $(@)
 249
 250 $(outdir)/lilypond-program/source:
 251         @rm -f $(@)
 252         mkdir -p $(outdir)/lilypond-program
 253         ln -sf ../../../ $(@)
 254
 255
 256 local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\
 257  $(datafiles) $(PDF_FILES) $(source-links) info info-dir
 258
 259 info-dir:
 260         $(SHELL) $(buildscript-dir)/install-info-html.sh --dir=$(outdir) lilypond lilypond-internals music-glossary lilypond-program
 261
 262
 263 $(outdir)/%.bib: %.bib
 264         ln -f $< $@
 265
 266
 267 # lilypond.texi deps
 268 $(top-build-dir)/mf/$(outconfbase)/feta16list.ly:
 269         $(MAKE) -C $(top-src-dir)/mf
 270
 271 $(outdir)/lilypond.texi: $(ITELY_FILES) $(ITEXI_FILES)
 272 $(outdir)/lilypond.nexi: $(ITELY_FILES) $(ITEXI_FILES)
 273
 274 # Prevent building music-glossary.texi from default target
 275 $(outdir)/music-glossary.nexi:
 276
 277 # Rules for the automatically generated documentation
 278
 279 # There used to be a dependency on a dummy target, to force a rebuild
 280 # of lilypond-internals every time.  however, this triggers
 281 # compilation during install, which is a bad thing (tm).
 282
 283 $(outdir)/lilypond-internals.nexi $(outdir)/lilypond-internals.texi: $(LILYPOND_BINARY)
 284         cd $(outdir) && $(LILYPOND_BINARY) --verbose $(top-src-dir)/ly/generate-documentation
 285         rm -f $(outdir)/lilypond-internals.nexi
 286         -ln $(outdir)/lilypond-internals.texi $(outdir)/lilypond-internals.nexi
 287
 288
 289 ## unused
 290 $(outdir)/interfaces.itexi: dummy
 291         cd $(outdir) && lilypond $(top-src-dir)/ly/generate-interface-doc