SCons/Tool/dvips.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="dvips">
  28 <summary>
  29 <para>
  30 Sets construction variables for the dvips utility.
  31 </para>
  32 </summary>
  33 <sets>
  34 <item>DVIPS</item>
  35 <item>DVIPSFLAGS</item>
  36 <item>PSCOM</item>
  37 <item>PSPREFIX</item>
  38 <item>PSSUFFIX</item>
  39 </sets>
  40 <uses>
  41 <item>PSCOMSTR</item>
  42 </uses>
  43 </tool>
  44
  45 <builder name="PostScript">
  46 <summary>
  47 <para>
  48 Builds a <filename>.ps</filename> file
  49 from a <filename>.dvi</filename> input file
  50 (or, by extension, a <filename>.tex</filename>,
  51 <filename>.ltx</filename>,
  52 or
  53 <filename>.latex</filename> input file).
  54 The suffix specified by the &cv-link-PSSUFFIX; construction variable
  55 (<filename>.ps</filename> by default)
  56 is added automatically to the target
  57 if it is not already present.
  58 &b-PostScript; is a single-source builder.
  59 Example:
  60 </para>
  61
  62 <programlisting language="python">
  63 # builds from aaa.tex
  64 env.PostScript(target = 'aaa.ps', source = 'aaa.tex')
  65 # builds bbb.ps from bbb.dvi
  66 env.PostScript(target = 'bbb', source = 'bbb.dvi')
  67 </programlisting>
  68 </summary>
  69 </builder>
  70
  71 <cvar name="DVIPS">
  72 <summary>
  73 <para>
  74 The TeX DVI file to PostScript converter.
  75 </para>
  76 </summary>
  77 </cvar>
  78
  79 <cvar name="DVIPSFLAGS">
  80 <summary>
  81 <para>
  82 General options passed to the TeX DVI file to PostScript converter.
  83 </para>
  84 </summary>
  85 </cvar>
  86
  87 <cvar name="PSCOM">
  88 <summary>
  89 <para>
  90 The command line used to convert TeX DVI files into a PostScript file.
  91 </para>
  92 </summary>
  93 </cvar>
  94
  95 <cvar name="PSCOMSTR">
  96 <summary>
  97 <para>
  98 The string displayed when a TeX DVI file
  99 is converted into a PostScript file.
 100 If this is not set, then &cv-link-PSCOM; (the command line) is displayed.
 101 </para>
 102 </summary>
 103 </cvar>
 104
 105 <cvar name="PSPREFIX">
 106 <summary>
 107 <para>
 108 The prefix used for PostScript file names.
 109 </para>
 110 </summary>
 111 </cvar>
 112
 113 <cvar name="PSSUFFIX">
 114 <summary>
 115 <para>
 116 The prefix used for PostScript file names.
 117 </para>
 118 </summary>
 119 </cvar>
 120
 121 </sconsdoc>