src/engine/SCons/Tool/dvi.xml

   1 <!--
   2 __COPYRIGHT__
   3
   4 This file is processed by the bin/SConsDoc.py module.
   5 See its __doc__ string for a discussion of the format.
   6 -->
   7 <tool name="dvi">
   8 <summary>
   9 Attaches the &b-DVI; builder to the
  10 construction environment.
  11 </summary>
  12 <sets>
  13 </sets>
  14 <uses>
  15 </uses>
  16 </tool>
  17
  18 <builder name="DVI">
  19 <summary>
  20 Builds a <filename>.dvi</filename> file
  21 from a <filename>.tex</filename>,
  22 <filename>.ltx</filename> or <filename>.latex</filename> input file.
  23 If the source file suffix is <filename>.tex</filename>,
  24 &scons;
  25 will examine the contents of the file;
  26 if the string
  27 <literal>\documentclass</literal>
  28 or
  29 <literal>\documentstyle</literal>
  30 is found, the file is assumed to be a LaTeX file and
  31 the target is built by invoking the &cv-link-LATEXCOM; command line;
  32 otherwise, the &cv-link-TEXCOM; command line is used.
  33 If the file is a LaTeX file,
  34 the
  35 &b-DVI;
  36 builder method will also examine the contents
  37 of the
  38 <filename>.aux</filename>
  39 file and invoke the &cv-link-BIBTEX; command line
  40 if the string
  41 <literal>bibdata</literal>
  42 is found,
  43 start &cv-link-MAKEINDEX; to generate an index if a
  44 <filename>.ind</filename>
  45 file is found
  46 and will examine the contents
  47 <filename>.log</filename>
  48 file and re-run the &cv-link-LATEXCOM; command
  49 if the log file says it is necessary.
  50
  51 The suffix <filename>.dvi</filename>
  52 (hard-coded within TeX itself)
  53 is automatically added to the target
  54 if it is not already present.
  55 Examples:
  56
  57 <example>
  58 # builds from aaa.tex
  59 env.DVI(target = 'aaa.dvi', source = 'aaa.tex')
  60 # builds bbb.dvi
  61 env.DVI(target = 'bbb', source = 'bbb.ltx')
  62 # builds from ccc.latex
  63 env.DVI(target = 'ccc.dvi', source = 'ccc.latex')
  64 </example>
  65 </summary>
  66 </builder>
  67