summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/pdf.xml
blob: e6fa4d7113cd40de85170ab8d7001107690e3d2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<!--
Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="pdf">
<summary>
Sets construction variables for the Portable Document Format builder.
</summary>
<sets>
PDFPREFIX
PDFSUFFIX
</sets>
</tool>

<builder name="PDF">
<summary>
Builds a <filename>.pdf</filename> file
from a <filename>.dvi</filename> input file
(or, by extension, a <filename>.tex</filename>,
<filename>.ltx</filename>,
or
<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:

<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')
</example>
</summary>
</builder>

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

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