summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/dvi.xml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2005-12-16 12:16:00 (GMT)
committerSteven Knight <knight@baldmt.com>2005-12-16 12:16:00 (GMT)
commit1d015435c604590ce2047848fd534b9900423bb2 (patch)
treef4ae8889202019c9a5ed7315e33802e03c8705c7 /src/engine/SCons/Tool/dvi.xml
parent12c9ca505ccc4a4cf0a10100984913aa03b9f41f (diff)
downloadSCons-1d015435c604590ce2047848fd534b9900423bb2.zip
SCons-1d015435c604590ce2047848fd534b9900423bb2.tar.gz
SCons-1d015435c604590ce2047848fd534b9900423bb2.tar.bz2
Fix DVIPDF tests, refactor various TeX Tool modules.
Diffstat (limited to 'src/engine/SCons/Tool/dvi.xml')
-rw-r--r--src/engine/SCons/Tool/dvi.xml56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/dvi.xml b/src/engine/SCons/Tool/dvi.xml
new file mode 100644
index 0000000..9d3110e
--- /dev/null
+++ b/src/engine/SCons/Tool/dvi.xml
@@ -0,0 +1,56 @@
+<!--
+__COPYRIGHT__
+
+This file is processed by the bin/SConsDoc.py module.
+See its __doc__ string for a discussion of the format.
+-->
+<builder name="DVI">
+<summary>
+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>,
+&scons;
+will examine the contents of the file;
+if the string
+<literal>\documentclass</literal>
+or
+<literal>\documentstyle</literal>
+is found, the file is assumed to be a LaTeX file and
+the target is built by invoking the &cv-LATEXCOM; command line;
+otherwise, the &cv-TEXCOM; command line is used.
+If the file is a LaTeX file,
+the
+&b-DVI;
+builder method will also examine the contents
+of the
+<filename>.aux</filename>
+file and invoke the &cv-BIBTEX; command line
+if the string
+<literal>bibdata</literal>
+is found,
+start &cv-MAKEINDEX; to generate an index if a
+<filename>.ind</filename>
+file is found
+and will examine the contents
+<filename>.log</filename>
+file and re-run the &cv-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.
+Examples:
+
+<example>
+# 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')
+</example>
+</summary>
+</builder>
+