src/engine/SCons/Tool/latex.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="latex">
   8 <summary>
   9 Sets construction variables for the &latex; utility.
  10 </summary>
  11 <sets>
  12 LATEX
  13 LATEXFLAGS
  14 LATEXCOM
  15 </sets>
  16 <uses>
  17 LATEXCOMSTR
  18 </uses>
  19 </tool>
  20
  21 <cvar name="LATEX">
  22 <summary>
  23 The LaTeX structured formatter and typesetter.
  24 </summary>
  25 </cvar>
  26
  27 <cvar name="LATEXCOM">
  28 <summary>
  29 The command line used to call the LaTeX structured formatter and typesetter.
  30 </summary>
  31 </cvar>
  32
  33 <cvar name="LATEXCOMSTR">
  34 <summary>
  35 The string displayed when calling
  36 the LaTeX structured formatter and typesetter.
  37 If this is not set, then &cv-link-LATEXCOM; (the command line) is displayed.
  38
  39 <example>
  40 env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES")
  41 </example>
  42 </summary>
  43 </cvar>
  44
  45 <cvar name="LATEXFLAGS">
  46 <summary>
  47 General options passed to the LaTeX structured formatter and typesetter.
  48 </summary>
  49 </cvar>
  50
  51 <cvar name="LATEXRETRIES">
  52 <summary>
  53 The maximum number of times that LaTeX
  54 will be re-run if the
  55 <filename>.log</filename>
  56 generated by the &cv-link-LATEXCOM; command
  57 indicates that there are undefined references.
  58 The default is to try to resolve undefined references
  59 by re-running LaTeX up to three times.
  60 </summary>
  61 </cvar>
  62
  63 <cvar name="TEXINPUTS">
  64 <summary>
  65 List of directories that the LaTeX programm will search
  66 for include directories.
  67 The LaTeX implicit dependency scanner will search these
  68 directories for \include and \import files.
  69 </summary>
  70 </cvar>
  71