SCons / src / engine / SCons / Tool / dvi.xml

Full commit
<?xml version="1.0" encoding="UTF-8"?>

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

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

<sconsdoc xmlns=""
          xsi:schemaLocation=" scons.xsd">

<tool name="dvi">
Attaches the &b-DVI; builder to the
construction environment.

<builder name="DVI">
Builds a <filename>.dvi</filename> file
from a <filename>.tex</filename>,
<filename>.ltx</filename> or <filename>.latex</filename> input file.
If the source file suffix is <filename>.tex</filename>,
will examine the contents of the file;
if the string
is found, the file is assumed to be a LaTeX file and
the target is built by invoking the &cv-link-LATEXCOM; command line;
otherwise, the &cv-link-TEXCOM; command line is used.
If the file is a LaTeX file,
builder method will also examine the contents
of the
file and invoke the &cv-link-BIBTEX; command line
if the string
is found,
start &cv-link-MAKEINDEX; to generate an index if a
file is found
and will examine the contents
file and re-run the &cv-link-LATEXCOM; command
if the log file says it is necessary.

The suffix <filename>.dvi</filename>
(hard-coded within TeX itself)
is automatically added to the target
if it is not already present.

# builds from aaa.tex
env.DVI(target = 'aaa.dvi', source = 'aaa.tex')
# builds bbb.dvi
env.DVI(target = 'bbb', source = 'bbb.ltx')
# builds from ccc.latex
env.DVI(target = 'ccc.dvi', source = 'ccc.latex')