src/engine/SCons/Tool/pdf.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 <builder name="PDF">
   8 <summary>
   9 Builds a <filename>.pdf</filename> file
  10 from a <filename>.dvi</filename> input file
  11 (or, by extension, a <filename>.tex</filename>,
  12 <filename>.ltx</filename>,
  13 or
  14 <filename>.latex</filename> input file).
  15 The suffix specified by the &cv-link-PDFSUFFIX; construction variable
  16 (<filename>.pdf</filename> by default)
  17 is added automatically to the target
  18 if it is not already present.  Example:
  19
  20 <example>
  21 # builds from aaa.tex
  22 env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
  23 # builds bbb.pdf from bbb.dvi
  24 env.PDF(target = 'bbb', source = 'bbb.dvi')
  25 </example>
  26 </summary>
  27 </builder>
  28
  29 <cvar name="PDFPREFIX">
  30 <summary>
  31 The prefix used for PDF file names.
  32 </summary>
  33 </cvar>
  34
  35 <cvar name="PDFSUFFIX">
  36 <summary>
  37 The suffix used for PDF file names.
  38 </summary>
  39 </cvar>