make.help

   1 # Help text for the GIMP-manual build system.
   2 #
   3 # This text will be printed when you type
   4 #       make [...] help
   5 # where %LANGUAGES% (and %ALL_LINGUAS% & %LINGUAS%) are
   6 # replaced with the value of the respective 'make' variable
   7 # and lines starting with '#' (comments) are skipped.
   8 #
   9 # Feel free to enhance this text... :-)
  10 #
  11
  12 Default (main) targets:
  13   all              Create/update HTML manual (and AUTHORS file)
  14                      (equivalent to "make [..] html AUTHORS" or "make [..]")
  15   html             Create/update HTML manual for all languages
  16                      (%LANGUAGES%)
  17   AUTHORS          Create/update AUTHORS file
  18
  19 Language-specific targets for making the GIMP-manual:
  20   html-LANG        Build HTML for language LANG (implies xml-LANG)
  21   pdf-LANG         Build  PDF for language LANG (implies xml-LANG)
  22   odf-LANG         Build  ODF for language LANG (implies xml-LANG)
  23
  24   Omitting LANG (e.g."make [..] html") is equivalent to making target
  25   for all languages: %LANGUAGES%
  26
  27   WARNING: Making HTML (or PDF, ODF, XML) will automatically update
  28   -------  po files if necessary. This may lead to unintended commits
  29            when working directly on a GIT sandbox.
  30
  31 Internal targets (intermediate stages):
  32   pot              Create/update POT files
  33   po-LANG          Create/update PO files for language LANG (implies pot)
  34   xml-LANG         Create/update XML files for language LANG (implies po-LANG)
  35
  36 Special (helper) targets for documenters and translators:
  37   status-LANG      Show translation progress for language LANG
  38   po/LANG/path/to/file.po
  39                    Force re-making of po file
  40   pot/path/to/file.pot
  41                    Force re-making of pot file
  42   preview-xml/LANG/path/to/file.xml
  43                    Make a single draft HTML file for language "LANG"
  44   preview-src/path/to/file.xml
  45                    Make single draft HTML files for all languages
  46
  47 Checks:
  48   validate-LANG    Validate XML for language LANG via 'xmllint'
  49   validate         Same as "validate-en"
  50   check-images-LANG
  51                    Find broken image references and orphaned image files
  52                    for language LANG (and for English images ("C"))
  53   check-images     Same as "check-images-en"
  54
  55 Packaging:
  56   gimp-help-2-html-LANG.tar.gz
  57   gimp-help-2-html-LANG.tar.bz2
  58   gimp-help-2-html-LANG.zip
  59                    Make HTML package for the specified language LANG.
  60
  61 Special (helper) targets for build-system development:
  62   dot              Create a visualized version of the Makefile dependencies
  63                    (this may be not up-to-date!)
  64
  65 Make variables (can be overriden at command-line):
  66   LINGUAS="..."    Space-separated list of manual languages (e.g. "en de fr"),
  67                    restricted to ALL_LINGUAS=%ALL_LINGUAS%
  68   LANGUAGES="..."  Space-separated list of manual languages (e.g. "en de fr"),
  69                    overriding ALL_LINGUAS
  70   VERBOSE=0|1|2    Controls the amount of output messages:
  71                      1 = moderate (default), 2 = all, 0 = nearly silent
  72
  73 More (optional) make variables (empty by default):
  74   GIMP_PO_ROOT     Path to the local GIMP (not: gimp-help-2) git repository
  75                    containing po files (po*/LANG.po) which may be used as
  76                    additional libraries of translations
  77   XSLTEXTRAFLAGS    Additional flags passed to the xsltproc tool
  78   DBLATEXEXTRAFLAGS Additional flags passed to the dblatex tool