SCons/Tool/tex.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="tex">
  28 <summary>
  29 <para>
  30 Sets construction variables for the TeX formatter and typesetter.
  31 </para>
  32 </summary>
  33 <sets>
  34 <item>TEX</item>
  35 <item>TEXFLAGS</item>
  36 <item>TEXCOM</item>
  37 <item>LATEX</item>
  38 <item>LATEXFLAGS</item>
  39 <item>LATEXCOM</item>
  40 <item>BIBTEX</item>
  41 <item>BIBTEXFLAGS</item>
  42 <item>BIBTEXCOM</item>
  43 <item>MAKEINDEX</item>
  44 <item>MAKEINDEXFLAGS</item>
  45 <item>MAKEINDEXCOM</item>
  46 </sets>
  47 <uses>
  48 <item>TEXCOMSTR</item>
  49 <item>LATEXCOMSTR</item>
  50 <item>BIBTEXCOMSTR</item>
  51 <item>MAKEINDEXCOMSTR</item>
  52 </uses>
  53 </tool>
  54
  55 <cvar name="BIBTEX">
  56 <summary>
  57 <para>
  58 The bibliography generator for the TeX formatter and typesetter and the
  59 LaTeX structured formatter and typesetter.
  60 </para>
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="BIBTEXCOM">
  65 <summary>
  66 <para>
  67 The command line used to call the bibliography generator for the
  68 TeX formatter and typesetter and the LaTeX structured formatter and
  69 typesetter.
  70 </para>
  71 </summary>
  72 </cvar>
  73
  74 <cvar name="BIBTEXCOMSTR">
  75 <summary>
  76 <para>
  77 The string displayed when generating a bibliography
  78 for TeX or LaTeX.
  79 If this is not set, then &cv-link-BIBTEXCOM; (the command line) is displayed.
  80 </para>
  81
  82 <example_commands>
  83 env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET")
  84 </example_commands>
  85 </summary>
  86 </cvar>
  87
  88 <cvar name="BIBTEXFLAGS">
  89 <summary>
  90 <para>
  91 General options passed to the bibliography generator for the TeX formatter
  92 and typesetter and the LaTeX structured formatter and typesetter.
  93 </para>
  94 </summary>
  95 </cvar>
  96
  97 <cvar name="MAKEINDEX">
  98 <summary>
  99 <para>
 100 The makeindex generator for the TeX formatter and typesetter and the
 101 LaTeX structured formatter and typesetter.
 102 </para>
 103 </summary>
 104 </cvar>
 105
 106 <cvar name="MAKEINDEXCOM">
 107 <summary>
 108 <para>
 109 The command line used to call the makeindex generator for the
 110 TeX formatter and typesetter and the LaTeX structured formatter and
 111 typesetter.
 112 </para>
 113 </summary>
 114 </cvar>
 115
 116 <cvar name="MAKEINDEXCOMSTR">
 117 <summary>
 118 <para>
 119 The string displayed when calling the makeindex generator for the
 120 TeX formatter and typesetter
 121 and the LaTeX structured formatter and typesetter.
 122 If this is not set, then &cv-link-MAKEINDEXCOM; (the command line) is displayed.
 123 </para>
 124 </summary>
 125 </cvar>
 126
 127 <cvar name="MAKEINDEXFLAGS">
 128 <summary>
 129 <para>
 130 General options passed to the makeindex generator for the TeX formatter
 131 and typesetter and the LaTeX structured formatter and typesetter.
 132 </para>
 133 </summary>
 134 </cvar>
 135
 136 <cvar name="TEX">
 137 <summary>
 138 <para>
 139 The TeX formatter and typesetter.
 140 </para>
 141 </summary>
 142 </cvar>
 143
 144 <cvar name="TEXCOM">
 145 <summary>
 146 <para>
 147 The command line used to call the TeX formatter and typesetter.
 148 </para>
 149 </summary>
 150 </cvar>
 151
 152 <cvar name="TEXCOMSTR">
 153 <summary>
 154 <para>
 155 The string displayed when calling
 156 the TeX formatter and typesetter.
 157 If this is not set, then &cv-link-TEXCOM; (the command line) is displayed.
 158 </para>
 159
 160 <example_commands>
 161 env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
 162 </example_commands>
 163 </summary>
 164 </cvar>
 165
 166 <cvar name="TEXFLAGS">
 167 <summary>
 168 <para>
 169 General options passed to the TeX formatter and typesetter.
 170 </para>
 171 </summary>
 172 </cvar>
 173
 174 </sconsdoc>