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