SCons/Tool/dvips.xml

   1 <?xml version="1.0"?>
   2 <!--
   3 __COPYRIGHT__
   4
   5 This file is processed by the bin/SConsDoc.py module.
   6 See its __doc__ string for a discussion of the format.
   7 -->
   8
   9 <!DOCTYPE sconsdoc [
  10 <!ENTITY % scons SYSTEM '../../doc/scons.mod'>
  11 %scons;
  12 <!ENTITY % builders-mod SYSTEM '../../doc/generated/builders.mod'>
  13 %builders-mod;
  14 <!ENTITY % functions-mod SYSTEM '../../doc/generated/functions.mod'>
  15 %functions-mod;
  16 <!ENTITY % tools-mod SYSTEM '../../doc/generated/tools.mod'>
  17 %tools-mod;
  18 <!ENTITY % variables-mod SYSTEM '../../doc/generated/variables.mod'>
  19 %variables-mod;
  20 ]>
  21
  22 <sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
  23           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  24           xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  25
  26 <tool name="dvips">
  27 <summary>
  28 <para>
  29 Sets construction variables for the dvips utility.
  30 </para>
  31 </summary>
  32 <sets>
  33 <item>DVIPS</item>
  34 <item>DVIPSFLAGS</item>
  35 <item>PSCOM</item>
  36 <item>PSPREFIX</item>
  37 <item>PSSUFFIX</item>
  38 </sets>
  39 <uses>
  40 <item>PSCOMSTR</item>
  41 </uses>
  42 </tool>
  43
  44 <builder name="PostScript">
  45 <summary>
  46 <para>
  47 Builds a <filename>.ps</filename> file
  48 from a <filename>.dvi</filename> input file
  49 (or, by extension, a <filename>.tex</filename>,
  50 <filename>.ltx</filename>,
  51 or
  52 <filename>.latex</filename> input file).
  53 The suffix specified by the &cv-link-PSSUFFIX; construction variable
  54 (<filename>.ps</filename> by default)
  55 is added automatically to the target
  56 if it is not already present.  Example:
  57 </para>
  58
  59 <example_commands>
  60 # builds from aaa.tex
  61 env.PostScript(target = 'aaa.ps', source = 'aaa.tex')
  62 # builds bbb.ps from bbb.dvi
  63 env.PostScript(target = 'bbb', source = 'bbb.dvi')
  64 </example_commands>
  65 </summary>
  66 </builder>
  67
  68 <cvar name="DVIPS">
  69 <summary>
  70 <para>
  71 The TeX DVI file to PostScript converter.
  72 </para>
  73 </summary>
  74 </cvar>
  75
  76 <cvar name="DVIPSFLAGS">
  77 <summary>
  78 <para>
  79 General options passed to the TeX DVI file to PostScript converter.
  80 </para>
  81 </summary>
  82 </cvar>
  83
  84 <cvar name="PSCOM">
  85 <summary>
  86 <para>
  87 The command line used to convert TeX DVI files into a PostScript file.
  88 </para>
  89 </summary>
  90 </cvar>
  91
  92 <cvar name="PSCOMSTR">
  93 <summary>
  94 <para>
  95 The string displayed when a TeX DVI file
  96 is converted into a PostScript file.
  97 If this is not set, then &cv-link-PSCOM; (the command line) is displayed.
  98 </para>
  99 </summary>
 100 </cvar>
 101
 102 <cvar name="PSPREFIX">
 103 <summary>
 104 <para>
 105 The prefix used for PostScript file names.
 106 </para>
 107 </summary>
 108 </cvar>
 109
 110 <cvar name="PSSUFFIX">
 111 <summary>
 112 <para>
 113 The prefix used for PostScript file names.
 114 </para>
 115 </summary>
 116 </cvar>
 117
 118 </sconsdoc>