documentation/Makefile

   1 #
   2 # "$Id: Makefile 8195 2011-01-05 23:00:33Z AlbrechtS $"
   3 #
   4 # Documentation makefile for the Fast Light Tool Kit (NTK).
   5 #
   6 # Copyright 1998-2010 by Bill Spitzak and others.
   7 #
   8 # This library is free software; you can redistribute it and/or
   9 # modify it under the terms of the GNU Library General Public
  10 # License as published by the Free Software Foundation; either
  11 # version 2 of the License, or (at your option) any later version.
  12 #
  13 # This library is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 # Library General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU Library General Public
  19 # License along with this library; if not, write to the Free Software
  20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 # USA.
  22 #
  23 # Please report all bugs and problems on the following page:
  24 #
  25 #      http://www.ntk.org/str.php
  26 #
  27
  28 # Get configuration stuff...
  29 include ../makeinclude
  30
  31 # make sure that all docs are (re-)created independent of missing deps
  32 .PHONY: pdf html refman.pdf
  33
  34 SRC_DOCDIR      =       ./src
  35
  36 # These are the HTML "source" files...
  37 HTMLFILES       =        \
  38                          $(SRC_DOCDIR)/index.dox \
  39                          $(SRC_DOCDIR)/preface.dox \
  40                          $(SRC_DOCDIR)/intro.dox \
  41                          $(SRC_DOCDIR)/basics.dox \
  42                          $(SRC_DOCDIR)/common.dox \
  43                          $(SRC_DOCDIR)/editor.dox \
  44                          $(SRC_DOCDIR)/drawing.dox \
  45                          $(SRC_DOCDIR)/events.dox \
  46                          $(SRC_DOCDIR)/subclassing.dox \
  47                          $(SRC_DOCDIR)/opengl.dox \
  48                          $(SRC_DOCDIR)/fluid.dox \
  49                          $(SRC_DOCDIR)/advanced.dox \
  50                          $(SRC_DOCDIR)/unicode.dox \
  51                          $(SRC_DOCDIR)/enumerations.dox \
  52                          $(SRC_DOCDIR)/glut.dox \
  53                          $(SRC_DOCDIR)/forms.dox \
  54                          $(SRC_DOCDIR)/osissues.dox \
  55                          $(SRC_DOCDIR)/migration_1_1.dox \
  56                          $(SRC_DOCDIR)/migration_1_3.dox \
  57                          $(SRC_DOCDIR)/development.dox \
  58                          $(SRC_DOCDIR)/license.dox \
  59                          $(SRC_DOCDIR)/examples.dox
  60
  61 MANPAGES =      $(SRC_DOCDIR)/ntk.$(CAT3EXT) $(SRC_DOCDIR)/ntk-config.$(CAT1EXT) \
  62                 $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(SRC_DOCDIR)/blocks.$(CAT6EXT) \
  63                 $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(SRC_DOCDIR)/sudoku.$(CAT6EXT)
  64
  65 all:    $(MANPAGES)
  66
  67 # use make dist to create all docs for distribution files
  68 # you need an installed version of doxygen for this
  69 dist:   all html pdf
  70
  71 # synonym for dist
  72 alldocs: dist
  73
  74 clean:
  75         $(RM) ntk.pdf refman.pdf
  76         $(RMDIR) html latex
  77         $(RM) *~ *.bck *.bak *.log
  78         $(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0
  79
  80 depend:
  81
  82 install: $(MANPAGES)
  83         echo "Installing documentation files in $(DESTDIR)$(docdir) ..."
  84         -$(INSTALL_DIR) $(DESTDIR)$(docdir)
  85         if test -f html/index.html ; then \
  86           for file in html/* ; do \
  87                 $(INSTALL_DATA) $$file $(DESTDIR)$(docdir); \
  88           done \
  89         fi
  90         if test -f ntk.pdf ; then \
  91           echo "Installing ntk.pdf in $(DESTDIR)$(docdir) ..."; \
  92           $(INSTALL_DATA) ntk.pdf $(DESTDIR)$(docdir); \
  93         fi
  94         echo "Installing man pages in $(DESTDIR)$(mandir) ..."
  95         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat1
  96         $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1
  97         $(INSTALL_MAN) $(SRC_DOCDIR)/ntk-config.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1
  98         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat3
  99         $(INSTALL_MAN) $(SRC_DOCDIR)/ntk.$(CAT3EXT) $(DESTDIR)$(mandir)/cat3
 100         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man1
 101         $(INSTALL_MAN) $(SRC_DOCDIR)/fluid.man $(DESTDIR)$(mandir)/man1/fluid.1
 102         $(INSTALL_MAN) $(SRC_DOCDIR)/ntk-config.man $(DESTDIR)$(mandir)/man1/ntk-config.1
 103         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man3
 104         $(INSTALL_MAN) $(SRC_DOCDIR)/ntk.man $(DESTDIR)$(mandir)/man3/ntk.3
 105
 106 install-linux install-osx:
 107         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat6
 108         $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
 109         $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
 110         $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
 111         -$(INSTALL_DIR) $(DESTDIR)$(mandir)/man6
 112         $(INSTALL_MAN) $(SRC_DOCDIR)/blocks.man $(DESTDIR)$(mandir)/man6/blocks.6
 113         $(INSTALL_MAN) $(SRC_DOCDIR)/checkers.man $(DESTDIR)$(mandir)/man6/checkers.6
 114         $(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.man $(DESTDIR)$(mandir)/man6/sudoku.6
 115
 116
 117 uninstall:
 118         $(RMDIR) $(DESTDIR)$(docdir)
 119         $(RM) $(DESTDIR)$(mandir)/cat1/fluid.$(CAT1EXT)
 120         $(RM) $(DESTDIR)$(mandir)/man1/fluid.1
 121         $(RM) $(DESTDIR)$(mandir)/cat1/ntk-config.$(CAT1EXT)
 122         $(RM) $(DESTDIR)$(mandir)/man1/ntk-config.1
 123         $(RM) $(DESTDIR)$(mandir)/cat3/ntk.$(CAT3EXT)
 124         $(RM) $(DESTDIR)$(mandir)/man3/ntk.3
 125
 126 uninstall-linux uninstall-osx:
 127         $(RM) $(DESTDIR)$(mandir)/cat6/blocks.$(CAT6EXT)
 128         $(RM) $(DESTDIR)$(mandir)/cat6/checkers.$(CAT6EXT)
 129         $(RM) $(DESTDIR)$(mandir)/cat6/sudoku.$(CAT6EXT)
 130         $(RM) $(DESTDIR)$(mandir)/man6/blocks.6
 131         $(RM) $(DESTDIR)$(mandir)/man6/checkers.6
 132         $(RM) $(DESTDIR)$(mandir)/man6/sudoku.6
 133
 134 # The HTML files are now generated using doxygen, and this needs
 135 # an installed doxygen version and may take some time, so this target
 136 # is not made by default.
 137 # Use `make html' or `make dist' to create the html docs
 138
 139 html:   $(HTMLFILES) Doxyfile
 140         echo "Generating HTML documentation..."
 141         -$(RMDIR) html
 142         -$(INSTALL_DIR) html
 143         -$(DOXYDOC)
 144         if test "x$(DOXYDOC)" = "x" ; then \
 145           echo "Sorry - doxygen not found. Please install doxygen and run configure."; \
 146         fi
 147         test -d html && cp src/tiny.png html/
 148
 149 # this is only used to minimize subversion updates of the online docs
 150 html-online: html
 151         echo "*** Warning: re-create HTML files if you want to build distribution files."
 152         echo "*** Warning: Use 'make html' to re-create the correct HTML files."
 153         echo "Stripping HTML files for online documentation upload..."
 154         ./strip_tags
 155
 156 pdf:    refman.pdf
 157         cp -f latex/refman.pdf ntk.pdf
 158
 159 refman.pdf: $(HTMLFILES) Doxybook
 160         -$(RMDIR) latex
 161         echo "Generating PDF documentation ..."
 162         $(DOXYDOC) Doxybook ;\
 163         (cd latex ;\
 164         pdflatex --interaction=nonstopmode refman.tex ;\
 165         makeindex refman.idx ;\
 166         pdflatex --interaction=nonstopmode refman.tex ;\
 167         latex_count=5;\
 168         while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log \
 169                 && [ $$latex_count -gt 0 ] ;\
 170             do \
 171               echo "Rerunning latex ..." ;\
 172               pdflatex --interaction=nonstopmode refman.tex ;\
 173               latex_count=`expr $$latex_count - 1` ;\
 174             done ; \
 175         cd ..) > pdfall.log 2>&1
 176
 177 #
 178 # End of "$Id: Makefile 8195 2011-01-05 23:00:33Z AlbrechtS $".
 179 #