src/engine/SCons/Tool/pdflatex.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="pdflatex">
   8 <summary>
   9 Sets construction variables for the &pdflatex; utility.
  10 </summary>
  11 <sets>
  12 PDFLATEX
  13 PDFLATEXFLAGS
  14 PDFLATEXCOM
  15 LATEXRETRIES
  16 </sets>
  17 <uses>
  18 PDFLATEXCOMSTR
  19 </uses>
  20 </tool>
  21
  22 <cvar name="PDFLATEX">
  23 <summary>
  24 The &pdflatex; utility.
  25 </summary>
  26 </cvar>
  27
  28 <cvar name="PDFLATEXCOM">
  29 <summary>
  30 The command line used to call the &pdflatex; utility.
  31 </summary>
  32 </cvar>
  33
  34 <cvar name="PDFLATEXCOMSTR">
  35 <summary>
  36 The string displayed when calling the &pdflatex; utility.
  37 If this is not set, then &cv-link-PDFLATEXCOM; (the command line) is displayed.
  38
  39 <example>
  40 env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES")
  41 </example>
  42 </summary>
  43 </cvar>
  44
  45 <cvar name="PDFLATEXFLAGS">
  46 <summary>
  47 General options passed to the &pdflatex; utility.
  48 </summary>
  49 </cvar>