Source

SCons / src / engine / SCons / Tool / tex.xml

Full commit
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="tex">
<summary>
Sets construction variables for the TeX formatter and typesetter.
</summary>
<sets>
TEX
TEXFLAGS
TEXCOM
LATEX
LATEXFLAGS
LATEXCOM
BIBTEX
BIBTEXFLAGS
BIBTEXCOM
MAKEINDEX
MAKEINDEXFLAGS
MAKEINDEXCOM
</sets>
<uses>
TEXCOMSTR
LATEXCOMSTR
BIBTEXCOMSTR
MAKEINDEXCOMSTR
</uses>
</tool>

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

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

<cvar name="BIBTEXCOMSTR">
<summary>
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.

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

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

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

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

<cvar name="MAKEINDEXCOMSTR">
<summary>
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.
</summary>
</cvar>

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

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

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

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

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

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