SCons/Tool/gs.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="gs">
  27 <summary>
  28 <para>
  29 This Tool sets the required construction variables for working with
  30 the Ghostscript software. It also registers an appropriate Action
  31 with the &b-link-PDF; Builder, such that the conversion from
  32 PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain.
  33 Finally, it adds an explicit &b-link-Gs; Builder for Ghostscript
  34 to the environment.
  35 </para>
  36 </summary>
  37 <sets>
  38 <item>GS</item>
  39 <item>GSFLAGS</item>
  40 <item>GSCOM</item>
  41 </sets>
  42 <uses>
  43 <item>GSCOMSTR</item>
  44 </uses>
  45 </tool>
  46
  47 <cvar name="GS">
  48 <summary>
  49 <para>
  50 The Ghostscript program used to, for example, convert PostScript to PDF files.
  51 </para>
  52 </summary>
  53 </cvar>
  54
  55 <cvar name="GSCOM">
  56 <summary>
  57 <para>
  58 The full Ghostscript command line used for the conversion process. Its default
  59 value is <quote><literal>$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES</literal></quote>.
  60 </para>
  61 </summary>
  62 </cvar>
  63
  64 <cvar name="GSCOMSTR">
  65 <summary>
  66 <para>
  67 The string displayed when
  68 Ghostscript is called for the conversion process.
  69 If this is not set (the default), then &cv-link-GSCOM; (the command line) is displayed.
  70 </para>
  71 </summary>
  72 </cvar>
  73
  74 <cvar name="GSFLAGS">
  75 <summary>
  76 <para>
  77 General options passed to the Ghostscript program,
  78 when converting PostScript to PDF files for example. Its default value
  79 is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote>
  80 </para>
  81 </summary>
  82 </cvar>
  83
  84 <builder name="Gs">
  85 <summary>
  86 <para>
  87 A Builder for explicitly calling the <application>gs</application> executable.
  88 Depending on the underlying OS, the different names <application>gs</application>,
  89 <application>gsos2</application> and <application>gswin32c</application>
  90 are tried.
  91 </para>
  92 <example_commands>
  93 env = Environment(tools=['gs'])
  94 env.Gs(
  95     'cover.jpg',
  96     'scons-scons.pdf',
  97     GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -q',
  98 )
  99 </example_commands>
 100 </summary>
 101 </builder>
 102
 103 </sconsdoc>