summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/pdflatex.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/pdflatex.xml')
-rw-r--r--src/engine/SCons/Tool/pdflatex.xml47
1 files changed, 39 insertions, 8 deletions
diff --git a/src/engine/SCons/Tool/pdflatex.xml b/src/engine/SCons/Tool/pdflatex.xml
index 548d81f..a4b7825 100644
--- a/src/engine/SCons/Tool/pdflatex.xml
+++ b/src/engine/SCons/Tool/pdflatex.xml
@@ -1,49 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
+
+<!DOCTYPE sconsdoc [
+<!ENTITY % scons SYSTEM '../../../../doc/scons.mod'>
+%scons;
+<!ENTITY % builders-mod SYSTEM '../../../../doc/generated/builders.mod'>
+%builders-mod;
+<!ENTITY % functions-mod SYSTEM '../../../../doc/generated/functions.mod'>
+%functions-mod;
+<!ENTITY % tools-mod SYSTEM '../../../../doc/generated/tools.mod'>
+%tools-mod;
+<!ENTITY % variables-mod SYSTEM '../../../../doc/generated/variables.mod'>
+%variables-mod;
+]>
+
+<sconsdoc xmlns="http://www.scons.org/dbxsd/v1.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
+
<tool name="pdflatex">
<summary>
+<para>
Sets construction variables for the &pdflatex; utility.
+</para>
</summary>
<sets>
-PDFLATEX
-PDFLATEXFLAGS
-PDFLATEXCOM
-LATEXRETRIES
+<item>PDFLATEX</item>
+<item>PDFLATEXFLAGS</item>
+<item>PDFLATEXCOM</item>
+<item>LATEXRETRIES</item>
</sets>
<uses>
-PDFLATEXCOMSTR
+<item>PDFLATEXCOMSTR</item>
</uses>
</tool>
<cvar name="PDFLATEX">
<summary>
+<para>
The &pdflatex; utility.
+</para>
</summary>
</cvar>
<cvar name="PDFLATEXCOM">
<summary>
+<para>
The command line used to call the &pdflatex; utility.
+</para>
</summary>
</cvar>
<cvar name="PDFLATEXCOMSTR">
<summary>
+<para>
The string displayed when calling the &pdflatex; utility.
If this is not set, then &cv-link-PDFLATEXCOM; (the command line) is displayed.
+</para>
-<example>
+<example_commands>
env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES")
-</example>
+</example_commands>
</summary>
</cvar>
<cvar name="PDFLATEXFLAGS">
<summary>
+<para>
General options passed to the &pdflatex; utility.
+</para>
</summary>
</cvar>
+
+</sconsdoc> \ No newline at end of file