summaryrefslogtreecommitdiffstats
blob: af4970c4493673351ccc0e3a3b81a1a2c6b0a42f (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
<?xml version="1.0" encoding="UTF-8"?>
<!--
__COPYRIGHT__

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="pdflatex">
<summary>
<para>
Sets construction variables for the &pdflatex; utility.
</para>
</summary>
<sets>
<item>PDFLATEX</item>
<item>PDFLATEXFLAGS</item>
<item>PDFLATEXCOM</item>
<item>LATEXRETRIES</item>
</sets>
<uses>
<item>PDFLATEXCOMSTR</item>
</uses>
</tool>

<cvar name="PDFLATEX">
<summary>
<para>
The &pdflatex; utility.
</para>
</summary>
</cvar>

<cvar name="PDFLATEXCOM">
<summary>
<para>
The command line used to call the &pdflatex; utility.
</para>
</summary>
</cvar>

<cvar name="PDFLATEXCOMSTR">
<summary>
<para>
The string displayed when calling the &pdflatex; utility.
If this is not set, then &cv-link-PDFLATEXCOM; (the command line) is displayed.
</para>

<example_commands>
env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES")
</example_commands>
</summary>
</cvar>

<cvar name="PDFLATEXFLAGS">
<summary>
<para>
General options passed to the &pdflatex; utility.
</para>
</summary>
</cvar>

</sconsdoc>