2098d8bfd8
Now we have less files to edit, and Doxyfile.in is shared with the CMake generation of Doxyfile and Doxybook. Besides that two files with FLTK version numbers are now removed (less work for future version updates). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10762 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
195 lines
6.7 KiB
Makefile
195 lines
6.7 KiB
Makefile
#
|
|
# "$Id$"
|
|
#
|
|
# Makefile for the Fast Light Tool Kit (FLTK) documentation.
|
|
#
|
|
# Copyright 1998-2015 by Bill Spitzak and others.
|
|
#
|
|
# This library is free software. Distribution and use rights are outlined in
|
|
# the file "COPYING" which should have been included with this file. If this
|
|
# file is missing or damaged, see the license at:
|
|
#
|
|
# http://www.fltk.org/COPYING.php
|
|
#
|
|
# Please report all bugs and problems on the following page:
|
|
#
|
|
# http://www.fltk.org/str.php
|
|
#
|
|
|
|
# Get configuration stuff...
|
|
include ../makeinclude
|
|
|
|
# make sure that all docs are (re-)created independent of missing deps
|
|
.PHONY: pdf html refman.pdf
|
|
|
|
SRC_DOCDIR = ./src
|
|
|
|
# These are the HTML "source" files...
|
|
HTMLFILES = \
|
|
$(SRC_DOCDIR)/index.dox \
|
|
$(SRC_DOCDIR)/preface.dox \
|
|
$(SRC_DOCDIR)/intro.dox \
|
|
$(SRC_DOCDIR)/basics.dox \
|
|
$(SRC_DOCDIR)/common.dox \
|
|
$(SRC_DOCDIR)/editor.dox \
|
|
$(SRC_DOCDIR)/drawing.dox \
|
|
$(SRC_DOCDIR)/events.dox \
|
|
$(SRC_DOCDIR)/subclassing.dox \
|
|
$(SRC_DOCDIR)/opengl.dox \
|
|
$(SRC_DOCDIR)/fluid.dox \
|
|
$(SRC_DOCDIR)/advanced.dox \
|
|
$(SRC_DOCDIR)/unicode.dox \
|
|
$(SRC_DOCDIR)/enumerations.dox \
|
|
$(SRC_DOCDIR)/glut.dox \
|
|
$(SRC_DOCDIR)/forms.dox \
|
|
$(SRC_DOCDIR)/osissues.dox \
|
|
$(SRC_DOCDIR)/migration_1_1.dox \
|
|
$(SRC_DOCDIR)/migration_1_3.dox \
|
|
$(SRC_DOCDIR)/development.dox \
|
|
$(SRC_DOCDIR)/license.dox \
|
|
$(SRC_DOCDIR)/examples.dox \
|
|
$(SRC_DOCDIR)/faq.dox
|
|
|
|
MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \
|
|
$(SRC_DOCDIR)/fluid.$(CAT1EXT) $(SRC_DOCDIR)/blocks.$(CAT6EXT) \
|
|
$(SRC_DOCDIR)/checkers.$(CAT6EXT) $(SRC_DOCDIR)/sudoku.$(CAT6EXT)
|
|
|
|
all: $(MANPAGES)
|
|
|
|
# Use `make docs' to create all docs for distribution files.
|
|
# You need installed versions of Doxygen and LaTeX for this.
|
|
|
|
docs: all html pdf
|
|
|
|
# Synonyms for docs:
|
|
|
|
alldocs: docs
|
|
dist: docs
|
|
|
|
clean:
|
|
$(RM) Doxyfile Doxybook
|
|
$(RM) fltk.pdf refman.pdf src/fltk-book.tex
|
|
$(RMDIR) html latex
|
|
$(RM) *~ *.bck *.bak *.log
|
|
$(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0
|
|
|
|
depend:
|
|
|
|
install: $(MANPAGES)
|
|
echo "Installing documentation files in $(DESTDIR)$(docdir) ..."
|
|
-$(INSTALL_DIR) $(DESTDIR)$(docdir)
|
|
if test -f html/index.html ; then \
|
|
for file in html/* ; do \
|
|
$(INSTALL_DATA) $$file $(DESTDIR)$(docdir); \
|
|
done \
|
|
fi
|
|
if test -f fltk.pdf ; then \
|
|
echo "Installing fltk.pdf in $(DESTDIR)$(docdir) ..."; \
|
|
$(INSTALL_DATA) fltk.pdf $(DESTDIR)$(docdir); \
|
|
fi
|
|
echo "Installing man pages in $(DESTDIR)$(mandir) ..."
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat1
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fluid.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) $(DESTDIR)$(mandir)/cat1
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat3
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(DESTDIR)$(mandir)/cat3
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/man1
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fluid.man $(DESTDIR)$(mandir)/man1/fluid.1
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fltk-config.man $(DESTDIR)$(mandir)/man1/fltk-config.1
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/man3
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/fltk.man $(DESTDIR)$(mandir)/man3/fltk.3
|
|
|
|
install-linux install-osx:
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/cat6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/blocks.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/checkers.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.$(CAT6EXT) $(DESTDIR)$(mandir)/cat6
|
|
-$(INSTALL_DIR) $(DESTDIR)$(mandir)/man6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/blocks.man $(DESTDIR)$(mandir)/man6/blocks.6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/checkers.man $(DESTDIR)$(mandir)/man6/checkers.6
|
|
$(INSTALL_MAN) $(SRC_DOCDIR)/sudoku.man $(DESTDIR)$(mandir)/man6/sudoku.6
|
|
|
|
|
|
uninstall:
|
|
$(RMDIR) $(DESTDIR)$(docdir)
|
|
$(RM) $(DESTDIR)$(mandir)/cat1/fluid.$(CAT1EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/man1/fluid.1
|
|
$(RM) $(DESTDIR)$(mandir)/cat1/fltk-config.$(CAT1EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/man1/fltk-config.1
|
|
$(RM) $(DESTDIR)$(mandir)/cat3/fltk.$(CAT3EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/man3/fltk.3
|
|
|
|
uninstall-linux uninstall-osx:
|
|
$(RM) $(DESTDIR)$(mandir)/cat6/blocks.$(CAT6EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/cat6/checkers.$(CAT6EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/cat6/sudoku.$(CAT6EXT)
|
|
$(RM) $(DESTDIR)$(mandir)/man6/blocks.6
|
|
$(RM) $(DESTDIR)$(mandir)/man6/checkers.6
|
|
$(RM) $(DESTDIR)$(mandir)/man6/sudoku.6
|
|
|
|
# The documentation is generated using doxygen. There are two control files
|
|
# for doxygen: Doxyfile for html documentation and Doxybook for pdf docs.
|
|
# Both files are generated from the common source file Doxyfile.in.
|
|
# Note that Doxyfile.in is shared with CMake to configure these files.
|
|
|
|
Doxyfile: Doxyfile.in
|
|
echo "Generating Doxyfile ..."
|
|
sed -e's,@FL_VERSION@,$(FL_VERSION),' \
|
|
-e's,@GENERATE_HTML@,YES,' \
|
|
-e's,@GENERATE_LATEX@,NO,' \
|
|
-e's, @LATEX_HEADER@,,' \
|
|
-e's,@CMAKE_CURRENT_SOURCE_DIR@/,,' \
|
|
-e's,@CMAKE_SOURCE_DIR@/,../,' \
|
|
< $< > $@
|
|
|
|
Doxybook: Doxyfile.in
|
|
echo "Generating Doxybook ..."
|
|
sed -e's,@FL_VERSION@,$(FL_VERSION),' \
|
|
-e's,@GENERATE_HTML@,NO,' \
|
|
-e's,@GENERATE_LATEX@,YES,' \
|
|
-e's,@LATEX_HEADER@,src/fltk-book.tex,' \
|
|
-e's,@CMAKE_CURRENT_SOURCE_DIR@/,,' \
|
|
-e's,@CMAKE_SOURCE_DIR@/,../,' \
|
|
< $< > $@
|
|
|
|
# The HTML files are generated using doxygen, and this needs
|
|
# an installed doxygen version and may take some time, so this target
|
|
# is not made by default.
|
|
# Use `make html' or `make docs' to create the html docs.
|
|
|
|
html: $(HTMLFILES) Doxyfile
|
|
echo "Generating HTML documentation..."
|
|
-$(RMDIR) html
|
|
-$(INSTALL_DIR) html
|
|
-$(DOXYDOC)
|
|
if test "x$(DOXYDOC)" = "x" ; then \
|
|
echo "Sorry - doxygen not found. Please install doxygen and run configure."; \
|
|
fi
|
|
test -d html && cp src/tiny.png html/
|
|
|
|
# The PDF documentation (fltk.pdf) is generated using doxygen and LaTeX, and
|
|
# this needs installed Doxygen and LaTeX programs and may take some time, so
|
|
# this target is not made by default.
|
|
# Use `make pdf' or `make docs' to create the PDF docs.
|
|
|
|
pdf: refman.pdf
|
|
cp -f latex/refman.pdf fltk.pdf
|
|
|
|
refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex
|
|
-$(RMDIR) latex
|
|
echo "Generating PDF documentation ..."
|
|
$(DOXYDOC) Doxybook
|
|
./make_pdf
|
|
|
|
src/fltk-book.tex: src/fltk-book.tex.in
|
|
DOXY_VERSION=`$(DOXYDOC) --version`; \
|
|
YEAR=`date +%Y`; \
|
|
sed -e"s/@YEAR@/$$YEAR/g" \
|
|
-e"s/@FL_VERSION@/$(FL_VERSION)/g" \
|
|
-e"s/@DOXY_VERSION@/$$DOXY_VERSION/g" \
|
|
< $< > $@
|
|
|
|
#
|
|
# End of "$Id$".
|
|
#
|