SCons / src / engine / SCons / Tool / pdf.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="pdf">
Sets construction variables for the Portable Document Format builder.

<builder name="PDF">
Builds a <filename>.pdf</filename> file
from a <filename>.dvi</filename> input file
(or, by extension, a <filename>.tex</filename>,
<filename>.latex</filename> input file).
The suffix specified by the &cv-link-PDFSUFFIX; construction variable
(<filename>.pdf</filename> by default)
is added automatically to the target
if it is not already present.  Example:

# builds from aaa.tex
env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
# builds bbb.pdf from bbb.dvi
env.PDF(target = 'bbb', source = 'bbb.dvi')

<cvar name="PDFPREFIX">
The prefix used for PDF file names.

<cvar name="PDFSUFFIX">
The suffix used for PDF file names.