doc/C/Makefile.am

   1 ## Process this fillocatee with automake to generate Makefile.in
   2 #
   3 #   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   4 #
   5 #   This program is free software; you can redistribute it and/or modify
   6 #   it under the terms of the GNU General Public License as published by
   7 #   the Free Software Foundation; either version 3 of the License, or
   8 #   (at your option) any later version.
   9 #
  10 #   This program is distributed in the hope that it will be useful,
  11 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #   GNU General Public License for more details.
  14 #
  15 #   You should have received a copy of the GNU General Public License
  16 #   along with this program; if not, write to the Free Software
  17 #   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19 # Building a PDF using Apache FOP only works with fop-0.20.5 for now.
  20
  21 htmldir = ${prefix}/share/doc/gnash
  22 infodir = ${prefix}/share/info
  23 man1dir = ${mandir}/man1
  24 docname = gnash
  25 lang = C
  26 omffile = gnash-C.omf
  27
  28 docdir = $(datadir)/$(PACKAGE)/doc/$(docname)/$(lang)
  29 omf_dest_dir=$(datadir)/omf/$(PACKAGE)
  30 scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper
  31
  32 # These are the top level files for each manual.
  33 XML_MAIN = \
  34         gnashuser.xml \
  35         gnashref.xml
  36
  37 # These are the files needed to build the Gnash user
  38 # manual.
  39 COMMON = \
  40         introduction.xml \
  41         security.xml \
  42         legal.xml \
  43         app_authors.xml \
  44         doc_authors.xml \
  45         fdl-appendix.xml \
  46         bugreport.xml
  47
  48 USERMAN = \
  49         usermanual/installation.xml \
  50         usermanual/revisions.xml \
  51         usermanual/usage.xml \
  52         usermanual/glossary.xml \
  53         usermanual/specification.xml \
  54         usermanual/gnashrc.xml \
  55         usermanual/acknowledgments.xml \
  56         usermanual/conventions.xml
  57
  58 # These are the files needed to build the Gnash reference
  59 # manual.
  60 REFMAN = \
  61         refmanual/amf.xml \
  62         refmanual/as_value.xml \
  63         refmanual/building.xml \
  64         refmanual/code_dependencies.xml \
  65         refmanual/codestyle.xml \
  66         refmanual/configuration.xml \
  67         refmanual/cross_compiling.xml \
  68         refmanual/custompath_configuration.xml \
  69         refmanual/documentation_dependencies.xml \
  70         refmanual/feature_configuration.xml \
  71         refmanual/install.xml \
  72         refmanual/internals.xml \
  73         refmanual/logging.xml \
  74         refmanual/memory.xml \
  75         refmanual/new_as_class.xml \
  76         refmanual/object.xml \
  77         refmanual/plugin.xml \
  78         refmanual/revisions.xml \
  79         refmanual/rtmp.xml \
  80         refmanual/sources.xml \
  81         refmanual/testing_dependencies.xml \
  82         refmanual/extensions/extensions.xml \
  83         refmanual/extensions/fileext.xml \
  84         refmanual/extensions/gtkext.xml \
  85         refmanual/extensions/mysqlext.xml
  86
  87 EXTRA_DIST = \
  88         $(USERMAN) \
  89         $(REFMAN) \
  90         $(COMMON) \
  91         $(XML_MAIN) \
  92         $(MANSRC) \
  93         preformatted/gnashuser.html.in \
  94         preformatted/gprocessor.1.in \
  95         preformatted/cygnal.1.in \
  96         preformatted/gnash.1.in \
  97         preformatted/gnash_ref.info.in \
  98         preformatted/soldumper.1.in \
  99         preformatted/flvdumper.1.in \
 100         preformatted/gnashref.html.in \
 101         preformatted/gnash_user.info.in \
 102         preformatted/rtmpget.1.in \
 103         preformatted/findmicrophones.1.in \
 104         preformatted/findwebcams.1.in \
 105         preformatted/gtk-gnash.1.in \
 106         preformatted/kde4-gnash.1.in
 107 #       preformatted/dumpshm.1.in
 108
 109 #noinst_SCRIPT = gen-doc.sh
 110 # We list the texi and info pages twice, as differing versions of the
 111 # docbook-utils transform the name at different steps in the process.
 112 # This is an easy way to handle it either way, since we only need it as
 113 # dependency anyway.
 114 MANPAGES = \
 115         gnash.1 \
 116         gprocessor.1 \
 117         soldumper.1 \
 118         flvdumper.1 \
 119         cygnal.1 \
 120         rtmpget.1 \
 121         findmicrophones.1 \
 122         findwebcams.1
 123 #       dumpshm.1
 124
 125 MANSRC = $(MANPAGES:.1=.man-xml)
 126 INFOS  = gnash_user.info gnash_ref.info
 127 HTMLS  = $(XML_MAIN:.xml=.html)
 128 PDFS   = $(XML_MAIN:.xml=.pdf)
 129 TEXIS  = gnash_user.texi gnashuser.texi gnash_ref.texi gnashref.texi
 130
 131 all-local: info html man link-extra-man
 132
 133 gnashuser.html gnashuser.pdf gnash_user.info: gnashuser.xml $(USERMAN) $(COMMON)
 134 gnashref.html gnashref.pdf gnash_ref.info: gnashref.xml $(REFMAN) $(COMMON)
 135
 136 # Convienience rules for developers of these manuals. By default
 137 # all output formats are built if the Docbook tools are installed
 138 # and working correctly.
 139 html: $(HTMLS)
 140 pdf:  $(PDFS)
 141 man:  $(MANPAGES)
 142 info: $(INFOS)
 143 if DOCBOOK
 144 texi: $(TEXIS)
 145 endif
 146
 147 #
 148 # Gnash uses suffix rules to build all the various supported
 149 # output formats. This section contains all the code that does
 150 # the document convesion from docbook to whatever. Note that
 151 # all of these are conditional, as the tools may not be
 152 # installed on all systems, and on some systems, getting a fully
 153 # working Docbook tools system can problematic. In this case
 154 # preformatted versions are in the top level packaging/doc
 155 # directory, so we just link to them so they can be installed.
 156 # While it's a bit of a pain in the neck for developers to
 157 # keep the preformatted versions up to date, it's much easier
 158 # for end users because the documentation in xml, html, and info
 159 # formats is always available.
 160 #
 161 SUFFIXES = .xml .html .texi .pdf .info .1 .fo .man-xml .in
 162
 163 if ENABLE_FOP
 164 .xml.pdf:
 165         -$(FOP) -xsl $(docbook_styles)/fo/docbook.xsl -xml $< -pdf $@
 166 else
 167 if ENABLE_XMLTEX
 168 .xml.fo:
 169         $(XSLTPROC) --output $@ --nonet $(docbook_styles)/fo/docbook.xsl $<
 170
 171 .fo.pdf:
 172         $(PDFXMLTEX) -interaction=nonstopmode $<
 173 else
 174 .xml.pdf:
 175         touch $@
 176 endif
 177 endif
 178
 179
 180 .xml.html:
 181 if ENABLE_HTML
 182         -$(XSLTPROC) --output $@ --nonet $(docbook_styles)/html/docbook.xsl $<
 183         @$(RM) $*.txml
 184 else
 185         @if test -d $(srcdir)/preformatted; then \
 186           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 187           $(LN_S) -f $(srcdir)/preformatted/$@.in ./$@; \
 188         else \
 189           touch $@; \
 190         fi
 191 endif
 192
 193 # The first test seems to be the default for Fedora/Redhat/Centos based distributions,
 194 # which use a wrapper script for jade.
 195 # Ubuntu/Debian uses a real perl script that actually does the real work
 196 .xml.texi:
 197 if ENABLE_TEXI
 198         -if test x$(DB2X_TEXI) != x; then \
 199           out=`echo $* | sed -e 's:gnash:gnash_:'`; \
 200           $(DB2X_TEXI) --encoding=us-ascii//TRANSLIT --string-param directory-description="Gnash" --string-param output-file=$${out} $<; \
 201           $(MAKEINFO) --force $${out}.texi; \
 202         else \
 203           basefile="$*"; \
 204           $(DB2X_XSLTPROC) -s texi $< --output $${basefile}.txml; \
 205           $(DB2X_TEXIXML) --info --encoding=us-ascii//TRANSLIT $${basefile}.txml ; \
 206           rm $${basefile}.txml; \
 207         fi
 208 endif
 209
 210 .texi.info:
 211 if ENABLE_TEXI
 212         -$(MAKEINFO) --force $<
 213 else
 214         touch $@;
 215 endif
 216
 217 .man-xml.1:
 218 if ENABLE_MAN
 219         -if test x$(DB2X_MAN) != x; then \
 220           $(DB2X_MAN) $?; \
 221         else \
 222           $(DB2X_XSLTPROC) -s man $? -o $*.mxml; \
 223           $(DB2X_MANXML) --solinks $*.mxml; \
 224           $(RM) $*.mxml; \
 225         fi
 226 else
 227         @if test -d $(srcdir)/preformatted; then \
 228           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 229           $(LN_S) -f $(srcdir)/preformatted/$@.in ./$@; \
 230         else \
 231           touch $@; \
 232         fi
 233 endif
 234
 235 gnash.1: $(srcdir)/gnash.man-xml
 236 gprocessor.1: $(srcdir)/gprocessor.man-xml
 237 #dumpshm.1: $(srcdir)/dumpshm.man-xml
 238 soldumper.1: $(srcdir)/soldumper.man-xml
 239 flvdumper.1: $(srcdir)/flvdumper.man-xml
 240 cygnal.1: $(srcdir)/cygnal.man-xml
 241 findmicrophones.1: $(srcdir)/findmicrophones.man-xml
 242 findwebcams.1: $(srcdir)/findwebcams.man-xml
 243
 244 if DOCBOOK
 245 gnash_user.info: gnashuser.texi
 246 gnash_ref.info: gnashref.texi
 247 gnashuser.texi gnash_user.texi: images gnashuser.xml
 248 gnashref.texi gnash_ref.texi: gnashref.xml
 249 else
 250 gnash_user.info: gnashuser.xml
 251         -@if test -d $(srcdir)/preformatted; then \
 252           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 253           $(LN_S) -f $(srcdir)/preformatted/gnash_user.info.in ./gnash_user.info; \
 254         fi
 255 gnash_ref.info: gnashref.xml
 256         -@if test -d $(srcdir)/preformatted; then \
 257           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 258           $(LN_S) -f $(srcdir)/preformatted/gnash_ref.info.in ./gnash_ref.info; \
 259         fi
 260 gnashref.html: gnashref.xml
 261         -@if test -d $(srcdir)/preformatted; then \
 262           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 263           $(LN_S) -f $(srcdir)/preformatted/gnashref.html.in ./gnashref.html; \
 264         fi
 265 gnashuser.html: gnashref.xml
 266         -@if test -d $(srcdir)/preformatted; then \
 267           echo "WARNING: Linking to preformatted version of $@, it could be out of date."; \
 268           $(LN_S) -f $(srcdir)/preformatted/gnashuser.html.in ./gnashuser.html; \
 269         fi
 270 endif
 271
 272 lint-user:
 273         @xmllint $(srcdir)/gnashuser.xml
 274
 275 lint-ref:
 276         @xmllint $(srcdir)/gnashref.xml
 277
 278 # This target adds the images to the dist file, which is
 279 # produced by the dist-bzip2, dist-gzip, or snapshot targets.
 280 # distdir is a built in target for Automake.
 281 dist-hook:
 282         test -d "$(distdir)/images" || $(mkinstalldirs) "$(distdir)/images"
 283         -@for file in $(srcdir)/images/*.png $(srcdir)/images/*.txt; do \
 284           basefile="`basename $${file}`"; \
 285           if test ! -e $(distdir)/images/$${basefile}; then \
 286             $(INSTALL_DATA) $$file $(distdir)/images/; \
 287           fi; \
 288         done
 289
 290 # When we build in a seperate build tree, we need links to the images
 291 # subdirectory to have them be included in the final output.
 292 images:
 293         -@if test ! -e images; then \
 294           $(LN_S) -f $(srcdir)/images images; \
 295         fi;
 296
 297 #
 298 # Installing documentation can be a complex process, as we build
 299 # multiple output formats. This section contains all of the
 300 # Makefile targets that are used to install or uninstall the
 301 # documentation.
 302 #
 303 install-html-hook: $(HTMLS)
 304         -@test -d "$(DESTDIR)$(htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(htmldir)"
 305         -$(INSTALL_DATA) gnashuser.html $(DESTDIR)$(htmldir)
 306         -$(INSTALL_DATA) gnashref.html $(DESTDIR)$(htmldir)
 307         @test -d "$(DESTDIR)$(htmldir)/images" || $(mkinstalldirs) "$(DESTDIR)$(htmldir)/images"
 308         -for file in $(srcdir)/images/*.png; do \
 309           basefile=`echo $$file | sed -e  's,^.*/,,'`; \
 310           $(INSTALL_DATA) $$file $(DESTDIR)$(htmldir)/images/$$basefile; \
 311         done
 312
 313 # There are two versions of install-info, with unfortunately different options.
 314 # Rather than test the version at configure time, we do it at runtime instead
 315 # so we can switch versions at installation time.
 316 install-info-hook: $(INFOS)
 317 if ENABLE_INFO
 318         -@test -d "$(DESTDIR)$(infodir)" || $(mkinstalldirs) "$(DESTDIR)$(infodir)"
 319         -for i in *.info; do \
 320           $(INSTALL_DATA) "$$i" $(DESTDIR)$(infodir)/"$$i"; \
 321         done; \
 322         type="`file $(INSTALL_INFO) | grep -ic "perl " 2>&1`"; \
 323         if test $${type} -gt 0; then \
 324           $(INSTALL_INFO) --menuentry="\"Gnash User Manual\"" --quiet --description="\"Gnash User Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_user.info; \
 325           $(INSTALL_INFO) --menuentry="\"Gnash Reference Manual\"" --quiet --description="\"Gnash Reference Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_ref.info; \
 326         else \
 327           $(INSTALL_INFO) --entry="\"Gnash User Manual: (gnash_user)    Gnash User Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_user.info; \
 328           $(INSTALL_INFO) --entry="\"Gnash Reference Manual (gnash_ref) Gnash Reference Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_ref.info; \
 329         fi
 330 else
 331         echo "Using preformtted output file,"
 332         -$(LN_S) -f $(srcdir)/preformatted/gnash_user.info.in gnash_user.info
 333         -$(LN_S) -f $(srcdir)/preformatted/gnash_ref.info.in gnash_ref.info
 334         -$(INSTALL_INFO) --entry="\"Gnash User Manual: (gnash_user)     Gnash User Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_user.info
 335         -$(INSTALL_INFO) --entry="\"Gnash Reference Manual (gnash_ref)  Gnash Reference Manual\"" --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/gnash_ref.info
 336 endif
 337
 338 uninstall-info-hook:
 339 if ENABLE_INFO
 340         -$(INSTALL_INFO) --dir-file=$(DESTDIR)$(infodir)/dir --remove $(DESTDIR)$(infodir)/gnash_user.info
 341         -$(INSTALL_INFO)  --dir-file=$(DESTDIR)$(infodir)/dir --remove $(DESTDIR)$(infodir)/gnash_ref.info
 342 endif
 343         -$(RM) $(DESTDIR)$(infodir)/gnash_user.info
 344         -$(RM) $(DESTDIR)$(infodir)/gnash_ref.info
 345
 346 uninstall-html-hook:
 347         -$(RM) $(DESTDIR)$(htmldir)/gnashuser.html
 348         -$(RM) $(DESTDIR)$(htmldir)/gnashref.html
 349         -$(RM) $(DESTDIR)$(htmldir)/images/*png
 350
 351 uninstall-man1-hook:
 352         -$(RM) $(DESTDIR)$(htmldir)/gnashuser.html
 353
 354 # install-data-hook: install-data-hook-omf
 355 # uninstall-local: uninstall-local-doc uninstall-local-omf
 356
 357 # gtk-gnash.1 and kde4-gnash.1 are special, as they are created by
 358 # the --solinks option to the docbook2 tools for creating man pages.
 359 install-man1: $(MANPAGES)
 360         -test -d "$(DESTDIR)$(man1dir)/" || $(mkinstalldirs) "$(DESTDIR)$(man1dir)/"
 361         -$(INSTALL_DATA) gtk-gnash.1 $(DESTDIR)$(man1dir)/gtk-gnash.1
 362         -$(INSTALL_DATA) kde4-gnash.1 $(DESTDIR)$(man1dir)/kde4-gnash.1
 363         -for file in $(MANPAGES); do \
 364            $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$file; \
 365         done
 366
 367 uninstall-man1:
 368         -for file in $(MANPAGES); do \
 369            $(RM) $(DESTDIR)$(man1dir)/$$file; \
 370         done
 371
 372 # the gtk-gnash.1 and kde4-gnash.1 manpages are generated as aliases
 373 # for the gnash.1 man page, so we can't use the suffix rules to build
 374 # them, but we need to install the ".so gnash.1" manpages also, or
 375 # they aren;t in the tarball.
 376 link-extra-man:
 377         -@if test ! -e gtk-gnash.1; then \
 378             echo "WARNING: Linking to preformatted version of gtk-gnash.1, it could be out of date."; \
 379             $(LN_S) -f $(srcdir)/preformatted/gtk-gnash.1.in gtk-gnash.1; \
 380           fi
 381         -@if test ! -e kde4-gnash.1; then \
 382             echo "WARNING: Linking to preformatted version of kde4-gnash.1, it could be out of date."; \
 383             $(LN_S) -f $(srcdir)/preformatted/kde4-gnash.1.in kde4-gnash.1; \
 384           fi
 385
 386 install-data-hook: $(MANPAGES) install-man1 install-info-hook install-html-hook
 387 uninstall-hook: uninstall-info-hook uninstall-html-hook
 388         -$(RM) -f $(DESTDIR)$(man1dir)/*.1
 389
 390 #
 391 # GNOME Help support, which currently isn't supported
 392 # by the Gnash GTK GUI.
 393 #
 394
 395 # if GHELP
 396 # all-local: omf
 397 # INSTALL_DATA_HOOK += omf install-data-omf-hook
 398 # UNINSTALL_HOOK += uninstall-omf-hook
 399 # endif
 400
 401 omf: omf_timestamp
 402
 403 omf_timestamp: $(omffile)
 404         for file in $(omffile); do \
 405             $(SCROLLINSTALL) $(docdir)/$(docname).xml $(srcdir)/$$file $$file.out; \
 406         done
 407         touch omf_timestamp
 408
 409 install-data-omf-hook:
 410         $(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
 411         for file in $(omffile); do \
 412           $(INSTALL_DATA) $$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \
 413         done
 414         -$(SCROLLUPDATE) -v -o $(DESTDIR)$(omf_dest_dir)
 415
 416 uninstall-omf-hook:
 417         -for file in $(omffile); do \
 418             $(RM) $(DESTDIR)$(omf_dest_dir)/$$file; \
 419         done
 420         -rmdir $(DESTDIR)$(omf_dest_dir)
 421         -$(SCROLLUPDATE) -v
 422
 423 CLEANFILES = \
 424         $(PDFS) \
 425         $(MANPAGES) \
 426         $(INFOS) \
 427         $(HTMLS) \
 428         $(TEXIS) \
 429         gnash-C.omf.out \
 430         manpage.links  \
 431         manpage.refs  \
 432         gnash.fo  \
 433         gnash.log  \
 434         gnashuser.txml \
 435         gnashuser.mxml \
 436         gnashref.txml \
 437         gnashref.mxml \
 438         omf_timestamp \
 439         images \
 440         gtk-gnash.1 \
 441         kde4-gnash.1
 442
 443 # This updates the copies of the manuals that are stored preformatted
 444 # so not everyone needs to get Docbook working well enough to produce
 445 # the documentation. This should only be used by developers after
 446 # making changes to a documentation source file.
 447 if DOCBOOK
 448 update-preformats:
 449         -@for type in 1 html info; do \
 450           for i in *.$${type}; do \
 451             name=$${i/\.$${type}/.$${type}.in}; \
 452             diff=`diff --brief $$i $(srcdir)/preformatted/$${name}`; \
 453             if test ! x"$${diff}" = x; then \
 454               echo "Updating the preformatted/$${name}"; \
 455               cp $$i $(srcdir)/preformatted/$${name}; \
 456             fi; \
 457           done; \
 458         done
 459 endif
 460
 461 # Always execute these targets as they have no real dependencies.
 462 .PHONY: images install-info-hook uninstall-info-hook install-html-hook uninstall-html-hook uninstall-data-hook install-data-hook images install-man1 update-preformats
 463