SCons/Tool/pdftex.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   4 SPDX-License-Identifier: MIT
   5 SPDX-FileType: DOCUMENTATION
   6
   7 This file is processed by the bin/SConsDoc.py module.
   8 -->
   9
  10 <!DOCTYPE sconsdoc [
  11 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  12 %scons;
  13 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  14 %builders-mod;
  15 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  16 %functions-mod;
  17 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  18 %tools-mod;
  19 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  20 %variables-mod;
  21 ]>
  22
  23 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  24           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  25           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  26
  27 <tool name="pdftex">
  28 <summary>
  29 <para>
  30 Sets construction variables for the &pdftex; utility.
  31 </para>
  32 </summary>
  33 <sets>
  34 <item>PDFTEX</item>
  35 <item>PDFTEXFLAGS</item>
  36 <item>PDFTEXCOM</item>
  37 <item>PDFLATEX</item>
  38 <item>PDFLATEXFLAGS</item>
  39 <item>PDFLATEXCOM</item>
  40 <item>LATEXRETRIES</item>
  41 </sets>
  42 <uses>
  43 <item>PDFTEXCOMSTR</item>
  44 <item>PDFLATEXCOMSTR</item>
  45 </uses>
  46 </tool>
  47
  48 <cvar name="PDFTEX">
  49 <summary>
  50 <para>
  51 The &pdftex; utility.
  52 </para>
  53 </summary>
  54 </cvar>
  55
  56 <cvar name="PDFTEXCOM">
  57 <summary>
  58 <para>
  59 The command line used to call the &pdftex; utility.
  60 </para>
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="PDFTEXCOMSTR">
  65 <summary>
  66 <para>
  67 The string displayed when calling the &pdftex; utility.
  68 If this is not set, then &cv-link-PDFTEXCOM; (the command line) is displayed.
  69 </para>
  70
  71 <example_commands>
  72 env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
  73 </example_commands>
  74 </summary>
  75 </cvar>
  76
  77 <cvar name="PDFTEXFLAGS">
  78 <summary>
  79 <para>
  80 General options passed to the &pdftex; utility.
  81 </para>
  82 </summary>
  83 </cvar>
  84
  85 </sconsdoc>