summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/tex.xml
blob: 893776d56d189162952389f1dfdd912252542c13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2001 - 2015 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->

<!DOCTYPE sconsdoc [
<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
%scons;
<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
%builders-mod;
<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
%functions-mod;
<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
%tools-mod;
<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
%variables-mod;
]>

<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">

<tool name="tex">
<summary>
<para>
Sets construction variables for the TeX formatter and typesetter.
</para>
</summary>
<sets>
<item>TEX</item>
<item>TEXFLAGS</item>
<item>TEXCOM</item>
<item>LATEX</item>
<item>LATEXFLAGS</item>
<item>LATEXCOM</item>
<item>BIBTEX</item>
<item>BIBTEXFLAGS</item>
<item>BIBTEXCOM</item>
<item>MAKEINDEX</item>
<item>MAKEINDEXFLAGS</item>
<item>MAKEINDEXCOM</item>
</sets>
<uses>
<item>TEXCOMSTR</item>
<item>LATEXCOMSTR</item>
<item>BIBTEXCOMSTR</item>
<item>MAKEINDEXCOMSTR</item>
</uses>
</tool>

<cvar name="BIBTEX">
<summary>
<para>
The bibliography generator for the TeX formatter and typesetter and the
LaTeX structured formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="BIBTEXCOM">
<summary>
<para>
The command line used to call the bibliography generator for the
TeX formatter and typesetter and the LaTeX structured formatter and
typesetter.
</para>
</summary>
</cvar>

<cvar name="BIBTEXCOMSTR">
<summary>
<para>
The string displayed when generating a bibliography
for TeX or LaTeX.
If this is not set, then &cv-link-BIBTEXCOM; (the command line) is displayed.
</para>

<example_commands>
env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET")
</example_commands>
</summary>
</cvar>

<cvar name="BIBTEXFLAGS">
<summary>
<para>
General options passed to the bibliography generator for the TeX formatter
and typesetter and the LaTeX structured formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="MAKEINDEX">
<summary>
<para>
The makeindex generator for the TeX formatter and typesetter and the
LaTeX structured formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="MAKEINDEXCOM">
<summary>
<para>
The command line used to call the makeindex generator for the
TeX formatter and typesetter and the LaTeX structured formatter and
typesetter.
</para>
</summary>
</cvar>

<cvar name="MAKEINDEXCOMSTR">
<summary>
<para>
The string displayed when calling the makeindex generator for the
TeX formatter and typesetter
and the LaTeX structured formatter and typesetter.
If this is not set, then &cv-link-MAKEINDEXCOM; (the command line) is displayed.
</para>
</summary>
</cvar>

<cvar name="MAKEINDEXFLAGS">
<summary>
<para>
General options passed to the makeindex generator for the TeX formatter
and typesetter and the LaTeX structured formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="TEX">
<summary>
<para>
The TeX formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="TEXCOM">
<summary>
<para>
The command line used to call the TeX formatter and typesetter.
</para>
</summary>
</cvar>

<cvar name="TEXCOMSTR">
<summary>
<para>
The string displayed when calling
the TeX formatter and typesetter.
If this is not set, then &cv-link-TEXCOM; (the command line) is displayed.
</para>

<example_commands>
env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
</example_commands>
</summary>
</cvar>

<cvar name="TEXFLAGS">
<summary>
<para>
General options passed to the TeX formatter and typesetter.
</para>
</summary>
</cvar>

</sconsdoc>