SCons/Tool/pdf.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   4 SPDX-License-Identifier: MIT
   5 SPDX-FileType: DOCUMENTATION
   6
   7 This file is processed by the bin/SConsDoc.py module.
   8 -->
   9
  10 <!DOCTYPE sconsdoc [
  11 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  12 %scons;
  13 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  14 %builders-mod;
  15 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  16 %functions-mod;
  17 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  18 %tools-mod;
  19 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  20 %variables-mod;
  21 ]>
  22
  23 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  24           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  25           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  26
  27 <tool name="pdf">
  28 <summary>
  29 <para>
  30 Sets construction variables for the Portable Document Format builder.
  31 </para>
  32 </summary>
  33 <sets>
  34 <item>PDFPREFIX</item>
  35 <item>PDFSUFFIX</item>
  36 </sets>
  37 </tool>
  38
  39 <builder name="PDF">
  40 <summary>
  41 <para>
  42 Builds a <filename>.pdf</filename> file
  43 from a <filename>.dvi</filename> input file
  44 (or, by extension, a <filename>.tex</filename>,
  45 <filename>.ltx</filename>,
  46 or
  47 <filename>.latex</filename> input file).
  48 The suffix specified by the &cv-link-PDFSUFFIX; construction variable
  49 (<filename>.pdf</filename> by default)
  50 is added automatically to the target
  51 if it is not already present.
  52 &b-PDF; is a single-source builder.
  53 Example:
  54 </para>
  55
  56 <programlisting language="python">
  57 # builds from aaa.tex
  58 env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
  59 # builds bbb.pdf from bbb.dvi
  60 env.PDF(target = 'bbb', source = 'bbb.dvi')
  61 </programlisting>
  62 </summary>
  63 </builder>
  64
  65 <cvar name="PDFPREFIX">
  66 <summary>
  67 <para>
  68 The prefix used for PDF file names.
  69 </para>
  70 </summary>
  71 </cvar>
  72
  73 <cvar name="PDFSUFFIX">
  74 <summary>
  75 <para>
  76 The suffix used for PDF file names.
  77 </para>
  78 </summary>
  79 </cvar>
  80
  81 </sconsdoc>