diff options
Diffstat (limited to 'src/engine/SCons/Tool/latex.xml')
-rw-r--r-- | src/engine/SCons/Tool/latex.xml | 49 |
1 files changed, 42 insertions, 7 deletions
diff --git a/src/engine/SCons/Tool/latex.xml b/src/engine/SCons/Tool/latex.xml index efa9ff6..f695533 100644 --- a/src/engine/SCons/Tool/latex.xml +++ b/src/engine/SCons/Tool/latex.xml @@ -1,55 +1,85 @@ +<?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="latex"> <summary> +<para> Sets construction variables for the &latex; utility. +</para> </summary> <sets> -LATEX -LATEXFLAGS -LATEXCOM +<item>LATEX</item> +<item>LATEXFLAGS</item> +<item>LATEXCOM</item> </sets> <uses> -LATEXCOMSTR +<item>LATEXCOMSTR</item> </uses> </tool> <cvar name="LATEX"> <summary> +<para> The LaTeX structured formatter and typesetter. +</para> </summary> </cvar> <cvar name="LATEXCOM"> <summary> +<para> The command line used to call the LaTeX structured formatter and typesetter. +</para> </summary> </cvar> <cvar name="LATEXCOMSTR"> <summary> +<para> The string displayed when calling the LaTeX structured formatter and typesetter. If this is not set, then &cv-link-LATEXCOM; (the command line) is displayed. +</para> -<example> +<example_commands> env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES") -</example> +</example_commands> </summary> </cvar> <cvar name="LATEXFLAGS"> <summary> +<para> General options passed to the LaTeX structured formatter and typesetter. +</para> </summary> </cvar> <cvar name="LATEXRETRIES"> <summary> +<para> The maximum number of times that LaTeX will be re-run if the <filename>.log</filename> @@ -57,15 +87,20 @@ generated by the &cv-link-LATEXCOM; command indicates that there are undefined references. The default is to try to resolve undefined references by re-running LaTeX up to three times. +</para> </summary> </cvar> <cvar name="TEXINPUTS"> <summary> +<para> List of directories that the LaTeX program will search for include directories. The LaTeX implicit dependency scanner will search these directories for \include and \import files. +</para> </summary> </cvar> + +</sconsdoc>
\ No newline at end of file |