diff options
Diffstat (limited to 'doc/generated')
228 files changed, 5710 insertions, 5884 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 59d2dca..20e5215 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,26 +11,21 @@ %variables-mod; ]> -<variablelist 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 http://www.scons.org/dbxsd/v1.0/scons.xsd"> +<variablelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <varlistentry id="b-CFile"> - <term> - <function>CFile()</function> - </term> - <term> - <function>env.CFile()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>CFile</function>()</term> + <term><parameter>env</parameter>.<methodname>CFile</methodname>()</term> + <listitem><para> Builds a C source file given a lex (<filename>.l</filename>) or yacc (<filename>.y</filename>) input file. -The suffix specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link> construction variable +The suffix specified by the <link linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link> construction variable (<filename>.c</filename> by default) is automatically added to the target if it is not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds foo.c env.CFile(target = 'foo.c', source = 'foo.l') # builds bar.c @@ -40,15 +34,10 @@ env.CFile(target = 'bar', source = 'bar.y') </listitem> </varlistentry> <varlistentry id="b-Command"> - <term> - <function>Command()</function> - </term> - <term> - <function>env.Command()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> "Builder" is actually + <term><function>Command</function>()</term> + <term><parameter>env</parameter>.<methodname>Command</methodname>()</term> + <listitem><para> +The <function>Command</function> "Builder" is actually a function that looks like a Builder, but takes a required third argument, which is the action to take to construct the target @@ -56,31 +45,26 @@ from the source, used for "one-off" builds where a full builder is not needed. Thus it does not follow the builder calling rules described at the start of this section. -See instead the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Command"><function>Command</function></link> function description +See instead the <link linkend="f-Command"><function>Command</function></link> function description for the calling syntax and details. </para> </listitem> </varlistentry> <varlistentry id="b-CXXFile"> - <term> - <function>CXXFile()</function> - </term> - <term> - <function>env.CXXFile()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>CXXFile</function>()</term> + <term><parameter>env</parameter>.<methodname>CXXFile</methodname>()</term> + <listitem><para> Builds a C++ source file given a lex (<filename>.ll</filename>) or yacc (<filename>.yy</filename>) input file. -The suffix specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link> construction variable +The suffix specified by the <link linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link> construction variable (<filename>.cc</filename> by default) is automatically added to the target if it is not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds foo.cc env.CXXFile(target = 'foo.cc', source = 'foo.ll') # builds bar.cc @@ -89,151 +73,126 @@ env.CXXFile(target = 'bar', source = 'bar.yy') </listitem> </varlistentry> <varlistentry id="b-DocbookEpub"> - <term> - <function>DocbookEpub()</function> - </term> - <term> - <function>env.DocbookEpub()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookEpub</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookEpub</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for EPUB output. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookEpub('manual.epub', 'manual.xml') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> or simply </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookEpub('manual') </example_commands> </listitem> </varlistentry> <varlistentry id="b-DocbookHtml"> - <term> - <function>DocbookHtml()</function> - </term> - <term> - <function>env.DocbookHtml()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookHtml</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookHtml</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for HTML output. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookHtml('manual.html', 'manual.xml') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> or simply </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookHtml('manual') </example_commands> </listitem> </varlistentry> <varlistentry id="b-DocbookHtmlChunked"> - <term> - <function>DocbookHtmlChunked()</function> - </term> - <term> - <function>env.DocbookHtmlChunked()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookHtmlChunked</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookHtmlChunked</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for chunked HTML output. It supports the <literal>base.dir</literal> parameter. The <filename>chunkfast.xsl</filename> file (requires "EXSLT") is used as the default stylesheet. Basic syntax: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookHtmlChunked('manual') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> where <filename>manual.xml</filename> is the input file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>root.filename</literal> +<para>If you use the <literal>root.filename</literal> parameter in your own stylesheets you have to specify the new target name. This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtmlChunked('mymanual.html', 'manual', xsl='htmlchunk.xsl') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> is provided. You +<para>Some basic support for the <literal>base.dir</literal> is provided. You can add the <literal>base_dir</literal> keyword to your Builder call, and the given prefix gets prepended to all the created filenames: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtmlChunked('manual', xsl='htmlchunk.xsl', base_dir='output/') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +<para>Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! </para> </listitem> </varlistentry> <varlistentry id="b-DocbookHtmlhelp"> - <term> - <function>DocbookHtmlhelp()</function> - </term> - <term> - <function>env.DocbookHtmlhelp()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookHtmlhelp</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookHtmlhelp</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for HTMLHELP output. Its basic syntax is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> where <filename>manual.xml</filename> is the input file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>root.filename</literal> +<para>If you use the <literal>root.filename</literal> parameter in your own stylesheets you have to specify the new target name. This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtmlhelp('mymanual.html', 'manual', xsl='htmlhelp.xsl') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> parameter +<para>Some basic support for the <literal>base.dir</literal> parameter is provided. You can add the <literal>base_dir</literal> keyword to your Builder call, and the given prefix gets prepended to all the created filenames: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual', xsl='htmlhelp.xsl', base_dir='output/') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +<para>Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! </para> </listitem> </varlistentry> <varlistentry id="b-DocbookMan"> - <term> - <function>DocbookMan()</function> - </term> - <term> - <function>env.DocbookMan()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookMan</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookMan</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for Man page output. Its basic syntax is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookMan('manual') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> where <filename>manual.xml</filename> is the input file. Note, that you can specify a target name, but the actual output names are automatically set from the <literal>refname</literal> entries in your XML source. @@ -241,175 +200,145 @@ set from the <literal>refname</literal> entries in your XML source. </listitem> </varlistentry> <varlistentry id="b-DocbookPdf"> - <term> - <function>DocbookPdf()</function> - </term> - <term> - <function>env.DocbookPdf()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookPdf</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookPdf</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for PDF output. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookPdf('manual.pdf', 'manual.xml') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> or simply </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookPdf('manual') </example_commands> </listitem> </varlistentry> <varlistentry id="b-DocbookSlidesHtml"> - <term> - <function>DocbookSlidesHtml()</function> - </term> - <term> - <function>env.DocbookSlidesHtml()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookSlidesHtml</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookSlidesHtml</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for HTML slides output. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookSlidesHtml('manual') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0">If you use the <literal>titlefoil.html</literal> parameter in +<para>If you use the <literal>titlefoil.html</literal> parameter in your own stylesheets you have to give the new target name. This ensures that the dependencies get correct, especially for the cleanup via <quote><literal>scons -c</literal></quote>: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookSlidesHtml('mymanual.html','manual', xsl='slideshtml.xsl') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Some basic support for the <literal>base.dir</literal> parameter +<para>Some basic support for the <literal>base.dir</literal> parameter is provided. You can add the <literal>base_dir</literal> keyword to your Builder call, and the given prefix gets prepended to all the created filenames: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookSlidesHtml('manual', xsl='slideshtml.xsl', base_dir='output/') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Make sure that you don't forget the trailing slash for the base folder, else +<para>Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! </para> </listitem> </varlistentry> <varlistentry id="b-DocbookSlidesPdf"> - <term> - <function>DocbookSlidesPdf()</function> - </term> - <term> - <function>env.DocbookSlidesPdf()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookSlidesPdf</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookSlidesPdf</methodname>()</term> + <listitem><para> A pseudo-Builder, providing a Docbook toolchain for PDF slides output. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookSlidesPdf('manual.pdf', 'manual.xml') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> or simply </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookSlidesPdf('manual') </example_commands> </listitem> </varlistentry> <varlistentry id="b-DocbookXInclude"> - <term> - <function>DocbookXInclude()</function> - </term> - <term> - <function>env.DocbookXInclude()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookXInclude</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookXInclude</methodname>()</term> + <listitem><para> A pseudo-Builder, for resolving XIncludes in a separate processing step. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookXInclude('manual_xincluded.xml', 'manual.xml') </example_commands> </listitem> </varlistentry> <varlistentry id="b-DocbookXslt"> - <term> - <function>DocbookXslt()</function> - </term> - <term> - <function>env.DocbookXslt()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DocbookXslt</function>()</term> + <term><parameter>env</parameter>.<methodname>DocbookXslt</methodname>()</term> + <listitem><para> A pseudo-Builder, applying a given XSL transformation to the input file. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<example_commands>env = Environment(tools=['docbook']) env.DocbookXslt('manual_transformed.xml', 'manual.xml', xsl='transform.xslt') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Note, that this builder requires the <literal>xsl</literal> parameter +<para>Note, that this builder requires the <literal>xsl</literal> parameter to be set. </para> </listitem> </varlistentry> <varlistentry id="b-DVI"> - <term> - <function>DVI()</function> - </term> - <term> - <function>env.DVI()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>DVI</function>()</term> + <term><parameter>env</parameter>.<methodname>DVI</methodname>()</term> + <listitem><para> Builds a <filename>.dvi</filename> file from a <filename>.tex</filename>, <filename>.ltx</filename> or <filename>.latex</filename> input file. If the source file suffix is <filename>.tex</filename>, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will examine the contents of the file; if the string <literal>\documentclass</literal> or <literal>\documentstyle</literal> is found, the file is assumed to be a LaTeX file and -the target is built by invoking the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command line; -otherwise, the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TEXCOM"><envar>$TEXCOM</envar></link> command line is used. +the target is built by invoking the <link linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command line; +otherwise, the <link linkend="cv-TEXCOM"><envar>$TEXCOM</envar></link> command line is used. If the file is a LaTeX file, the -<function xmlns="http://www.scons.org/dbxsd/v1.0">DVI</function> +<function>DVI</function> builder method will also examine the contents of the <filename>.aux</filename> -file and invoke the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-BIBTEX"><envar>$BIBTEX</envar></link> command line +file and invoke the <link linkend="cv-BIBTEX"><envar>$BIBTEX</envar></link> command line if the string <literal>bibdata</literal> is found, -start <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MAKEINDEX"><envar>$MAKEINDEX</envar></link> to generate an index if a +start <link linkend="cv-MAKEINDEX"><envar>$MAKEINDEX</envar></link> to generate an index if a <filename>.ind</filename> file is found and will examine the contents <filename>.log</filename> -file and re-run the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command +file and re-run the <link linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command if the log file says it is necessary. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The suffix <filename>.dvi</filename> (hard-coded within TeX itself) is automatically added to the target @@ -417,7 +346,7 @@ if it is not already present. Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds from aaa.tex env.DVI(target = 'aaa.dvi', source = 'aaa.tex') # builds bbb.dvi @@ -428,20 +357,15 @@ env.DVI(target = 'ccc.dvi', source = 'ccc.latex') </listitem> </varlistentry> <varlistentry id="b-Gs"> - <term> - <function>Gs()</function> - </term> - <term> - <function>env.Gs()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Gs</function>()</term> + <term><parameter>env</parameter>.<methodname>Gs</methodname>()</term> + <listitem><para> A Builder for explicitly calling the <literal>gs</literal> executable. Depending on the underlying OS, the different names <literal>gs</literal>, <literal>gsos2</literal> and <literal>gswin32c</literal> are tried. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['gs']) +<example_commands>env = Environment(tools=['gs']) env.Gs('cover.jpg','scons-scons.pdf', GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -q') ) @@ -449,14 +373,9 @@ env.Gs('cover.jpg','scons-scons.pdf', </listitem> </varlistentry> <varlistentry id="b-Install"> - <term> - <function>Install()</function> - </term> - <term> - <function>env.Install()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Install</function>()</term> + <term><parameter>env</parameter>.<methodname>Install</methodname>()</term> + <listitem><para> Installs one or more source files or directories in the specified target, which must be a directory. @@ -466,11 +385,25 @@ sources may be given as a string or as a node returned by a builder. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.Install('/usr/local/bin', source = ['foo', 'bar']) +<example_commands> +env.Install(target='/usr/local/bin', source=['foo', 'bar']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +Note that if target paths chosen for the +<function>Install</function> builder (and the related <function>InstallAs</function> and +<function>InstallVersionedLib</function> builders) are outside the +project tree, such as in the example above, +they may not be selected for "building" by default, +since in the absence of other instructions +<command>scons</command> builds targets that are underneath the top directory +(the directory that contains the <filename>SConstruct</filename> file, +usually the current directory). +Use command line targets or the <function>Default</function> function +in this case. +</para> + +<para> If the <option>--install-sandbox</option> command line option is given, the target directory will be prefixed by the directory path specified. @@ -478,8 +411,8 @@ This is useful to test installs without installing to a "live" location in the system. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -See also <function xmlns="http://www.scons.org/dbxsd/v1.0">FindInstalledFiles</function>. +<para> +See also <function>FindInstalledFiles</function>. For more thoughts on installation, see the User Guide (particularly the section on Command-Line Targets and the chapters on Installing Files and on Alias Targets). @@ -488,14 +421,9 @@ and the chapters on Installing Files and on Alias Targets). </listitem> </varlistentry> <varlistentry id="b-InstallAs"> - <term> - <function>InstallAs()</function> - </term> - <term> - <function>env.InstallAs()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>InstallAs</function>()</term> + <term><parameter>env</parameter>.<methodname>InstallAs</methodname>()</term> + <listitem><para> Installs one or more source files or directories to specific names, allowing changing a file or directory name @@ -507,76 +435,75 @@ source arguments list different numbers of files or directories. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.InstallAs(target = '/usr/local/bin/foo', - source = 'foo_debug') -env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], - source = ['libFOO.a', 'libBAR.a']) +<example_commands> +env.InstallAs(target='/usr/local/bin/foo', + source='foo_debug') +env.InstallAs(target=['../lib/libfoo.a', '../lib/libbar.a'], + source=['libFOO.a', 'libBAR.a']) </example_commands> +<para> +See the note under <function>Install</function>. +</para> + </listitem> </varlistentry> <varlistentry id="b-InstallVersionedLib"> - <term> - <function>InstallVersionedLib()</function> - </term> - <term> - <function>env.InstallVersionedLib()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>InstallVersionedLib</function>()</term> + <term><parameter>env</parameter>.<methodname>InstallVersionedLib</methodname>()</term> + <listitem><para> Installs a versioned shared library. The symlinks appropriate to the architecture will be generated based on symlinks of the source library. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.InstallVersionedLib(target = '/usr/local/bin/foo', - source = 'libxyz.1.5.2.so') +<example_commands> +env.InstallVersionedLib(target='/usr/local/bin/foo', + source='libxyz.1.5.2.so') </example_commands> + +<para> +See the note under <function>Install</function>. +</para> + </listitem> </varlistentry> <varlistentry id="b-Jar"> - <term> - <function>Jar()</function> - </term> - <term> - <function>env.Jar()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Jar</function>()</term> + <term><parameter>env</parameter>.<methodname>Jar</methodname>()</term> + <listitem><para> Builds a Java archive (<filename>.jar</filename>) file from the specified list of sources. Any directories in the source list will be searched for <filename>.class</filename> files). Any <filename>.java</filename> files in the source list will be compiled to <filename>.class</filename> files -by calling the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Java"><function>Java</function></link> Builder. +by calling the <link linkend="b-Java"><function>Java</function></link> Builder. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JARCHDIR"><envar>$JARCHDIR</envar></link> value is set, the -<application xmlns="http://www.scons.org/dbxsd/v1.0">jar</application> +<para> +If the <link linkend="cv-JARCHDIR"><envar>$JARCHDIR</envar></link> value is set, the +<application>jar</application> command will change to the specified directory using the <option>-C</option> option. -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JARCHDIR</envar> is not set explicitly, -<application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> will use the top of any subdirectory tree +If <envar>$JARCHDIR</envar> is not set explicitly, +<application>SCons</application> will use the top of any subdirectory tree in which Java <filename>.class</filename> -were built by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Java"><function>Java</function></link> Builder. +were built by the <link linkend="b-Java"><function>Java</function></link> Builder. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the contents any of the source files begin with the string <literal>Manifest-Version</literal>, the file is assumed to be a manifest and is passed to the -<application xmlns="http://www.scons.org/dbxsd/v1.0">jar</application> +<application>jar</application> command with the <option>m</option> option set. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Jar(target = 'foo.jar', source = 'classes') env.Jar(target = 'bar.jar', @@ -585,14 +512,9 @@ env.Jar(target = 'bar.jar', </listitem> </varlistentry> <varlistentry id="b-Java"> - <term> - <function>Java()</function> - </term> - <term> - <function>env.Java()</function> - </term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Java</function>()</term> + <term><parameter>env</parameter>.<methodname>Java</methodname>()</term> + <listitem><para> Builds one or more Java class files. The sources may be any combination of explicit <filename>.java</filename> @@ -601,7 +523,7 @@ env.Jar(target = 'bar.jar', for <filename>.java</filename> files. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> SCons will parse each source <filename>.java</filename> file to find the classes (including inner classes) @@ -612,7 +534,7 @@ env.Jar(target = 'bar.jar', the specified target directory. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> SCons will also search each Java file for the Java package name, which it assumes can be found on a line @@ -635,17 +557,17 @@ env.Jar(target = 'bar.jar', class file. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Examples: </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.Java(target = 'classes', source = 'src') - env.Java(target = 'classes', source = ['src1', 'src2']) - env.Java(target = 'classes', source = ['File1.java', 'File2.java']) + <example_commands> +env.Java(target = 'classes', source = 'src') +env.Java(target = 'classes', source = ['src1', 'src2']) +env.Java(target = 'classes', source = ['File1.java', 'File2.java']) </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Java source files can use the native encoding for the underlying OS. Since SCons compiles in simple ASCII mode by default, the compiler will generate warnings about unmappable characters, @@ -658,21 +580,16 @@ env.Jar(target = 'bar.jar', with a different encoding. </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env = Environment() - env['ENV']['LANG'] = 'en_GB.UTF-8' + <example_commands> +env = Environment() +env['ENV']['LANG'] = 'en_GB.UTF-8' </example_commands> </listitem> </varlistentry> <varlistentry id="b-JavaH"> - <term> - <function>JavaH()</function> - </term> - <term> - <function>env.JavaH()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>JavaH</function>()</term> + <term><parameter>env</parameter>.<methodname>JavaH</methodname>()</term> + <listitem><para> Builds C header and source files for implementing Java native methods. The target can be either a directory @@ -682,87 +599,73 @@ will contain all of the definitions. The source can be the names of <filename>.class</filename> files, the names of <filename>.java</filename> files to be compiled into <filename>.class</filename> files -by calling the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Java"><function>Java</function></link> builder method, +by calling the <link linkend="b-Java"><function>Java</function></link> builder method, or the objects returned from the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Java</function> +<function>Java</function> builder method. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the construction variable -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVACLASSDIR"><envar>$JAVACLASSDIR</envar></link> +<link linkend="cv-JAVACLASSDIR"><envar>$JAVACLASSDIR</envar></link> is set, either in the environment or in the call to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">JavaH</function> +<function>JavaH</function> builder method itself, then the value of the variable will be stripped from the beginning of any <filename>.class</filename> file names. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds java_native.h -classes = env.Java(target = 'classdir', source = 'src') -env.JavaH(target = 'java_native.h', source = classes) +classes = env.Java(target="classdir", source="src") +env.JavaH(target="java_native.h", source=classes) # builds include/package_foo.h and include/package_bar.h -env.JavaH(target = 'include', - source = ['package/foo.class', 'package/bar.class']) +env.JavaH(target="include", source=["package/foo.class", "package/bar.class"]) # builds export/foo.h and export/bar.h -env.JavaH(target = 'export', - source = ['classes/foo.class', 'classes/bar.class'], - JAVACLASSDIR = 'classes') +env.JavaH( + target="export", + source=["classes/foo.class", "classes/bar.class"], + JAVACLASSDIR="classes", +) </example_commands> </listitem> </varlistentry> <varlistentry id="b-Library"> - <term> - <function>Library()</function> - </term> - <term> - <function>env.Library()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Library</function>()</term> + <term><parameter>env</parameter>.<methodname>Library</methodname>()</term> + <listitem><para> A synonym for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticLibrary</function> +<function>StaticLibrary</function> builder method. </para> </listitem> </varlistentry> <varlistentry id="b-LoadableModule"> - <term> - <function>LoadableModule()</function> - </term> - <term> - <function>env.LoadableModule()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>LoadableModule</function>()</term> + <term><parameter>env</parameter>.<methodname>LoadableModule</methodname>()</term> + <listitem><para> On most systems, this is the same as -<function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function>. +<function>SharedLibrary</function>. On Mac OS X (Darwin) platforms, this creates a loadable module bundle. </para> </listitem> </varlistentry> <varlistentry id="b-M4"> - <term> - <function>M4()</function> - </term> - <term> - <function>env.M4()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>M4</function>()</term> + <term><parameter>env</parameter>.<methodname>M4</methodname>()</term> + <listitem><para> Builds an output file from an M4 input file. -This uses a default <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-M4FLAGS"><envar>$M4FLAGS</envar></link> value of +This uses a default <link linkend="cv-M4FLAGS"><envar>$M4FLAGS</envar></link> value of <option>-E</option>, which considers all warnings to be fatal and stops on the first warning @@ -770,81 +673,71 @@ when using the GNU version of m4. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.M4(target = 'foo.c', source = 'foo.c.m4') </example_commands> </listitem> </varlistentry> <varlistentry id="b-Moc"> - <term> - <function>Moc()</function> - </term> - <term> - <function>env.Moc()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Moc</function>()</term> + <term><parameter>env</parameter>.<methodname>Moc</methodname>()</term> + <listitem><para> Builds an output file from a moc input file. Moc input files are either header files or cxx files. This builder is only available after using the -tool 'qt'. See the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QTDIR"><envar>$QTDIR</envar></link> variable for more information. +tool 'qt'. See the <link linkend="cv-QTDIR"><envar>$QTDIR</envar></link> variable for more information. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Moc('foo.h') # generates moc_foo.cc env.Moc('foo.cpp') # generates foo.moc </example_commands> </listitem> </varlistentry> <varlistentry id="b-MOFiles"> - <term> - <function>MOFiles()</function> - </term> - <term> - <function>env.MOFiles()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This builder belongs to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool. The builder compiles + <term><function>MOFiles</function>()</term> + <term><parameter>env</parameter>.<methodname>MOFiles</methodname>()</term> + <listitem><para> +This builder belongs to <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool. The builder compiles <literal>PO</literal> files to <literal>MO</literal> files. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 1</emphasis>. Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling <filename>pl.po</filename> and <filename>en.po</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.MOFiles(['pl', 'en']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 2</emphasis>. Compile files for languages defined in <filename>LINGUAS</filename> file: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.MOFiles(LINGUAS_FILE = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 3</emphasis>. Create <filename>pl.mo</filename> and <filename>en.mo</filename> by compiling <filename>pl.po</filename> and <filename>en.po</filename> plus files for languages defined in <filename>LINGUAS</filename> file: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 4</emphasis>. Compile files for languages defined in <filename>LINGUAS</filename> file (another version): </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env['LINGUAS_FILE'] = 1 env.MOFiles() @@ -852,60 +745,55 @@ Compile files for languages defined in <filename>LINGUAS</filename> file </listitem> </varlistentry> <varlistentry id="b-MSVSProject"> - <term> - <function>MSVSProject()</function> - </term> - <term> - <function>env.MSVSProject()</function> - </term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>MSVSProject</function>()</term> + <term><parameter>env</parameter>.<methodname>MSVSProject</methodname>()</term> + <listitem><para> Builds a Microsoft Visual Studio project file, and by default builds a solution file as well. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> This builds a Visual Studio project file, based on the version of Visual Studio that is configured (either the latest installed version, or the version specified by - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link> in the Environment constructor). For + <link linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link> in the Environment constructor). For Visual Studio 6, it will generate a <filename>.dsp</filename> file. For Visual Studio 7, 8, and 9, it will generate a <filename>.vcproj</filename> file. For Visual Studio 10 and later, it will generate a <filename>.vcxproj</filename> file. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> By default, this also generates a solution file for the specified project, a <filename>.dsw</filename> file for Visual Studio 6 or a <filename>.sln</filename> file for Visual Studio 7 and later. This behavior may be disabled by specifying <literal>auto_build_solution=0</literal> when you - call <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSProject</function>, in which case you presumably want to - build the solution file(s) by calling the <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSSolution</function> + call <function>MSVSProject</function>, in which case you presumably want to + build the solution file(s) by calling the <function>MSVSSolution</function> Builder (see below). </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSProject</function> builder takes several lists of filenames + <para> + The <function>MSVSProject</function> builder takes several lists of filenames to be placed into the project file. These are currently limited to <literal>srcs</literal>, <literal>incs</literal>, <literal>localincs</literal>, <literal>resources</literal>, and <literal>misc</literal>. These are pretty self-explanatory, but it should be noted that these lists are added to the - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SOURCES"><envar>$SOURCES</envar></link> construction variable as strings, NOT as + <link linkend="cv-SOURCES"><envar>$SOURCES</envar></link> construction variable as strings, NOT as SCons File Nodes. This is because they represent file names to be added to the project file, not the source files used to build the project file. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> The above filename lists are all optional, although at least one must be specified for the resulting project file to be non-empty. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> In addition to the above lists of values, the following values may be specified: </para> - <variablelist xmlns="http://www.scons.org/dbxsd/v1.0"> + <variablelist> <varlistentry> <term>target</term> <listitem> @@ -913,7 +801,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file The name of the target <filename>.dsp</filename> or <filename>.vcproj</filename> file. The correct suffix for the version of Visual Studio - must be used, but the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVSPROJECTSUFFIX"><envar>$MSVSPROJECTSUFFIX</envar></link> + must be used, but the <link linkend="cv-MSVSPROJECTSUFFIX"><envar>$MSVSPROJECTSUFFIX</envar></link> construction variable will be defined to the correct value (see example below). </para> @@ -931,7 +819,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file separated from the variant name by a <literal>|</literal> (vertical pipe) character: <literal>Debug|Xbox</literal>. The default target platform is Win32. Multiple calls - to <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSProject</function> with different variants are allowed; + to <function>MSVSProject</function> with different variants are allowed; all variants will be added to the project file with their appropriate build targets and sources. </para> @@ -966,6 +854,25 @@ Compile files for languages defined in <filename>LINGUAS</filename> file </listitem> </varlistentry> <varlistentry> + <term>cppflags</term> + <listitem> + <para> + Compiler flags for the different variants. + If a /std:c++ flag is found then /Zc:__cplusplus is + appended to the flags if not already found, this + ensures that intellisense uses the /std:c++ switch. + The number of <literal>cppflags</literal> entries + must match the number of <literal>variant</literal> + entries, or be empty (not specified). If you give + only one, it will automatically be propagated to all + variants. If you don't give this parameter, SCons + will combine the invoking environment's + <literal>CCFLAGS</literal>, <literal>CXXFLAGS</literal>, + <literal>CPPFLAGS</literal> entries for all variants. + </para> + </listitem> + </varlistentry> + <varlistentry> <term>cpppaths</term> <listitem> <para> @@ -1007,20 +914,20 @@ Compile files for languages defined in <filename>LINGUAS</filename> file </listitem> </varlistentry> </variablelist> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Note that because <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> always executes its build commands - from the directory in which the <filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> file is located, + <para> + Note that because <application>SCons</application> always executes its build commands + from the directory in which the <filename>SConstruct</filename> file is located, if you generate a project file in a different directory - than the <filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> directory, users will not be able to + than the <filename>SConstruct</filename> directory, users will not be able to double-click on the file name in compilation error messages displayed in the Visual Studio console output window. This can be remedied by adding the Visual C/C++ <literal>/FC</literal> - compiler option to the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link> variable so that + compiler option to the <link linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link> variable so that the compiler will print the full path name of any files that cause compilation errors. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Example usage:</para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> + <para>Example usage:</para> + <example_commands> barsrcs = ['bar.cpp'] barincs = ['bar.h'] barlocalincs = ['StdAfx.h'] @@ -1039,13 +946,13 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], buildtarget=buildtarget, variant='Release') </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Starting with version 2.4 of SCons it is also possible to specify the optional argument <parameter>DebugSettings</parameter>, which creates files for debugging under Visual Studio: </para> - <variablelist xmlns="http://www.scons.org/dbxsd/v1.0"> + <variablelist> <varlistentry> <term>DebugSettings</term> <listitem> @@ -1061,7 +968,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], </listitem> </varlistentry> </variablelist> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Currently, only Visual Studio v9.0 and Visual Studio version v11 are implemented, for other versions no file is generated. To generate the user file, you just need to @@ -1070,11 +977,11 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], the dictionary is empty, or does not contain any good value, no file will be generated. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Following is a more contrived example, involving the setup of a project for variants and DebugSettings: </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> + <example_commands> # Assuming you store your defaults in a file vars = Variables('variables.py') msvcver = vars.args.get('vc', '9') @@ -1192,32 +1099,27 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], </listitem> </varlistentry> <varlistentry id="b-MSVSSolution"> - <term> - <function>MSVSSolution()</function> - </term> - <term> - <function>env.MSVSSolution()</function> - </term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Builds a Microsoft Visual Studio solution file.</para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>MSVSSolution</function>()</term> + <term><parameter>env</parameter>.<methodname>MSVSSolution</methodname>()</term> + <listitem><para>Builds a Microsoft Visual Studio solution file.</para> + <para> This builds a Visual Studio solution file, based on the version of Visual Studio that is configured (either the latest installed version, or the version specified by - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link> in the construction environment). For + <link linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link> in the construction environment). For Visual Studio 6, it will generate a <filename>.dsw</filename> file. For Visual Studio 7 (.NET), it will generate a <filename>.sln</filename> file. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0">The following values must be specified:</para> - <variablelist xmlns="http://www.scons.org/dbxsd/v1.0"> + <para>The following values must be specified:</para> + <variablelist> <varlistentry> <term>target</term> <listitem> <para> The name of the target .dsw or .sln file. The correct suffix for the version of Visual Studio must be used, - but the value <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVSSOLUTIONSUFFIX"><envar>$MSVSSOLUTIONSUFFIX</envar></link> will be + but the value <link linkend="cv-MSVSSOLUTIONSUFFIX"><envar>$MSVSSOLUTIONSUFFIX</envar></link> will be defined to the correct value (see example below). </para> </listitem> @@ -1236,7 +1138,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], <term>projects</term> <listitem> <para> A list of project file names, or Project nodes returned - by calls to the <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSProject</function> Builder, to be placed + by calls to the <function>MSVSProject</function> Builder, to be placed into the solution file. It should be noted that these file names are NOT added to the $SOURCES environment variable in form of files, but rather as strings. @@ -1247,111 +1149,105 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], </listitem> </varlistentry> </variablelist> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Example Usage:</para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.MSVSSolution(target='Bar' + env['MSVSSOLUTIONSUFFIX'], projects=['bar' + env['MSVSPROJECTSUFFIX']], variant='Release') + <para>Example Usage:</para> + <example_commands> +env.MSVSSolution( + target="Bar" + env["MSVSSOLUTIONSUFFIX"], + projects=["bar" + env["MSVSPROJECTSUFFIX"]], + variant="Release", +) </example_commands> </listitem> </varlistentry> <varlistentry id="b-Object"> - <term> - <function>Object()</function> - </term> - <term> - <function>env.Object()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Object</function>()</term> + <term><parameter>env</parameter>.<methodname>Object</methodname>()</term> + <listitem><para> A synonym for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticObject</function> +<function>StaticObject</function> builder method. </para> </listitem> </varlistentry> <varlistentry id="b-Package"> - <term> - <function>Package()</function> - </term> - <term> - <function>env.Package()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Builds a Binary Package of the given source files. -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Package</function>()</term> + <term><parameter>env</parameter>.<methodname>Package</methodname>()</term> + <listitem><para> +Builds a Binary Package of the given source files. +</para> + +<example_commands> env.Package(source = FindInstalledFiles()) </example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Builds software distribution packages. Packages consist of files to install and packaging information. -The former may be specified with the <varname xmlns="http://www.scons.org/dbxsd/v1.0">source</varname> parameter and may be left out, -in which case the <function xmlns="http://www.scons.org/dbxsd/v1.0">FindInstalledFiles</function> function will collect -all files that have an <function xmlns="http://www.scons.org/dbxsd/v1.0">Install</function> or <function xmlns="http://www.scons.org/dbxsd/v1.0">InstallAs</function> Builder attached. -If the <varname xmlns="http://www.scons.org/dbxsd/v1.0">target</varname> is not specified +The former may be specified with the <varname>source</varname> parameter and may be left out, +in which case the <function>FindInstalledFiles</function> function will collect +all files that have an <function>Install</function> or <function>InstallAs</function> Builder attached. +If the <varname>target</varname> is not specified it will be deduced from additional information given to this Builder. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The packaging information is specified with the help of construction variables documented below. This information is called a tag to stress that -some of them can also be attached to files with the <function xmlns="http://www.scons.org/dbxsd/v1.0">Tag</function> function. +some of them can also be attached to files with the <function>Tag</function> function. The mandatory ones will complain if they were not specified. They vary depending on chosen target packager. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The target packager may be selected with the "PACKAGETYPE" command line -option or with the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$PACKAGETYPE</envar> construction variable. Currently +option or with the <envar>$PACKAGETYPE</envar> construction variable. Currently the following packagers available: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - * msi - Microsoft Installer - * rpm - RPM Package Manger - * ipkg - Itsy Package Management System - * tarbz2 - bzip2 compressed tar - * targz - gzip compressed tar - * tarxz - xz compressed tar - * zip - zip file - * src_tarbz2 - bzip2 compressed tar source - * src_targz - gzip compressed tar source - * src_tarxz - xz compressed tar source - * src_zip - zip file source -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -An updated list is always available under the "package_type" option when -running "scons --help" on a project that has packaging activated. -</para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(tools=['default', 'packaging']) -env.Install('/bin/', 'my_program') -env.Package( NAME = 'foo', - VERSION = '1.2.3', - PACKAGEVERSION = 0, - PACKAGETYPE = 'rpm', - LICENSE = 'gpl', - SUMMARY = 'balalalalal', - DESCRIPTION = 'this should be really really long', - X_RPM_GROUP = 'Application/fu', - SOURCE_URL = 'http://foo.org/foo-1.2.3.tar.gz' - ) +<blockquote> +<simplelist type="vert" columns="1"> +<member><literal>msi</literal> - Microsoft Installer</member> +<member><literal>rpm</literal> - RPM Package Manger</member> +<member><literal>ipkg</literal> - Itsy Package Management System</member> +<member><literal>tarbz2</literal> - bzip2 compressed tar</member> +<member><literal>targz</literal> - gzip compressed tar</member> +<member><literal>tarxz</literal> - xz compressed tar</member> +<member><literal>zip</literal> - zip file</member> +<member><literal>src_tarbz2</literal> - bzip2 compressed tar source</member> +<member><literal>src_targz</literal> - gzip compressed tar source</member> +<member><literal>src_tarxz</literal> - xz compressed tar source</member> +<member><literal>src_zip</literal> - zip file source</member> +</simplelist> +</blockquote> + +<para> +An updated list is always available under the +<replaceable>package_type</replaceable> option when +running <command>scons --help</command> +on a project that has packaging activated. +</para> + +<example_commands> +env = Environment(tools=["default", "packaging"]) +env.Install("/bin/", "my_program") +env.Package( + NAME="foo", + VERSION="1.2.3", + PACKAGEVERSION=0, + PACKAGETYPE="rpm", + LICENSE="gpl", + SUMMARY="balalalalal", + DESCRIPTION="this should be really really long", + X_RPM_GROUP="Application/fu", + SOURCE_URL="http://foo.org/foo-1.2.3.tar.gz", +) </example_commands> </listitem> </varlistentry> <varlistentry id="b-PCH"> - <term> - <function>PCH()</function> - </term> - <term> - <function>env.PCH()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>PCH</function>()</term> + <term><parameter>env</parameter>.<methodname>PCH</methodname>()</term> + <listitem><para> Builds a Microsoft Visual C++ precompiled header. Calling this builder method returns a list of two targets: the PCH as the first element, and the object @@ -1363,33 +1259,28 @@ conjunction with the PCH construction variable to force object files to use the precompiled header: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['PCH'] = env.PCH('StdAfx.cpp')[0] </example_commands> </listitem> </varlistentry> <varlistentry id="b-PDF"> - <term> - <function>PDF()</function> - </term> - <term> - <function>env.PDF()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>PDF</function>()</term> + <term><parameter>env</parameter>.<methodname>PDF</methodname>()</term> + <listitem><para> Builds a <filename>.pdf</filename> file from a <filename>.dvi</filename> input file (or, by extension, a <filename>.tex</filename>, <filename>.ltx</filename>, or <filename>.latex</filename> input file). -The suffix specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PDFSUFFIX"><envar>$PDFSUFFIX</envar></link> construction variable +The suffix specified by the <link linkend="cv-PDFSUFFIX"><envar>$PDFSUFFIX</envar></link> construction variable (<filename>.pdf</filename> by default) is added automatically to the target if it is not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds from aaa.tex env.PDF(target = 'aaa.pdf', source = 'aaa.tex') # builds bbb.pdf from bbb.dvi @@ -1398,133 +1289,123 @@ env.PDF(target = 'bbb', source = 'bbb.dvi') </listitem> </varlistentry> <varlistentry id="b-POInit"> - <term> - <function>POInit()</function> - </term> - <term> - <function>env.POInit()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This builder belongs to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool. The builder initializes missing -<literal>PO</literal> file(s) if <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is set. If -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is not set (default), <function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> prints instruction for + <term><function>POInit</function>()</term> + <term><parameter>env</parameter>.<methodname>POInit</methodname>()</term> + <listitem><para> +This builder belongs to <link linkend="t-msginit"><literal>msginit</literal></link> tool. The builder initializes missing +<literal>PO</literal> file(s) if <link linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is set. If +<link linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is not set (default), <function>POInit</function> prints instruction for user (that is supposed to be a translator), telling how the <literal>PO</literal> file should be initialized. In normal projects -<emphasis>you should not use <function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> and use <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> -instead</emphasis>. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> chooses intelligently between -<command>msgmerge(1)</command> and <command>msginit(1)</command>. <function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> +<emphasis>you should not use <function>POInit</function> and use <link linkend="b-POUpdate"><function>POUpdate</function></link> +instead</emphasis>. <link linkend="b-POUpdate"><function>POUpdate</function></link> chooses intelligently between +<command>msgmerge(1)</command> and <command>msginit(1)</command>. <function>POInit</function> always uses <command>msginit(1)</command> and should be regarded as builder for special purposes or for temporary use (e.g. for quick, one time initialization of a bunch of <literal>PO</literal> files) or for tests. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Target nodes defined through <function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> are not built by default (they're +<para> +Target nodes defined through <function>POInit</function> are not built by default (they're <literal>Ignore</literal>d from <literal>'.'</literal> node) but are added to special <literal>Alias</literal> (<literal>'po-create'</literal> by default). -The alias name may be changed through the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POCREATE_ALIAS"><envar>$POCREATE_ALIAS</envar></link> +The alias name may be changed through the <link linkend="cv-POCREATE_ALIAS"><envar>$POCREATE_ALIAS</envar></link> construction variable. All <literal>PO</literal> files defined through -<function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> may be easily initialized by <command>scons po-create</command>. +<function>POInit</function> may be easily initialized by <command>scons po-create</command>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 1</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>messages.pot</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 2</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 3</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.po</filename> from -<filename>foo.pot</filename> but using <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> construction +<filename>foo.pot</filename> but using <link linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> construction variable: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 4</emphasis>. Initialize <literal>PO</literal> files for languages defined in <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 5</emphasis>. Initialize <filename>en.po</filename> and <filename>pl.pl</filename> <literal>PO</literal> files plus files for languages defined in <filename>LINGUAS</filename> file. The files will be initialized from template <filename>messages.pot</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(['en', 'pl'], LINGUAS_FILE = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 6</emphasis>. You may preconfigure your environment first, and then initialize <literal>PO</literal> files: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env['POAUTOINIT'] = 1 env['LINGUAS_FILE'] = 1 env['POTDOMAIN'] = 'foo' env.POInit() </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> which has same efect as: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo') </example_commands> </listitem> </varlistentry> <varlistentry id="b-PostScript"> - <term> - <function>PostScript()</function> - </term> - <term> - <function>env.PostScript()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>PostScript</function>()</term> + <term><parameter>env</parameter>.<methodname>PostScript</methodname>()</term> + <listitem><para> Builds a <filename>.ps</filename> file from a <filename>.dvi</filename> input file (or, by extension, a <filename>.tex</filename>, <filename>.ltx</filename>, or <filename>.latex</filename> input file). -The suffix specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PSSUFFIX"><envar>$PSSUFFIX</envar></link> construction variable +The suffix specified by the <link linkend="cv-PSSUFFIX"><envar>$PSSUFFIX</envar></link> construction variable (<filename>.ps</filename> by default) is added automatically to the target if it is not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds from aaa.tex env.PostScript(target = 'aaa.ps', source = 'aaa.tex') # builds bbb.ps from bbb.dvi @@ -1533,30 +1414,25 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') </listitem> </varlistentry> <varlistentry id="b-POTUpdate"> - <term> - <function>POTUpdate()</function> - </term> - <term> - <function>env.POTUpdate()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The builder belongs to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool. The builder updates target + <term><function>POTUpdate</function>()</term> + <term><parameter>env</parameter>.<methodname>POTUpdate</methodname>()</term> + <listitem><para> +The builder belongs to <link linkend="t-xgettext"><literal>xgettext</literal></link> tool. The builder updates target <literal>POT</literal> file if exists or creates one if it doesn't. The node is not built by default (i.e. it is <literal>Ignore</literal>d from <literal>'.'</literal>), but only on demand (i.e. when given <literal>POT</literal> file is required or when special alias is invoked). This builder adds its targe node (<filename>messages.pot</filename>, say) to a special alias (<literal>pot-update</literal> by default, see -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POTUPDATE_ALIAS"><envar>$POTUPDATE_ALIAS</envar></link>) so you can update/create them easily with +<link linkend="cv-POTUPDATE_ALIAS"><envar>$POTUPDATE_ALIAS</envar></link>) so you can update/create them easily with <command>scons pot-update</command>. The file is not written until there is no real change in internationalized messages (or in comments that enter <literal>POT</literal> file). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <note> <para>You may see <command>xgettext(1)</command> being invoked by the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool even if there is no real change in internationalized +<link linkend="t-xgettext"><literal>xgettext</literal></link> tool even if there is no real change in internationalized messages (so the <literal>POT</literal> file is not being updated). This happens every time a source file has changed. In such case we invoke <command>xgettext(1)</command> and compare its output with the content of @@ -1564,38 +1440,38 @@ happens every time a source file has changed. In such case we invoke not.</para></note> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 1.</emphasis> Let's create <filename>po/</filename> directory and place following <filename>SConstruct</filename> script there: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct in 'po/' subdir env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp']) env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Then invoke scons few times: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> user@host:$ scons # Does not create foo.pot nor bar.pot user@host:$ scons foo.pot # Updates or creates foo.pot user@host:$ scons pot-update # Updates or creates foo.pot and bar.pot user@host:$ scons -c # Does not clean foo.pot nor bar.pot. </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> the results shall be as the comments above say. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 2.</emphasis> -The <function xmlns="http://www.scons.org/dbxsd/v1.0">POTUpdate</function> builder may be used with no target specified, in which +The <function>POTUpdate</function> builder may be used with no target specified, in which case default target <filename>messages.pot</filename> will be used. The -default target may also be overridden by setting <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> construction -variable or providing it as an override to <function xmlns="http://www.scons.org/dbxsd/v1.0">POTUpdate</function> builder: +default target may also be overridden by setting <link linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> construction +variable or providing it as an override to <function>POTUpdate</function> builder: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct script env = Environment( tools = ['default', 'xgettext'] ) env['POTDOMAIN'] = "foo" @@ -1603,49 +1479,49 @@ variable or providing it as an override to <function xmlns="http://www.scons.org env.POTUpdate(POTDOMAIN = "bar", source = ["c.cpp", "d.cpp"]) # and bar.pot </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 3.</emphasis> The sources may be specified within separate file, for example <filename>POTFILES.in</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # POTFILES.in in 'po/' subdirectory ../a.cpp ../b.cpp # end of file </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The name of the file (<filename>POTFILES.in</filename>) containing the list of -sources is provided via <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link>: +sources is provided via <link linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct file in 'po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 4.</emphasis> -You may use <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTPATH"><envar>$XGETTEXTPATH</envar></link> to define source search path. Assume, for +You may use <link linkend="cv-XGETTEXTPATH"><envar>$XGETTEXTPATH</envar></link> to define source search path. Assume, for example, that you have files <filename>a.cpp</filename>, <filename>b.cpp</filename>, <filename>po/SConstruct</filename>, <filename>po/POTFILES.in</filename>. Then your <literal>POT</literal>-related files could look as below: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # POTFILES.in in 'po/' subdirectory a.cpp b.cpp # end of file </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct file in 'po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH='../') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 5.</emphasis> Multiple search directories may be defined within a list, i.e. <literal>XGETTEXTPATH = ['dir1', 'dir2', ...]</literal>. The order in the list @@ -1653,48 +1529,48 @@ determines the search order of source files. The path to the first file found is used. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Let's create <filename>0/1/po/SConstruct</filename> script: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct file in '0/1/po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../', '../../']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> and <filename>0/1/po/POTFILES.in</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # POTFILES.in in '0/1/po/' subdirectory a.cpp # end of file </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Write two <filename>*.cpp</filename> files, the first one is <filename>0/a.cpp</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> /* 0/a.cpp */ gettext("Hello from ../../a.cpp") </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> and the second is <filename>0/1/a.cpp</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> /* 0/1/a.cpp */ gettext("Hello from ../a.cpp") </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> then run scons. You'll obtain <literal>0/1/po/messages.pot</literal> with the message <literal>"Hello from ../a.cpp"</literal>. When you reverse order in <varname>$XGETTEXTFOM</varname>, i.e. when you write SConscript as </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct file in '0/1/po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../../', '../']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> then the <filename>messages.pot</filename> will contain <literal>msgid "Hello from ../../a.cpp"</literal> line and not <literal>msgid "Hello from ../a.cpp"</literal>. @@ -1703,113 +1579,108 @@ then the <filename>messages.pot</filename> will contain </listitem> </varlistentry> <varlistentry id="b-POUpdate"> - <term> - <function>POUpdate()</function> - </term> - <term> - <function>env.POUpdate()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The builder belongs to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool. The builder updates + <term><function>POUpdate</function>()</term> + <term><parameter>env</parameter>.<methodname>POUpdate</methodname>()</term> + <listitem><para> +The builder belongs to <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool. The builder updates <literal>PO</literal> files with <command>msgmerge(1)</command>, or initializes missing <literal>PO</literal> files as described in documentation of -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder (see also -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link>). Note, that <function xmlns="http://www.scons.org/dbxsd/v1.0">POUpdate</function> <emphasis>does not add its -targets to <literal>po-create</literal> alias</emphasis> as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> +<link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder (see also +<link linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link>). Note, that <function>POUpdate</function> <emphasis>does not add its +targets to <literal>po-create</literal> alias</emphasis> as <link linkend="b-POInit"><function>POInit</function></link> does. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Target nodes defined through <function xmlns="http://www.scons.org/dbxsd/v1.0">POUpdate</function> are not built by default +<para> +Target nodes defined through <function>POUpdate</function> are not built by default (they're <literal>Ignore</literal>d from <literal>'.'</literal> node). Instead, they are added automatically to special <literal>Alias</literal> (<literal>'po-update'</literal> by default). The alias name may be changed -through the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POUPDATE_ALIAS"><envar>$POUPDATE_ALIAS</envar></link> construction variable. You can easily +through the <link linkend="cv-POUPDATE_ALIAS"><envar>$POUPDATE_ALIAS</envar></link> construction variable. You can easily update <literal>PO</literal> files in your project by <command>scons po-update</command>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 1.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> from -<filename>messages.pot</filename> template (see also <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link>), +<filename>messages.pot</filename> template (see also <link linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link>), assuming that the later one exists or there is rule to build it (see -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link>): +<link linkend="b-POTUpdate"><function>POTUpdate</function></link>): </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(['en','pl']) # messages.pot --> [en.po, pl.po] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 2.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename> template: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.pl] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 3.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> from <filename>foo.pot</filename> (another version): </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- > [en.po, pl.pl] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 4.</emphasis> Update files for languages defined in <filename>LINGUAS</filename> file. The files are updated from <filename>messages.pot</filename> template: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(LINGUAS_FILE = 1) # needs 'LINGUAS' file </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 5.</emphasis> Same as above, but update from <filename>foo.pot</filename> template: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(LINGUAS_FILE = 1, source = ['foo']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 6.</emphasis> Update <filename>en.po</filename> and <filename>pl.po</filename> plus files for languages defined in <filename>LINGUAS</filename> file. The files are updated from <filename>messages.pot</filename> template: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # produce 'en.po', 'pl.po' + files defined in 'LINGUAS': env.POUpdate(['en', 'pl' ], LINGUAS_FILE = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 7.</emphasis> -Use <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> to automatically initialize <literal>PO</literal> file +Use <link linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> to automatically initialize <literal>PO</literal> file if it doesn't exist: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env.POUpdate(LINGUAS_FILE = 1, POAUTOINIT = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 8.</emphasis> Update <literal>PO</literal> files for languages defined in <filename>LINGUAS</filename> file. The files are updated from <filename>foo.pot</filename> template. All necessary settings are pre-configured via environment. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # ... env['POAUTOINIT'] = 1 env['LINGUAS_FILE'] = 1 @@ -1820,63 +1691,53 @@ pre-configured via environment. </listitem> </varlistentry> <varlistentry id="b-Program"> - <term> - <function>Program()</function> - </term> - <term> - <function>env.Program()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Program</function>()</term> + <term><parameter>env</parameter>.<methodname>Program</methodname>()</term> + <listitem><para> Builds an executable given one or more object files or C, C++, D, or Fortran source files. If any C, C++, D or Fortran source files are specified, then they will be automatically compiled to object files using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Object</function> +<function>Object</function> builder method; see that builder method's description for a list of legal source file suffixes and how they are interpreted. The target executable file prefix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PROGPREFIX"><envar>$PROGPREFIX</envar></link> construction variable; nothing by default) +(specified by the <link linkend="cv-PROGPREFIX"><envar>$PROGPREFIX</envar></link> construction variable; nothing by default) and suffix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PROGSUFFIX"><envar>$PROGSUFFIX</envar></link> construction variable; +(specified by the <link linkend="cv-PROGSUFFIX"><envar>$PROGSUFFIX</envar></link> construction variable; by default, <filename>.exe</filename> on Windows systems, nothing on POSIX systems) are automatically added to the target if not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) </example_commands> </listitem> </varlistentry> <varlistentry id="b-ProgramAllAtOnce"> - <term> - <function>ProgramAllAtOnce()</function> - </term> - <term> - <function>env.ProgramAllAtOnce()</function> - </term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>ProgramAllAtOnce</function>()</term> + <term><parameter>env</parameter>.<methodname>ProgramAllAtOnce</methodname>()</term> + <listitem><para> Builds an executable from D sources without first creating individual objects for each file. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> D sources can be compiled file-by-file as C and C++ source are, and - D is integrated into the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> Object and Program builders for + D is integrated into the <command>scons</command> Object and Program builders for this model of build. D codes can though do whole source meta-programming (some of the testing frameworks do this). For this it is imperative that all sources are compiled and linked in a single call to the D compiler. This builder serves that purpose. </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> + <example_commands> env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> This command will compile the modules mod_a, mod_b, and mod_c in a single compilation process without first creating object files for the modules. Some of the D compilers will create executable.o others @@ -1885,14 +1746,9 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) </listitem> </varlistentry> <varlistentry id="b-RES"> - <term> - <function>RES()</function> - </term> - <term> - <function>env.RES()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RES</function>()</term> + <term><parameter>env</parameter>.<methodname>RES</methodname>()</term> + <listitem><para> Builds a Microsoft Visual C++ resource file. This builder method is only provided when Microsoft Visual C++ or MinGW is being used as the compiler. The @@ -1905,20 +1761,15 @@ file is scanned for implicit dependencies as though it were a C file. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.RES('resource.rc') </example_commands> </listitem> </varlistentry> <varlistentry id="b-RMIC"> - <term> - <function>RMIC()</function> - </term> - <term> - <function>env.RMIC()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RMIC</function>()</term> + <term><parameter>env</parameter>.<methodname>RMIC</methodname>()</term> + <listitem><para> Builds stub and skeleton class files for remote objects from Java <filename>.class</filename> files. @@ -1927,16 +1778,16 @@ relative to which the stub and skeleton class files will be written. The source can be the names of <filename>.class</filename> files, or the objects return from the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Java</function> +<function>Java</function> builder method. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the construction variable -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVACLASSDIR"><envar>$JAVACLASSDIR</envar></link> +<link linkend="cv-JAVACLASSDIR"><envar>$JAVACLASSDIR</envar></link> is set, either in the environment or in the call to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">RMIC</function> +<function>RMIC</function> builder method itself, then the value of the variable will be stripped from the @@ -1944,7 +1795,7 @@ beginning of any <filename>.class </filename> file names. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> classes = env.Java(target = 'classdir', source = 'src') env.RMIC(target = 'outdir1', source = classes) @@ -1958,14 +1809,9 @@ env.RMIC(target = 'outdir3', </listitem> </varlistentry> <varlistentry id="b-RPCGenClient"> - <term> - <function>RPCGenClient()</function> - </term> - <term> - <function>env.RPCGenClient()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RPCGenClient</function>()</term> + <term><parameter>env</parameter>.<methodname>RPCGenClient</methodname>()</term> + <listitem><para> Generates an RPC client stub (<filename>_clnt.c</filename>) file from a specified RPC (<filename>.x</filename>) source file. Because rpcgen only builds output files @@ -1974,21 +1820,16 @@ the command will be executed in the source file's directory by default. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Builds src/rpcif_clnt.c env.RPCGenClient('src/rpcif.x') </example_commands> </listitem> </varlistentry> <varlistentry id="b-RPCGenHeader"> - <term> - <function>RPCGenHeader()</function> - </term> - <term> - <function>env.RPCGenHeader()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RPCGenHeader</function>()</term> + <term><parameter>env</parameter>.<methodname>RPCGenHeader</methodname>()</term> + <listitem><para> Generates an RPC header (<filename>.h</filename>) file from a specified RPC (<filename>.x</filename>) source file. Because rpcgen only builds output files @@ -1997,21 +1838,16 @@ the command will be executed in the source file's directory by default. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Builds src/rpcif.h env.RPCGenHeader('src/rpcif.x') </example_commands> </listitem> </varlistentry> <varlistentry id="b-RPCGenService"> - <term> - <function>RPCGenService()</function> - </term> - <term> - <function>env.RPCGenService()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RPCGenService</function>()</term> + <term><parameter>env</parameter>.<methodname>RPCGenService</methodname>()</term> + <listitem><para> Generates an RPC server-skeleton (<filename>_svc.c</filename>) file from a specified RPC (<filename>.x</filename>) source file. Because rpcgen only builds output files @@ -2020,21 +1856,16 @@ the command will be executed in the source file's directory by default. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Builds src/rpcif_svc.c env.RPCGenClient('src/rpcif.x') </example_commands> </listitem> </varlistentry> <varlistentry id="b-RPCGenXDR"> - <term> - <function>RPCGenXDR()</function> - </term> - <term> - <function>env.RPCGenXDR()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>RPCGenXDR</function>()</term> + <term><parameter>env</parameter>.<methodname>RPCGenXDR</methodname>()</term> + <listitem><para> Generates an RPC XDR routine (<filename>_xdr.c</filename>) file from a specified RPC (<filename>.x</filename>) source file. Because rpcgen only builds output files @@ -2043,21 +1874,16 @@ the command will be executed in the source file's directory by default. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Builds src/rpcif_xdr.c env.RPCGenClient('src/rpcif.x') </example_commands> </listitem> </varlistentry> <varlistentry id="b-SharedLibrary"> - <term> - <function>SharedLibrary()</function> - </term> - <term> - <function>env.SharedLibrary()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SharedLibrary</function>()</term> + <term><parameter>env</parameter>.<methodname>SharedLibrary</methodname>()</term> + <listitem><para> Builds a shared library (<filename>.so</filename> on a POSIX system, <filename>.dll</filename> on Windows) @@ -2069,24 +1895,24 @@ compiled to object files. The static library prefix and suffix (if any) are automatically added to the target. The target library file prefix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link> construction variable; +(specified by the <link linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link> construction variable; by default, <filename>lib</filename> on POSIX systems, nothing on Windows systems) and suffix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBSUFFIX"><envar>$SHLIBSUFFIX</envar></link> construction variable; +(specified by the <link linkend="cv-SHLIBSUFFIX"><envar>$SHLIBSUFFIX</envar></link> construction variable; by default, <filename>.dll</filename> on Windows systems, <filename>.so</filename> on POSIX systems) are automatically added to the target if not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On Windows systems, the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function> +<function>SharedLibrary</function> builder method will always build an import (<filename>.lib</filename>) library in addition to the shared (<filename>.dll</filename>) library, @@ -2095,9 +1921,9 @@ if there is not already a <filename>.lib</filename> file explicitly listed in the targets. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On Cygwin systems, the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function> +<function>SharedLibrary</function> builder method will always build an import (<filename>.dll.a</filename>) library in addition to the shared (<filename>.dll</filename>) library, @@ -2106,36 +1932,36 @@ if there is not already a <filename>.dll.a</filename> file explicitly listed in the targets. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any object files listed in the <literal>source</literal> must have been built for a shared library (that is, using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SharedObject</function> +<function>SharedObject</function> builder method). -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will raise an error if there is any mismatch. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On some platforms, there is a distinction between a shared library (loaded automatically by the system to resolve external references) and a loadable module (explicitly loaded by user action). -For maximum portability, use the <function xmlns="http://www.scons.org/dbxsd/v1.0">LoadableModule</function> builder for the latter. +For maximum portability, use the <function>LoadableModule</function> builder for the latter. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -When the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> construction variable is defined a versioned -shared library is created. This modifies the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKFLAGS"><envar>$SHLINKFLAGS</envar></link> as required, +<para> +When the <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> construction variable is defined a versioned +shared library is created. This modifies the <link linkend="cv-SHLINKFLAGS"><envar>$SHLINKFLAGS</envar></link> as required, adds the version number to the library name, and creates the symlinks that are needed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'], SHLIBVERSION='1.5.2') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On a POSIX system, versions with a single token create exactly one symlink: libbar.so.6 would have symlinks libbar.so only. On a POSIX system, versions with two or more @@ -2144,47 +1970,42 @@ libbar.so and libbar.so.2; on a Darwin (OSX) system the library would be libbar.2.3.1.dylib and the link would be libbar.dylib. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On Windows systems, specifying <literal>register=1</literal> will cause the <filename>.dll</filename> to be registered after it is built using REGSVR32. The command that is run -("regsvr32" by default) is determined by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-REGSVR"><envar>$REGSVR</envar></link> construction -variable, and the flags passed are determined by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link>. By -default, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link> includes the <option>/s</option> option, +("regsvr32" by default) is determined by <link linkend="cv-REGSVR"><envar>$REGSVR</envar></link> construction +variable, and the flags passed are determined by <link linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link>. By +default, <link linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link> includes the <option>/s</option> option, to prevent dialogs from popping up and requiring user attention when it is run. If you change -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link>, be sure to include the <option>/s</option> option. +<link linkend="cv-REGSVRFLAGS"><envar>$REGSVRFLAGS</envar></link>, be sure to include the <option>/s</option> option. For example, </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SharedLibrary(target = 'bar', source = ['bar.cxx', 'foo.obj'], register=1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> will register <filename>bar.dll</filename> as a COM object when it is done linking it. </para> </listitem> </varlistentry> <varlistentry id="b-SharedObject"> - <term> - <function>SharedObject()</function> - </term> - <term> - <function>env.SharedObject()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SharedObject</function>()</term> + <term><parameter>env</parameter>.<methodname>SharedObject</methodname>()</term> + <listitem><para> Builds an object file for inclusion in a shared library. Source files must have one of the same set of extensions specified above for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticObject</function> +<function>StaticObject</function> builder method. On some platforms building a shared object requires additional compiler option @@ -2199,21 +2020,21 @@ and shared objects to be linked into a shared library, and will use the same suffix for shared and normal (static) objects. The target object file prefix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHOBJPREFIX"><envar>$SHOBJPREFIX</envar></link> construction variable; -by default, the same as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-OBJPREFIX"><envar>$OBJPREFIX</envar></link>) +(specified by the <link linkend="cv-SHOBJPREFIX"><envar>$SHOBJPREFIX</envar></link> construction variable; +by default, the same as <link linkend="cv-OBJPREFIX"><envar>$OBJPREFIX</envar></link>) and suffix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHOBJSUFFIX"><envar>$SHOBJSUFFIX</envar></link> construction variable) +(specified by the <link linkend="cv-SHOBJSUFFIX"><envar>$SHOBJSUFFIX</envar></link> construction variable) are automatically added to the target if not already present. Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SharedObject(target = 'ddd', source = 'ddd.c') env.SharedObject(target = 'eee.o', source = 'eee.cpp') env.SharedObject(target = 'fff.obj', source = 'fff.for') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the source files will be scanned according to the suffix mappings in the <literal>SourceFileScanner</literal> @@ -2224,14 +2045,9 @@ below, for more information. </listitem> </varlistentry> <varlistentry id="b-StaticLibrary"> - <term> - <function>StaticLibrary()</function> - </term> - <term> - <function>env.StaticLibrary()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>StaticLibrary</function>()</term> + <term><parameter>env</parameter>.<methodname>StaticLibrary</methodname>()</term> + <listitem><para> Builds a static library given one or more object files or C, C++, D or Fortran source files. If any source files are given, @@ -2240,48 +2056,43 @@ compiled to object files. The static library prefix and suffix (if any) are automatically added to the target. The target library file prefix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPREFIX"><envar>$LIBPREFIX</envar></link> construction variable; +(specified by the <link linkend="cv-LIBPREFIX"><envar>$LIBPREFIX</envar></link> construction variable; by default, <filename>lib</filename> on POSIX systems, nothing on Windows systems) and suffix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBSUFFIX"><envar>$LIBSUFFIX</envar></link> construction variable; +(specified by the <link linkend="cv-LIBSUFFIX"><envar>$LIBSUFFIX</envar></link> construction variable; by default, <filename>.lib</filename> on Windows systems, <filename>.a</filename> on POSIX systems) are automatically added to the target if not already present. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.StaticLibrary(target = 'bar', source = ['bar.c', 'foo.o']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any object files listed in the <literal>source</literal> must have been built for a static library (that is, using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticObject</function> +<function>StaticObject</function> builder method). -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will raise an error if there is any mismatch. </para> </listitem> </varlistentry> <varlistentry id="b-StaticObject"> - <term> - <function>StaticObject()</function> - </term> - <term> - <function>env.StaticObject()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>StaticObject</function>()</term> + <term><parameter>env</parameter>.<methodname>StaticObject</methodname>()</term> + <listitem><para> Builds a static object file from one or more C, C++, D, or Fortran source files. Source files must have one of the following extensions: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> .asm assembly language file .ASM assembly language file .c C file @@ -2312,24 +2123,24 @@ Source files must have one of the following extensions: .SPP assembly language file + C pre-processor </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The target object file prefix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-OBJPREFIX"><envar>$OBJPREFIX</envar></link> construction variable; nothing by default) +(specified by the <link linkend="cv-OBJPREFIX"><envar>$OBJPREFIX</envar></link> construction variable; nothing by default) and suffix -(specified by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-OBJSUFFIX"><envar>$OBJSUFFIX</envar></link> construction variable; +(specified by the <link linkend="cv-OBJSUFFIX"><envar>$OBJSUFFIX</envar></link> construction variable; <filename>.obj</filename> on Windows systems, <filename>.o</filename> on POSIX systems) are automatically added to the target if not already present. Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.StaticObject(target = 'aaa', source = 'aaa.c') env.StaticObject(target = 'bbb.o', source = 'bbb.c++') env.StaticObject(target = 'ccc.obj', source = 'ccc.f') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the source files will be scanned according to the suffix mappings in <literal>SourceFileScanner</literal> @@ -2340,34 +2151,29 @@ below, for more information. </listitem> </varlistentry> <varlistentry id="b-Substfile"> - <term> - <function>Substfile()</function> - </term> - <term> - <function>env.Substfile()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> builder creates a single text file from another file or set of -files by concatenating them with <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINESEPARATOR</envar> and replacing text -using the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SUBST_DICT</envar> construction variable. Nested lists of source files -are flattened. See also <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Substfile</function>()</term> + <term><parameter>env</parameter>.<methodname>Substfile</methodname>()</term> + <listitem><para> +The <function>Substfile</function> builder creates a single text file from another file or set of +files by concatenating them with <envar>$LINESEPARATOR</envar> and replacing text +using the <envar>$SUBST_DICT</envar> construction variable. Nested lists of source files +are flattened. See also <function>Textfile</function>. +</para> + +<para> If a single source file is present with an <filename>.in</filename> suffix, the suffix is stripped and the remainder is used as the default target name. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The prefix and suffix specified by the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SUBSTFILEPREFIX</envar> -and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SUBSTFILESUFFIX</envar> construction variables -(the null string by default in both cases) +<para> +The prefix and suffix specified by the <envar>$SUBSTFILEPREFIX</envar> +and <envar>$SUBSTFILESUFFIX</envar> construction variables +(an empty string by default in both cases) are automatically added to the target if they are not already present. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If a construction variable named <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SUBST_DICT</envar> is present, +<para> +If a construction variable named <envar>$SUBST_DICT</envar> is present, it may be either a Python dictionary or a sequence of (key,value) tuples. If it is a dictionary it is converted into a list of tuples in an arbitrary order, so if one key is a prefix of another key @@ -2375,7 +2181,7 @@ or if one substitution could be further expanded by another subsitition, it is unpredictable whether the expansion will occur. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any occurrences of a key in the source are replaced by the corresponding value, which may be a Python callable function or a string. @@ -2384,7 +2190,7 @@ Strings are <emphasis>subst</emphasis>-expanded and the result replaces the key. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(tools=['default']) env['prefix'] = '/usr/bin' @@ -2430,19 +2236,14 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), </listitem> </varlistentry> <varlistentry id="b-Tar"> - <term> - <function>Tar()</function> - </term> - <term> - <function>env.Tar()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Tar</function>()</term> + <term><parameter>env</parameter>.<methodname>Tar</methodname>()</term> + <listitem><para> Builds a tar archive of the specified files and/or directories. Unlike most builder methods, the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Tar</function> +<function>Tar</function> builder method may be called multiple times for a given target; each additional call @@ -2452,11 +2253,11 @@ Any source directories will be scanned for changes to any on-disk files, regardless of whether or not -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> knows about them from other Builder or function calls. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Tar('src.tar', 'src') # Create the stuff.tar file. @@ -2476,35 +2277,30 @@ env.Tar('foo') </listitem> </varlistentry> <varlistentry id="b-Textfile"> - <term> - <function>Textfile()</function> - </term> - <term> - <function>env.Textfile()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> builder generates a single text file. + <term><function>Textfile</function>()</term> + <term><parameter>env</parameter>.<methodname>Textfile</methodname>()</term> + <listitem><para> +The <function>Textfile</function> builder generates a single text file. The source strings constitute the lines; nested lists of sources are flattened. -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINESEPARATOR</envar> is used to separate the strings. +<envar>$LINESEPARATOR</envar> is used to separate the strings. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If present, the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SUBST_DICT</envar> construction variable +<para> +If present, the <envar>$SUBST_DICT</envar> construction variable is used to modify the strings before they are written; -see the <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> description for details. +see the <function>Substfile</function> description for details. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The prefix and suffix specified by the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$TEXTFILEPREFIX</envar> -and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$TEXTFILESUFFIX</envar> construction variables -(the null string and <filename>.txt</filename> by default, respectively) +<para> +The prefix and suffix specified by the <envar>$TEXTFILEPREFIX</envar> +and <envar>$TEXTFILESUFFIX</envar> construction variables +(an empty string and <filename>.txt</filename> by default, respectively) are automatically added to the target if they are not already present. Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # builds/writes foo.txt env.Textfile(target = 'foo.txt', source = ['Goethe', 42, 'Schiller']) @@ -2547,56 +2343,51 @@ blob.txt </listitem> </varlistentry> <varlistentry id="b-Translate"> - <term> - <function>Translate()</function> - </term> - <term> - <function>env.Translate()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This pseudo-builder belongs to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gettext"><literal>gettext</literal></link> toolset. The builder extracts + <term><function>Translate</function>()</term> + <term><parameter>env</parameter>.<methodname>Translate</methodname>()</term> + <listitem><para> +This pseudo-builder belongs to <link linkend="t-gettext"><literal>gettext</literal></link> toolset. The builder extracts internationalized messages from source files, updates <literal>POT</literal> template (if necessary) and then updates <literal>PO</literal> translations (if -necessary). If <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is set, missing <literal>PO</literal> files +necessary). If <link linkend="cv-POAUTOINIT"><envar>$POAUTOINIT</envar></link> is set, missing <literal>PO</literal> files will be automatically created (i.e. without translator person intervention). -The variables <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LINGUAS_FILE"><envar>$LINGUAS_FILE</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> are taken into -acount too. All other construction variables used by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link>, and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> work here too. +The variables <link linkend="cv-LINGUAS_FILE"><envar>$LINGUAS_FILE</envar></link> and <link linkend="cv-POTDOMAIN"><envar>$POTDOMAIN</envar></link> are taken into +acount too. All other construction variables used by <link linkend="b-POTUpdate"><function>POTUpdate</function></link>, and +<link linkend="b-POUpdate"><function>POUpdate</function></link> work here too. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 1</emphasis>. The simplest way is to specify input files and output languages inline in -a SCons script when invoking <function xmlns="http://www.scons.org/dbxsd/v1.0">Translate</function> +a SCons script when invoking <function>Translate</function> </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConscript in 'po/' directory env = Environment( tools = ["default", "gettext"] ) env['POAUTOINIT'] = 1 env.Translate(['en','pl'], ['../a.cpp','../b.cpp']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 2</emphasis>. If you wish, you may also stick to conventional style known from <productname>autotools</productname>, i.e. using <filename>POTFILES.in</filename> and <filename>LINGUAS</filename> files </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # LINGUAS en pl #end </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # POTFILES.in a.cpp b.cpp # end </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConscript env = Environment( tools = ["default", "gettext"] ) env['POAUTOINIT'] = 1 @@ -2604,7 +2395,7 @@ env['XGETTEXTPATH'] = ['../'] env.Translate(LINGUAS_FILE = 1, XGETTEXTFROM = 'POTFILES.in') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The last approach is perhaps the recommended one. It allows easily split internationalization/localization onto separate SCons scripts, where a script in source tree is responsible for translations (from sources to @@ -2621,11 +2412,11 @@ so the source tree looks familiar to translators, and they may work with the project in their usual way. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis>Example 3</emphasis>. Let's prepare a development tree as below </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> project/ + SConstruct + build/ @@ -2636,11 +2427,11 @@ Let's prepare a development tree as below + POTFILES.in + LINGUAS </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> with <filename>build</filename> being variant directory. Write the top-level <filename>SConstruct</filename> script as follows </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # SConstruct env = Environment( tools = ["default", "gettext"] ) VariantDir('build', 'src', duplicate = 0) @@ -2648,23 +2439,23 @@ with <filename>build</filename> being variant directory. Write the top-level SConscript('src/po/SConscript.i18n', exports = 'env') SConscript('build/po/SConscript', exports = 'env') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> the <filename>src/po/SConscript.i18n</filename> as </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # src/po/SConscript.i18n Import('env') env.Translate(LINGUAS_FILE=1, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> and the <filename>src/po/SConscript</filename> </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # src/po/SConscript Import('env') env.MOFiles(LINGUAS_FILE = 1) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Such setup produces <literal>POT</literal> and <literal>PO</literal> files under source tree in <filename>src/po/</filename> and binary <literal>MO</literal> files under variant tree in @@ -2674,7 +2465,7 @@ not be committed back to source repositories (e.g. <literal>MO</literal> files). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <note><para>In above example, the <literal>PO</literal> files are not updated, nor created automatically when you issue <command>scons '.'</command> command. The files must be updated (created) by hand via <command>scons @@ -2685,14 +2476,9 @@ running <command>scons '.'</command>.</para></note> </listitem> </varlistentry> <varlistentry id="b-TypeLibrary"> - <term> - <function>TypeLibrary()</function> - </term> - <term> - <function>env.TypeLibrary()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>TypeLibrary</function>()</term> + <term><parameter>env</parameter>.<methodname>TypeLibrary</methodname>()</term> + <listitem><para> Builds a Windows type library (<filename>.tlb</filename>) file from an input IDL file (<filename>.idl</filename>). In addition, it will build the associated interface stub and @@ -2701,11 +2487,11 @@ naming them according to the base name of the <filename>.idl</filename> file. For example, </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.TypeLibrary(source="foo.idl") </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Will create <filename>foo.tlb</filename>, <filename>foo.h</filename>, <filename>foo_i.c</filename>, @@ -2717,28 +2503,23 @@ files. </listitem> </varlistentry> <varlistentry id="b-Uic"> - <term> - <function>Uic()</function> - </term> - <term> - <function>env.Uic()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Uic</function>()</term> + <term><parameter>env</parameter>.<methodname>Uic</methodname>()</term> + <listitem><para> Builds a header file, an implementation file and a moc file from an ui file. and returns the corresponding nodes in the above order. This builder is only available after using the tool 'qt'. Note: you can specify <filename>.ui</filename> files directly as source -files to the <function xmlns="http://www.scons.org/dbxsd/v1.0">Program</function>, -<function xmlns="http://www.scons.org/dbxsd/v1.0">Library</function> and <function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function> builders +files to the <function>Program</function>, +<function>Library</function> and <function>SharedLibrary</function> builders without using this builder. Using this builder lets you override the standard naming conventions (be careful: prefixes are always prepended to names of built files; if you don't want prefixes, you may set them to ``). -See the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QTDIR"><envar>$QTDIR</envar></link> variable for more information. +See the <link linkend="cv-QTDIR"><envar>$QTDIR</envar></link> variable for more information. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Uic('foo.ui') # -> ['foo.h', 'uic_foo.cc', 'moc_foo.cc'] env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), source = 'foo.ui') # -> ['include/foo.h', 'gen/uicfoo.cc', 'gen/mocfoo.cc'] @@ -2746,19 +2527,14 @@ env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), </listitem> </varlistentry> <varlistentry id="b-Zip"> - <term> - <function>Zip()</function> - </term> - <term> - <function>env.Zip()</function> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Zip</function>()</term> + <term><parameter>env</parameter>.<methodname>Zip</methodname>()</term> + <listitem><para> Builds a zip archive of the specified files and/or directories. Unlike most builder methods, the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Zip</function> +<function>Zip</function> builder method may be called multiple times for a given target; each additional call @@ -2768,11 +2544,11 @@ Any source directories will be scanned for changes to any on-disk files, regardless of whether or not -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> knows about them from other Builder or function calls. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Zip('src.zip', 'src') # Create the stuff.zip file. diff --git a/doc/generated/examples/EnumVariable_map_1.xml b/doc/generated/examples/EnumVariable_map_1.xml index 4380be0..856731e 100644 --- a/doc/generated/examples/EnumVariable_map_1.xml +++ b/doc/generated/examples/EnumVariable_map_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=navy foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=navy foo.o</userinput> cc -o foo.o -c -DCOLOR="blue" foo.c </screen> diff --git a/doc/generated/examples/addmethod_ex1_1.xml b/doc/generated/examples/addmethod_ex1_1.xml index 84dfd20..5cacf9d 100644 --- a/doc/generated/examples/addmethod_ex1_1.xml +++ b/doc/generated/examples/addmethod_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q /</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q /</userinput> cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello" diff --git a/doc/generated/examples/addmethod_ex2_1.xml b/doc/generated/examples/addmethod_ex2_1.xml index 3930341..4d0cb44 100644 --- a/doc/generated/examples/addmethod_ex2_1.xml +++ b/doc/generated/examples/addmethod_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o test_stuff.o -c test_stuff.c cc -o tests/test_stuff test_stuff.o </screen> diff --git a/doc/generated/examples/addmethod_ex2_2.xml b/doc/generated/examples/addmethod_ex2_2.xml index 734da63..7ad282f 100644 --- a/doc/generated/examples/addmethod_ex2_2.xml +++ b/doc/generated/examples/addmethod_ex2_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> rc /nologo /fores.res res.rc cl /Fotest_stuff.obj /c test_stuff.c /nologo link /nologo /OUT:tests\test_stuff.exe test_stuff.obj res.res diff --git a/doc/generated/examples/alias_ex1_1.xml b/doc/generated/examples/alias_ex1_1.xml index 3ee3f1b..d0db114 100644 --- a/doc/generated/examples/alias_ex1_1.xml +++ b/doc/generated/examples/alias_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello" diff --git a/doc/generated/examples/alias_ex2_1.xml b/doc/generated/examples/alias_ex2_1.xml index 3fa7dfd..56cc365 100644 --- a/doc/generated/examples/alias_ex2_1.xml +++ b/doc/generated/examples/alias_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install-bin</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install-bin</userinput> cc -o foo.o -c foo.c cc -o foo foo.o Install file: "foo" as "/usr/bin/foo" diff --git a/doc/generated/examples/buildersbuiltin_ex1_1.xml b/doc/generated/examples/buildersbuiltin_ex1_1.xml index 74cc779..75b365d 100644 --- a/doc/generated/examples/buildersbuiltin_ex1_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> tar -c -f out1.tar file1 file2 tar -c -f out2.tar directory </screen> diff --git a/doc/generated/examples/buildersbuiltin_ex2_1.xml b/doc/generated/examples/buildersbuiltin_ex2_1.xml index 6c66d7b..88abed4 100644 --- a/doc/generated/examples/buildersbuiltin_ex2_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex2_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> tar -c -z -f out.tar.gz directory </screen> diff --git a/doc/generated/examples/buildersbuiltin_ex3_1.xml b/doc/generated/examples/buildersbuiltin_ex3_1.xml index 4d281e5..5cb16d1 100644 --- a/doc/generated/examples/buildersbuiltin_ex3_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex3_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> tar -c -z -f out.tgz directory </screen> diff --git a/doc/generated/examples/buildersbuiltin_ex4_1.xml b/doc/generated/examples/buildersbuiltin_ex4_1.xml index 856f024..e907422 100644 --- a/doc/generated/examples/buildersbuiltin_ex4_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex4_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> zip(["out.zip"], ["file1", "file2"]) </screen> diff --git a/doc/generated/examples/buildersbuiltin_libs_1.xml b/doc/generated/examples/buildersbuiltin_libs_1.xml index 8e1ee49..5b7abd9 100644 --- a/doc/generated/examples/buildersbuiltin_libs_1.xml +++ b/doc/generated/examples/buildersbuiltin_libs_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o goodbye.o -c goodbye.c cc -o hello.o -c hello.c cc -o hello hello.o goodbye.o -L/usr/dir1 -Ldir2 -lfoo1 -lfoo2 diff --git a/doc/generated/examples/buildersbuiltin_libs_2.xml b/doc/generated/examples/buildersbuiltin_libs_2.xml index 41a9c1e..31f3a46 100644 --- a/doc/generated/examples/buildersbuiltin_libs_2.xml +++ b/doc/generated/examples/buildersbuiltin_libs_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fogoodbye.obj /c goodbye.c /nologo cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:hello.exe /LIBPATH:\usr\dir1 /LIBPATH:dir2 foo1.lib foo2.lib hello.obj goodbye.obj diff --git a/doc/generated/examples/builderscommands_ex1_1.xml b/doc/generated/examples/builderscommands_ex1_1.xml index 8782773..470b5a4 100644 --- a/doc/generated/examples/builderscommands_ex1_1.xml +++ b/doc/generated/examples/builderscommands_ex1_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> sed 's/x/y/' < foo.in > foo.out </screen> diff --git a/doc/generated/examples/builderscommands_ex2_1.xml b/doc/generated/examples/builderscommands_ex2_1.xml index 3fc1dde..1593352 100644 --- a/doc/generated/examples/builderscommands_ex2_1.xml +++ b/doc/generated/examples/builderscommands_ex2_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> build(["foo.out"], ["foo.in"]) </screen> diff --git a/doc/generated/examples/builderswriting_MY_EMITTER_1.xml b/doc/generated/examples/builderswriting_MY_EMITTER_1.xml index 0c17d0e..ef831e5 100644 --- a/doc/generated/examples/builderswriting_MY_EMITTER_1.xml +++ b/doc/generated/examples/builderswriting_MY_EMITTER_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> ./my_command file1.input modify1.in > file1.foo ./my_command file2.input modify2.in > file2.foo </screen> diff --git a/doc/generated/examples/builderswriting_ex1_1.xml b/doc/generated/examples/builderswriting_ex1_1.xml index cefcfa2..1c6379a 100644 --- a/doc/generated/examples/builderswriting_ex1_1.xml +++ b/doc/generated/examples/builderswriting_ex1_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> foobuild < file.input > file.foo </screen> diff --git a/doc/generated/examples/builderswriting_ex2_1.xml b/doc/generated/examples/builderswriting_ex2_1.xml index 445dfb0..e86ee7b 100644 --- a/doc/generated/examples/builderswriting_ex2_1.xml +++ b/doc/generated/examples/builderswriting_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> AttributeError: 'SConsEnvironment' object has no attribute 'Program': File "/home/my/project/SConstruct", line 4: env.Program('hello.c') diff --git a/doc/generated/examples/builderswriting_ex3_1.xml b/doc/generated/examples/builderswriting_ex3_1.xml index 2d8bcac..8e107c8 100644 --- a/doc/generated/examples/builderswriting_ex3_1.xml +++ b/doc/generated/examples/builderswriting_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> foobuild < file.input > file.foo cc -o hello.o -c hello.c cc -o hello hello.o diff --git a/doc/generated/examples/builderswriting_ex4_1.xml b/doc/generated/examples/builderswriting_ex4_1.xml index cc71b19..f3ecd43 100644 --- a/doc/generated/examples/builderswriting_ex4_1.xml +++ b/doc/generated/examples/builderswriting_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> foobuild < file1.input > file1.foo foobuild < file2.input > file2.foo </screen> diff --git a/doc/generated/examples/builderswriting_ex5_1.xml b/doc/generated/examples/builderswriting_ex5_1.xml index d0aa83b..e7e9097 100644 --- a/doc/generated/examples/builderswriting_ex5_1.xml +++ b/doc/generated/examples/builderswriting_ex5_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> build_function(["file.foo"], ["file.input"]) </screen> diff --git a/doc/generated/examples/builderswriting_ex6_1.xml b/doc/generated/examples/builderswriting_ex6_1.xml index cefcfa2..1c6379a 100644 --- a/doc/generated/examples/builderswriting_ex6_1.xml +++ b/doc/generated/examples/builderswriting_ex6_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> foobuild < file.input > file.foo </screen> diff --git a/doc/generated/examples/builderswriting_ex7_1.xml b/doc/generated/examples/builderswriting_ex7_1.xml index f14d598..88284fe 100644 --- a/doc/generated/examples/builderswriting_ex7_1.xml +++ b/doc/generated/examples/builderswriting_ex7_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> foobuild file.foo new_target - file.input new_source </screen> diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml index 1c99727..52ad77d 100644 --- a/doc/generated/examples/caching_ex-random_1.xml +++ b/doc/generated/examples/caching_ex-random_1.xml @@ -1,9 +1,8 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f3.o -c f3.c -cc -o f4.o -c f4.c -cc -o f1.o -c f1.c cc -o f2.o -c f2.c +cc -o f1.o -c f1.c cc -o f5.o -c f5.c +cc -o f4.o -c f4.c cc -o prog f1.o f2.o f3.o f4.o f5.o </screen> diff --git a/doc/generated/examples/caching_ex1_1.xml b/doc/generated/examples/caching_ex1_1.xml index 38eaf82..2d65d46 100644 --- a/doc/generated/examples/caching_ex1_1.xml +++ b/doc/generated/examples/caching_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q -c</userinput> diff --git a/doc/generated/examples/caching_ex1_2.xml b/doc/generated/examples/caching_ex1_2.xml index 2f0bcde..1b27272 100644 --- a/doc/generated/examples/caching_ex1_2.xml +++ b/doc/generated/examples/caching_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q -c</userinput> diff --git a/doc/generated/examples/caching_ex1_4.xml b/doc/generated/examples/caching_ex1_4.xml index 922f1b6..c33dd9b 100644 --- a/doc/generated/examples/caching_ex1_4.xml +++ b/doc/generated/examples/caching_ex1_4.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q -c</userinput> diff --git a/doc/generated/examples/caching_ex1_5.xml b/doc/generated/examples/caching_ex1_5.xml index 968727f..b784319 100644 --- a/doc/generated/examples/caching_ex1_5.xml +++ b/doc/generated/examples/caching_ex1_5.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --cache-disable</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --cache-disable</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q -c</userinput> diff --git a/doc/generated/examples/commandline_ARGLIST_1.xml b/doc/generated/examples/commandline_ARGLIST_1.xml index e094bc0..af2d032 100644 --- a/doc/generated/examples/commandline_ARGLIST_1.xml +++ b/doc/generated/examples/commandline_ARGLIST_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q define=FOO</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q define=FOO</userinput> cc -o prog.o -c -DFOO prog.c % <userinput>scons -Q define=FOO define=BAR</userinput> cc -o prog.o -c -DFOO -DBAR prog.c diff --git a/doc/generated/examples/commandline_ARGUMENTS_1.xml b/doc/generated/examples/commandline_ARGUMENTS_1.xml index 6aa4ed2..cd76cfb 100644 --- a/doc/generated/examples/commandline_ARGUMENTS_1.xml +++ b/doc/generated/examples/commandline_ARGUMENTS_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q debug=0</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q debug=0</userinput> cc -o prog.o -c prog.c cc -o prog prog.o % <userinput>scons -Q debug=0</userinput> diff --git a/doc/generated/examples/commandline_AddOption_1.xml b/doc/generated/examples/commandline_AddOption_1.xml index 55df25a..5877f6d 100644 --- a/doc/generated/examples/commandline_AddOption_1.xml +++ b/doc/generated/examples/commandline_AddOption_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -n</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -n</userinput> Install file: "foo.in" as "/usr/bin/foo.in" </screen> diff --git a/doc/generated/examples/commandline_AddOption_2.xml b/doc/generated/examples/commandline_AddOption_2.xml index 7d0b978..3000a43 100644 --- a/doc/generated/examples/commandline_AddOption_2.xml +++ b/doc/generated/examples/commandline_AddOption_2.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -n --prefix=/tmp/install</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -n --prefix=/tmp/install</userinput> Install file: "foo.in" as "/tmp/install/usr/bin/foo.in" </screen> diff --git a/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml b/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml index bd51961..be22abf 100644 --- a/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml +++ b/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> BUILD_TARGETS is ['prog1'] cc -o prog1.o -c prog1.c cc -o prog1 prog1.o diff --git a/doc/generated/examples/commandline_BoolVariable_1.xml b/doc/generated/examples/commandline_BoolVariable_1.xml index e4c1792..481c0a3 100644 --- a/doc/generated/examples/commandline_BoolVariable_1.xml +++ b/doc/generated/examples/commandline_BoolVariable_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=yes foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=yes foo.o</userinput> cc -o foo.o -c -DRELEASE_BUILD=True foo.c </screen> diff --git a/doc/generated/examples/commandline_BoolVariable_2.xml b/doc/generated/examples/commandline_BoolVariable_2.xml index dc1e068..69f8155 100644 --- a/doc/generated/examples/commandline_BoolVariable_2.xml +++ b/doc/generated/examples/commandline_BoolVariable_2.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=t foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=t foo.o</userinput> cc -o foo.o -c -DRELEASE_BUILD=True foo.c </screen> diff --git a/doc/generated/examples/commandline_BoolVariable_3.xml b/doc/generated/examples/commandline_BoolVariable_3.xml index 0750fb5..8d635f7 100644 --- a/doc/generated/examples/commandline_BoolVariable_3.xml +++ b/doc/generated/examples/commandline_BoolVariable_3.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=no foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=no foo.o</userinput> cc -o foo.o -c -DRELEASE_BUILD=False foo.c </screen> diff --git a/doc/generated/examples/commandline_BoolVariable_4.xml b/doc/generated/examples/commandline_BoolVariable_4.xml index 84e4639..c576eee 100644 --- a/doc/generated/examples/commandline_BoolVariable_4.xml +++ b/doc/generated/examples/commandline_BoolVariable_4.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=f foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=f foo.o</userinput> cc -o foo.o -c -DRELEASE_BUILD=False foo.c </screen> diff --git a/doc/generated/examples/commandline_BoolVariable_5.xml b/doc/generated/examples/commandline_BoolVariable_5.xml index 81f1d4e..2a31296 100644 --- a/doc/generated/examples/commandline_BoolVariable_5.xml +++ b/doc/generated/examples/commandline_BoolVariable_5.xml @@ -1,7 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=bad_value foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=bad_value foo.o</userinput> scons: *** Error converting option: RELEASE Invalid value for boolean option: bad_value -File "/home/my/project/SConstruct", line 4, in <module> +File "/home/my/project/SConstruct", line 5, in <module> </screen> diff --git a/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml b/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml index 1812f74..ba270b8 100644 --- a/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml +++ b/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o foo.o -c foo.c cc -o foo foo.o % <userinput>scons -Q bar</userinput> diff --git a/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml b/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml index f92f160..3f9e0fe 100644 --- a/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml +++ b/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... DEFAULT_TARGETS is ['prog1'] scons: done reading SConscript files. diff --git a/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml b/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml index 01e953b..c51626d 100644 --- a/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml +++ b/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... DEFAULT_TARGETS is now ['prog1'] DEFAULT_TARGETS is now ['prog1', 'prog2'] diff --git a/doc/generated/examples/commandline_Default1_1.xml b/doc/generated/examples/commandline_Default1_1.xml index 18008d8..8679e25 100644 --- a/doc/generated/examples/commandline_Default1_1.xml +++ b/doc/generated/examples/commandline_Default1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q</userinput> diff --git a/doc/generated/examples/commandline_Default1_2.xml b/doc/generated/examples/commandline_Default1_2.xml index 0f1a93e..e40c298 100644 --- a/doc/generated/examples/commandline_Default1_2.xml +++ b/doc/generated/examples/commandline_Default1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q .</userinput> cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o cc -o hello.o -c hello.c diff --git a/doc/generated/examples/commandline_Default2_1.xml b/doc/generated/examples/commandline_Default2_1.xml index 606ed67..bb4cd0c 100644 --- a/doc/generated/examples/commandline_Default2_1.xml +++ b/doc/generated/examples/commandline_Default2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o prog1.o -c prog1.c cc -o prog1 prog1.o cc -o prog3.o -c prog3.c diff --git a/doc/generated/examples/commandline_Default3_1.xml b/doc/generated/examples/commandline_Default3_1.xml index d18575c..de93fb6 100644 --- a/doc/generated/examples/commandline_Default3_1.xml +++ b/doc/generated/examples/commandline_Default3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o prog1/foo.o -c prog1/foo.c cc -o prog1/main.o -c prog1/main.c cc -o prog1/main prog1/main.o prog1/foo.o diff --git a/doc/generated/examples/commandline_Default4_1.xml b/doc/generated/examples/commandline_Default4_1.xml index 35e0b10..3c16091 100644 --- a/doc/generated/examples/commandline_Default4_1.xml +++ b/doc/generated/examples/commandline_Default4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> scons: *** No targets specified and no Default() targets found. Stop. Found nothing to build % <userinput>scons -Q .</userinput> diff --git a/doc/generated/examples/commandline_EnumVariable_1.xml b/doc/generated/examples/commandline_EnumVariable_1.xml index d658f69..2178dba 100644 --- a/doc/generated/examples/commandline_EnumVariable_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=red foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=red foo.o</userinput> cc -o foo.o -c -DCOLOR="red" foo.c % <userinput>scons -Q COLOR=blue foo.o</userinput> cc -o foo.o -c -DCOLOR="blue" foo.c diff --git a/doc/generated/examples/commandline_EnumVariable_2.xml b/doc/generated/examples/commandline_EnumVariable_2.xml index a8a18df..65b255b 100644 --- a/doc/generated/examples/commandline_EnumVariable_2.xml +++ b/doc/generated/examples/commandline_EnumVariable_2.xml @@ -1,6 +1,5 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=magenta foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=magenta foo.o</userinput> scons: *** Invalid value for option COLOR: magenta. Valid values are: ('red', 'green', 'blue') -File "/home/my/project/SConstruct", line 5, in <module> +File "/home/my/project/SConstruct", line 6, in <module> </screen> diff --git a/doc/generated/examples/commandline_EnumVariable_ic1_1.xml b/doc/generated/examples/commandline_EnumVariable_ic1_1.xml index db786e5..33f668d 100644 --- a/doc/generated/examples/commandline_EnumVariable_ic1_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_ic1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=Red foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=Red foo.o</userinput> cc -o foo.o -c -DCOLOR="Red" foo.c % <userinput>scons -Q COLOR=BLUE foo.o</userinput> cc -o foo.o -c -DCOLOR="BLUE" foo.c diff --git a/doc/generated/examples/commandline_EnumVariable_ic2_1.xml b/doc/generated/examples/commandline_EnumVariable_ic2_1.xml index 5596608..ef24936 100644 --- a/doc/generated/examples/commandline_EnumVariable_ic2_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_ic2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=Red foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLOR=Red foo.o</userinput> cc -o foo.o -c -DCOLOR="red" foo.c % <userinput>scons -Q COLOR=nAvY foo.o</userinput> cc -o foo.o -c -DCOLOR="blue" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_1.xml b/doc/generated/examples/commandline_ListVariable_1.xml index 6e245a3..f04d1f3 100644 --- a/doc/generated/examples/commandline_ListVariable_1.xml +++ b/doc/generated/examples/commandline_ListVariable_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=red,blue foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=red,blue foo.o</userinput> cc -o foo.o -c -DCOLORS="red blue" foo.c % <userinput>scons -Q COLORS=blue,green,red foo.o</userinput> cc -o foo.o -c -DCOLORS="blue green red" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_2.xml b/doc/generated/examples/commandline_ListVariable_2.xml index b964669..50bc815 100644 --- a/doc/generated/examples/commandline_ListVariable_2.xml +++ b/doc/generated/examples/commandline_ListVariable_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=all foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=all foo.o</userinput> cc -o foo.o -c -DCOLORS="red green blue" foo.c % <userinput>scons -Q COLORS=none foo.o</userinput> cc -o foo.o -c -DCOLORS="" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_3.xml b/doc/generated/examples/commandline_ListVariable_3.xml index ae13d8b..a5e4b89 100644 --- a/doc/generated/examples/commandline_ListVariable_3.xml +++ b/doc/generated/examples/commandline_ListVariable_3.xml @@ -1,7 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=magenta foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q COLORS=magenta foo.o</userinput> scons: *** Error converting option: COLORS Invalid value(s) for option: magenta -File "/home/my/project/SConstruct", line 5, in <module> +File "/home/my/project/SConstruct", line 6, in <module> </screen> diff --git a/doc/generated/examples/commandline_PackageVariable_1.xml b/doc/generated/examples/commandline_PackageVariable_1.xml index b83fd80..daaa696 100644 --- a/doc/generated/examples/commandline_PackageVariable_1.xml +++ b/doc/generated/examples/commandline_PackageVariable_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q foo.o</userinput> cc -o foo.o -c -DPACKAGE="/opt/location" foo.c % <userinput>scons -Q PACKAGE=/usr/local/location foo.o</userinput> cc -o foo.o -c -DPACKAGE="/usr/local/location" foo.c diff --git a/doc/generated/examples/commandline_PathVariable_1.xml b/doc/generated/examples/commandline_PathVariable_1.xml index 81693b9..e995a69 100644 --- a/doc/generated/examples/commandline_PathVariable_1.xml +++ b/doc/generated/examples/commandline_PathVariable_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q foo.o</userinput> cc -o foo.o -c -DCONFIG_FILE="/etc/my_config" foo.c % <userinput>scons -Q CONFIG=/usr/local/etc/other_config foo.o</userinput> scons: `foo.o' is up to date. diff --git a/doc/generated/examples/commandline_PathVariable_2.xml b/doc/generated/examples/commandline_PathVariable_2.xml index 7dde5b1..68a40cb 100644 --- a/doc/generated/examples/commandline_PathVariable_2.xml +++ b/doc/generated/examples/commandline_PathVariable_2.xml @@ -1,6 +1,5 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q CONFIG=/does/not/exist foo.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q CONFIG=/does/not/exist foo.o</userinput> scons: *** Path for option CONFIG does not exist: /does/not/exist -File "/home/my/project/SConstruct", line 6, in <module> +File "/home/my/project/SConstruct", line 5, in <module> </screen> diff --git a/doc/generated/examples/commandline_SCONSFLAGS_1.xml b/doc/generated/examples/commandline_SCONSFLAGS_1.xml index 35e366c..fc54357 100644 --- a/doc/generated/examples/commandline_SCONSFLAGS_1.xml +++ b/doc/generated/examples/commandline_SCONSFLAGS_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/commandline_SetOption_1.xml b/doc/generated/examples/commandline_SetOption_1.xml index bac0cf4..4aedc2e 100644 --- a/doc/generated/examples/commandline_SetOption_1.xml +++ b/doc/generated/examples/commandline_SetOption_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> running with -j 2 scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/commandline_SetOption_2.xml b/doc/generated/examples/commandline_SetOption_2.xml index b00e073..54e214f 100644 --- a/doc/generated/examples/commandline_SetOption_2.xml +++ b/doc/generated/examples/commandline_SetOption_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>export NUM_CPU="4"</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>export NUM_CPU="4"</userinput> % <userinput>scons -Q</userinput> running with -j 4 scons: `.' is up to date. diff --git a/doc/generated/examples/commandline_SetOption_3.xml b/doc/generated/examples/commandline_SetOption_3.xml index df42ff0..2db0d62 100644 --- a/doc/generated/examples/commandline_SetOption_3.xml +++ b/doc/generated/examples/commandline_SetOption_3.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -j 7</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -j 7</userinput> running with -j 7 scons: `.' is up to date. % <userinput>export NUM_CPU="4"</userinput> diff --git a/doc/generated/examples/commandline_UnknownVariables_1.xml b/doc/generated/examples/commandline_UnknownVariables_1.xml index 272a954..ecca75f 100644 --- a/doc/generated/examples/commandline_UnknownVariables_1.xml +++ b/doc/generated/examples/commandline_UnknownVariables_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q NOT_KNOWN=foo</userinput> -Unknown variables: ['NOT_KNOWN'] +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q NOT_KNOWN=foo</userinput> +Unknown variables: dict_keys(['NOT_KNOWN']) </screen> diff --git a/doc/generated/examples/commandline_Variables1_1.xml b/doc/generated/examples/commandline_Variables1_1.xml index 512ae65..2b6ecf8 100644 --- a/doc/generated/examples/commandline_Variables1_1.xml +++ b/doc/generated/examples/commandline_Variables1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=1</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q RELEASE=1</userinput> cc -o bar.o -c -DRELEASE_BUILD=1 bar.c cc -o foo.o -c -DRELEASE_BUILD=1 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/commandline_Variables_Help_1.xml b/doc/generated/examples/commandline_Variables_Help_1.xml index db171eb..9fe588e 100644 --- a/doc/generated/examples/commandline_Variables_Help_1.xml +++ b/doc/generated/examples/commandline_Variables_Help_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -h</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q -h</userinput> RELEASE: Set to 1 to build for release default: 0 diff --git a/doc/generated/examples/commandline_Variables_custom_py_1_1.xml b/doc/generated/examples/commandline_Variables_custom_py_1_1.xml index 4ef4d48..bf31267 100644 --- a/doc/generated/examples/commandline_Variables_custom_py_1_1.xml +++ b/doc/generated/examples/commandline_Variables_custom_py_1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar.o -c -DRELEASE_BUILD=1 bar.c cc -o foo.o -c -DRELEASE_BUILD=1 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/commandline_Variables_custom_py_2_1.xml b/doc/generated/examples/commandline_Variables_custom_py_2_1.xml index 5961d0a..fc07260 100644 --- a/doc/generated/examples/commandline_Variables_custom_py_2_1.xml +++ b/doc/generated/examples/commandline_Variables_custom_py_2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar.o -c -DRELEASE_BUILD=0 bar.c cc -o foo.o -c -DRELEASE_BUILD=0 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/depends_AlwaysBuild_1.xml b/doc/generated/examples/depends_AlwaysBuild_1.xml index 86700fe..e8bafae 100644 --- a/doc/generated/examples/depends_AlwaysBuild_1.xml +++ b/doc/generated/examples/depends_AlwaysBuild_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q</userinput> diff --git a/doc/generated/examples/depends_AlwaysBuild_2.xml b/doc/generated/examples/depends_AlwaysBuild_2.xml index d1bdd6d..501ffa1 100644 --- a/doc/generated/examples/depends_AlwaysBuild_2.xml +++ b/doc/generated/examples/depends_AlwaysBuild_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q hello.o</userinput> diff --git a/doc/generated/examples/depends_Requires_1.xml b/doc/generated/examples/depends_Requires_1.xml index 04bfc35..0a07c01 100644 --- a/doc/generated/examples/depends_Requires_1.xml +++ b/doc/generated/examples/depends_Requires_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o version.o -c version.c cc -o hello.o -c hello.c cc -o hello version.o hello.o diff --git a/doc/generated/examples/depends_ex1_1.xml b/doc/generated/examples/depends_ex1_1.xml index 25355c9..1a94afc 100644 --- a/doc/generated/examples/depends_ex1_1.xml +++ b/doc/generated/examples/depends_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q</userinput> diff --git a/doc/generated/examples/depends_ex1_2.xml b/doc/generated/examples/depends_ex1_2.xml index 09ecc73..0fd2024 100644 --- a/doc/generated/examples/depends_ex1_2.xml +++ b/doc/generated/examples/depends_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q hello</userinput> diff --git a/doc/generated/examples/depends_ex1_3.xml b/doc/generated/examples/depends_ex1_3.xml index 20062df..6bfba52 100644 --- a/doc/generated/examples/depends_ex1_3.xml +++ b/doc/generated/examples/depends_ex1_3.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>touch hello.c</userinput> diff --git a/doc/generated/examples/depends_ex1_4.xml b/doc/generated/examples/depends_ex1_4.xml index 31aa5bd..bae5bd7 100644 --- a/doc/generated/examples/depends_ex1_4.xml +++ b/doc/generated/examples/depends_ex1_4.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % [CHANGE THE CONTENTS OF hello.c] diff --git a/doc/generated/examples/depends_ex1_5.xml b/doc/generated/examples/depends_ex1_5.xml index 776bda2..358bf5b 100644 --- a/doc/generated/examples/depends_ex1_5.xml +++ b/doc/generated/examples/depends_ex1_5.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % [CHANGE A COMMENT IN hello.c] diff --git a/doc/generated/examples/depends_ex1_6.xml b/doc/generated/examples/depends_ex1_6.xml index 7493627..8461234 100644 --- a/doc/generated/examples/depends_ex1_6.xml +++ b/doc/generated/examples/depends_ex1_6.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-cache hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-cache hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q hello</userinput> diff --git a/doc/generated/examples/depends_ex1_7.xml b/doc/generated/examples/depends_ex1_7.xml index 22b56d3..ea9088a 100644 --- a/doc/generated/examples/depends_ex1_7.xml +++ b/doc/generated/examples/depends_ex1_7.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-deps-changed hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-deps-changed hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q hello</userinput> diff --git a/doc/generated/examples/depends_ex1_8.xml b/doc/generated/examples/depends_ex1_8.xml index d60db97..cc4ee6c 100644 --- a/doc/generated/examples/depends_ex1_8.xml +++ b/doc/generated/examples/depends_ex1_8.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-deps-unchanged hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --implicit-deps-unchanged hello</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q hello</userinput> diff --git a/doc/generated/examples/depends_ex5_1.xml b/doc/generated/examples/depends_ex5_1.xml index e81cb0c..37985df 100644 --- a/doc/generated/examples/depends_ex5_1.xml +++ b/doc/generated/examples/depends_ex5_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c -Iinclude -I/home/project/inc hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/depends_ex5_2.xml b/doc/generated/examples/depends_ex5_2.xml index ea78590..460d135 100644 --- a/doc/generated/examples/depends_ex5_2.xml +++ b/doc/generated/examples/depends_ex5_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q hello.exe</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q hello.exe</userinput> cl /Fohello.obj /c hello.c /nologo /Iinclude /I\home\project\inc link /nologo /OUT:hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/depends_ignore_explicit_1.xml b/doc/generated/examples/depends_ignore_explicit_1.xml index a45a852..79ebca2 100644 --- a/doc/generated/examples/depends_ignore_explicit_1.xml +++ b/doc/generated/examples/depends_ignore_explicit_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> scons: `.' is up to date. % <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c diff --git a/doc/generated/examples/depends_include_1.xml b/doc/generated/examples/depends_include_1.xml index e22bd03..987fead 100644 --- a/doc/generated/examples/depends_include_1.xml +++ b/doc/generated/examples/depends_include_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c -I. hello.c cc -o hello hello.o % <userinput>scons -Q hello</userinput> diff --git a/doc/generated/examples/depends_macroinc_1.xml b/doc/generated/examples/depends_macroinc_1.xml index 95d4e0b..d15f4ef 100644 --- a/doc/generated/examples/depends_macroinc_1.xml +++ b/doc/generated/examples/depends_macroinc_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c -I. hello.c cc -o hello hello.o % [CHANGE CONTENTS OF foo.h] diff --git a/doc/generated/examples/depends_match_1.xml b/doc/generated/examples/depends_match_1.xml index 7dc3831..cde65ca 100644 --- a/doc/generated/examples/depends_match_1.xml +++ b/doc/generated/examples/depends_match_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello.o</userinput> cc -o hello.o -c hello.c % <userinput>touch -t 198901010000 hello.c</userinput> % <userinput>scons -Q hello.o</userinput> diff --git a/doc/generated/examples/depends_mixing_1.xml b/doc/generated/examples/depends_mixing_1.xml index 258dc90..30d2527 100644 --- a/doc/generated/examples/depends_mixing_1.xml +++ b/doc/generated/examples/depends_mixing_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o program1.o -c -I. program1.c cc -o prog-MD5 program1.o cc -o program2.o -c -I. program2.c diff --git a/doc/generated/examples/depends_newer_1.xml b/doc/generated/examples/depends_newer_1.xml index 28cb427..b09d0d6 100644 --- a/doc/generated/examples/depends_newer_1.xml +++ b/doc/generated/examples/depends_newer_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello.o</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello.o</userinput> cc -o hello.o -c hello.c % <userinput>touch hello.c</userinput> % <userinput>scons -Q hello.o</userinput> diff --git a/doc/generated/examples/depends_no-Requires_1.xml b/doc/generated/examples/depends_no-Requires_1.xml index 8e2729f..8be3285 100644 --- a/doc/generated/examples/depends_no-Requires_1.xml +++ b/doc/generated/examples/depends_no-Requires_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q hello</userinput> cc -o hello.o -c hello.c cc -o version.o -c version.c cc -o hello hello.o version.o diff --git a/doc/generated/examples/depends_parsedep_1.xml b/doc/generated/examples/depends_parsedep_1.xml index 910930b1..e83eccf 100644 --- a/doc/generated/examples/depends_parsedep_1.xml +++ b/doc/generated/examples/depends_parsedep_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c -MD -MF hello.d -I. hello.c cc -o hello hello.o % [CHANGE CONTENTS OF foo.h] diff --git a/doc/generated/examples/environments_Append-nonexistent_1.xml b/doc/generated/examples/environments_Append-nonexistent_1.xml index bb15965..43b6834 100644 --- a/doc/generated/examples/environments_Append-nonexistent_1.xml +++ b/doc/generated/examples/environments_Append-nonexistent_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> NEW_VARIABLE = added scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/environments_Prepend-nonexistent_1.xml b/doc/generated/examples/environments_Prepend-nonexistent_1.xml index bb15965..43b6834 100644 --- a/doc/generated/examples/environments_Prepend-nonexistent_1.xml +++ b/doc/generated/examples/environments_Prepend-nonexistent_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> NEW_VARIABLE = added scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/environments_Replace-nonexistent_1.xml b/doc/generated/examples/environments_Replace-nonexistent_1.xml index c4480b5..2aba4c8 100644 --- a/doc/generated/examples/environments_Replace-nonexistent_1.xml +++ b/doc/generated/examples/environments_Replace-nonexistent_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> NEW_VARIABLE = xyzzy scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/environments_Replace1_1.xml b/doc/generated/examples/environments_Replace1_1.xml index 54f4976..6fedc45 100644 --- a/doc/generated/examples/environments_Replace1_1.xml +++ b/doc/generated/examples/environments_Replace1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o foo.o -c -DDEFINE2 foo.c cc -o foo foo.o </screen> diff --git a/doc/generated/examples/environments_Replace2_1.xml b/doc/generated/examples/environments_Replace2_1.xml index 9ad257b..61027c8 100644 --- a/doc/generated/examples/environments_Replace2_1.xml +++ b/doc/generated/examples/environments_Replace2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... CCFLAGS = -DDEFINE1 CCFLAGS = -DDEFINE2 diff --git a/doc/generated/examples/environments_ex1_1.xml b/doc/generated/examples/environments_ex1_1.xml index 84d22b8..1c4da07 100644 --- a/doc/generated/examples/environments_ex1_1.xml +++ b/doc/generated/examples/environments_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> gcc -o foo.o -c -O2 foo.c gcc -o foo foo.o </screen> diff --git a/doc/generated/examples/environments_ex2_1.xml b/doc/generated/examples/environments_ex2_1.xml index eb86c9e..acab07b 100644 --- a/doc/generated/examples/environments_ex2_1.xml +++ b/doc/generated/examples/environments_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar.o -c -g bar.c cc -o bar bar.o cc -o foo.o -c -O2 foo.c diff --git a/doc/generated/examples/environments_ex3_1.xml b/doc/generated/examples/environments_ex3_1.xml index 3262302..1c7bce9 100644 --- a/doc/generated/examples/environments_ex3_1.xml +++ b/doc/generated/examples/environments_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> scons: *** Two environments with different actions were specified for the same target: foo.o File "/home/my/project/SConstruct", line 6, in <module> diff --git a/doc/generated/examples/environments_ex4_1.xml b/doc/generated/examples/environments_ex4_1.xml index 286f46f..4eda402 100644 --- a/doc/generated/examples/environments_ex4_1.xml +++ b/doc/generated/examples/environments_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o foo-dbg.o -c -g foo.c cc -o foo-dbg foo-dbg.o cc -o foo-opt.o -c -O2 foo.c diff --git a/doc/generated/examples/environments_ex5_1.xml b/doc/generated/examples/environments_ex5_1.xml index d6f0094..7316a6c 100644 --- a/doc/generated/examples/environments_ex5_1.xml +++ b/doc/generated/examples/environments_ex5_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> gcc -o foo.o -c foo.c gcc -o foo foo.o gcc -o foo-dbg.o -c -g foo.c diff --git a/doc/generated/examples/environments_ex6_1.xml b/doc/generated/examples/environments_ex6_1.xml index af8667f..f6aa4b6 100644 --- a/doc/generated/examples/environments_ex6_1.xml +++ b/doc/generated/examples/environments_ex6_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> CC is: cc scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/environments_ex6b_1.xml b/doc/generated/examples/environments_ex6b_1.xml index 47a499a..0da8d90 100644 --- a/doc/generated/examples/environments_ex6b_1.xml +++ b/doc/generated/examples/environments_ex6b_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> key = OBJSUFFIX, value = .o key = LIBSUFFIX, value = .a key = PROGSUFFIX, value = diff --git a/doc/generated/examples/environments_ex6b_2.xml b/doc/generated/examples/environments_ex6b_2.xml index 73a6d19..d0f20e9 100644 --- a/doc/generated/examples/environments_ex6b_2.xml +++ b/doc/generated/examples/environments_ex6b_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> key = OBJSUFFIX, value = .obj key = LIBSUFFIX, value = .lib key = PROGSUFFIX, value = .exe diff --git a/doc/generated/examples/environments_ex8_1.xml b/doc/generated/examples/environments_ex8_1.xml index 68ebac4..fe3b464 100644 --- a/doc/generated/examples/environments_ex8_1.xml +++ b/doc/generated/examples/environments_ex8_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o foo.o -c -DMY_VALUE -DLAST foo.c cc -o foo foo.o </screen> diff --git a/doc/generated/examples/environments_ex9_1.xml b/doc/generated/examples/environments_ex9_1.xml index 3e31c3f..4d7bfd8 100644 --- a/doc/generated/examples/environments_ex9_1.xml +++ b/doc/generated/examples/environments_ex9_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o foo.o -c -DFIRST -DMY_VALUE foo.c cc -o foo foo.o </screen> diff --git a/doc/generated/examples/environments_missing1_1.xml b/doc/generated/examples/environments_missing1_1.xml index edf136f..56b0ff5 100644 --- a/doc/generated/examples/environments_missing1_1.xml +++ b/doc/generated/examples/environments_missing1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> value is: -><- scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/environments_missing2_1.xml b/doc/generated/examples/environments_missing2_1.xml index ffb308c..5a11ede 100644 --- a/doc/generated/examples/environments_missing2_1.xml +++ b/doc/generated/examples/environments_missing2_1.xml @@ -1,6 +1,5 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> -scons: *** NameError `MISSING' trying to evaluate `$MISSING' +scons: *** NameError `name 'MISSING' is not defined' trying to evaluate `$MISSING' File "/home/my/project/SConstruct", line 3, in <module> </screen> diff --git a/doc/generated/examples/environments_missing3_1.xml b/doc/generated/examples/environments_missing3_1.xml index edf136f..56b0ff5 100644 --- a/doc/generated/examples/environments_missing3_1.xml +++ b/doc/generated/examples/environments_missing3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> value is: -><- scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/factories_Chmod_1.xml b/doc/generated/examples/factories_Chmod_1.xml index a324ed4..04e543c 100644 --- a/doc/generated/examples/factories_Chmod_1.xml +++ b/doc/generated/examples/factories_Chmod_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("file.out", "file.in") Chmod("file.out", 0755) </screen> diff --git a/doc/generated/examples/factories_Copy1_1.xml b/doc/generated/examples/factories_Copy1_1.xml index 852412f..02941a2 100644 --- a/doc/generated/examples/factories_Copy1_1.xml +++ b/doc/generated/examples/factories_Copy1_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("file.out", "file.in") </screen> diff --git a/doc/generated/examples/factories_Copy2_1.xml b/doc/generated/examples/factories_Copy2_1.xml index 852412f..02941a2 100644 --- a/doc/generated/examples/factories_Copy2_1.xml +++ b/doc/generated/examples/factories_Copy2_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("file.out", "file.in") </screen> diff --git a/doc/generated/examples/factories_Copy3_1.xml b/doc/generated/examples/factories_Copy3_1.xml index bcb41ff..224ec79 100644 --- a/doc/generated/examples/factories_Copy3_1.xml +++ b/doc/generated/examples/factories_Copy3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("tempfile", "file.in") modify tempfile Copy("file.out", "tempfile") diff --git a/doc/generated/examples/factories_Delete1_1.xml b/doc/generated/examples/factories_Delete1_1.xml index e9a287e..22b5070 100644 --- a/doc/generated/examples/factories_Delete1_1.xml +++ b/doc/generated/examples/factories_Delete1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Delete("tempfile") Copy("tempfile", "file.in") modify tempfile diff --git a/doc/generated/examples/factories_Delete2_1.xml b/doc/generated/examples/factories_Delete2_1.xml index 2be3c3a..109ed2c 100644 --- a/doc/generated/examples/factories_Delete2_1.xml +++ b/doc/generated/examples/factories_Delete2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Delete("file.out") Copy("file.out", "file.in") </screen> diff --git a/doc/generated/examples/factories_Execute_1.xml b/doc/generated/examples/factories_Execute_1.xml index a7ae0c7..0481396 100644 --- a/doc/generated/examples/factories_Execute_1.xml +++ b/doc/generated/examples/factories_Execute_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... Mkdir("/tmp/my_temp_directory") scons: done reading SConscript files. diff --git a/doc/generated/examples/factories_Mkdir_1.xml b/doc/generated/examples/factories_Mkdir_1.xml index ea3d79d..37c601d 100644 --- a/doc/generated/examples/factories_Mkdir_1.xml +++ b/doc/generated/examples/factories_Mkdir_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Delete("tempdir") Mkdir("tempdir") Copy("tempdir/file.in", "file.in") diff --git a/doc/generated/examples/factories_Move_1.xml b/doc/generated/examples/factories_Move_1.xml index a5e4ccd..a49ecef 100644 --- a/doc/generated/examples/factories_Move_1.xml +++ b/doc/generated/examples/factories_Move_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("tempfile", "file.in") modify tempfile Move("file.out", "tempfile") diff --git a/doc/generated/examples/factories_Touch_1.xml b/doc/generated/examples/factories_Touch_1.xml index 7417fa4..dbc256a 100644 --- a/doc/generated/examples/factories_Touch_1.xml +++ b/doc/generated/examples/factories_Touch_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Copy("file.out", "file.in") Touch("file.out") </screen> diff --git a/doc/generated/examples/fileremoval_clean-ex1_1.xml b/doc/generated/examples/fileremoval_clean-ex1_1.xml index c76a7e5..0d79060 100644 --- a/doc/generated/examples/fileremoval_clean-ex1_1.xml +++ b/doc/generated/examples/fileremoval_clean-ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> build -o foo.out foo.in % <userinput>scons -Q -c</userinput> Removed foo.out diff --git a/doc/generated/examples/fileremoval_noclean-ex1_1.xml b/doc/generated/examples/fileremoval_noclean-ex1_1.xml index 45bd878..bf5e42f 100644 --- a/doc/generated/examples/fileremoval_noclean-ex1_1.xml +++ b/doc/generated/examples/fileremoval_noclean-ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/fileremoval_precious-ex1_1.xml b/doc/generated/examples/fileremoval_precious-ex1_1.xml index 36e5a25..232703f 100644 --- a/doc/generated/examples/fileremoval_precious-ex1_1.xml +++ b/doc/generated/examples/fileremoval_precious-ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/hierarchy_Return_1.xml b/doc/generated/examples/hierarchy_Return_1.xml index e5ab7f7..417780f 100644 --- a/doc/generated/examples/hierarchy_Return_1.xml +++ b/doc/generated/examples/hierarchy_Return_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar/bar.o -c bar/bar.c cc -o foo/foo.o -c foo/foo.c ar rc libprog.a foo/foo.o bar/bar.o diff --git a/doc/generated/examples/hierarchy_ex1_1.xml b/doc/generated/examples/hierarchy_ex1_1.xml index bb5cc7b..c043c4b 100644 --- a/doc/generated/examples/hierarchy_ex1_1.xml +++ b/doc/generated/examples/hierarchy_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o prog1/foo1.o -c prog1/foo1.c cc -o prog1/foo2.o -c prog1/foo2.c cc -o prog1/main.o -c prog1/main.c diff --git a/doc/generated/examples/hierarchy_ex2_1.xml b/doc/generated/examples/hierarchy_ex2_1.xml index 800a921..c6c7401 100644 --- a/doc/generated/examples/hierarchy_ex2_1.xml +++ b/doc/generated/examples/hierarchy_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o lib/foo1.o -c lib/foo1.c cc -o src/prog/foo2.o -c src/prog/foo2.c cc -o src/prog/main.o -c src/prog/main.c diff --git a/doc/generated/examples/hierarchy_ex3_1.xml b/doc/generated/examples/hierarchy_ex3_1.xml index 473c9f4..8c13ee3 100644 --- a/doc/generated/examples/hierarchy_ex3_1.xml +++ b/doc/generated/examples/hierarchy_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o src/prog/foo2.o -c src/prog/foo2.c cc -o src/prog/main.o -c src/prog/main.c cc -o /usr/joe/lib/foo1.o -c /usr/joe/lib/foo1.c diff --git a/doc/generated/examples/install_ex1_1.xml b/doc/generated/examples/install_ex1_1.xml index 776f7e8..30613e2 100644 --- a/doc/generated/examples/install_ex1_1.xml +++ b/doc/generated/examples/install_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q /usr/bin</userinput> diff --git a/doc/generated/examples/install_ex2_1.xml b/doc/generated/examples/install_ex2_1.xml index 98de9c4..2354878 100644 --- a/doc/generated/examples/install_ex2_1.xml +++ b/doc/generated/examples/install_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o % <userinput>scons -Q install</userinput> diff --git a/doc/generated/examples/install_ex3_1.xml b/doc/generated/examples/install_ex3_1.xml index e306111..0396853 100644 --- a/doc/generated/examples/install_ex3_1.xml +++ b/doc/generated/examples/install_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o Install file: "goodbye" as "/usr/bin/goodbye" diff --git a/doc/generated/examples/install_ex4_1.xml b/doc/generated/examples/install_ex4_1.xml index 36cd90c..1bbbf65 100644 --- a/doc/generated/examples/install_ex4_1.xml +++ b/doc/generated/examples/install_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello-new" diff --git a/doc/generated/examples/install_ex5_1.xml b/doc/generated/examples/install_ex5_1.xml index 89f7c56..22c6b01 100644 --- a/doc/generated/examples/install_ex5_1.xml +++ b/doc/generated/examples/install_ex5_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q install</userinput> cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o Install file: "goodbye" as "/usr/bin/goodbye-new" diff --git a/doc/generated/examples/java_JAVACLASSDIR_1.xml b/doc/generated/examples/java_JAVACLASSDIR_1.xml index 5e0709a..75e5f95 100644 --- a/doc/generated/examples/java_JAVACLASSDIR_1.xml +++ b/doc/generated/examples/java_JAVACLASSDIR_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -d native -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 </screen> diff --git a/doc/generated/examples/java_RMIC_1.xml b/doc/generated/examples/java_RMIC_1.xml index 4db895e..16297dc 100644 --- a/doc/generated/examples/java_RMIC_1.xml +++ b/doc/generated/examples/java_RMIC_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java rmic -d outdir -classpath classes pkg.sub.Example1 pkg.sub.Example2 </screen> diff --git a/doc/generated/examples/java_jar1_1.xml b/doc/generated/examples/java_jar1_1.xml index de93227..a88c00a 100644 --- a/doc/generated/examples/java_jar1_1.xml +++ b/doc/generated/examples/java_jar1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java jar cf test.jar classes </screen> diff --git a/doc/generated/examples/java_jar2_1.xml b/doc/generated/examples/java_jar2_1.xml index 9e942e2..c696fbd 100644 --- a/doc/generated/examples/java_jar2_1.xml +++ b/doc/generated/examples/java_jar2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath prog1 prog1/Example1.java prog1/Example2.java javac -d classes -sourcepath prog2 prog2/Example3.java prog2/Example4.java jar cf prog1.jar -C classes Example1.class -C classes Example2.class diff --git a/doc/generated/examples/java_java-classes_1.xml b/doc/generated/examples/java_java-classes_1.xml index 6f02f5f..ce3c9ef 100644 --- a/doc/generated/examples/java_java-classes_1.xml +++ b/doc/generated/examples/java_java-classes_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java % <userinput>scons -Q classes</userinput> scons: `classes' is up to date. diff --git a/doc/generated/examples/java_java-classes_2.xml b/doc/generated/examples/java_java-classes_2.xml index 31f6028..b773402 100644 --- a/doc/generated/examples/java_java-classes_2.xml +++ b/doc/generated/examples/java_java-classes_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java % <userinput>scons -Q -c classes</userinput> Removed classes/Example1.class diff --git a/doc/generated/examples/java_java_1.xml b/doc/generated/examples/java_java_1.xml index 551a5d4..13078eb 100644 --- a/doc/generated/examples/java_java_1.xml +++ b/doc/generated/examples/java_java_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java </screen> diff --git a/doc/generated/examples/java_javah_1.xml b/doc/generated/examples/java_javah_1.xml index 5e0709a..75e5f95 100644 --- a/doc/generated/examples/java_javah_1.xml +++ b/doc/generated/examples/java_javah_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -d native -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 </screen> diff --git a/doc/generated/examples/java_javah_file_1.xml b/doc/generated/examples/java_javah_file_1.xml index 163a53d..018a964 100644 --- a/doc/generated/examples/java_javah_file_1.xml +++ b/doc/generated/examples/java_javah_file_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -o native.h -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 </screen> diff --git a/doc/generated/examples/lesssimple_ex2_1.xml b/doc/generated/examples/lesssimple_ex2_1.xml index 6093f0c..d643101 100644 --- a/doc/generated/examples/lesssimple_ex2_1.xml +++ b/doc/generated/examples/lesssimple_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o prog.o -c prog.c diff --git a/doc/generated/examples/lesssimple_ex3_1.xml b/doc/generated/examples/lesssimple_ex3_1.xml index b3ac2f0..5ff2046 100644 --- a/doc/generated/examples/lesssimple_ex3_1.xml +++ b/doc/generated/examples/lesssimple_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o prog.o -c prog.c diff --git a/doc/generated/examples/lesssimple_ex3_2.xml b/doc/generated/examples/lesssimple_ex3_2.xml index 835f048..753bf7f 100644 --- a/doc/generated/examples/lesssimple_ex3_2.xml +++ b/doc/generated/examples/lesssimple_ex3_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fofile1.obj /c file1.c /nologo cl /Fofile2.obj /c file2.c /nologo cl /Foprog.obj /c prog.c /nologo diff --git a/doc/generated/examples/lesssimple_ex4_1.xml b/doc/generated/examples/lesssimple_ex4_1.xml index 87af41d..26d6167 100644 --- a/doc/generated/examples/lesssimple_ex4_1.xml +++ b/doc/generated/examples/lesssimple_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar1.o -c bar1.c cc -o bar2.o -c bar2.c cc -o bar bar1.o bar2.o diff --git a/doc/generated/examples/lesssimple_ex5_1.xml b/doc/generated/examples/lesssimple_ex5_1.xml index 0043e11..ea9e0e5 100644 --- a/doc/generated/examples/lesssimple_ex5_1.xml +++ b/doc/generated/examples/lesssimple_ex5_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o bar1.o -c bar1.c cc -o bar2.o -c bar2.c cc -o common1.o -c common1.c diff --git a/doc/generated/examples/lesssimple_target_1.xml b/doc/generated/examples/lesssimple_target_1.xml index a958acb..6280522 100644 --- a/doc/generated/examples/lesssimple_target_1.xml +++ b/doc/generated/examples/lesssimple_target_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o new_hello hello.o </screen> diff --git a/doc/generated/examples/lesssimple_target_2.xml b/doc/generated/examples/lesssimple_target_2.xml index ef7b241..a438d35 100644 --- a/doc/generated/examples/lesssimple_target_2.xml +++ b/doc/generated/examples/lesssimple_target_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:new_hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/libraries_SharedLibrary_1.xml b/doc/generated/examples/libraries_SharedLibrary_1.xml index 2300891..ed11d19 100644 --- a/doc/generated/examples/libraries_SharedLibrary_1.xml +++ b/doc/generated/examples/libraries_SharedLibrary_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.os -c f1.c cc -o f2.os -c f2.c cc -o f3.os -c f3.c diff --git a/doc/generated/examples/libraries_SharedLibrary_2.xml b/doc/generated/examples/libraries_SharedLibrary_2.xml index b6b484d..7b752d7 100644 --- a/doc/generated/examples/libraries_SharedLibrary_2.xml +++ b/doc/generated/examples/libraries_SharedLibrary_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex1_1.xml b/doc/generated/examples/libraries_ex1_1.xml index bfd69b4..4a14b5b 100644 --- a/doc/generated/examples/libraries_ex1_1.xml +++ b/doc/generated/examples/libraries_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/libraries_ex1_2.xml b/doc/generated/examples/libraries_ex1_2.xml index 912e7ad..75c4186 100644 --- a/doc/generated/examples/libraries_ex1_2.xml +++ b/doc/generated/examples/libraries_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex2_1.xml b/doc/generated/examples/libraries_ex2_1.xml index c43f7e9..c59edf4 100644 --- a/doc/generated/examples/libraries_ex2_1.xml +++ b/doc/generated/examples/libraries_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/libraries_ex2_2.xml b/doc/generated/examples/libraries_ex2_2.xml index 84b4d75..f590dc8 100644 --- a/doc/generated/examples/libraries_ex2_2.xml +++ b/doc/generated/examples/libraries_ex2_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex3_1.xml b/doc/generated/examples/libraries_ex3_1.xml index 9dd6ca9..f5fd4c8 100644 --- a/doc/generated/examples/libraries_ex3_1.xml +++ b/doc/generated/examples/libraries_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o prog.o -c prog.c cc -o prog prog.o -L/usr/lib -L/usr/local/lib -lm </screen> diff --git a/doc/generated/examples/libraries_ex3_2.xml b/doc/generated/examples/libraries_ex3_2.xml index e5ec4ce..433f7fb 100644 --- a/doc/generated/examples/libraries_ex3_2.xml +++ b/doc/generated/examples/libraries_ex3_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Foprog.obj /c prog.c /nologo link /nologo /OUT:prog.exe /LIBPATH:\usr\lib /LIBPATH:\usr\local\lib m.lib prog.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/libraries_objects_1.xml b/doc/generated/examples/libraries_objects_1.xml index 5d732da..db5d88c 100644 --- a/doc/generated/examples/libraries_objects_1.xml +++ b/doc/generated/examples/libraries_objects_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o f1.o -c f1.c cc -o f3.o -c f3.c ar rc libfoo.a f1.o f2.o f3.o f4.o diff --git a/doc/generated/examples/mergeflags_MergeFlags1_1.xml b/doc/generated/examples/mergeflags_MergeFlags1_1.xml index 8f18fd8..fafefd4 100644 --- a/doc/generated/examples/mergeflags_MergeFlags1_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> ['-option', '-O1', '-whatever', '-O3'] scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/mergeflags_MergeFlags2_1.xml b/doc/generated/examples/mergeflags_MergeFlags2_1.xml index 8cae827..017158a 100644 --- a/doc/generated/examples/mergeflags_MergeFlags2_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> ['/include', '/usr/local/include', '/usr/include', '/usr/opt/include'] scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/mergeflags_MergeFlags3_1.xml b/doc/generated/examples/mergeflags_MergeFlags3_1.xml index d4f23d4..2173cf3 100644 --- a/doc/generated/examples/mergeflags_MergeFlags3_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> ['-option', '-O1', '-whatever', '-O3'] ['/include', '/usr/local/include', '/usr/include', '/usr/opt/include'] scons: `.' is up to date. diff --git a/doc/generated/examples/misc_Exit_1.xml b/doc/generated/examples/misc_Exit_1.xml index 6af378f..5a5e411 100644 --- a/doc/generated/examples/misc_Exit_1.xml +++ b/doc/generated/examples/misc_Exit_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q FUTURE=1</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q FUTURE=1</userinput> The FUTURE option is not supported yet! % <userinput>scons -Q</userinput> cc -o hello.o -c hello.c diff --git a/doc/generated/examples/misc_FindFile1a_1.xml b/doc/generated/examples/misc_FindFile1a_1.xml index eca0328..efa6b7c 100644 --- a/doc/generated/examples/misc_FindFile1a_1.xml +++ b/doc/generated/examples/misc_FindFile1a_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> None <class 'SCons.Node.FS.File'> exists scons: `.' is up to date. diff --git a/doc/generated/examples/misc_FindFile1b_1.xml b/doc/generated/examples/misc_FindFile1b_1.xml index 4b194ce..2ab6acb 100644 --- a/doc/generated/examples/misc_FindFile1b_1.xml +++ b/doc/generated/examples/misc_FindFile1b_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> nonesuch.h : None config.h : config.h private.h : src/include/private.h diff --git a/doc/generated/examples/misc_FindFile1d_1.xml b/doc/generated/examples/misc_FindFile1d_1.xml index 5ab499f..3312c42 100644 --- a/doc/generated/examples/misc_FindFile1d_1.xml +++ b/doc/generated/examples/misc_FindFile1d_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> sub1/multiple sub2/multiple sub3/multiple diff --git a/doc/generated/examples/misc_FindFile2_1.xml b/doc/generated/examples/misc_FindFile2_1.xml index 149c5d5..7302968 100644 --- a/doc/generated/examples/misc_FindFile2_1.xml +++ b/doc/generated/examples/misc_FindFile2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> leaf derived cat > derived leaf diff --git a/doc/generated/examples/misc_FindFile2_2.xml b/doc/generated/examples/misc_FindFile2_2.xml index 149c5d5..7302968 100644 --- a/doc/generated/examples/misc_FindFile2_2.xml +++ b/doc/generated/examples/misc_FindFile2_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> leaf derived cat > derived leaf diff --git a/doc/generated/examples/misc_FindFile3_1.xml b/doc/generated/examples/misc_FindFile3_1.xml index 2c09fed..69cfacf 100644 --- a/doc/generated/examples/misc_FindFile3_1.xml +++ b/doc/generated/examples/misc_FindFile3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> build/leaf scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/misc_Flatten1_1.xml b/doc/generated/examples/misc_Flatten1_1.xml index 54720bb..db574ed 100644 --- a/doc/generated/examples/misc_Flatten1_1.xml +++ b/doc/generated/examples/misc_Flatten1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o prog1.o -c prog1.c cc -o prog2.o -c -DFOO prog2.c cc -o prog1 prog1.o prog2.o diff --git a/doc/generated/examples/misc_Flatten2_1.xml b/doc/generated/examples/misc_Flatten2_1.xml index 66161ec..06b99c3 100644 --- a/doc/generated/examples/misc_Flatten2_1.xml +++ b/doc/generated/examples/misc_Flatten2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> AttributeError: 'NodeList' object has no attribute 'abspath': File "/home/my/project/SConstruct", line 8: print(object_file.abspath) diff --git a/doc/generated/examples/nodes_GetBuildPath_1.xml b/doc/generated/examples/nodes_GetBuildPath_1.xml index 376f65e..50543ab 100644 --- a/doc/generated/examples/nodes_GetBuildPath_1.xml +++ b/doc/generated/examples/nodes_GetBuildPath_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> ['foo.c', 'sub/dir/value'] scons: `.' is up to date. </screen> diff --git a/doc/generated/examples/nodes_ex1_1.xml b/doc/generated/examples/nodes_ex1_1.xml index e7eb8c4..f05281f 100644 --- a/doc/generated/examples/nodes_ex1_1.xml +++ b/doc/generated/examples/nodes_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o goodbye.o -c -DGOODBYE goodbye.c cc -o hello.o -c -DHELLO hello.c cc -o hello hello.o goodbye.o diff --git a/doc/generated/examples/nodes_ex1_2.xml b/doc/generated/examples/nodes_ex1_2.xml index a1ed1fb..3648775 100644 --- a/doc/generated/examples/nodes_ex1_2.xml +++ b/doc/generated/examples/nodes_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fogoodbye.obj /c goodbye.c -DGOODBYE cl /Fohello.obj /c hello.c -DHELLO link /nologo /OUT:hello.exe hello.obj goodbye.obj diff --git a/doc/generated/examples/nodes_exists_1.xml b/doc/generated/examples/nodes_exists_1.xml index a290b1c..f9abc43 100644 --- a/doc/generated/examples/nodes_exists_1.xml +++ b/doc/generated/examples/nodes_exists_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> hello does not exist! cc -o hello.o -c hello.c cc -o hello hello.o diff --git a/doc/generated/examples/nodes_print_1.xml b/doc/generated/examples/nodes_print_1.xml index 11a3f45..0d07e97 100644 --- a/doc/generated/examples/nodes_print_1.xml +++ b/doc/generated/examples/nodes_print_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> The object file is: hello.o The program file is: hello cc -o hello.o -c hello.c diff --git a/doc/generated/examples/nodes_print_2.xml b/doc/generated/examples/nodes_print_2.xml index a62b522..3c66573 100644 --- a/doc/generated/examples/nodes_print_2.xml +++ b/doc/generated/examples/nodes_print_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> The object file is: hello.obj The program file is: hello.exe cl /Fohello.obj /c hello.c /nologo diff --git a/doc/generated/examples/output_Progress-TARGET_1.xml b/doc/generated/examples/output_Progress-TARGET_1.xml index b233c6e..3408cdc 100644 --- a/doc/generated/examples/output_Progress-TARGET_1.xml +++ b/doc/generated/examples/output_Progress-TARGET_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> Evaluating SConstruct Evaluating f1.c Evaluating f1.o diff --git a/doc/generated/examples/output_ex1_1.xml b/doc/generated/examples/output_ex1_1.xml index 535960b..bff25da 100644 --- a/doc/generated/examples/output_ex1_1.xml +++ b/doc/generated/examples/output_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -h</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -h</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_ex2_1.xml b/doc/generated/examples/output_ex2_1.xml index e951c3a..5d02707 100644 --- a/doc/generated/examples/output_ex2_1.xml +++ b/doc/generated/examples/output_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -h</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -h</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_ex2_2.xml b/doc/generated/examples/output_ex2_2.xml index 8dca6c3..5a25472 100644 --- a/doc/generated/examples/output_ex2_2.xml +++ b/doc/generated/examples/output_ex2_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -h</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -h</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_gbf2_1.xml b/doc/generated/examples/output_gbf2_1.xml index c31b41a..267035e 100644 --- a/doc/generated/examples/output_gbf2_1.xml +++ b/doc/generated/examples/output_gbf2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> scons: `.' is up to date. Build succeeded. % <userinput>scons -Q fail=1</userinput> diff --git a/doc/generated/examples/parseflags_ex1_1.xml b/doc/generated/examples/parseflags_ex1_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex1_1.xml +++ b/doc/generated/examples/parseflags_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex1_2.xml b/doc/generated/examples/parseflags_ex1_2.xml index 4c115d0..d9f00a5 100644 --- a/doc/generated/examples/parseflags_ex1_2.xml +++ b/doc/generated/examples/parseflags_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex2_1.xml b/doc/generated/examples/parseflags_ex2_1.xml index da84ee3..0a35925 100644 --- a/doc/generated/examples/parseflags_ex2_1.xml +++ b/doc/generated/examples/parseflags_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> CCFLAGS -whatever cc -o f1.o -c -whatever f1.c cc -o f1 f1.o diff --git a/doc/generated/examples/parseflags_ex3_1.xml b/doc/generated/examples/parseflags_ex3_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex3_1.xml +++ b/doc/generated/examples/parseflags_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex4_1.xml b/doc/generated/examples/parseflags_ex4_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex4_1.xml +++ b/doc/generated/examples/parseflags_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/repositories_CPPPATH3_1.xml b/doc/generated/examples/repositories_CPPPATH3_1.xml index d53ffdb..f983d96 100644 --- a/doc/generated/examples/repositories_CPPPATH3_1.xml +++ b/doc/generated/examples/repositories_CPPPATH3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c -Idir1 -I/r1/dir1 -I/r2/dir1 -Idir2 -I/r1/dir2 -I/r2/dir2 -Idir3 -I/r1/dir3 -I/r2/dir3 hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/repositories_CPPPATH_1.xml b/doc/generated/examples/repositories_CPPPATH_1.xml index 6c5a2d1..30b5d75 100644 --- a/doc/generated/examples/repositories_CPPPATH_1.xml +++ b/doc/generated/examples/repositories_CPPPATH_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c -I. -I/usr/repository1 hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/repositories_ex1_1.xml b/doc/generated/examples/repositories_ex1_1.xml index a21fdc8..efc6d5a 100644 --- a/doc/generated/examples/repositories_ex1_1.xml +++ b/doc/generated/examples/repositories_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/repositories_ex2_1.xml b/doc/generated/examples/repositories_ex2_1.xml index 819c936..e773a8d 100644 --- a/doc/generated/examples/repositories_ex2_1.xml +++ b/doc/generated/examples/repositories_ex2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c /usr/repository1/hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/repositories_ex3_1.xml b/doc/generated/examples/repositories_ex3_1.xml index 76d69cd..c437bb7 100644 --- a/doc/generated/examples/repositories_ex3_1.xml +++ b/doc/generated/examples/repositories_ex3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c /usr/repository2/hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/repositories_ex4_1.xml b/doc/generated/examples/repositories_ex4_1.xml index 8911683..47d9923 100644 --- a/doc/generated/examples/repositories_ex4_1.xml +++ b/doc/generated/examples/repositories_ex4_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>cd /usr/repository1</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>cd /usr/repository1</userinput> % <userinput>scons -Q</userinput> cc -o file1.o -c file1.c cc -o file2.o -c file2.c diff --git a/doc/generated/examples/repositories_quote1_1.xml b/doc/generated/examples/repositories_quote1_1.xml index d2ba624..c503900 100644 --- a/doc/generated/examples/repositories_quote1_1.xml +++ b/doc/generated/examples/repositories_quote1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o hello.o -c -I. -I/usr/repository1 /usr/repository1/hello.c cc -o hello hello.o </screen> diff --git a/doc/generated/examples/separate_builddir_1.xml b/doc/generated/examples/separate_builddir_1.xml index a763172..36d4383 100644 --- a/doc/generated/examples/separate_builddir_1.xml +++ b/doc/generated/examples/separate_builddir_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> hello.c % <userinput>scons -Q</userinput> cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_builddir_sconscript_1.xml b/doc/generated/examples/separate_builddir_sconscript_1.xml index 5694a56..d719829 100644 --- a/doc/generated/examples/separate_builddir_sconscript_1.xml +++ b/doc/generated/examples/separate_builddir_sconscript_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> SConscript hello.c % <userinput>scons -Q</userinput> cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_duplicate0_1.xml b/doc/generated/examples/separate_duplicate0_1.xml index 207c5d7..3c8b642 100644 --- a/doc/generated/examples/separate_duplicate0_1.xml +++ b/doc/generated/examples/separate_duplicate0_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> hello.c % <userinput>scons -Q</userinput> cc -o build/hello.o -c src/hello.c diff --git a/doc/generated/examples/separate_ex1_1.xml b/doc/generated/examples/separate_ex1_1.xml index 5694a56..d719829 100644 --- a/doc/generated/examples/separate_ex1_1.xml +++ b/doc/generated/examples/separate_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> SConscript hello.c % <userinput>scons -Q</userinput> cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_glob_builddir_sconscript_1.xml b/doc/generated/examples/separate_glob_builddir_sconscript_1.xml index 7cdb420..4ff49d5 100644 --- a/doc/generated/examples/separate_glob_builddir_sconscript_1.xml +++ b/doc/generated/examples/separate_glob_builddir_sconscript_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>ls src</userinput> SConscript f1.c f2.c f2.h % <userinput>scons -Q</userinput> cc -o build/f1.o -c build/f1.c diff --git a/doc/generated/examples/sideeffect_parallel_1.xml b/doc/generated/examples/sideeffect_parallel_1.xml index 9478c52..0152803 100644 --- a/doc/generated/examples/sideeffect_parallel_1.xml +++ b/doc/generated/examples/sideeffect_parallel_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> echo > file1.out data1 echo > file2.out data2 </screen> diff --git a/doc/generated/examples/sideeffect_shared_1.xml b/doc/generated/examples/sideeffect_shared_1.xml index 2abb806..355578a 100644 --- a/doc/generated/examples/sideeffect_shared_1.xml +++ b/doc/generated/examples/sideeffect_shared_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> ./build --log logfile.txt file1.in file1.out ./build --log logfile.txt file2.in file2.out </screen> diff --git a/doc/generated/examples/sideeffect_simple_1.xml b/doc/generated/examples/sideeffect_simple_1.xml index e88630c..ed97594 100644 --- a/doc/generated/examples/sideeffect_simple_1.xml +++ b/doc/generated/examples/sideeffect_simple_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --jobs=2</userinput> File "/home/my/project/SConstruct", line 4 'echo >$TARGET data1; echo >log updated file1')) diff --git a/doc/generated/examples/simple_Object_1.xml b/doc/generated/examples/simple_Object_1.xml index 6d5c80d..0dfb85a 100644 --- a/doc/generated/examples/simple_Object_1.xml +++ b/doc/generated/examples/simple_Object_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_Object_2.xml b/doc/generated/examples/simple_Object_2.xml index 3686006..b7dea0c 100644 --- a/doc/generated/examples/simple_Object_2.xml +++ b/doc/generated/examples/simple_Object_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_clean_1.xml b/doc/generated/examples/simple_clean_1.xml index 21adbe7..c15ec25 100644 --- a/doc/generated/examples/simple_clean_1.xml +++ b/doc/generated/examples/simple_clean_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_clean_2.xml b/doc/generated/examples/simple_clean_2.xml index 26f3c37..7e3d564 100644 --- a/doc/generated/examples/simple_clean_2.xml +++ b/doc/generated/examples/simple_clean_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_declarative_1.xml b/doc/generated/examples/simple_declarative_1.xml index 01061cf..da29097 100644 --- a/doc/generated/examples/simple_declarative_1.xml +++ b/doc/generated/examples/simple_declarative_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... Calling Program('hello.c') Calling Program('goodbye.c') diff --git a/doc/generated/examples/simple_ex1_1.xml b/doc/generated/examples/simple_ex1_1.xml index 5833ede..f645a2a 100644 --- a/doc/generated/examples/simple_ex1_1.xml +++ b/doc/generated/examples/simple_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_2.xml b/doc/generated/examples/simple_ex1_2.xml index f0e07a1..518b437 100644 --- a/doc/generated/examples/simple_ex1_2.xml +++ b/doc/generated/examples/simple_ex1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_3.xml b/doc/generated/examples/simple_ex1_3.xml index f0e07a1..518b437 100644 --- a/doc/generated/examples/simple_ex1_3.xml +++ b/doc/generated/examples/simple_ex1_3.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_4.xml b/doc/generated/examples/simple_ex1_4.xml index 80c7b63..eb10a06 100644 --- a/doc/generated/examples/simple_ex1_4.xml +++ b/doc/generated/examples/simple_ex1_4.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q</userinput> cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/simple_java_1.xml b/doc/generated/examples/simple_java_1.xml index 75cc6cc..decf1b5 100644 --- a/doc/generated/examples/simple_java_1.xml +++ b/doc/generated/examples/simple_java_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/tasks_ex1_1.xml b/doc/generated/examples/tasks_ex1_1.xml index 4885fde..0bbbae1 100644 --- a/doc/generated/examples/tasks_ex1_1.xml +++ b/doc/generated/examples/tasks_ex1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cat < test.bar > test.h cc -o app main.cpp cat < foo.bar2 > foo.cpp diff --git a/doc/generated/examples/troubleshoot_Dump_1.xml b/doc/generated/examples/troubleshoot_Dump_1.xml index 1f6f250..513babe 100644 --- a/doc/generated/examples/troubleshoot_Dump_1.xml +++ b/doc/generated/examples/troubleshoot_Dump_1.xml @@ -1,7 +1,8 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstall': <function InstallBuilderWrapper at 0x700000>, '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, +{ 'BUILDERS': { '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, + '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>, + '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>}, 'CONFIGUREDIR': '#/.sconf_temp', 'CONFIGURELOG': '#/config.log', 'CPPSUFFIXES': [ '.c', @@ -27,7 +28,7 @@ scons: Reading SConscript files ... 'DSUFFIXES': ['.d'], 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, - 'ENV': { 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}, + 'ENV': {'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}, 'ESCAPE': <function escape at 0x700000>, 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'HOST_ARCH': None, @@ -60,9 +61,12 @@ scons: Reading SConscript files ... 'TEMPFILEARGJOIN': ' ', 'TEMPFILEPREFIX': '@', 'TOOLS': ['install', 'install'], - '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, __env__)}', - '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', - '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', + '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, ' + '__env__)}', + '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, ' + 'TARGET, SOURCE)} $)', + '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, ' + 'RDirs, TARGET, SOURCE)} $)', '_LIBFLAGS': '${_concat(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, __env__)}', '__DRPATH': '$_DRPATH', '__DSHLIBVERSIONFLAGS': '${__libversionflags(__env__,"DSHLIBVERSION","_DSHLIBVERSIONFLAGS")}', diff --git a/doc/generated/examples/troubleshoot_Dump_2.xml b/doc/generated/examples/troubleshoot_Dump_2.xml index 4b8aa0b..357ecfd 100644 --- a/doc/generated/examples/troubleshoot_Dump_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_2.xml @@ -1,11 +1,18 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, 'Object': <SCons.Builder.CompositeBuilder object at 0x700000>, 'PCH': <SCons.Builder.BuilderBase object at 0x700000>, 'RES': <SCons.Builder.BuilderBase object at 0x700000>, 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000>, 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, +{ 'BUILDERS': { 'Object': <SCons.Builder.CompositeBuilder object at 0x700000>, + 'PCH': <SCons.Builder.BuilderBase object at 0x700000>, + 'RES': <SCons.Builder.BuilderBase object at 0x700000>, + 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000>, + 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000>, + '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, + '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>, + '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>}, 'CC': 'cl', 'CCCOM': <SCons.Action.FunctionAction object at 0x700000>, 'CCFLAGS': ['/nologo'], - 'CCPCHFLAGS': ['${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) or ""}'], + 'CCPCHFLAGS': [ '${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) ' + 'or ""}'], 'CCPDBFLAGS': ['${(PDB and "/Z7") or ""}'], 'CFILESUFFIX': '.c', 'CFLAGS': [], @@ -34,7 +41,8 @@ scons: Reading SConscript files ... '.SPP', '.sx'], 'CXX': '$CC', - 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS $CCFLAGS $_CCCOMCOM","$CXXCOMSTR")}', + 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS ' + '$CCFLAGS $_CCCOMCOM","$CXXCOMSTR")}', 'CXXFILESUFFIX': '.cc', 'CXXFLAGS': ['$(', '/TP', '$)'], 'DSUFFIXES': ['.d'], @@ -61,7 +69,9 @@ scons: Reading SConscript files ... 'MSVC_SETUP_RUN': True, 'OBJPREFIX': '', 'OBJSUFFIX': '.obj', - 'PCHCOM': '$CXX /Fo${TARGETS[1]} $CXXFLAGS $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS /c $SOURCES /Yc$PCHSTOP /Fp${TARGETS[0]} $CCPDBFLAGS $PCHPDBFLAGS', + 'PCHCOM': '$CXX /Fo${TARGETS[1]} $CXXFLAGS $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS ' + '$_CPPINCFLAGS /c $SOURCES /Yc$PCHSTOP /Fp${TARGETS[0]} ' + '$CCPDBFLAGS $PCHPDBFLAGS', 'PCHPDBFLAGS': ['${(PDB and "/Yd") or ""}'], 'PLATFORM': 'win32', 'PROGPREFIX': '', @@ -78,9 +88,10 @@ scons: Reading SConscript files ... 'SHCCFLAGS': ['$CCFLAGS'], 'SHCFLAGS': ['$CFLAGS'], 'SHCXX': '$CXX', - 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', + 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES ' + '$SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', 'SHCXXFLAGS': ['$CXXFLAGS'], - 'SHELL': None, + 'SHELL': 'command', 'SHLIBPREFIX': '', 'SHLIBSUFFIX': '.dll', 'SHOBJPREFIX': '$OBJPREFIX', @@ -93,10 +104,14 @@ scons: Reading SConscript files ... 'TEMPFILEARGJOIN': '\n', 'TEMPFILEPREFIX': '@', 'TOOLS': ['msvc', 'install', 'install'], + 'VSWHERE': None, '_CCCOMCOM': '$CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $CCPCHFLAGS $CCPDBFLAGS', - '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, __env__)}', - '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', - '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', + '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, ' + '__env__)}', + '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, ' + 'TARGET, SOURCE)} $)', + '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, ' + 'RDirs, TARGET, SOURCE)} $)', '_LIBFLAGS': '${_concat(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, __env__)}', '_MSVC_OUTPUT_FLAG': <function msvc_output_flag at 0x700000>, '__DSHLIBVERSIONFLAGS': '${__libversionflags(__env__,"DSHLIBVERSION","_DSHLIBVERSIONFLAGS")}', diff --git a/doc/generated/examples/troubleshoot_Dump_ENV_1.xml b/doc/generated/examples/troubleshoot_Dump_ENV_1.xml index 786491f..7ed4d86 100644 --- a/doc/generated/examples/troubleshoot_Dump_ENV_1.xml +++ b/doc/generated/examples/troubleshoot_Dump_ENV_1.xml @@ -1,7 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons</userinput> scons: Reading SConscript files ... -{ 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'} +{'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'} scons: done reading SConscript files. scons: Building targets ... scons: `.' is up to date. diff --git a/doc/generated/examples/troubleshoot_Dump_ENV_2.xml b/doc/generated/examples/troubleshoot_Dump_ENV_2.xml index b91c31c..e421f6a 100644 --- a/doc/generated/examples/troubleshoot_Dump_ENV_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_ENV_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons</userinput> scons: Reading SConscript files ... { 'PATH': 'C:\\WINDOWS\\System32:/usr/bin', 'PATHEXT': '.COM;.EXE;.BAT;.CMD', diff --git a/doc/generated/examples/troubleshoot_explain1_1.xml b/doc/generated/examples/troubleshoot_explain1_1.xml index 2a9547d..c73e5ac 100644 --- a/doc/generated/examples/troubleshoot_explain1_1.xml +++ b/doc/generated/examples/troubleshoot_explain1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cp file.in file.oout % <userinput>scons -Q</userinput> cp file.in file.oout diff --git a/doc/generated/examples/troubleshoot_explain1_2.xml b/doc/generated/examples/troubleshoot_explain1_2.xml index 9864cd7..77eb88b 100644 --- a/doc/generated/examples/troubleshoot_explain1_2.xml +++ b/doc/generated/examples/troubleshoot_explain1_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=explain</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=explain</userinput> scons: building `file.out' because it doesn't exist cp file.in file.oout </screen> diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml index ebc13f8..f927648 100644 --- a/doc/generated/examples/troubleshoot_explain1_3.xml +++ b/doc/generated/examples/troubleshoot_explain1_3.xml @@ -1,7 +1,6 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --warn=target-not-built</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --warn=target-not-built</userinput> cp file.in file.oout scons: warning: Cannot find target file.out after building -File "/home/bdeegan/devel/scons/git/as_scons/src/script/scons.py", line 204, in <module> +File "/home/mats/github/scons/scripts/scons.py", line 96, in <module> </screen> diff --git a/doc/generated/examples/troubleshoot_explain2_1.xml b/doc/generated/examples/troubleshoot_explain2_1.xml index cd95a44..80fefda 100644 --- a/doc/generated/examples/troubleshoot_explain2_1.xml +++ b/doc/generated/examples/troubleshoot_explain2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o file3.o -c file3.c diff --git a/doc/generated/examples/troubleshoot_explain3_1.xml b/doc/generated/examples/troubleshoot_explain3_1.xml index bacb7e8..4fde5ac 100644 --- a/doc/generated/examples/troubleshoot_explain3_1.xml +++ b/doc/generated/examples/troubleshoot_explain3_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> cc -o file1.o -c -I. file1.c cc -o file2.o -c -I. file2.c cc -o file3.o -c -I. file3.c diff --git a/doc/generated/examples/troubleshoot_findlibs_1.xml b/doc/generated/examples/troubleshoot_findlibs_1.xml index 8fc4e5f..9fddc2b 100644 --- a/doc/generated/examples/troubleshoot_findlibs_1.xml +++ b/doc/generated/examples/troubleshoot_findlibs_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=findlibs</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=findlibs</userinput> findlibs: looking for 'libfoo.a' in 'libs1' ... findlibs: ... FOUND 'libfoo.a' in 'libs1' findlibs: looking for 'libfoo.so' in 'libs1' ... diff --git a/doc/generated/examples/troubleshoot_stacktrace_1.xml b/doc/generated/examples/troubleshoot_stacktrace_1.xml index cc3ca7b..464eca5 100644 --- a/doc/generated/examples/troubleshoot_stacktrace_1.xml +++ b/doc/generated/examples/troubleshoot_stacktrace_1.xml @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput> scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'. </screen> diff --git a/doc/generated/examples/troubleshoot_stacktrace_2.xml b/doc/generated/examples/troubleshoot_stacktrace_2.xml index 7ace0ec..79cf5b5 100644 --- a/doc/generated/examples/troubleshoot_stacktrace_2.xml +++ b/doc/generated/examples/troubleshoot_stacktrace_2.xml @@ -1,12 +1,12 @@ <screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=stacktrace</userinput> scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'. scons: internal stack trace: - File "src/engine/SCons/Job.py", line 199, in start + File "SCons/Job.py", line 199, in start task.prepare() - File "src/engine/SCons/Script/Main.py", line 189, in prepare + File "SCons/Script/Main.py", line 189, in prepare return SCons.Taskmaster.OutOfDateTask.prepare(self) - File "src/engine/SCons/Taskmaster.py", line 196, in prepare + File "SCons/Taskmaster.py", line 196, in prepare executor.prepare() - File "src/engine/SCons/Executor.py", line 429, in prepare + File "SCons/Executor.py", line 429, in prepare raise SCons.Errors.StopError(msg % (s, self.batches[0].targets[0])) </screen> diff --git a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml index 578951d..cfa2c8b 100644 --- a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml +++ b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --taskmastertrace=- prog</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --taskmastertrace=- prog</userinput> Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <no_state 0 'prog'> and its children: diff --git a/doc/generated/examples/troubleshoot_tree1_1.xml b/doc/generated/examples/troubleshoot_tree1_1.xml index 4ccadc6..0f3c3c8 100644 --- a/doc/generated/examples/troubleshoot_tree1_1.xml +++ b/doc/generated/examples/troubleshoot_tree1_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=all</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=all</userinput> cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/troubleshoot_tree2_1.xml b/doc/generated/examples/troubleshoot_tree2_1.xml index 85febf5..e7e2d5d 100644 --- a/doc/generated/examples/troubleshoot_tree2_1.xml +++ b/doc/generated/examples/troubleshoot_tree2_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=all</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=all</userinput> cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/troubleshoot_tree2_2.xml b/doc/generated/examples/troubleshoot_tree2_2.xml index 5380fad..c2f0e64 100644 --- a/doc/generated/examples/troubleshoot_tree2_2.xml +++ b/doc/generated/examples/troubleshoot_tree2_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=prune</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --tree=prune</userinput> cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/variants_ex_1.xml b/doc/generated/examples/variants_ex_1.xml index 12a14d6..b51655c 100644 --- a/doc/generated/examples/variants_ex_1.xml +++ b/doc/generated/examples/variants_ex_1.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q OS=linux</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q OS=linux</userinput> Install file: "build/linux/world/world.h" as "export/linux/include/world.h" cc -o build/linux/hello/hello.o -c -Iexport/linux/include build/linux/hello/hello.c cc -o build/linux/world/world.o -c -Iexport/linux/include build/linux/world/world.c diff --git a/doc/generated/examples/variants_ex_2.xml b/doc/generated/examples/variants_ex_2.xml index c129cc4..22385e3 100644 --- a/doc/generated/examples/variants_ex_2.xml +++ b/doc/generated/examples/variants_ex_2.xml @@ -1,5 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> -<screen 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 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q OS=windows</userinput> +<screen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">C:\><userinput>scons -Q OS=windows</userinput> Install file: "build/windows/world/world.h" as "export/windows/include/world.h" cl /Fobuild\windows\hello\hello.obj /c build\windows\hello\hello.c /nologo /Iexport\windows\include cl /Fobuild\windows\world\world.obj /c build\windows\world\world.c /nologo /Iexport\windows\include diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index d71387e..5dc356e 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,16 +11,11 @@ %variables-mod; ]> -<variablelist 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 http://www.scons.org/dbxsd/v1.0/scons.xsd"> +<variablelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <varlistentry id="f-Action"> - <term> - <literal>Action(action, [cmd/str/fun, [var, ...]] [option=value, ...])</literal> - </term> - <term> - <literal>env.Action(action, [cmd/str/fun, [var, ...]] [option=value, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Action</function>(<parameter>action, [cmd/str/fun, [var, ...]] [option=value, ...]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Action</methodname>(<parameter>action, [cmd/str/fun, [var, ...]] [option=value, ...]</parameter>)</term> + <listitem><para> Creates an Action object for the specified <varname>action</varname>. @@ -29,7 +23,7 @@ See the manpage section "Action Objects" for a complete explanation of the arguments and behavior. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the <function>env.Action</function>() form of the invocation will expand @@ -50,14 +44,9 @@ until the Action object is actually used. </listitem> </varlistentry> <varlistentry id="f-AddMethod"> - <term> - <literal>AddMethod(object, function, [name])</literal> - </term> - <term> - <literal>env.AddMethod(function, [name])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AddMethod</function>(<parameter>object, function, [name]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>AddMethod</methodname>(<parameter>function, [name]</parameter>)</term> + <listitem><para> When called with the <function>AddMethod</function>() form, @@ -86,11 +75,11 @@ specified itself is used for the method name. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Note that the first argument to the function to # be attached as a method must be the object through # which the method will be called; the Python @@ -113,11 +102,8 @@ env.other_method_name('another arg') </listitem> </varlistentry> <varlistentry id="f-AddOption"> - <term> - <literal>AddOption(arguments)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AddOption</function>(<parameter>arguments</parameter>)</term> + <listitem><para> This function adds a new command-line option to be recognized. The specified <varname>arguments</varname> @@ -129,12 +115,12 @@ see the documentation for for a thorough discussion of its option-processing capabities. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> In addition to the arguments and values supported by the <function>optparse.add_option</function>() method, the SCons -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +<function>AddOption</function> function allows you to set the <literal>nargs</literal> keyword value to @@ -146,7 +132,7 @@ argument. When <literal>nargs = '?'</literal> is passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +<function>AddOption</function> function, the <literal>const</literal> keyword argument @@ -156,29 +142,29 @@ option is specified on the command line without an explicit argument. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If no <literal>default=</literal> keyword argument is supplied when calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>, +<function>AddOption</function>, the option will have a default value of <literal>None</literal>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Unlike regular <emphasis>optparse</emphasis>, option names added via <function>AddOption</function> must be matched exactly, the automatic matching of abbreviations on the command line for long options is not supported. To allow specific abbreviations, -include them in the <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> call. +include them in the <function>AddOption</function> call. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Once a new command-line option has been added with -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>, +<function>AddOption</function>, the option value may be accessed using -<function xmlns="http://www.scons.org/dbxsd/v1.0">GetOption</function> +<function>GetOption</function> or <function>env.GetOption</function>(). <!-- @@ -194,11 +180,11 @@ value specified on the command line will <emphasis>always</emphasis> override a value set by any SConscript file. --> -<function xmlns="http://www.scons.org/dbxsd/v1.0">SetOption</function> is not currently supported for -options added with <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>. +<function>SetOption</function> is not currently supported for +options added with <function>AddOption</function>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any specified <literal>help=</literal> strings for the new option(s) @@ -210,22 +196,22 @@ options (the latter only if no other help text is specified in the SConscript files). The help text for the local options specified by -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +<function>AddOption</function> will appear below the SCons options themselves, under a separate <literal>Local Options</literal> heading. The options will appear in the help text in the order in which the -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +<function>AddOption</function> calls occur. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> AddOption('--prefix', dest='prefix', nargs=1, type='string', @@ -235,12 +221,12 @@ AddOption('--prefix', env = Environment(PREFIX = GetOption('prefix')) </example_commands> -<note xmlns="http://www.scons.org/dbxsd/v1.0"> +<note> <para> -While <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> behaves like +While <function>AddOption</function> behaves like <function>add_option</function>, from the <emphasis>optparse</emphasis> module, -the behavior of options added by <function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +the behavior of options added by <function>AddOption</function> which take arguments is underfined in <command>scons</command> if whitespace (rather than an <literal>=</literal> sign) is used as @@ -253,14 +239,9 @@ Such usage should be avoided. </listitem> </varlistentry> <varlistentry id="f-AddPostAction"> - <term> - <literal>AddPostAction(target, action)</literal> - </term> - <term> - <literal>env.AddPostAction(target, action)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AddPostAction</function>(<parameter>target, action</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>AddPostAction</methodname>(<parameter>target, action</parameter>)</term> + <listitem><para> Arranges for the specified <varname>action</varname> to be performed @@ -274,7 +255,7 @@ See the manpage section "Action Objects" for a complete explanation. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> When multiple targets are supplied, the action may be called multiple times, once after each action that generates @@ -283,14 +264,9 @@ one or more targets in the list. </listitem> </varlistentry> <varlistentry id="f-AddPreAction"> - <term> - <literal>AddPreAction(target, action)</literal> - </term> - <term> - <literal>env.AddPreAction(target, action)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AddPreAction</function>(<parameter>target, action</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>AddPreAction</methodname>(<parameter>target, action</parameter>)</term> + <listitem><para> Arranges for the specified <varname>action</varname> to be performed @@ -304,14 +280,14 @@ See the manpage section "Action Objects" for a complete explanation. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> When multiple targets are specified, the action(s) may be called multiple times, once before each action that generates one or more targets in the list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that if any of the targets are built in multiple steps, the action will be invoked just before the "final" action that specifically @@ -322,16 +298,16 @@ from a specified source file via an intermediate object file: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> foo = Program('foo.c') AddPreAction(foo, 'pre_action') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The specified <literal>pre_action</literal> would be executed before -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> calls the link command that actually generates the executable program binary <filename>foo</filename>, @@ -342,14 +318,9 @@ file into an object file. </listitem> </varlistentry> <varlistentry id="f-Alias"> - <term> - <literal>Alias(alias, [targets, [action]])</literal> - </term> - <term> - <literal>env.Alias(alias, [targets, [action]])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Alias</function>(<parameter>alias, [targets, [action]]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Alias</methodname>(<parameter>alias, [targets, [action]]</parameter>)</term> + <listitem><para> Creates one or more phony targets that expand to one or more other targets. An optional @@ -363,17 +334,19 @@ which exists outside of any file system. This Node object, or the alias name, may be used as a dependency of any other target, including another alias. -<function xmlns="http://www.scons.org/dbxsd/v1.0">Alias</function> +<function>Alias</function> can be called multiple times for the same alias to add additional targets to the alias, or additional actions to the list for this alias. +Aliases are global even if set through +the construction environment method. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Alias('install') Alias('install', '/usr/bin') Alias(['install', 'install-lib'], '/usr/local/lib') @@ -386,11 +359,8 @@ env.Alias('update', ['file1', 'file2'], "update_database $SOURCES") </listitem> </varlistentry> <varlistentry id="f-AllowSubstExceptions"> - <term> - <literal>AllowSubstExceptions([exception, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AllowSubstExceptions</function>(<parameter>[exception, ...]</parameter>)</term> + <listitem><para> Specifies the exceptions that will be allowed when expanding construction variables. By default, @@ -400,25 +370,25 @@ or <literal>IndexError</literal> exception will expand to a <literal>''</literal> -(a null string) and not cause scons to fail. +(an empty string) and not cause scons to fail. All exceptions not in the specified list will generate an error message and terminate processing. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If -<function xmlns="http://www.scons.org/dbxsd/v1.0">AllowSubstExceptions</function> +<function>AllowSubstExceptions</function> is called multiple times, each call completely overwrites the previous list of allowed exceptions. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Requires that all construction variable names exist. # (You may wish to do this if you want to enforce strictly # that all construction variables must be defined before use.) @@ -431,20 +401,15 @@ AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) </listitem> </varlistentry> <varlistentry id="f-AlwaysBuild"> - <term> - <literal>AlwaysBuild(target, ...)</literal> - </term> - <term> - <literal>env.AlwaysBuild(target, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>AlwaysBuild</function>(<parameter>target, ...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>AlwaysBuild</methodname>(<parameter>target, ...</parameter>)</term> + <listitem><para> Marks each given <varname>target</varname> so that it is always assumed to be out of date, and will always be rebuilt if needed. Note, however, that -<function xmlns="http://www.scons.org/dbxsd/v1.0">AlwaysBuild</function> +<function>AlwaysBuild</function> does not add its target(s) to the default target list, so the targets will only be built if they are specified on the command line, @@ -453,16 +418,13 @@ they will <emphasis>always</emphasis> be built if so specified. Multiple targets can be passed in to a single call to -<function xmlns="http://www.scons.org/dbxsd/v1.0">AlwaysBuild</function>. +<function>AlwaysBuild</function>. </para> </listitem> </varlistentry> <varlistentry id="f-Append"> - <term> - <literal>env.Append(key=val, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Append</methodname>(<parameter>key=val, [...]</parameter>)</term> + <listitem><para> Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -475,24 +437,21 @@ Otherwise, the construction variable and the value of the keyword argument are both coerced to lists, and the lists are added together. -(See also the <function xmlns="http://www.scons.org/dbxsd/v1.0">Prepend</function> method). +(See also the <function>Prepend</function> method). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Append(CCFLAGS = ' -g', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> <varlistentry id="f-AppendENVPath"> - <term> - <literal>env.AppendENVPath(name, newpath, [envname, sep, delete_existing])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>AppendENVPath</methodname>(<parameter>name, newpath, [envname, sep, delete_existing]</parameter>)</term> + <listitem><para> This appends new path elements to the given path in the specified external environment (<literal>ENV</literal> @@ -510,18 +469,18 @@ case where the given old path variable is a list instead of a string, in which case a list will be returned instead of a string. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>delete_existing</varname> is 0, then adding a path that already exists will not move it to the end; it will stay where it is in the list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> print 'before:',env['ENV']['INCLUDE'] include_path = '/foo/bar:/foo' env.AppendENVPath('INCLUDE', include_path) @@ -534,11 +493,8 @@ after: /biz:/foo/bar:/foo </listitem> </varlistentry> <varlistentry id="f-AppendUnique"> - <term> - <literal>env.AppendUnique(key=val, [...], delete_existing=0)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>AppendUnique</methodname>(<parameter>key=val, [...], delete_existing=0</parameter>)</term> + <listitem><para> Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -554,24 +510,19 @@ existing matching values are removed first, so existing values in the arg list move to the end of the list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> <varlistentry id="f-Builder"> - <term> - <literal>Builder(action, [arguments])</literal> - </term> - <term> - <literal>env.Builder(action, [arguments])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Builder</function>(<parameter>action, [arguments]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Builder</methodname>(<parameter>action, [arguments]</parameter>)</term> + <listitem><para> Creates a Builder object for the specified <varname>action</varname>. @@ -579,7 +530,7 @@ See the manpage section "Builder Objects" for a complete explanation of the arguments and behavior. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the <function>env.Builder</function>() form of the invocation will expand @@ -594,28 +545,23 @@ construction environment through which <function>env.Builder</function>() was called. The -<function xmlns="http://www.scons.org/dbxsd/v1.0">Builder</function> +<function>Builder</function> form delays all variable expansion until after the Builder object is actually called. </para> </listitem> </varlistentry> <varlistentry id="f-CacheDir"> - <term> - <literal>CacheDir(cache_dir)</literal> - </term> - <term> - <literal>env.CacheDir(cache_dir)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>CacheDir</function>(<parameter>cache_dir</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>CacheDir</methodname>(<parameter>cache_dir</parameter>)</term> + <listitem><para> Specifies that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will maintain a cache of derived files in <varname>cache_dir</varname>. The derived files in the cache will be shared among all the builds using the same -<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function> +<function>CacheDir</function> call. Specifying a <varname>cache_dir</varname> @@ -624,13 +570,13 @@ of disables derived file caching. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Calling <function>env.CacheDir</function>() will only affect targets built through the specified construction environment. Calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function> +<function>CacheDir</function> sets a global default that will be used by all targets built through construction environments @@ -641,21 +587,21 @@ have an specified. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> When a <function>CacheDir</function>() is being used and -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> finds a derived file that needs to be rebuilt, it will first look in the cache to see if a derived file has already been built from identical input files and an identical build action (as incorporated into the MD5 build signature). If so, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will retrieve the file from the cache. If the derived file is not present in the cache, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will rebuild it and then place a copy of the built file in the cache (identified by its MD5 build signature), @@ -664,20 +610,20 @@ builds that need to build the same derived file from identical inputs. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Use of a specified -<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function> +<function>CacheDir</function> may be disabled for any invocation by using the <option>--cache-disable</option> option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the <option>--cache-force</option> option is used, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will place a copy of <emphasis>all</emphasis> derived files in the cache, @@ -685,17 +631,17 @@ even if they already existed and were not built by this invocation. This is useful to populate a cache the first time -<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function> +<function>CacheDir</function> is added to a build, or after using the <option>--cache-disable</option> option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> When using -<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<function>CacheDir</function>, +<command>scons</command> will report, "Retrieved `file' from cache," unless the @@ -704,7 +650,7 @@ option is being used. When the <option>--cache-show</option> option is used, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will print the action that <emphasis>would</emphasis> have been used to build the file, @@ -716,9 +662,9 @@ a given derived file has been built in-place or retrieved from the cache. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-NoCache"><function>NoCache</function></link> +<link linkend="f-NoCache"><function>NoCache</function></link> method can be used to disable caching of specific files. This can be useful if inputs and/or outputs of some tool are impossible to predict or prohibitively large. @@ -726,14 +672,9 @@ predict or prohibitively large. </listitem> </varlistentry> <varlistentry id="f-Clean"> - <term> - <literal>Clean(targets, files_or_dirs)</literal> - </term> - <term> - <literal>env.Clean(targets, files_or_dirs)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Clean</function>(<parameter>targets, files_or_dirs</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Clean</methodname>(<parameter>targets, files_or_dirs</parameter>)</term> + <listitem><para> This specifies a list of files or directories which should be removed whenever the targets are specified with the <option>-c</option> @@ -741,28 +682,28 @@ command line option. The specified targets may be a list or an individual target. Multiple calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function> +<function>Clean</function> are legal, and create new targets or add files and directories to the clean list for the specified targets. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Multiple files or directories should be specified either as separate arguments to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function> +<function>Clean</function> method, or as a list. -<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function> +<function>Clean</function> will also accept the return value of any of the construction environment Builder methods. Examples: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The related -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-NoClean"><function>NoClean</function></link> +<link linkend="f-NoClean"><function>NoClean</function></link> function overrides calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function> +<function>Clean</function> for the same target, and any targets passed to both functions will <emphasis>not</emphasis> @@ -771,33 +712,30 @@ be removed by the option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Clean('foo', ['bar', 'baz']) Clean('dist', env.Program('hello', 'hello.c')) Clean(['foo', 'bar'], 'something_else_to_clean') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> In this example, installing the project creates a subdirectory for the documentation. This statement causes the subdirectory to be removed if the project is deinstalled. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Clean(docdir, os.path.join(docdir, projectname)) </example_commands> </listitem> </varlistentry> <varlistentry id="f-Clone"> - <term> - <literal>env.Clone([key=val, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Clone</methodname>(<parameter>[key=val, ...]</parameter>)</term> + <listitem><para> Returns a separate copy of a construction environment. If there are any keyword arguments specified, they are added to the returned copy, @@ -805,48 +743,43 @@ overwriting any existing values for the keywords. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env2 = env.Clone() env3 = env.Clone(CCFLAGS = '-g') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Additionally, a list of tools and a toolpath may be specified, as in -the Environment constructor: +the <link linkend="f-Environment"><function>Environment</function></link> constructor: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def MyTool(env): env['FOO'] = 'bar' env4 = env.Clone(tools = ['msvc', MyTool]) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>parse_flags</varname> keyword argument is also recognized to allow merging command-line style arguments into the appropriate construction -variables (see <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link>). +variables (see <link linkend="f-MergeFlags"><function>env.MergeFlags</function></link>). </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # create an environment for compiling programs that use wxWidgets wx_env = env.Clone(parse_flags='!wx-config --cflags --cxxflags') </example_commands> </listitem> </varlistentry> <varlistentry id="f-Command"> - <term> - <literal>Command(target, source, action, [key=val, ...])</literal> - </term> - <term> - <literal>env.Command(target, source, action, [key=val, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Command</function>(<parameter>target, source, action, [key=val, ...]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Command</methodname>(<parameter>target, source, action, [key=val, ...]</parameter>)</term> + <listitem><para> Executes a specific action (or list of actions) to build a target file or files. @@ -855,8 +788,8 @@ than defining a separate Builder object for a single special-case build. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> builder accepts +<para> +<function>Command</function> builder accepts <varname>source_scanner</varname>, <varname>target_scanner</varname>, <varname>source_factory</varname>, and @@ -881,12 +814,12 @@ below, for more information about how these args work in a Builder. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any other keyword arguments specified override any same-named existing construction variables. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> An action can be an external command, specified as a string, or a callable Python object; @@ -903,11 +836,11 @@ or by a to ignore the exit status of the external command. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Command('foo.out', 'foo.in', "$FOO_BUILD < $SOURCES > $TARGET") @@ -925,9 +858,9 @@ env.Command('baz.out', 'baz.in', rename]) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function> +<function>Command</function> function will usually assume, by default, that the specified targets and/or sources are Files, if no other part of the configuration @@ -936,24 +869,24 @@ If necessary, you can explicitly specify that targets or source nodes should be treated as directories by using the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Dir"><function>Dir</function></link> +<link linkend="f-Dir"><function>Dir</function></link> or <function>env.Dir</function> functions. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Command('ddd.list', Dir('ddd'), 'ls -l $SOURCE > $TARGET') env['DISTDIR'] = 'destination/directory' env.Command(env.Dir('$DISTDIR')), None, make_distdir) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Also note that SCons will usually automatically create any directory necessary to hold a target file, so you normally don't need to create directories by hand. @@ -961,14 +894,9 @@ so you normally don't need to create directories by hand. </listitem> </varlistentry> <varlistentry id="f-Configure"> - <term> - <literal>Configure(env, [custom_tests, conf_dir, log_file, config_h])</literal> - </term> - <term> - <literal>env.Configure([custom_tests, conf_dir, log_file, config_h])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Configure</function>(<parameter>env, [custom_tests, conf_dir, log_file, config_h]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Configure</methodname>(<parameter>[custom_tests, conf_dir, log_file, config_h]</parameter>)</term> + <listitem><para> Creates a Configure object for integrated functionality similar to GNU autoconf. See the manpage section "Configure Contexts" @@ -977,25 +905,17 @@ for a complete explanation of the arguments and behavior. </listitem> </varlistentry> <varlistentry id="f-Copy"> - <term> - <literal>env.Copy([key=val, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Copy</methodname>(<parameter>[key=val, ...]</parameter>)</term> + <listitem><para> A now-deprecated synonym for <function>env.Clone</function>(). </para> </listitem> </varlistentry> <varlistentry id="f-Decider"> - <term> - <literal>Decider(function)</literal> - </term> - <term> - <literal>env.Decider(function)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Decider</function>(<parameter>function</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Decider</methodname>(<parameter>function</parameter>)</term> + <listitem><para> Specifies that all up-to-date decisions for targets built through this construction environment will be handled by the specified @@ -1007,7 +927,7 @@ that specify the type of decision function to be performed: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <variablelist> <varlistentry> <term><literal>timestamp-newer</literal></term> @@ -1090,11 +1010,11 @@ all within a single second. </variablelist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Use exact timestamp matches by default. Decider('timestamp-match') @@ -1103,15 +1023,14 @@ Decider('timestamp-match') env.Decider('content') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -In addition to the above already-available functions, -the +<para> +In addition to the above already-available functions, the <varname>function</varname> -argument may be an actual Python function -that takes the following three arguments: +argument may be a Python function you supply. +Such a function must accept the following four arguments: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <variablelist> <varlistentry> <term><parameter>dependency</parameter></term> @@ -1160,9 +1079,14 @@ size, or content signature. <term><parameter>repo_node</parameter></term> <listitem> <para> -Use this node instead of the one specified by +If set, use this Node instead of the one specified by <varname>dependency</varname> - to determine if the dependency has changed. +to determine if the dependency has changed. +This argument is optional so should be written +as a default argument (typically it would be +written as <literal>repo_node=None</literal>). +A caller will normally only set this if the +target only exists in a Repository. </para> </listitem> </varlistentry> @@ -1170,13 +1094,12 @@ Use this node instead of the one specified by </variablelist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>function</varname> -should return a -<literal>True</literal> -(non-zero) -value if the +should return a value which evaluates +<constant>True</constant> +if the <varname>dependency</varname> has "changed" since the last time the @@ -1185,9 +1108,8 @@ was built (indicating that the target <emphasis>should</emphasis> be rebuilt), -and -<literal>False</literal> -(zero) +and a value which evaluates +<constant>False</constant> otherwise (indicating that the target should <emphasis>not</emphasis> @@ -1198,11 +1120,11 @@ Ignoring some or all of the function arguments is perfectly normal. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def my_decider(dependency, target, prev_ni, repo_node=None): return not os.path.exists(str(target)) @@ -1211,20 +1133,15 @@ env.Decider(my_decider) </listitem> </varlistentry> <varlistentry id="f-Default"> - <term> - <literal>Default(targets)</literal> - </term> - <term> - <literal>env.Default(targets)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Default</function>(<parameter>targets...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Default</methodname>(<parameter>targets...</parameter>)</term> + <listitem><para> This specifies a list of default targets, which will be built by -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> if no explicit targets are given on the command line. Multiple calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> are legal, and add to the list of default targets. As noted above, both forms of this call affect the @@ -1233,43 +1150,43 @@ construction environment method applies construction variable expansion to the targets. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Multiple targets should be specified as separate arguments to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> method, or as a list. -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> will also accept the Node returned by any of a construction environment's builder methods. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Default('foo', 'bar', 'baz') env.Default(['a', 'b', 'c']) hello = env.Program('hello', 'hello.c') env.Default(hello) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> An argument to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> of <literal>None</literal> will clear all default targets. Later calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> will add to the (now empty) default-target list like normal. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The current list of targets added using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function> +<function>Default</function> function or method is available in the <literal>DEFAULT_TARGETS</literal> list; @@ -1278,34 +1195,29 @@ see below. </listitem> </varlistentry> <varlistentry id="f-DefaultEnvironment"> - <term> - <literal>DefaultEnvironment([**kwargs])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Creates and returns the default <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal> object. -The default <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal> is used internally by SCons + <term><function>DefaultEnvironment</function>(<parameter>[**kwargs]</parameter>)</term> + <listitem><para> +Creates and returns the default <phrase>construction environment</phrase> object. +The default <phrase>construction environment</phrase> is used internally by SCons in order to execute many of the global functions in this list (i.e. those not called as methods of a specific -<literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>), and to fetch source files transparently +<phrase>construction environment</phrase>), and to fetch source files transparently from source code management systems. The default environment is a singleton, so the keyword arguments affect it only on the first call, on subsequent -calls the already-constructed object is returned. +calls the already-constructed object is returned and +any arguments are ignored. The default environment can be modified in the same way -as any <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. +as any <phrase>construction environment</phrase>. +Modifying the <phrase>default environment</phrase> has no effect on the environment +constructed by a subsequent <function>Environment</function> call. </para> </listitem> </varlistentry> <varlistentry id="f-Depends"> - <term> - <literal>Depends(target, dependency)</literal> - </term> - <term> - <literal>env.Depends(target, dependency)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Depends</function>(<parameter>target, dependency</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Depends</methodname>(<parameter>target, dependency</parameter>)</term> + <listitem><para> Specifies an explicit dependency; the <varname>target</varname> @@ -1328,11 +1240,11 @@ is not caught by a Scanner for the file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Depends('foo', 'other-input-file-for-foo') mylib = env.Library('mylib.c') @@ -1349,44 +1261,51 @@ env.Depends(bar, installed_lib) </example_commands> </listitem> </varlistentry> + <varlistentry id="f-Detect"> + <term><replaceable>env</replaceable>.<methodname>Detect</methodname>(<parameter>progs</parameter>)</term> + <listitem><para> +Find an executable from one or more choices: +<parameter>progs</parameter> may be a string or a list of strings. +Returns the first value from <parameter>progs</parameter> +that was found, or <constant>None</constant>. +Executable is searched by checking the paths specified +by <replaceable>env</replaceable><literal>['ENV']['PATH']</literal>. +On Windows systems, additionally applies the filename suffixes found in +<replaceable>env</replaceable><literal>['ENV']['PATHEXT']</literal> +but will not include any such extension in the return value. +<function>env.Detect</function> is a wrapper around <link linkend="f-WhereIs"><function>env.WhereIs</function></link>. +</para> +</listitem> + </varlistentry> <varlistentry id="f-Dictionary"> - <term> - <literal>env.Dictionary([vars])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Dictionary</methodname>(<parameter>[vars]</parameter>)</term> + <listitem><para> Returns a dictionary object -containing the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> in the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. +containing the <phrase>construction variables</phrase> in the <phrase>construction environment</phrase>. If there are any arguments specified, -the values of the specified <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> +the values of the specified <phrase>construction variables</phrase> are returned as a string (if one argument) or as a list of strings. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> cvars = env.Dictionary() cc_values = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') </example_commands> </listitem> </varlistentry> <varlistentry id="f-Dir"> - <term> - <literal>Dir(name, [directory])</literal> - </term> - <term> - <literal>env.Dir(name, [directory])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This returns a Directory Node, -an object that represents the specified directory -<varname>name</varname>. + <term><function>Dir</function>(<parameter>name, [directory]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Dir</methodname>(<parameter>name, [directory]</parameter>)</term> + <listitem><para> +Returns Directory Node(s). +A Directory Node is an object that represents a directory. <varname>name</varname> -can be a relative or absolute path. +can be a relative or absolute path or a list of such paths. <varname>directory</varname> is an optional directory that will be used as the parent directory. If no @@ -1394,15 +1313,18 @@ If no is specified, the current script's directory is used as the parent. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>name</varname> -is a list, SCons returns a list of Dir nodes. +is a single pathname, the corresponding node is returned. +If +<varname>name</varname> +is a list, SCons returns a list of nodes. Construction variables are expanded in <varname>name</varname>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Directory Nodes can be used anywhere you would supply a string as a directory name to a Builder method or function. @@ -1414,11 +1336,8 @@ for more information. </listitem> </varlistentry> <varlistentry id="f-Dump"> - <term> - <literal>env.Dump([key])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Dump</methodname>(<parameter>[key]</parameter>)</term> + <listitem><para> Returns a pretty printable representation of the environment. <varname>key</varname>, if not @@ -1426,36 +1345,36 @@ if not should be a string containing the name of the variable of interest. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This SConstruct: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env=Environment() print(env.Dump('CCCOM')) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> will print: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> '$CC -c -o $TARGET $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $SOURCES' </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> While this SConstruct: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env=Environment() print(env.Dump()) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> will print: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> { 'AR': 'ar', 'ARCOM': '$AR $ARFLAGS $TARGET $SOURCES\n$RANLIB $RANLIBFLAGS $TARGET', 'ARFLAGS': ['r'], @@ -1467,14 +1386,9 @@ will print: </listitem> </varlistentry> <varlistentry id="f-EnsurePythonVersion"> - <term> - <literal>EnsurePythonVersion(major, minor)</literal> - </term> - <term> - <literal>env.EnsurePythonVersion(major, minor)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>EnsurePythonVersion</function>(<parameter>major, minor</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>EnsurePythonVersion</methodname>(<parameter>major, minor</parameter>)</term> + <listitem><para> Ensure that the Python version is at least <varname>major</varname>.<varname>minor</varname>. This function will @@ -1482,24 +1396,19 @@ print out an error message and exit SCons with a non-zero exit code if the actual Python version is not late enough. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> EnsurePythonVersion(2,2) </example_commands> </listitem> </varlistentry> <varlistentry id="f-EnsureSConsVersion"> - <term> - <literal>EnsureSConsVersion(major, minor, [revision])</literal> - </term> - <term> - <literal>env.EnsureSConsVersion(major, minor, [revision])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>EnsureSConsVersion</function>(<parameter>major, minor, [revision]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>EnsureSConsVersion</methodname>(<parameter>major, minor, [revision]</parameter>)</term> + <listitem><para> Ensure that the SCons version is at least <varname>major.minor</varname>, or @@ -1512,11 +1421,11 @@ print out an error message and exit SCons with a non-zero exit code if the actual SCons version is not late enough. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> EnsureSConsVersion(0,14) EnsureSConsVersion(0,96,90) @@ -1524,14 +1433,9 @@ EnsureSConsVersion(0,96,90) </listitem> </varlistentry> <varlistentry id="f-Environment"> - <term> - <literal>Environment([key=value, ...])</literal> - </term> - <term> - <literal>env.Environment([key=value, ...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Environment</function>(<parameter>[key=value, ...]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Environment</methodname>(<parameter>[key=value, ...]</parameter>)</term> + <listitem><para> Return a new construction environment initialized with the specified <varname>key</varname><literal>=</literal><varname>value</varname> @@ -1540,14 +1444,9 @@ pairs. </listitem> </varlistentry> <varlistentry id="f-Execute"> - <term> - <literal>Execute(action, [strfunction, varlist])</literal> - </term> - <term> - <literal>env.Execute(action, [strfunction, varlist])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Execute</function>(<parameter>action, [strfunction, varlist]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Execute</methodname>(<parameter>action, [strfunction, varlist]</parameter>)</term> + <listitem><para> Executes an Action object. The specified <varname>action</varname> @@ -1565,14 +1464,14 @@ or return value of the Python function will be returned. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will print an error message if the executed <varname>action</varname> fails--that is, exits with or returns a non-zero value. -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will <emphasis>not</emphasis>, however, @@ -1581,12 +1480,12 @@ if the specified <varname>action</varname> fails. If you want the build to stop in response to a failed -<function xmlns="http://www.scons.org/dbxsd/v1.0">Execute</function> +<function>Execute</function> call, you must explicitly check for a non-zero return value: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Execute(Copy('file.out', 'file.in')) if Execute("mkdir sub/dir/ectory"): @@ -1596,16 +1495,11 @@ if Execute("mkdir sub/dir/ectory"): </listitem> </varlistentry> <varlistentry id="f-Exit"> - <term> - <literal>Exit([value])</literal> - </term> - <term> - <literal>env.Exit([value])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Exit</function>(<parameter>[value]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Exit</methodname>(<parameter>[value]</parameter>)</term> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to exit immediately with the specified <varname>value</varname>. @@ -1617,35 +1511,33 @@ is used if no value is specified. </listitem> </varlistentry> <varlistentry id="f-Export"> - <term> - <literal>Export(vars)</literal> - </term> - <term> - <literal>env.Export(vars)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -to export a list of variables from the current -SConscript file to all other SConscript files. -The exported variables are kept in a global collection, -so subsequent calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function> -will over-write previous exports that have the same name. -Multiple variable names can be passed to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function> -as separate arguments or as a list. + <term><function>Export</function>(<parameter>[vars...], [key=value...]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Export</methodname>(<parameter>[vars...], [key=value...]</parameter>)</term> + <listitem><para> +Exports variables from the current +SConscript file to a global collection where they can be +imported by other SConscript files. +<parameter>vars</parameter> may be one or more +strings representing variable names to be exported. +If a string contains whitespace, it is split into +separate strings, as if multiple string arguments +had been given. A <parameter>vars</parameter> argument +may also be a dictionary, which can be used to map variables +to different names when exported. Keyword arguments can be used to provide names and their values. -A dictionary can be used to map variables to a different name when exported. +</para> + +<para> +<function>Export</function> calls are cumulative. Specifying a previously +exported variable will overwrite the earlier value. Both local variables and global variables can be exported. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() # Make env available for all SConscript files to Import(). Export("env") @@ -1658,53 +1550,49 @@ Export("env", "package") Export(["env", "package"]) # Make env available using the name debug: -Export(debug = env) +Export(debug=env) # Make env available using the name debug: -Export({"debug":env}) +Export({"debug": env}) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> -function supports an -<varname>exports</varname> -argument that makes it easier to to export a variable or -set of variables to a single SConscript file. -See the description of the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> -function, below. +<link linkend="f-SConscript"><function>SConscript</function></link> +function supports an <varname>exports</varname> +argument that allows exporting a variable or +set of variables to a specific SConscript file or files. +See the description below. </para> </listitem> </varlistentry> <varlistentry id="f-File"> - <term> - <literal>File(name, [directory])</literal> - </term> - <term> - <literal>env.File(name, [directory])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This returns a -File Node, -an object that represents the specified file -<varname>name</varname>. + <term><function>File</function>(<parameter>name, [directory]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>File</methodname>(<parameter>name, [directory]</parameter>)</term> + <listitem><para> +Returns File Node(s). +A File Node is an object that represents a file. <varname>name</varname> -can be a relative or absolute path. +can be a relative or absolute path or a list of such paths. <varname>directory</varname> is an optional directory that will be used as the parent directory. +If no +<varname>directory</varname> +is specified, the current script's directory is used as the parent. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +If +<varname>name</varname> +is a single pathname, the corresponding node is returned. If <varname>name</varname> -is a list, SCons returns a list of File nodes. +is a list, SCons returns a list of nodes. Construction variables are expanded in <varname>name</varname>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> File Nodes can be used anywhere you would supply a string as a file name to a Builder method or function. @@ -1716,14 +1604,9 @@ for more information. </listitem> </varlistentry> <varlistentry id="f-FindFile"> - <term> - <literal>FindFile(file, dirs)</literal> - </term> - <term> - <literal>env.FindFile(file, dirs)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>FindFile</function>(<parameter>file, dirs</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>FindFile</methodname>(<parameter>file, dirs</parameter>)</term> + <listitem><para> Search for <varname>file</varname> in the path specified by @@ -1735,41 +1618,36 @@ this function also searches for derived files that have not yet been built. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> foo = env.FindFile('foo', ['dir1', 'dir2']) </example_commands> </listitem> </varlistentry> <varlistentry id="f-FindInstalledFiles"> - <term> - <literal>FindInstalledFiles()</literal> - </term> - <term> - <literal>env.FindInstalledFiles()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>FindInstalledFiles</function>()</term> + <term><replaceable>env</replaceable>.<methodname>FindInstalledFiles</methodname>()</term> + <listitem><para> Returns the list of targets set up by the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Install"><function>Install</function></link> +<link linkend="b-Install"><function>Install</function></link> or -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-InstallAs"><function>InstallAs</function></link> +<link linkend="b-InstallAs"><function>InstallAs</function></link> builders. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function serves as a convenient method to select the contents of a binary package. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Install( '/bin', [ 'executable_a', 'executable_b' ] ) # will return the file node list @@ -1785,11 +1663,8 @@ FindInstalledFiles() </listitem> </varlistentry> <varlistentry id="f-FindPathDirs"> - <term> - <literal>FindPathDirs(variable)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>FindPathDirs</function>(<parameter>variable</parameter>)</term> + <listitem><para> Returns a function (actually a callable Python object) intended to be used as the @@ -1801,14 +1676,14 @@ in a construction environment and treat the construction variable's value as a list of directory paths that should be searched (like -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>, +<link linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>, +<link linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>, etc.). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that use of -<function xmlns="http://www.scons.org/dbxsd/v1.0">FindPathDirs</function> +<function>FindPathDirs</function> is generally preferable to writing your own <varname>path_function</varname> @@ -1816,11 +1691,11 @@ for the following reasons: 1) The returned list will contain all appropriate directories found in source trees (when -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link> +<link linkend="f-VariantDir"><function>VariantDir</function></link> is used) or in code repositories (when -<function xmlns="http://www.scons.org/dbxsd/v1.0">Repository</function> +<function>Repository</function> or the <option>-Y</option> option are used). @@ -1832,11 +1707,11 @@ and avoid re-scanning the directories for files, when possible. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def my_scan(node, env, path, arg): # Code to scan file contents goes here... return include_files @@ -1848,14 +1723,9 @@ scanner = Scanner(name = 'myscanner', </listitem> </varlistentry> <varlistentry id="f-FindSourceFiles"> - <term> - <literal>FindSourceFiles(node='"."')</literal> - </term> - <term> - <literal>env.FindSourceFiles(node='"."')</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>FindSourceFiles</function>(<parameter>node='"."'</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>FindSourceFiles</methodname>(<parameter>node='"."'</parameter>)</term> + <listitem><para> Returns the list of nodes which serve as the source of the built files. It does so by inspecting the dependency tree starting at the optional argument @@ -1865,16 +1735,16 @@ which defaults to the '"."'-node. It will then return all leaves of These are all children which have no further children. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function is a convenient method to select the contents of a Source Package. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Program( 'src/main_a.c' ) Program( 'src/main_b.c' ) Program( 'main_c.c' ) @@ -1886,21 +1756,16 @@ FindSourceFiles() FindSourceFiles( 'src' ) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> As you can see build support files (SConstruct in the above example) will also be returned by this function. </para> </listitem> </varlistentry> <varlistentry id="f-Flatten"> - <term> - <literal>Flatten(sequence)</literal> - </term> - <term> - <literal>env.Flatten(sequence)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Flatten</function>(<parameter>sequence</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Flatten</methodname>(<parameter>sequence</parameter>)</term> + <listitem><para> Takes a sequence (that is, a Python list or tuple) that may contain nested sequences and returns a flattened list containing @@ -1913,11 +1778,11 @@ but direct Python manipulation of these lists does not. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> foo = Object('foo.c') bar = Object('bar.c') @@ -1937,11 +1802,8 @@ for object in Flatten(objects): </listitem> </varlistentry> <varlistentry id="f-GetBuildFailures"> - <term> - <literal>GetBuildFailures()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>GetBuildFailures</function>()</term> + <listitem><para> Returns a list of exceptions for the actions that failed while attempting to build targets. @@ -1953,13 +1815,13 @@ that record various aspects of the build failure: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.node</literal> The node that was being built when the build failure occurred. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.status</literal> The numeric exit status returned by the command or Python function @@ -1967,7 +1829,7 @@ that failed when trying to build the specified Node. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.errstr</literal> The SCons error string describing the build failure. @@ -1977,7 +1839,7 @@ to indicate that an executed command exited with a status of 2.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.filename</literal> The name of the file or directory that actually caused the failure. @@ -2000,7 +1862,7 @@ attribute will be <filename>sub/dir</filename>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.executor</literal> The SCons Executor object for the target Node @@ -2010,7 +1872,7 @@ the construction environment used for the failed action. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.action</literal> The actual SCons Action object that failed. This will be one specific action @@ -2019,26 +1881,26 @@ actions that would have been executed to build the target. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>.command</literal> The actual expanded command that was executed and failed, after expansion of -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TARGET"><envar>$TARGET</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SOURCE"><envar>$SOURCE</envar></link>, +<link linkend="cv-TARGET"><envar>$TARGET</envar></link>, +<link linkend="cv-SOURCE"><envar>$SOURCE</envar></link>, and other construction variables. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the -<function xmlns="http://www.scons.org/dbxsd/v1.0">GetBuildFailures</function> +<function>GetBuildFailures</function> function will always return an empty list until any build failure has occurred, which means that -<function xmlns="http://www.scons.org/dbxsd/v1.0">GetBuildFailures</function> +<function>GetBuildFailures</function> will always return an empty list while the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> files are being read. Its primary intended use is for functions that will be @@ -2050,7 +1912,7 @@ function. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import atexit def print_build_failures(): @@ -2063,16 +1925,11 @@ atexit.register(print_build_failures) </listitem> </varlistentry> <varlistentry id="f-GetBuildPath"> - <term> - <literal>GetBuildPath(file, [...])</literal> - </term> - <term> - <literal>env.GetBuildPath(file, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>GetBuildPath</function>(<parameter>file, [...]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>GetBuildPath</methodname>(<parameter>file, [...]</parameter>)</term> + <listitem><para> Returns the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> path name (or names) for the specified <varname>file</varname> (or files). @@ -2080,22 +1937,17 @@ The specified <varname>file</varname> or files may be -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> Nodes or strings representing path names. </para> </listitem> </varlistentry> <varlistentry id="f-GetLaunchDir"> - <term> - <literal>GetLaunchDir()</literal> - </term> - <term> - <literal>env.GetLaunchDir()</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>GetLaunchDir</function>()</term> + <term><replaceable>env</replaceable>.<methodname>GetLaunchDir</methodname>()</term> + <listitem><para> Returns the absolute path name of the directory from which -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> was initially invoked. This can be useful when using the <option>-u</option>, @@ -2104,35 +1956,30 @@ or <option>-D</option> options, which internally change to the directory in which the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> +<filename>SConstruct</filename> file is found. </para> </listitem> </varlistentry> <varlistentry id="f-GetOption"> - <term> - <literal>GetOption(name)</literal> - </term> - <term> - <literal>env.GetOption(name)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>GetOption</function>(<parameter>name</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>GetOption</methodname>(<parameter>name</parameter>)</term> + <listitem><para> This function provides a way to query the value of SCons options set on scons command line (or set using the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SetOption"><function>SetOption</function></link> +<link linkend="f-SetOption"><function>SetOption</function></link> function). The options supported are: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <variablelist> <varlistentry> <term><literal>cache_debug</literal></term> <listitem> <para> -which corresponds to --cache-debug; +which corresponds to <option>--cache-debug</option>; </para> </listitem> </varlistentry> @@ -2140,7 +1987,7 @@ which corresponds to --cache-debug; <term><literal>cache_disable</literal></term> <listitem> <para> -which corresponds to --cache-disable; +which corresponds to <option>--cache-disable</option>; </para> </listitem> </varlistentry> @@ -2148,7 +1995,7 @@ which corresponds to --cache-disable; <term><literal>cache_force</literal></term> <listitem> <para> -which corresponds to --cache-force; +which corresponds to <option>--cache-force</option>; </para> </listitem> </varlistentry> @@ -2156,7 +2003,7 @@ which corresponds to --cache-force; <term><literal>cache_show</literal></term> <listitem> <para> -which corresponds to --cache-show; +which corresponds to <option>--cache-show</option>; </para> </listitem> </varlistentry> @@ -2164,7 +2011,8 @@ which corresponds to --cache-show; <term><literal>clean</literal></term> <listitem> <para> -which corresponds to -c, --clean and --remove; +which corresponds to <option>-c</option>, <option>--clean</option> +and <option>--remove</option>; </para> </listitem> </varlistentry> @@ -2172,7 +2020,7 @@ which corresponds to -c, --clean and --remove; <term><literal>config</literal></term> <listitem> <para> -which corresponds to --config; +which corresponds to <option>--config</option>; </para> </listitem> </varlistentry> @@ -2180,7 +2028,7 @@ which corresponds to --config; <term><literal>directory</literal></term> <listitem> <para> -which corresponds to -C and --directory; +which corresponds to <option>-C</option> and <option>--directory</option>; </para> </listitem> </varlistentry> @@ -2188,7 +2036,7 @@ which corresponds to -C and --directory; <term><literal>diskcheck</literal></term> <listitem> <para> -which corresponds to --diskcheck +which corresponds to <option>--diskcheck</option>; </para> </listitem> </varlistentry> @@ -2196,7 +2044,7 @@ which corresponds to --diskcheck <term><literal>duplicate</literal></term> <listitem> <para> -which corresponds to --duplicate; +which corresponds to <option>--duplicate</option>; </para> </listitem> </varlistentry> @@ -2204,7 +2052,7 @@ which corresponds to --duplicate; <term><literal>file</literal></term> <listitem> <para> -which corresponds to -f, --file, --makefile and --sconstruct; +which corresponds to <option>-f</option>, <option>--file</option>, <option>--makefile</option> and <option>--sconstruct</option>; </para> </listitem> </varlistentry> @@ -2212,7 +2060,7 @@ which corresponds to -f, --file, --makefile and --sconstruct; <term><literal>help</literal></term> <listitem> <para> -which corresponds to -h and --help; +which corresponds to <option>-h</option> and <option>--help</option>; </para> </listitem> </varlistentry> @@ -2220,7 +2068,7 @@ which corresponds to -h and --help; <term><literal>ignore_errors</literal></term> <listitem> <para> -which corresponds to --ignore-errors; +which corresponds to <option>--ignore-errors</option>; </para> </listitem> </varlistentry> @@ -2228,7 +2076,7 @@ which corresponds to --ignore-errors; <term><literal>implicit_cache</literal></term> <listitem> <para> -which corresponds to --implicit-cache; +which corresponds to <option>--implicit-cache</option>; </para> </listitem> </varlistentry> @@ -2236,7 +2084,7 @@ which corresponds to --implicit-cache; <term><literal>implicit_deps_changed</literal></term> <listitem> <para> -which corresponds to --implicit-deps-changed; +which corresponds to <option>--implicit-deps-changed</option>; </para> </listitem> </varlistentry> @@ -2244,7 +2092,7 @@ which corresponds to --implicit-deps-changed; <term><literal>implicit_deps_unchanged</literal></term> <listitem> <para> -which corresponds to --implicit-deps-unchanged; +which corresponds to <option>--implicit-deps-unchanged</option>; </para> </listitem> </varlistentry> @@ -2252,7 +2100,7 @@ which corresponds to --implicit-deps-unchanged; <term><literal>interactive</literal></term> <listitem> <para> -which corresponds to --interact and --interactive; +which corresponds to <option>--interact</option> and <option>--interactive</option>; </para> </listitem> </varlistentry> @@ -2260,7 +2108,7 @@ which corresponds to --interact and --interactive; <term><literal>keep_going</literal></term> <listitem> <para> -which corresponds to -k and --keep-going; +which corresponds to <option>-k</option> and <option>--keep-going</option>; </para> </listitem> </varlistentry> @@ -2268,7 +2116,7 @@ which corresponds to -k and --keep-going; <term><literal>max_drift</literal></term> <listitem> <para> -which corresponds to --max-drift; +which corresponds to <option>--max-drift</option>; </para> </listitem> </varlistentry> @@ -2276,7 +2124,9 @@ which corresponds to --max-drift; <term><literal>no_exec</literal></term> <listitem> <para> -which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; +which corresponds to <option>-n</option>, +<option>--no-exec</option>, <option>--just-print</option>, +<option>--dry-run</option> and <option>--recon</option>; </para> </listitem> </varlistentry> @@ -2284,7 +2134,7 @@ which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; <term><literal>no_site_dir</literal></term> <listitem> <para> -which corresponds to --no-site-dir; +which corresponds to <option>--no-site-dir</option>; </para> </listitem> </varlistentry> @@ -2292,7 +2142,7 @@ which corresponds to --no-site-dir; <term><literal>num_jobs</literal></term> <listitem> <para> -which corresponds to -j and --jobs; +which corresponds to <option>-j</option> and <option>--jobs</option>; </para> </listitem> </varlistentry> @@ -2300,7 +2150,7 @@ which corresponds to -j and --jobs; <term><literal>profile_file</literal></term> <listitem> <para> -which corresponds to --profile; +which corresponds to <option>--profile</option>; </para> </listitem> </varlistentry> @@ -2308,7 +2158,7 @@ which corresponds to --profile; <term><literal>question</literal></term> <listitem> <para> -which corresponds to -q and --question; +which corresponds to <option>-q</option> and <option>--question</option>; </para> </listitem> </varlistentry> @@ -2316,7 +2166,7 @@ which corresponds to -q and --question; <term><literal>random</literal></term> <listitem> <para> -which corresponds to --random; +which corresponds to <option>--random</option>; </para> </listitem> </varlistentry> @@ -2324,7 +2174,7 @@ which corresponds to --random; <term><literal>repository</literal></term> <listitem> <para> -which corresponds to -Y, --repository and --srcdir; +which corresponds to <option>-Y</option>, <option>--repository</option> and <option>--srcdir</option>; </para> </listitem> </varlistentry> @@ -2332,7 +2182,7 @@ which corresponds to -Y, --repository and --srcdir; <term><literal>silent</literal></term> <listitem> <para> -which corresponds to -s, --silent and --quiet; +which corresponds to <option>-s</option>, <option>--silent</option> and <option>--quiet</option>; </para> </listitem> </varlistentry> @@ -2340,7 +2190,7 @@ which corresponds to -s, --silent and --quiet; <term><literal>site_dir</literal></term> <listitem> <para> -which corresponds to --site-dir; +which corresponds to <option>--site-dir</option>; </para> </listitem> </varlistentry> @@ -2348,7 +2198,7 @@ which corresponds to --site-dir; <term><literal>stack_size</literal></term> <listitem> <para> -which corresponds to --stack-size; +which corresponds to <option>--stack-size</option>; </para> </listitem> </varlistentry> @@ -2356,7 +2206,7 @@ which corresponds to --stack-size; <term><literal>taskmastertrace_file</literal></term> <listitem> <para> -which corresponds to --taskmastertrace; and +which corresponds to <option>--taskmastertrace</option>; and </para> </listitem> </varlistentry> @@ -2364,33 +2214,28 @@ which corresponds to --taskmastertrace; and <term><literal>warn</literal></term> <listitem> <para> -which corresponds to --warn and --warning. +which corresponds to <option>--warn</option> and <option>--warning</option>. </para> </listitem> </varlistentry> </variablelist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> See the documentation for the -corresponding command line object for information about each specific +corresponding command line option for information about each specific option. </para> </listitem> </varlistentry> <varlistentry id="f-Glob"> - <term> - <literal>Glob(pattern, [ondisk, source, strings, exclude])</literal> - </term> - <term> - <literal>env.Glob(pattern, [ondisk, source, strings, exclude])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Glob</function>(<parameter>pattern, [ondisk, source, strings, exclude]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Glob</methodname>(<parameter>pattern, [ondisk, source, strings, exclude]</parameter>)</term> + <listitem><para> Returns Nodes (or strings) that match the specified <varname>pattern</varname>, relative to the directory of the current -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> file. The <function>env.Glob</function>() @@ -2400,20 +2245,20 @@ and returns whatever matches the resulting expanded pattern. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The specified <varname>pattern</varname> uses Unix shell style metacharacters for matching: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the first character of a filename is a dot, it must be matched explicitly. Character matches do @@ -2421,17 +2266,17 @@ Character matches do span directory separators. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">Glob</function> +<function>Glob</function> knows about repositories (see the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Repository"><function>Repository</function></link> +<link linkend="f-Repository"><function>Repository</function></link> function) and source directories (see the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link> +<link linkend="f-VariantDir"><function>VariantDir</function></link> function) and returns a Node (or string, if so configured) @@ -2441,12 +2286,11 @@ anywhere in a corresponding repository or source directory. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>ondisk</varname> -argument may be set to -<literal>False</literal> -(or any other non-true value) +argument may be set to a value which evaluates +<constant>False</constant> to disable the search for matches on disk, thereby only returning matches among already-configured File or Dir Nodes. @@ -2455,28 +2299,26 @@ return corresponding Nodes for any on-disk matches found. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>source</varname> -argument may be set to -<literal>True</literal> -(or any equivalent value) +argument may be set to a value which evaluates +<constant>True</constant> to specify that, when the local directory is a -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>, +<function>VariantDir</function>, the returned Nodes should be from the corresponding source directory, not the local directory. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>strings</varname> -argument may be set to -<literal>True</literal> -(or any equivalent value) +argument may be set to a value which evaluates +<constant>True</constant> to have the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Glob</function> +<function>Glob</function> function return strings, not Nodes, that represent the matched files or directories. The returned strings will be relative to @@ -2485,18 +2327,18 @@ the local (SConscript) directory. arbitrary manipulation of file names, but if the returned strings are passed to a different -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> file, any Node translation will be relative to the other -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> directory, not the original -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> directory.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>exclude</varname> argument may be set to a pattern or a list of patterns @@ -2506,80 +2348,71 @@ Elements matching a least one pattern of this list will be excluded. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -Program('foo', Glob('*.c')) -Zip('/tmp/everything', Glob('.??*') + Glob('*')) -sources = Glob('*.cpp', exclude=['os_*_specific_*.cpp']) + Glob('os_%s_specific_*.cpp'%currentOS) +<example_commands> +Program("foo", Glob("*.c")) +Zip("/tmp/everything", Glob(".??*") + Glob("*")) +sources = Glob("*.cpp", exclude=["os_*_specific_*.cpp"]) + \ + Glob( "os_%s_specific_*.cpp" % currentOS) </example_commands> </listitem> </varlistentry> <varlistentry id="f-Help"> - <term> - <literal>Help(text, append=False)</literal> - </term> - <term> - <literal>env.Help(text, append=False)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Help</function>(<parameter>text, append=False</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Help</methodname>(<parameter>text, append=False</parameter>)</term> + <listitem><para> This specifies help text to be printed if the <option>-h</option> argument is given to -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>. -If -<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function> -is called multiple times, the text is appended together in the order that -<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function> -is called. With append set to False, any -<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function> -text generated with -<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function> +<command>scons</command>. +If +<function>Help</function> +is called multiple times, the text is appended together in the order that +<function>Help</function> +is called. With append set to False, any +<function>Help</function> +text generated with +<function>AddOption</function> is clobbered. If append is True, the AddOption help is prepended to the help -string, thus preserving the +string, thus preserving the <option>-h</option> message. </para> </listitem> </varlistentry> <varlistentry id="f-Ignore"> - <term> - <literal>Ignore(target, dependency)</literal> - </term> - <term> - <literal>env.Ignore(target, dependency)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Ignore</function>(<parameter>target, dependency</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Ignore</methodname>(<parameter>target, dependency</parameter>)</term> + <listitem><para> The specified dependency file(s) will be ignored when deciding if the target file(s) need to be rebuilt. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> You can also use -<function xmlns="http://www.scons.org/dbxsd/v1.0">Ignore</function> +<function>Ignore</function> to remove a target from the default build. In order to do this you must specify the directory the target will be built in as the target, and the file you want to skip building as the dependency. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that this will only remove the dependencies listed from the files built by default. It will still be built if that dependency is needed by another object being built. See the third and forth examples below. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Ignore('foo', 'foo.c') env.Ignore('bar', ['bar1.h', 'bar2.h']) env.Ignore('.','foobar.obj') @@ -2588,37 +2421,31 @@ env.Ignore('bar','bar/foobar.obj') </listitem> </varlistentry> <varlistentry id="f-Import"> - <term> - <literal>Import(vars)</literal> - </term> - <term> - <literal>env.Import(vars)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -to import a list of variables into the current SConscript file. This -will import variables that were exported with -<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function> -or in the -<varname>exports</varname> -argument to -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SConscript"><function>SConscript</function></link>. + <term><function>Import</function>(<parameter>vars...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Import</methodname>(<parameter>vars...</parameter>)</term> + <listitem><para> +Imports variables into the current SConscript file. +<parameter>vars</parameter> +must be strings representing names of variables +which have been previously exported either by the +<link linkend="f-Export"><function>Export</function></link> function or by the +<varname>exports</varname> argument to +<link linkend="f-SConscript"><function>SConscript</function></link>. Variables exported by -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> -have precedence. +<function>SConscript</function> +take precedence. Multiple variable names can be passed to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Import</function> -as separate arguments or as a list. The variable "*" can be used -to import all variables. +<function>Import</function> +as separate arguments or as words in a space-separated string. +The wildcard <literal>"*"</literal> can be used to import all +available variables. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Import("env") Import("env", "variable") Import(["env", "variable"]) @@ -2627,14 +2454,9 @@ Import("*") </listitem> </varlistentry> <varlistentry id="f-Literal"> - <term> - <literal>Literal(string)</literal> - </term> - <term> - <literal>env.Literal(string)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Literal</function>(<parameter>string</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Literal</methodname>(<parameter>string</parameter>)</term> + <listitem><para> The specified <varname>string</varname> will be preserved as-is @@ -2643,14 +2465,9 @@ and not have construction variables expanded. </listitem> </varlistentry> <varlistentry id="f-Local"> - <term> - <literal>Local(targets)</literal> - </term> - <term> - <literal>env.Local(targets)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Local</function>(<parameter>targets</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Local</methodname>(<parameter>targets</parameter>)</term> + <listitem><para> The specified <varname>targets</varname> will have copies made in the local tree, @@ -2661,11 +2478,8 @@ Returns a list of the target Node or Nodes. </listitem> </varlistentry> <varlistentry id="f-MergeFlags"> - <term> - <literal>env.MergeFlags(arg, [unique])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>MergeFlags</methodname>(<parameter>arg, [unique]</parameter>)</term> + <listitem><para> Merges the specified <varname>arg</varname> values to the construction environment's construction variables. @@ -2673,7 +2487,7 @@ If the <varname>arg</varname> argument is not a dictionary, it is converted to one by calling -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link> +<link linkend="f-ParseFlags"><function>env.ParseFlags</function></link> on the argument before the values are merged. Note that @@ -2682,10 +2496,10 @@ must be a single value, so multiple strings must be passed in as a list, not as separate arguments to -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.MergeFlags</function>. +<function>env.MergeFlags</function>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> By default, duplicate values are eliminated; you can, however, specify @@ -2701,11 +2515,11 @@ All other construction variables keep the right-most unique value. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Add an optimization flag to $CCFLAGS. env.MergeFlags('-O3') @@ -2722,59 +2536,49 @@ env.MergeFlags(['-O3', </listitem> </varlistentry> <varlistentry id="f-NoCache"> - <term> - <literal>NoCache(target, ...)</literal> - </term> - <term> - <literal>env.NoCache(target, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>NoCache</function>(<parameter>target, ...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>NoCache</methodname>(<parameter>target, ...</parameter>)</term> + <listitem><para> Specifies a list of files which should <emphasis>not</emphasis> be cached whenever the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-CacheDir"><function>CacheDir</function></link> +<link linkend="f-CacheDir"><function>CacheDir</function></link> method has been activated. The specified targets may be a list or an individual target. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Multiple files should be specified either as separate arguments to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function> +<function>NoCache</function> method, or as a list. -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function> +<function>NoCache</function> will also accept the return value of any of the construction environment Builder methods. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function> +<function>NoCache</function> on directories and other non-File Node types has no effect because only File Nodes are cached. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> NoCache('foo.elf') NoCache(env.Program('hello', 'hello.c')) </example_commands> </listitem> </varlistentry> <varlistentry id="f-NoClean"> - <term> - <literal>NoClean(target, ...)</literal> - </term> - <term> - <literal>env.NoClean(target, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>NoClean</function>(<parameter>target, ...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>NoClean</methodname>(<parameter>target, ...</parameter>)</term> + <listitem><para> Specifies a list of files or directories which should <emphasis>not</emphasis> be removed whenever the targets (or their dependencies) @@ -2784,7 +2588,7 @@ command line option. The specified targets may be a list or an individual target. Multiple calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function> +<function>NoClean</function> are legal, and prevent each specified target from being removed by calls to the @@ -2792,21 +2596,21 @@ from being removed by calls to the option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Multiple files or directories should be specified either as separate arguments to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function> +<function>NoClean</function> method, or as a list. -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function> +<function>NoClean</function> will also accept the return value of any of the construction environment Builder methods. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function> +<function>NoClean</function> for a target overrides calling -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Clean"><function>Clean</function></link> +<link linkend="f-Clean"><function>Clean</function></link> for the same target, and any targets passed to both functions will <emphasis>not</emphasis> @@ -2815,22 +2619,19 @@ be removed by the option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> NoClean('foo.elf') NoClean(env.Program('hello', 'hello.c')) </example_commands> </listitem> </varlistentry> <varlistentry id="f-ParseConfig"> - <term> - <literal>env.ParseConfig(command, [function, unique])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>ParseConfig</methodname>(<parameter>command, [function, unique]</parameter>)</term> + <listitem><para> Calls the specified <varname>function</varname> to modify the environment as specified by the output of @@ -2838,7 +2639,7 @@ to modify the environment as specified by the output of The default <varname>function</varname> is -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link>, +<link linkend="f-MergeFlags"><function>env.MergeFlags</function></link>, which expects the output of a typical <application>*-config</application> command @@ -2855,11 +2656,11 @@ to allow duplicate values to be added. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Interpreted options and the construction variables they affect are as specified for the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link> +<link linkend="f-ParseFlags"><function>env.ParseFlags</function></link> method (which this method calls). See that method's description for a table of options and construction variables. @@ -2867,24 +2668,19 @@ for a table of options and construction variables. </listitem> </varlistentry> <varlistentry id="f-ParseDepends"> - <term> - <literal>ParseDepends(filename, [must_exist, only_one])</literal> - </term> - <term> - <literal>env.ParseDepends(filename, [must_exist, only_one])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>ParseDepends</function>(<parameter>filename, [must_exist, only_one]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>ParseDepends</methodname>(<parameter>filename, [must_exist, only_one]</parameter>)</term> + <listitem><para> Parses the contents of the specified <varname>filename</varname> as a list of dependencies in the style of -<application xmlns="http://www.scons.org/dbxsd/v1.0">Make</application> +<application>Make</application> or <application>mkdep</application>, and explicitly establishes all of the listed dependencies. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> By default, it is not an error if the specified @@ -2900,7 +2696,7 @@ generate an error if the file does not exist, or is otherwise inaccessible. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional <varname>only_one</varname> argument may be set to a non-zero @@ -2922,43 +2718,40 @@ one output file into a corresponding file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>filename</varname> and all of the files listed therein will be interpreted relative to the directory of the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> file which calls the -<function xmlns="http://www.scons.org/dbxsd/v1.0">ParseDepends</function> +<function>ParseDepends</function> function. </para> </listitem> </varlistentry> <varlistentry id="f-ParseFlags"> - <term> - <literal>env.ParseFlags(flags, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>ParseFlags</methodname>(<parameter>flags, ...</parameter>)</term> + <listitem><para> Parses one or more strings containing typical command-line flags for GCC tool chains and returns a dictionary with the flag values separated into the appropriate SCons construction variables. This is intended as a companion to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link> +<link linkend="f-MergeFlags"><function>env.MergeFlags</function></link> method, but allows for the values in the returned dictionary to be modified, if necessary, before merging them into the construction environment. (Note that -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.MergeFlags</function> +<function>env.MergeFlags</function> will call this method if its argument is not a dictionary, so it is usually not necessary to call -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link> +<link linkend="f-ParseFlags"><function>env.ParseFlags</function></link> directly unless you want to manipulate the values.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the first character in any string is an exclamation mark (!), the rest of the string is executed as a command, @@ -2967,12 +2760,12 @@ parsed as GCC tool chain command-line flags and added to the resulting dictionary. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Flag values are translated accordig to the prefix found, and added to the following construction variables: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> -arch CCFLAGS, LINKFLAGS -D CPPDEFINES -framework FRAMEWORKS @@ -3003,19 +2796,19 @@ and added to the following construction variables: + CCFLAGS, LINKFLAGS </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any other strings not associated with options are assumed to be the names of libraries and added to the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar> +<envar>$LIBS</envar> construction variable. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples (all of which produce the same result): </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> dict = env.ParseFlags('-O2 -Dfoo -Dbar=1') dict = env.ParseFlags('-O2', '-Dfoo', '-Dbar=1') dict = env.ParseFlags(['-O2', '-Dfoo -Dbar=1']) @@ -3024,42 +2817,39 @@ dict = env.ParseFlags('-O2', '!echo -Dfoo -Dbar=1') </listitem> </varlistentry> <varlistentry id="f-Platform"> - <term> - <literal>Platform(string)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Platform</function>(<parameter>string</parameter>)</term> + <listitem><para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">Platform</function> +<function>Platform</function> form returns a callable object that can be used to initialize a construction environment using the platform keyword of the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Environment</function> +<function>Environment</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(platform = Platform('win32')) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Platform</function> +<function>env.Platform</function> form applies the callable object for the specified platform <varname>string</varname> to the environment through which the method was called. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Platform('posix') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the <literal>win32</literal> platform adds the @@ -3068,7 +2858,7 @@ and <literal>SystemRoot</literal> variables from the user's external environment to the construction environment's -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ENV"><envar>$ENV</envar></link> +<link linkend="cv-ENV"><envar>$ENV</envar></link> dictionary. This is so that any executed commands that use sockets to connect with other systems @@ -3080,30 +2870,22 @@ will work on Windows systems. </listitem> </varlistentry> <varlistentry id="f-Precious"> - <term> - <literal>Precious(target, ...)</literal> - </term> - <term> - <literal>env.Precious(target, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Precious</function>(<parameter>target, ...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Precious</methodname>(<parameter>target, ...</parameter>)</term> + <listitem><para> Marks each given <varname>target</varname> as precious so it is not deleted before it is rebuilt. Normally -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> deletes a target before building it. Multiple targets can be passed in to a single call to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Precious</function>. +<function>Precious</function>. </para> </listitem> </varlistentry> <varlistentry id="f-Prepend"> - <term> - <literal>env.Prepend(key=val, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Prepend</methodname>(<parameter>key=val, [...]</parameter>)</term> + <listitem><para> Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3119,24 +2901,21 @@ and the lists are added together. (See also the Append method, above.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Prepend(CCFLAGS = '-g ', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> <varlistentry id="f-PrependENVPath"> - <term> - <literal>env.PrependENVPath(name, newpath, [envname, sep, delete_existing])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>PrependENVPath</methodname>(<parameter>name, newpath, [envname, sep, delete_existing]</parameter>)</term> + <listitem><para> This appends new path elements to the given path in the specified external environment -(<envar xmlns="http://www.scons.org/dbxsd/v1.0">$ENV</envar> +(<envar>$ENV</envar> by default). This will only add any particular path once (leaving the first one it encounters and @@ -3151,7 +2930,7 @@ case where the given old path variable is a list instead of a string, in which case a list will be returned instead of a string. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>delete_existing</varname> is 0, then adding a path that already exists @@ -3159,33 +2938,30 @@ will not move it to the beginning; it will stay where it is in the list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> print 'before:',env['ENV']['INCLUDE'] include_path = '/foo/bar:/foo' env.PrependENVPath('INCLUDE', include_path) print 'after:',env['ENV']['INCLUDE'] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The above example will print: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> before: /biz:/foo after: /foo/bar:/foo:/biz </example_commands> </listitem> </varlistentry> <varlistentry id="f-PrependUnique"> - <term> - <literal>env.PrependUnique(key=val, delete_existing=0, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>PrependUnique</methodname>(<parameter>key=val, delete_existing=0, [...]</parameter>)</term> + <listitem><para> Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3201,33 +2977,26 @@ existing matching values are removed first, so existing values in the arg list move to the front of the list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) </example_commands> </listitem> </varlistentry> <varlistentry id="f-Progress"> - <term> - <literal>Progress(callable, [interval])</literal> - </term> - <term> - <literal>Progress(string, [interval, file, overwrite])</literal> - </term> - <term> - <literal>Progress(list_of_strings, [interval, file, overwrite])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Progress</function>(<parameter>callable, [interval]</parameter>)</term> + <term><function>Progress</function>(<parameter>string, [interval, file, overwrite]</parameter>)</term> + <term><function>Progress</function>(<parameter>list_of_strings, [interval, file, overwrite]</parameter>)</term> + <listitem><para> Allows SCons to show progress made during the build by displaying a string or calling a function while evaluating Nodes (e.g. files). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the first specified argument is a Python callable (a function or an object that has a <function>__call__</function>() @@ -3249,19 +3018,19 @@ if SCons ever changes the interface to call the function with additional arguments in the future.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> An example of a simple custom progress function that prints a string containing the Node name every 10 Nodes: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def my_progress_function(node, *args, **kw): print('Evaluating node %s!' % node) Progress(my_progress_function, interval=10) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> A more complicated example of a custom progress display object that prints a string containing a count every 100 evaluated Nodes. @@ -3272,7 +3041,7 @@ at the end so that the string will overwrite itself on a display: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import sys class ProgressCounter(object): count = 0 @@ -3282,9 +3051,9 @@ class ProgressCounter(object): Progress(ProgressCounter(), interval=100) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the first argument -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Progress"><function>Progress</function></link> +<link linkend="f-Progress"><function>Progress</function></link> is a string, the string will be displayed every @@ -3300,14 +3069,14 @@ on the error output, one dot for every 100 evaluated Nodes: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import sys Progress('.', interval=100, file=sys.stderr) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the string contains the verbatim substring -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET</envar>, +<envar>$TARGET</envar>, it will be replaced with the Node. Note that, for performance reasons, this is <emphasis>not</emphasis> @@ -3325,14 +3094,14 @@ keyword argument to make sure the previously-printed file name is overwritten with blank spaces: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import sys Progress('$TARGET\r', overwrite=True) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the first argument to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Progress</function> +<function>Progress</function> is a list of strings, then each string in the list will be displayed in rotating fashion every @@ -3342,42 +3111,32 @@ This can be used to implement a "spinner" on the user's screen as follows: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Progress(['-\r', '\\\r', '|\r', '/\r'], interval=5) </example_commands> </listitem> </varlistentry> <varlistentry id="f-Pseudo"> - <term> - <literal>Pseudo(target, ...)</literal> - </term> - <term> - <literal>env.Pseudo(target, ...)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Pseudo</function>(<parameter>target, ...</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Pseudo</methodname>(<parameter>target, ...</parameter>)</term> + <listitem><para> This indicates that each given <varname>target</varname> should not be created by the build rule, and if the target is created, an error will be generated. This is similar to the gnu make .PHONY target. However, in the vast majority of cases, an -<function xmlns="http://www.scons.org/dbxsd/v1.0">Alias</function> +<function>Alias</function> is more appropriate. Multiple targets can be passed in to a single call to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Pseudo</function>. +<function>Pseudo</function>. </para> </listitem> </varlistentry> <varlistentry id="f-PyPackageDir"> - <term> - <literal>PyPackageDir(modulename)</literal> - </term> - <term> - <literal>env.PyPackageDir(modulename)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>PyPackageDir</function>(<parameter>modulename</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>PyPackageDir</methodname>(<parameter>modulename</parameter>)</term> + <listitem><para> This returns a Directory Node similar to Dir. The python module / package is looked up and if located the directory is returned for the location. @@ -3385,7 +3144,7 @@ the directory is returned for the location. Is a named python package / module to lookup the directory for it's location. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>modulename</varname> is a list, SCons returns a list of Dir nodes. @@ -3395,46 +3154,38 @@ Construction variables are expanded in </listitem> </varlistentry> <varlistentry id="f-Replace"> - <term> - <literal>env.Replace(key=val, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>Replace</methodname>(<parameter>key=val, [...]</parameter>)</term> + <listitem><para> Replaces construction variables in the Environment with the specified keyword arguments. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Replace(CCFLAGS = '-g', FOO = 'foo.xxx') </example_commands> </listitem> </varlistentry> <varlistentry id="f-Repository"> - <term> - <literal>Repository(directory)</literal> - </term> - <term> - <literal>env.Repository(directory)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Repository</function>(<parameter>directory</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Repository</methodname>(<parameter>directory</parameter>)</term> + <listitem><para> Specifies that <varname>directory</varname> is a repository to be searched for files. Multiple calls to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Repository</function> +<function>Repository</function> are legal, and each one adds to the list of repositories that will be searched. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> To -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>, +<command>scons</command>, a repository is a copy of the source tree, from the top-level directory on down, which may contain @@ -3445,39 +3196,34 @@ The canonical example would be an official source tree maintained by an integrator. If the repository contains derived files, then the derived files should have been built using -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>, +<command>scons</command>, so that the repository contains the necessary signature information to allow -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to figure out when it is appropriate to use the repository copy of a derived file, instead of building one locally. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that if an up-to-date derived file already exists in a repository, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will <emphasis>not</emphasis> make a copy in the local directory tree. In order to guarantee that a local copy will be made, use the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Local"><function>Local</function></link> +<link linkend="f-Local"><function>Local</function></link> method. </para> </listitem> </varlistentry> <varlistentry id="f-Requires"> - <term> - <literal>Requires(target, prerequisite)</literal> - </term> - <term> - <literal>env.Requires(target, prerequisite)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Requires</function>(<parameter>target, prerequisite</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Requires</methodname>(<parameter>target, prerequisite</parameter>)</term> + <listitem><para> Specifies an order-only relationship between the specified target file(s) and the specified prerequisite file(s). @@ -3491,55 +3237,55 @@ and will not be rebuilt simply because the prerequisite file(s) change. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Requires('foo', 'file-that-must-be-built-before-foo') </example_commands> </listitem> </varlistentry> <varlistentry id="f-Return"> - <term> - <literal>Return([vars..., stop=])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -By default, -this stops processing the current SConscript -file and returns to the calling SConscript file -the values of the variables named in the -<varname>vars</varname> -string arguments. + <term><function>Return</function>(<parameter>[vars..., stop=True]</parameter>)</term> + <listitem><para> +Return to the calling SConscript, optionally +returning the values of variables named in +<varname>vars</varname>. Multiple strings contaning variable names may be passed to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function>. -Any strings that contain white space +<function>Return</function>. A string containing white space +is split into individual variable names. +Returns the value if one variable is specified, +else returns a tuple of values. +Returns an empty tuple if <parameter>vars</parameter> +is omitted. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +By default <function>Return</function> stops processing the current SConscript +and returns immediately. The optional -<literal>stop=</literal> -keyword argument may be set to a false value +<literal>stop</literal> +keyword argument +may be set to a false value to continue processing the rest of the SConscript file after the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function> -call. -This was the default behavior prior to SCons 0.98. +<function>Return</function> +call (this was the default behavior prior to SCons 0.98.) However, the values returned are still the values of the variables in the named <varname>vars</varname> at the point -<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function> -is called. +<function>Return</function> +was called. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -# Returns without returning a value. +<example_commands> +# Returns no values (evaluates False) Return() # Returns the value of the 'foo' Python variable. @@ -3554,14 +3300,9 @@ Return('val1 val2') </listitem> </varlistentry> <varlistentry id="f-Scanner"> - <term> - <literal>Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive])</literal> - </term> - <term> - <literal>env.Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Scanner</function>(<parameter>function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Scanner</methodname>(<parameter>function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]</parameter>)</term> + <listitem><para> Creates a Scanner object for the specified <varname>function</varname>. @@ -3571,36 +3312,18 @@ for a complete explanation of the arguments and behavior. </listitem> </varlistentry> <varlistentry id="f-SConscript"> - <term> - <literal>SConscript(scripts, [exports, variant_dir, duplicate, must_exist])</literal> - </term> - <term> - <literal>env.SConscript(scripts, [exports, variant_dir, duplicate, must_exist])</literal> - </term> - <term> - <literal>SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist])</literal> - </term> - <term> - <literal>env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -to execute -one or more subsidiary SConscript (configuration) files. -Any variables returned by a called script using -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Return"><function>Return</function></link> -will be returned by the call to -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>. + <term><function>SConscript</function>(<parameter>scripts, [exports, variant_dir, duplicate, must_exist]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SConscript</methodname>(<parameter>scripts, [exports, variant_dir, duplicate, must_exist]</parameter>)</term> + <term><function>SConscript</function>(<parameter>dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SConscript</methodname>(<parameter>dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]</parameter>)</term> + <listitem><para> +Execute one or more subsidiary SConscript (configuration) files. There are two ways to call the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> -function. +<function>SConscript</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The first way you can call -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<para> +The first calling style is to explicitly specify one or more <varname>scripts</varname> as the first argument. @@ -3608,148 +3331,131 @@ A single script may be specified as a string; multiple scripts must be specified as a list (either explicitly or as created by a function like -<function xmlns="http://www.scons.org/dbxsd/v1.0">Split</function>). +<link linkend="f-Split"><function>Split</function></link>). Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> SConscript('SConscript') # run SConscript in the current directory SConscript('src/SConscript') # run SConscript in the src directory SConscript(['src/SConscript', 'doc/SConscript']) config = SConscript('MyConfig.py') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The second way you can call -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<para> +The second way to call +<function>SConscript</function> is to specify a list of (sub)directory names as a -<literal>dirs=</literal><varname>subdirs</varname> +<varname>dirs</varname>=<replaceable>subdirs</replaceable> keyword argument. In this case, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will, by default, +<command>scons</command> +will execute a subsidiary configuration file named -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> in each of the specified directories. You may specify a name other than -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> by supplying an optional -<literal>name=</literal><varname>script</varname> +<varname>name</varname>=<replaceable>script</replaceable> keyword argument. The first three examples below have the same effect as the first three examples above: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> SConscript(dirs='.') # run SConscript in the current directory SConscript(dirs='src') # run SConscript in the src directory SConscript(dirs=['src', 'doc']) SConscript(dirs=['sub1', 'sub2'], name='MySConscript') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional <varname>exports</varname> -argument provides a list of variable names or a dictionary of -named values to export to the -<varname>script(s)</varname>. -These variables are locally exported only to the specified -<varname>script(s)</varname>, -and do not affect the global pool of variables used by the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function> +argument provides a string or list of strings representing +variable names, or a dictionary of named values, to export. +These variables are locally exported only to the called +SConscript file(s) +and do not affect the global pool of variables managed by the +<link linkend="f-Export"><function>Export</function></link> function. <!-- If multiple dirs are provided, each script gets a fresh export. --> -The subsidiary -<varname>script(s)</varname> +The subsidiary SConscript files must use the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Import"><function>Import</function></link> +<link linkend="f-Import"><function>Import</function></link> function to import the variables. Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> foo = SConscript('sub/SConscript', exports='env') SConscript('dir/SConscript', exports=['env', 'variable']) SConscript(dirs='subdir', exports='env variable') SConscript(dirs=['one', 'two', 'three'], exports='shared_info') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the optional <varname>variant_dir</varname> argument is present, it causes an effect equivalent to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link> -method described below. -(If -<varname>variant_dir</varname> -is not present, the -<!-- <varname>src_dir</varname> and --> -<varname>duplicate</varname> -<!-- arguments are ignored.) --> -argument is ignored.) -The -<varname>variant_dir</varname> -<!-- -and -<varname>src_dir</varname> -arguments are interpreted relative to the directory of the calling ---> +<link linkend="f-VariantDir"><function>VariantDir</function></link> function. +The <varname>variant_dir</varname> argument is interpreted relative to the directory of the calling -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> -file. -See the description of the -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> -function below for additional details and restrictions. +SConscript file. +The optional +<varname>duplicate</varname> argument is +interpreted as for <link linkend="f-VariantDir"><function>VariantDir</function></link>. +If <varname>variant_dir</varname> +is omitted, the <varname>duplicate</varname> argument is ignored. +See the description of +<link linkend="f-VariantDir"><function>VariantDir</function></link> +below for additional details and restrictions. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>variant_dir</varname> is present, -<!-- -but -<varname>src_dir</varname> -is not, ---> the source directory is the directory in which the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +SConscript file resides and the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +SConscript file is evaluated as if it were in the <varname>variant_dir</varname> directory: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -SConscript('src/SConscript', variant_dir = 'build') +<example_commands> +SConscript('src/SConscript', variant_dir='build') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> is equivalent to </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> VariantDir('build', 'src') SConscript('build/SConscript') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This later paradigm is often used when the sources are in the same directory as the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename>: +<filename>SConstruct</filename>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -SConscript('SConscript', variant_dir = 'build') +<example_commands> +SConscript('SConscript', variant_dir='build') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> is equivalent to </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> VariantDir('build', '.') SConscript('build/SConscript') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <!-- If <varname>variant_dir</varname> @@ -3782,36 +3488,39 @@ TODO??? SConscript('build/SConscript', src_dir='src') --> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The optional +<para> +If the optional <varname>must_exist</varname> -argument, if true, causes an exception to be raised if a requested -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> file is not found. The current default is false, -causing only a warning to be omitted, but this behavior is deprecated. +is <constant>True</constant>, +causes an exception to be raised if a requested +SConscript file is not found. The current default is +<constant>False</constant>, +causing only a warning to be emitted, but this default is deprecated +(<emphasis>since 3.1</emphasis>). For scripts which truly intend to be optional, transition to -explicty supplying -<literal>must_exist=False</literal> to the call. +explicitly supplying +<literal>must_exist=False</literal> to the <function>SConscript</function> call. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Here are some composite examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # collect the configuration information and use it to build src and doc shared_info = SConscript('MyConfig.py') SConscript('src/SConscript', exports='shared_info') SConscript('doc/SConscript', exports='shared_info') </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # build debugging and production versions. SConscript # can use Dir('.').path to determine variant. SConscript('SConscript', variant_dir='debug', duplicate=0) SConscript('SConscript', variant_dir='prod', duplicate=0) </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # build debugging and production versions. SConscript # is passed flags to use. opts = { 'CPPDEFINES' : ['DEBUG'], 'CCFLAGS' : '-pgdb' } @@ -3820,25 +3529,32 @@ opts = { 'CPPDEFINES' : ['NODEBUG'], 'CCFLAGS' : '-O' } SConscript('SConscript', variant_dir='prod', duplicate=0, exports=opts) </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # build common documentation and compile for different architectures SConscript('doc/SConscript', variant_dir='build/doc', duplicate=0) SConscript('src/SConscript', variant_dir='build/x86', duplicate=0) SConscript('src/SConscript', variant_dir='build/ppc', duplicate=0) </example_commands> + +<para> +<function>SConscript</function> returns the values of any variables +named by the executed SConscript(s) in arguments +to the <link linkend="f-Return"><function>Return</function></link> function (see above for details). +If a single <function>SConscript</function> call causes multiple scripts to +be executed, the return value is a tuple containing +the returns of all of the scripts. If an executed +script does not explicitly call <function>Return</function>, it returns +<constant>None</constant>. +</para> + </listitem> </varlistentry> <varlistentry id="f-SConscriptChdir"> - <term> - <literal>SConscriptChdir(value)</literal> - </term> - <term> - <literal>env.SConscriptChdir(value)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SConscriptChdir</function>(<parameter>value</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SConscriptChdir</methodname>(<parameter>value</parameter>)</term> + <listitem><para> By default, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> changes its working directory to the directory in which each subsidiary SConscript file lives. @@ -3846,14 +3562,14 @@ This behavior may be disabled by specifying either: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> SConscriptChdir(0) env.SConscriptChdir(0) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> in which case -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will stay in the top-level directory while reading all SConscript files. (This may be necessary when building from repositories, @@ -3865,11 +3581,11 @@ SConscriptChdir() multiple times. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() SConscriptChdir(0) SConscript('foo/SConscript') # will not chdir to foo @@ -3879,16 +3595,11 @@ SConscript('bar/SConscript') # will chdir to bar </listitem> </varlistentry> <varlistentry id="f-SConsignFile"> - <term> - <literal>SConsignFile([file, dbm_module])</literal> - </term> - <term> - <literal>env.SConsignFile([file, dbm_module])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SConsignFile</function>(<parameter>[file, dbm_module]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SConsignFile</methodname>(<parameter>[file, dbm_module]</parameter>)</term> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to store all file signatures in the specified database <varname>file</varname>. @@ -3905,17 +3616,17 @@ If <varname>file</varname> is not an absolute path name, the file is placed in the same directory as the top-level -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> +<filename>SConstruct</filename> file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>file</varname> is <literal>None</literal>, then -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will store file signatures in a separate <filename>.sconsign</filename> @@ -3925,7 +3636,7 @@ not in one global database file. prior to SCons 0.96.91 and 0.97.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional <varname>dbm_module</varname> argument can be used to specify @@ -3937,11 +3648,11 @@ Python data structures, and which works on all Python versions. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Explicitly stores signatures in ".sconsign.dblite" # in the top-level SConstruct directory (the # default behavior). @@ -3961,17 +3672,14 @@ SConsignFile(None) </listitem> </varlistentry> <varlistentry id="f-SetDefault"> - <term> - <literal>env.SetDefault(key=val, [...])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>SetDefault</methodname>(<parameter>key=val, [...]</parameter>)</term> + <listitem><para> Sets construction variables to default values specified with the keyword arguments if (and only if) the variables are not already set. The following statements are equivalent: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SetDefault(FOO = 'foo') if 'FOO' not in env: env['FOO'] = 'foo' @@ -3979,25 +3687,21 @@ if 'FOO' not in env: env['FOO'] = 'foo' </listitem> </varlistentry> <varlistentry id="f-SetOption"> - <term> - <literal>SetOption(name, value)</literal> - </term> - <term> - <literal>env.SetOption(name, value)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SetOption</function>(<parameter>name, value</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SetOption</methodname>(<parameter>name, value</parameter>)</term> + <listitem><para> This function provides a way to set a select subset of the scons command line options from a SConscript file. The options supported are: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <variablelist> <varlistentry> <term><literal>clean</literal></term> <listitem> <para> -which corresponds to -c, --clean and --remove; +which corresponds to <option>-c</option>, <option>--clean</option> +and <option>--remove</option>; </para> </listitem> </varlistentry> @@ -4005,7 +3709,7 @@ which corresponds to -c, --clean and --remove; <term><literal>duplicate</literal></term> <listitem> <para> -which corresponds to --duplicate; +which corresponds to <option>--duplicate</option>; </para> </listitem> </varlistentry> @@ -4013,7 +3717,7 @@ which corresponds to --duplicate; <term><literal>help</literal></term> <listitem> <para> -which corresponds to -h and --help; +which corresponds to <option>-h</option> and <option>--help</option>; </para> </listitem> </varlistentry> @@ -4021,7 +3725,7 @@ which corresponds to -h and --help; <term><literal>implicit_cache</literal></term> <listitem> <para> -which corresponds to --implicit-cache; +which corresponds to <option>--implicit-cache</option>; </para> </listitem> </varlistentry> @@ -4029,7 +3733,7 @@ which corresponds to --implicit-cache; <term><literal>max_drift</literal></term> <listitem> <para> -which corresponds to --max-drift; +which corresponds to <option>--max-drift</option>; </para> </listitem> </varlistentry> @@ -4037,7 +3741,9 @@ which corresponds to --max-drift; <term><literal>no_exec</literal></term> <listitem> <para> -which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; +which corresponds to <option>-n</option>, <option>--no-exec</option>, +<option>--just-print</option>, <option>--dry-run</option> +and <option>--recon</option>; </para> </listitem> </varlistentry> @@ -4045,7 +3751,7 @@ which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; <term><literal>num_jobs</literal></term> <listitem> <para> -which corresponds to -j and --jobs; +which corresponds to <option>-j</option> and <option>--jobs</option>; </para> </listitem> </varlistentry> @@ -4053,7 +3759,7 @@ which corresponds to -j and --jobs; <term><literal>random</literal></term> <listitem> <para> -which corresponds to --random; and +which corresponds to <option>--random</option>; and </para> </listitem> </varlistentry> @@ -4061,7 +3767,7 @@ which corresponds to --random; and <term><literal>silent</literal></term> <listitem> <para> -which corresponds to --silent. +which corresponds to <option>--silent</option>. </para> </listitem> </varlistentry> @@ -4076,30 +3782,25 @@ which corresponds to --stack-size. </variablelist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> See the documentation for the -corresponding command line object for information about each specific +corresponding command line option for information about each specific option. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> SetOption('max_drift', 1) </example_commands> </listitem> </varlistentry> <varlistentry id="f-SideEffect"> - <term> - <literal>SideEffect(side_effect, target)</literal> - </term> - <term> - <literal>env.SideEffect(side_effect, target)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>SideEffect</function>(<parameter>side_effect, target</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>SideEffect</methodname>(<parameter>side_effect, target</parameter>)</term> + <listitem><para> Declares <varname>side_effect</varname> as a side effect of building @@ -4117,7 +3818,7 @@ files for a static library, and various log files are created updated as side effects of various TeX commands. If a target is a side effect of multiple build commands, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will ensure that only one set of commands is executed at a time. Consequently, you only need to use this method @@ -4125,7 +3826,7 @@ for side-effect targets that are built as a result of multiple build commands. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Because multiple build commands may update the same side effect file, by default the @@ -4149,160 +3850,53 @@ is cleaned whenever a specific is cleaned, you must specify this explicitly with the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Clean"><function>Clean</function></link> +<link linkend="f-Clean"><function>Clean</function></link> or -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Clean</function> +<function>env.Clean</function> function. </para> </listitem> </varlistentry> - <varlistentry id="f-SourceCode"> - <term> - <literal>SourceCode(entries, builder)</literal> - </term> - <term> - <literal>env.SourceCode(entries, builder)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This function and its associate factory functions are deprecated. -There is no replacement. -The intended use was to keep a local tree in sync with an archive, -but in actuality the function only causes the archive -to be fetched on the first run. -Synchronizing with the archive is best done external to <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application>. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Arrange for non-existent source files to -be fetched from a source code management system -using the specified -<varname>builder</varname>. -The specified -<varname>entries</varname> -may be a Node, string or list of both, -and may represent either individual -source files or directories in which -source files can be found. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -For any non-existent source files, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will search up the directory tree -and use the first -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -builder it finds. -The specified -<varname>builder</varname> -may be -<literal>None</literal>, -in which case -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will not use a builder to fetch -source files for the specified -<varname>entries</varname>, -even if a -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> -builder has been specified -for a directory higher up the tree. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -will, by default, -fetch files from SCCS or RCS subdirectories -without explicit configuration. -This takes some extra processing time -to search for the necessary -source code management files on disk. -You can avoid these extra searches -and speed up your build a little -by disabling these searches as follows: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', None) -</example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Note that if the specified -<varname>builder</varname> -is one you create by hand, -it must have an associated -construction environment to use -when fetching a source file. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> -provides a set of canned factory -functions that return appropriate -Builders for various popular -source code management systems. -Canonical examples of invocation include: -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.SourceCode('.', env.BitKeeper('/usr/local/BKsources')) -env.SourceCode('src', env.CVS('/usr/local/CVSROOT')) -env.SourceCode('/', env.RCS()) -env.SourceCode(['f1.c', 'f2.c'], env.SCCS()) -env.SourceCode('no_source.c', None) -</example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<!-- env.SourceCode('.', env.Subversion('file:///usr/local/Subversion')) --> -</para> -</listitem> - </varlistentry> <varlistentry id="f-Split"> - <term> - <literal>Split(arg)</literal> - </term> - <term> - <literal>env.Split(arg)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Split</function>(<parameter>arg</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Split</methodname>(<parameter>arg</parameter>)</term> + <listitem><para> Returns a list of file names or other objects. -If arg is a string, +If <varname>arg</varname> is a string, it will be split on strings of white-space characters within the string, making it easier to write long lists of file names. -If arg is already a list, +If <varname>arg</varname> is already a list, the list will be returned untouched. -If arg is any other type of object, +If <varname>arg</varname> is any other type of object, it will be returned as a list containing just the object. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> files = Split("f1.c f2.c f3.c") files = env.Split("f4.c f5.c f6.c") files = Split(""" - f7.c - f8.c - f9.c + f7.c + f8.c + f9.c """) </example_commands> </listitem> </varlistentry> <varlistentry id="f-subst"> - <term> - <literal>env.subst(input, [raw, target, source, conv])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><replaceable>env</replaceable>.<methodname>subst</methodname>(<parameter>input, [raw, target, source, conv]</parameter>)</term> + <listitem><para> Performs construction variable interpolation on the specified string or sequence argument <varname>input</varname>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> By default, leading or trailing white space will be removed from the result. @@ -4334,7 +3928,7 @@ pairs (as is done for signature calculation). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the input is a sequence (list or tuple), the individual elements of @@ -4342,7 +3936,7 @@ the sequence will be expanded, and the results will be returned as a list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional <varname>target</varname> and @@ -4351,20 +3945,20 @@ keyword arguments must be set to lists of target and source nodes, respectively, if you want the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET</envar>, -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGETS</envar>, -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SOURCE</envar> +<envar>$TARGET</envar>, +<envar>$TARGETS</envar>, +<envar>$SOURCE</envar> and -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SOURCES</envar> +<envar>$SOURCES</envar> to be available for expansion. This is usually necessary if you are calling -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.subst</function> +<function>env.subst</function> from within a Python function used as an SCons action. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Returned string values or sequence elements are converted to their string representation by default. The optional @@ -4382,11 +3976,11 @@ idiom to pass in an unnamed function that simply returns its unconverted argument. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> print(env.subst("The C compiler is: $CC")) def compile(target, source, env): @@ -4400,23 +3994,20 @@ source_nodes = env.subst('$EXPAND_TO_NODELIST', </listitem> </varlistentry> <varlistentry id="f-Tag"> - <term> - <literal>Tag(node, tags)</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Tag</function>(<parameter>node, tags</parameter>)</term> + <listitem><para> Annotates file or directory Nodes with information about how the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Package"><function>Package</function></link> +<link linkend="b-Package"><function>Package</function></link> Builder should package those files or directories. All tags are optional. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # makes sure the built library will be installed with 0o644 file # access mode Tag( Library( 'lib.c' ), UNIX_ATTR="0o644" ) @@ -4427,81 +4018,71 @@ Tag( 'file2.txt', DOC ) </listitem> </varlistentry> <varlistentry id="f-Tool"> - <term> - <literal>Tool(string, [toolpath, **kw])</literal> - </term> - <term> - <literal>env.Tool(string, [toolpath, **kw])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The -<function xmlns="http://www.scons.org/dbxsd/v1.0">Tool</function> -form of the function -returns a callable object -that can be used to initialize -a construction environment using the -tools keyword of the Environment() method. -The object may be called with a construction -environment as an argument, -in which case the object will -add the necessary variables -to the construction environment -and the name of the tool will be added to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TOOLS"><envar>$TOOLS</envar></link> -construction variable. + <term><function>Tool</function>(<parameter>name, [toolpath, **kwargs]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Tool</methodname>(<parameter>name, [toolpath, **kwargs]</parameter>)</term> + <listitem><para> +Runs the tool identified by +<parameter>name</parameter>, which is +searched for in standard locations and any +paths specified by the optional +<parameter>toolpath</parameter>, +to update a <phrase>construction environment</phrase> with <phrase>construction variables</phrase> +needed to use the mechanisms that tool describes. +Any additional keyword arguments +<parameter>kwargs</parameter> are passed +on to the tool module's <function>generate</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Additional keyword arguments are passed to the tool's -<function>generate</function>() -method. +<para> +When called as a <phrase>construction environment</phrase> method, +the tool module is called to update the +<phrase>construction environment</phrase> and the name of the tool is +appended to the <link linkend="cv-TOOLS"><envar>$TOOLS</envar></link> +<phrase>construction variable</phrase> in that environment. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(tools = [ Tool('msvc') ]) - -env = Environment() -t = Tool('msvc') -t(env) # adds 'msvc' to the TOOLS variable -u = Tool('opengl', toolpath = ['tools']) -u(env) # adds 'opengl' to the TOOLS variable +<example_commands> +env.Tool('gcc') +env.Tool('opengl', toolpath=['build/tools']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Tool</function> -form of the function -applies the callable object for the specified tool -<varname>string</varname> -to the environment through which the method was called. +<para> +When called as a global function, +returns a callable tool object; +the tool is not called at this time, +as it lacks the context of an environment to update. +This tool object can be passed to an +<link linkend="f-Environment"><function>Environment</function></link> or <link linkend="f-Clone"><function>Clone</function></link> call +as part of the <parameter>tools</parameter> keyword argument, +or it can be called directly, +passing a <phrase>construction environment</phrase> to update as the argument. +Either approach will also update the +<varname>TOOLS</varname> <phrase>construction variable</phrase>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Additional keyword arguments are passed to the tool's -<function>generate</function>() -method. +<para> +Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env.Tool('gcc') -env.Tool('opengl', toolpath = ['build/tools']) +<example_commands> +env = Environment(tools=[Tool('msvc')]) + +env = Environment() +t = Tool('msvc') +t(env) # adds 'msvc' to the TOOLS variable +u = Tool('opengl', toolpath = ['tools']) +u(env) # adds 'opengl' to the TOOLS variable </example_commands> </listitem> </varlistentry> <varlistentry id="f-Value"> - <term> - <literal>Value(value, [built_value])</literal> - </term> - <term> - <literal>env.Value(value, [built_value])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>Value</function>(<parameter>value, [built_value], [name]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>Value</methodname>(<parameter>value, [built_value], [name]</parameter>)</term> + <listitem><para> Returns a Node object representing the specified Python value. Value Nodes can be used as dependencies of targets. If the result of calling @@ -4513,9 +4094,13 @@ will be rebuilt. files are up-to-date.) When using timestamp source signatures, Value Nodes' timestamps are equal to the system time when the Node is created. +<varname>name</varname> can be provided as an alternative name +for the resulting <literal>Value</literal> node; this is advised +if the <varname>value</varname> parameter can't be converted to +a string. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The returned Value Node object has a <function>write</function>() method that can be used to "build" a Value Node @@ -4531,11 +4116,11 @@ There is a corresponding method that will return the built value of the Node. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() def create(target, source, env): @@ -4571,16 +4156,11 @@ env.UpdateValue(target = Value(output), source = Value(input)) </listitem> </varlistentry> <varlistentry id="f-VariantDir"> - <term> - <literal>VariantDir(variant_dir, src_dir, [duplicate])</literal> - </term> - <term> - <literal>env.VariantDir(variant_dir, src_dir, [duplicate])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>VariantDir</function>(<parameter>variant_dir, src_dir, [duplicate]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>VariantDir</methodname>(<parameter>variant_dir, src_dir, [duplicate]</parameter>)</term> + <listitem><para> Use the -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<function>VariantDir</function> function to create a copy of your sources in another location: if a name under <varname>variant_dir</varname> @@ -4593,8 +4173,8 @@ than the original sources by simply refering to the sources (and targets) within the variant tree. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<para> +<function>VariantDir</function> can be called multiple times with the same <varname>src_dir</varname> to set up multiple builds with different options @@ -4612,9 +4192,9 @@ TODO: src_dir = '.' works fine with a build dir under it. --> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The default behavior is for -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to physically duplicate the source files in the variant tree. Thus, a build performed in the variant tree is guaranteed to be identical to a build performed in the source tree even if @@ -4625,7 +4205,7 @@ or individual compilers or other invoked tools are hard-coded to put derived files in the same directory as source files. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If possible on the platform, the duplication is performed by linking rather than copying; see also the @@ -4636,14 +4216,14 @@ files and directories that are not used are not present in <varname>variant_dir</varname>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Duplicating the source tree may be disabled by setting the <literal>duplicate</literal> argument to <literal>0</literal> (zero). This will cause -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to invoke Builders using the path names of source files in <varname>src_dir</varname> and the path names of derived files within @@ -4654,9 +4234,9 @@ and is usually safe for most builds (but see above for cases that may cause problems). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<function>VariantDir</function> works most naturally with a subsidiary SConscript file. However, you would then call the subsidiary SConscript file not in the source directory, but in the @@ -4664,11 +4244,11 @@ not in the source directory, but in the regardless of the value of <literal>duplicate</literal>. This is how you tell -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> which variant of a source tree to build: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # run src/SConscript in two variant directories VariantDir('build/variant1', 'src') SConscript('build/variant1/SConscript') @@ -4676,31 +4256,31 @@ VariantDir('build/variant2', 'src') SConscript('build/variant2/SConscript') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> See also the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SConscript"><function>SConscript</function></link> +<link linkend="f-SConscript"><function>SConscript</function></link> function, described above, for another way to specify a variant directory in conjunction with calling a subsidiary SConscript file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # use names in the build directory, not the source directory VariantDir('build', 'src', duplicate=0) Program('build/prog', 'build/source.c') </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # this builds both the source and docs in a separate subtree VariantDir('build', '.', duplicate=0) SConscript(dirs=['build/src','build/doc']) </example_commands> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # same as previous example, but only uses SConscript SConscript(dirs='src', variant_dir='build/src', duplicate=0) SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) @@ -4708,61 +4288,58 @@ SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) </listitem> </varlistentry> <varlistentry id="f-WhereIs"> - <term> - <literal>WhereIs(program, [path, pathext, reject])</literal> - </term> - <term> - <literal>env.WhereIs(program, [path, pathext, reject])</literal> - </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term><function>WhereIs</function>(<parameter>program, [path, pathext, reject]</parameter>)</term> + <term><replaceable>env</replaceable>.<methodname>WhereIs</methodname>(<parameter>program, [path, pathext, reject]</parameter>)</term> + <listitem><para> Searches for the specified executable <varname>program</varname>, -returning the full path name to the program -if it is found, else <literal>None</literal>. -Searches the value of the +returning the full path to the program +or <constant>None</constant>. +</para> +<para> +When called as a <phrase>construction environment</phrase> method, +searches the paths in the <varname>path</varname> keyword argument, -or if <literal>None</literal> (the default) -the value of the calling environment's <envar>PATH</envar> -(<literal>env['ENV']['PATH']</literal>). -If <varname>path</varname> is <literal>None</literal> and -the <literal>env['ENV']['PATH']</literal> key does not exist, -the user's current external <envar>PATH</envar> -(<literal>os.environ['PATH']</literal>) is used as fallback. -</para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +or if <constant>None</constant> (the default) +the paths listed in the <phrase>construction environment</phrase> +(<replaceable>env</replaceable><literal>['ENV']['PATH']</literal>). +The external environment's path list +(<literal>os.environ['PATH']</literal>) +is used as a fallback if the key +<replaceable>env</replaceable><literal>['ENV']['PATH']</literal> +does not exist. +</para> +<para> On Windows systems, searches for executable programs with any of the file extensions listed in the <varname>pathext</varname> keyword argument, or if <literal>None</literal> (the default) -the calling environment's <envar>PATHEXT</envar> -(<literal>env['ENV']['PATHEXT']</literal>). -The user's current external <envar>PATHEXT</envar> +the pathname extensions listed in the <phrase>construction environment</phrase> +(<replaceable>env</replaceable><literal>['ENV']['PATHEXT']</literal>). +The external environment's pathname extensions list (<literal>os.environ['PATHEXT']</literal>) -is used as a fallback if <varname>pathext</varname> is -<literal>None</literal> -and the key <literal>env['ENV']['PATHEXT']</literal> +is used as a fallback if the key +<replaceable>env</replaceable><literal>['ENV']['PATHEXT']</literal> does not exist. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> +When called as a global function, uses the external +environment's path +<literal>os.environ['PATH']</literal> +and path extensions +<literal>os.environ['PATHEXT']</literal>, +respectively, if +<varname>path</varname> and +<varname>pathext</varname> are +<constant>None</constant>. +</para> +<para> Will not select any path name or names -in the specified +in the optional <varname>reject</varname> -list, if any. +list. </para> -<note xmlns="http://www.scons.org/dbxsd/v1.0"> -<para> -If you would prefer to search -the user's current external <envar>PATH</envar> -(<literal>os.environ['PATH']</literal>) -by default, -consider using the function <literal>SCons.Util.WhereIs</literal> instead. -Note that <literal>SCons.Util.WhereIs</literal> -does not expand environment variables automatically -(no implicit <literal>env.subst</literal> for its arguments). -</para> -</note> </listitem> </varlistentry> diff --git a/doc/generated/functions.mod b/doc/generated/functions.mod index 47d2be4..9ff02a0 100644 --- a/doc/generated/functions.mod +++ b/doc/generated/functions.mod @@ -30,6 +30,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-Default "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Default</function>"> <!ENTITY f-DefaultEnvironment "<function xmlns='http://www.scons.org/dbxsd/v1.0'>DefaultEnvironment</function>"> <!ENTITY f-Depends "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Depends</function>"> +<!ENTITY f-Detect "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Detect</function>"> <!ENTITY f-Dictionary "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Dictionary</function>"> <!ENTITY f-Dir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Dir</function>"> <!ENTITY f-Dump "<function xmlns='http://www.scons.org/dbxsd/v1.0'>Dump</function>"> @@ -110,6 +111,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-env-Default "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Default</function>"> <!ENTITY f-env-DefaultEnvironment "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.DefaultEnvironment</function>"> <!ENTITY f-env-Depends "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Depends</function>"> +<!ENTITY f-env-Detect "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Detect</function>"> <!ENTITY f-env-Dictionary "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Dictionary</function>"> <!ENTITY f-env-Dir "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Dir</function>"> <!ENTITY f-env-Dump "<function xmlns='http://www.scons.org/dbxsd/v1.0'>env.Dump</function>"> @@ -200,6 +202,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-Default "<link linkend='f-Default' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Default</function></link>"> <!ENTITY f-link-DefaultEnvironment "<link linkend='f-DefaultEnvironment' xmlns='http://www.scons.org/dbxsd/v1.0'><function>DefaultEnvironment</function></link>"> <!ENTITY f-link-Depends "<link linkend='f-Depends' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Depends</function></link>"> +<!ENTITY f-link-Detect "<link linkend='f-Detect' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Detect</function></link>"> <!ENTITY f-link-Dictionary "<link linkend='f-Dictionary' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Dictionary</function></link>"> <!ENTITY f-link-Dir "<link linkend='f-Dir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Dir</function></link>"> <!ENTITY f-link-Dump "<link linkend='f-Dump' xmlns='http://www.scons.org/dbxsd/v1.0'><function>Dump</function></link>"> @@ -280,6 +283,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY f-link-env-Default "<link linkend='f-Default' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Default</function></link>"> <!ENTITY f-link-env-DefaultEnvironment "<link linkend='f-DefaultEnvironment' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.DefaultEnvironment</function></link>"> <!ENTITY f-link-env-Depends "<link linkend='f-Depends' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Depends</function></link>"> +<!ENTITY f-link-env-Detect "<link linkend='f-Detect' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Detect</function></link>"> <!ENTITY f-link-env-Dictionary "<link linkend='f-Dictionary' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Dictionary</function></link>"> <!ENTITY f-link-env-Dir "<link linkend='f-Dir' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Dir</function></link>"> <!ENTITY f-link-env-Dump "<link linkend='f-Dump' xmlns='http://www.scons.org/dbxsd/v1.0'><function>env.Dump</function></link>"> diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index 0d30f6f..e81eb09 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,153 +11,137 @@ %variables-mod; ]> -<variablelist 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 http://www.scons.org/dbxsd/v1.0/scons.xsd"> +<variablelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <varlistentry id="t-386asm"> <term>386asm</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the 386ASM assembler for the Phar Lap ETS embedded operating system. </para> -<para>Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.</para><para>Uses: &cv-link-CC;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> <link linkend="cv-ASCOM"><varname>$ASCOM</varname></link> <link linkend="cv-ASFLAGS"><varname>$ASFLAGS</varname></link> <link linkend="cv-ASPPCOM"><varname>$ASPPCOM</varname></link> <link linkend="cv-ASPPFLAGS"><varname>$ASPPFLAGS</varname></link> </para><para>Uses: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_CPPINCFLAGS"><varname>$_CPPINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-aixcXX"> <term>aixc++</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the IMB xlc / Visual Age C++ compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXVERSION"><varname>$CXXVERSION</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-aixcc"> <term>aixcc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the IBM xlc / Visual Age C compiler. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCC;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCVERSION"><varname>$CCVERSION</varname></link> <link linkend="cv-SHCC"><varname>$SHCC</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-aixf77"> <term>aixf77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the IBM Visual Age f77 Fortran compiler. </para> -<para>Sets: &cv-link-F77;, &cv-link-SHF77;.</para></listitem> +<para>Sets: <link linkend="cv-F77"><varname>$F77</varname></link> <link linkend="cv-SHF77"><varname>$SHF77</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-aixlink"> <term>aixlink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the IBM Visual Age linker. </para> -<para>Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-SHLIBSUFFIX"><varname>$SHLIBSUFFIX</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-applelink"> <term>applelink</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Apple linker (similar to the GNU linker). </para> - <para>Sets: &cv-link-APPLELINK_COMPATIBILITY_VERSION;, &cv-link-APPLELINK_CURRENT_VERSION;, &cv-link-APPLELINK_NO_COMPATIBILITY_VERSION;, &cv-link-APPLELINK_NO_CURRENT_VERSION;, &cv-link-FRAMEWORKPATHPREFIX;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LINKCOM;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-_APPLELINK_COMPATIBILITY_VERSION;, &cv-link-_APPLELINK_CURRENT_VERSION;, &cv-link-_FRAMEWORKPATH;, &cv-link-_FRAMEWORKS;.</para><para>Uses: &cv-link-FRAMEWORKSFLAGS;.</para></listitem> + <para>Sets: <link linkend="cv-APPLELINK_COMPATIBILITY_VERSION"><varname>$APPLELINK_COMPATIBILITY_VERSION</varname></link> <link linkend="cv-APPLELINK_CURRENT_VERSION"><varname>$APPLELINK_CURRENT_VERSION</varname></link> <link linkend="cv-APPLELINK_NO_COMPATIBILITY_VERSION"><varname>$APPLELINK_NO_COMPATIBILITY_VERSION</varname></link> <link linkend="cv-APPLELINK_NO_CURRENT_VERSION"><varname>$APPLELINK_NO_CURRENT_VERSION</varname></link> <link linkend="cv-FRAMEWORKPATHPREFIX"><varname>$FRAMEWORKPATHPREFIX</varname></link> <link linkend="cv-LDMODULECOM"><varname>$LDMODULECOM</varname></link> <link linkend="cv-LDMODULEFLAGS"><varname>$LDMODULEFLAGS</varname></link> <link linkend="cv-LDMODULEPREFIX"><varname>$LDMODULEPREFIX</varname></link> <link linkend="cv-LDMODULESUFFIX"><varname>$LDMODULESUFFIX</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-_APPLELINK_COMPATIBILITY_VERSION"><varname>$_APPLELINK_COMPATIBILITY_VERSION</varname></link> <link linkend="cv-_APPLELINK_CURRENT_VERSION"><varname>$_APPLELINK_CURRENT_VERSION</varname></link> <link linkend="cv-_FRAMEWORKPATH"><varname>$_FRAMEWORKPATH</varname></link> <link linkend="cv-_FRAMEWORKS"><varname>$_FRAMEWORKS</varname></link> </para><para>Uses: <link linkend="cv-FRAMEWORKSFLAGS"><varname>$FRAMEWORKSFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-ar"> <term>ar</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">ar</application> library archiver. + <listitem><para> +Sets construction variables for the <application>ar</application> library archiver. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-RANLIB;, &cv-link-RANLIBCOM;, &cv-link-RANLIBFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOM"><varname>$ARCOM</varname></link> <link linkend="cv-ARFLAGS"><varname>$ARFLAGS</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> <link linkend="cv-RANLIB"><varname>$RANLIB</varname></link> <link linkend="cv-RANLIBCOM"><varname>$RANLIBCOM</varname></link> <link linkend="cv-RANLIBFLAGS"><varname>$RANLIBFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-as"> <term>as</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">as</application> assembler. + <listitem><para> +Sets construction variables for the <application>as</application> assembler. </para> -<para>Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.</para><para>Uses: &cv-link-CC;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> <link linkend="cv-ASCOM"><varname>$ASCOM</varname></link> <link linkend="cv-ASFLAGS"><varname>$ASFLAGS</varname></link> <link linkend="cv-ASPPCOM"><varname>$ASPPCOM</varname></link> <link linkend="cv-ASPPFLAGS"><varname>$ASPPFLAGS</varname></link> </para><para>Uses: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_CPPINCFLAGS"><varname>$_CPPINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-bcc32"> <term>bcc32</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the bcc32 compiler. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHOBJSUFFIX;.</para><para>Uses: &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCCOM"><varname>$CCCOM</varname></link> <link linkend="cv-CCFLAGS"><varname>$CCFLAGS</varname></link> <link linkend="cv-CFILESUFFIX"><varname>$CFILESUFFIX</varname></link> <link linkend="cv-CFLAGS"><varname>$CFLAGS</varname></link> <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> <link linkend="cv-SHCC"><varname>$SHCC</varname></link> <link linkend="cv-SHCCCOM"><varname>$SHCCCOM</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHCFLAGS"><varname>$SHCFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_CPPINCFLAGS"><varname>$_CPPINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-cc"> <term>cc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for generic POSIX C compilers. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHOBJSUFFIX;.</para><para>Uses: &cv-link-PLATFORM;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCCOM"><varname>$CCCOM</varname></link> <link linkend="cv-CCFLAGS"><varname>$CCFLAGS</varname></link> <link linkend="cv-CFILESUFFIX"><varname>$CFILESUFFIX</varname></link> <link linkend="cv-CFLAGS"><varname>$CFLAGS</varname></link> <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-FRAMEWORKPATH"><varname>$FRAMEWORKPATH</varname></link> <link linkend="cv-FRAMEWORKS"><varname>$FRAMEWORKS</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> <link linkend="cv-SHCC"><varname>$SHCC</varname></link> <link linkend="cv-SHCCCOM"><varname>$SHCCCOM</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHCFLAGS"><varname>$SHCFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-CCCOMSTR"><varname>$CCCOMSTR</varname></link> <link linkend="cv-PLATFORM"><varname>$PLATFORM</varname></link> <link linkend="cv-SHCCCOMSTR"><varname>$SHCCCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-clang"> <term>clang</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for the Clang C compiler. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCVERSION"><varname>$CCVERSION</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-clangxx"> <term>clangxx</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for the Clang C++ compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXVERSION"><varname>$CXXVERSION</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> <link linkend="cv-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"><varname>$STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-cvf"> <term>cvf</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Compaq Visual Fortran compiler. </para> -<para>Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANMODDIR;, &cv-link-FORTRANMODDIRPREFIX;, &cv-link-FORTRANMODDIRSUFFIX;, &cv-link-FORTRANPPCOM;, &cv-link-OBJSUFFIX;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANPPCOM;.</para><para>Uses: &cv-link-CPPFLAGS;, &cv-link-FORTRANFLAGS;, &cv-link-SHFORTRANFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_FORTRANINCFLAGS;, &cv-link-_FORTRANMODFLAG;.</para></listitem> +<para>Sets: <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-FORTRANCOM"><varname>$FORTRANCOM</varname></link> <link linkend="cv-FORTRANMODDIR"><varname>$FORTRANMODDIR</varname></link> <link linkend="cv-FORTRANMODDIRPREFIX"><varname>$FORTRANMODDIRPREFIX</varname></link> <link linkend="cv-FORTRANMODDIRSUFFIX"><varname>$FORTRANMODDIRSUFFIX</varname></link> <link linkend="cv-FORTRANPPCOM"><varname>$FORTRANPPCOM</varname></link> <link linkend="cv-OBJSUFFIX"><varname>$OBJSUFFIX</varname></link> <link linkend="cv-SHFORTRANCOM"><varname>$SHFORTRANCOM</varname></link> <link linkend="cv-SHFORTRANPPCOM"><varname>$SHFORTRANPPCOM</varname></link> </para><para>Uses: <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-FORTRANFLAGS"><varname>$FORTRANFLAGS</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_FORTRANINCFLAGS"><varname>$_FORTRANINCFLAGS</varname></link> <link linkend="cv-_FORTRANMODFLAG"><varname>$_FORTRANMODFLAG</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-cXX"> <term>cXX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for generic POSIX C++ compilers. </para> -<para>Sets: &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-CXXFLAGS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-OBJSUFFIX;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;.</para><para>Uses: &cv-link-CXXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXCOM"><varname>$CXXCOM</varname></link> <link linkend="cv-CXXFILESUFFIX"><varname>$CXXFILESUFFIX</varname></link> <link linkend="cv-CXXFLAGS"><varname>$CXXFLAGS</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> <link linkend="cv-OBJSUFFIX"><varname>$OBJSUFFIX</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHCXXCOM"><varname>$SHCXXCOM</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-CXXCOMSTR"><varname>$CXXCOMSTR</varname></link> <link linkend="cv-SHCXXCOMSTR"><varname>$SHCXXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-cyglink"> <term>cyglink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for cygwin linker/loader. </para> -<para>Sets: &cv-link-IMPLIBPREFIX;, &cv-link-IMPLIBSUFFIX;, &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-LINKFLAGS;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLIBPREFIX;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLIBVERSIONFLAGS;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-_LDMODULEVERSIONFLAGS;, &cv-link-_SHLIBVERSIONFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-IMPLIBPREFIX"><varname>$IMPLIBPREFIX</varname></link> <link linkend="cv-IMPLIBSUFFIX"><varname>$IMPLIBSUFFIX</varname></link> <link linkend="cv-LDMODULEVERSIONFLAGS"><varname>$LDMODULEVERSIONFLAGS</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-RPATHPREFIX"><varname>$RPATHPREFIX</varname></link> <link linkend="cv-RPATHSUFFIX"><varname>$RPATHSUFFIX</varname></link> <link linkend="cv-SHLIBPREFIX"><varname>$SHLIBPREFIX</varname></link> <link linkend="cv-SHLIBSUFFIX"><varname>$SHLIBSUFFIX</varname></link> <link linkend="cv-SHLIBVERSIONFLAGS"><varname>$SHLIBVERSIONFLAGS</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-_LDMODULEVERSIONFLAGS"><varname>$_LDMODULEVERSIONFLAGS</varname></link> <link linkend="cv-_SHLIBVERSIONFLAGS"><varname>$_SHLIBVERSIONFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-default"> <term>default</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variables</literal> for a default list of Tool modules. + <listitem><para> +Sets <phrase>construction variables</phrase> for a default list of Tool modules. Use <emphasis role="bold">default</emphasis> in the tools list to retain the original defaults, since the <parameter>tools</parameter> parameter is treated as a literal statement of the tools -to be made available in that <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>, not an addition. +to be made available in that <phrase>construction environment</phrase>, not an addition. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The list of tools selected by default is not static, but is dependent both on the platform and on the software installed on the platform. Some tools will not initialize if an underlying command is not found, and some tools are selected from a list of choices on a first-found basis. The finished tool list can be -examined by inspecting the <envar>TOOLS</envar> <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction variable</literal> -in the <literal xmlns="http://www.scons.org/dbxsd/v1.0">construction environment</literal>. +examined by inspecting the <envar>TOOLS</envar> <phrase>construction variable</phrase> +in the <phrase>construction environment</phrase>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On all platforms, all tools from the following list are selected whose respective conditions are met: filesystem, wix, lex, yacc, rpcgen, swig, @@ -166,7 +149,7 @@ jar, javac, javah, rmic, dvipdf, dvips, gs, tex, latex, pdflatex, pdftex, tar, zip, textfile. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On Linux systems, the default tools list selects (first-found): a C compiler from gcc, intelc, icc, cc; @@ -183,7 +166,7 @@ It also selects all found from the list m4, rpm. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On Windows systems, the default tools list selects (first-found): a C compiler from msvc, mingw, gcc, intelc, icl, icc, cc, bcc32; @@ -201,7 +184,7 @@ It also selects all found from the list msvs, midl. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> On MacOS systems, the default tools list selects (first-found): a C compiler from gcc, cc; @@ -217,9 +200,9 @@ It also selects all found from the list m4, rpm. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Default lists for other platforms can be found by -examining the <filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +examining the <command>scons</command> source code (see <filename>SCons/Tool/__init__.py</filename>). </para> @@ -228,16 +211,14 @@ source code (see </varlistentry> <varlistentry id="t-dmd"> <term>dmd</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for D language compiler DMD. </para> -<para>Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-DC"><varname>$DC</varname></link> <link linkend="cv-DCOM"><varname>$DCOM</varname></link> <link linkend="cv-DDEBUG"><varname>$DDEBUG</varname></link> <link linkend="cv-DDEBUGPREFIX"><varname>$DDEBUGPREFIX</varname></link> <link linkend="cv-DDEBUGSUFFIX"><varname>$DDEBUGSUFFIX</varname></link> <link linkend="cv-DFILESUFFIX"><varname>$DFILESUFFIX</varname></link> <link linkend="cv-DFLAGPREFIX"><varname>$DFLAGPREFIX</varname></link> <link linkend="cv-DFLAGS"><varname>$DFLAGS</varname></link> <link linkend="cv-DFLAGSUFFIX"><varname>$DFLAGSUFFIX</varname></link> <link linkend="cv-DINCPREFIX"><varname>$DINCPREFIX</varname></link> <link linkend="cv-DINCSUFFIX"><varname>$DINCSUFFIX</varname></link> <link linkend="cv-DLIB"><varname>$DLIB</varname></link> <link linkend="cv-DLIBCOM"><varname>$DLIBCOM</varname></link> <link linkend="cv-DLIBDIRPREFIX"><varname>$DLIBDIRPREFIX</varname></link> <link linkend="cv-DLIBDIRSUFFIX"><varname>$DLIBDIRSUFFIX</varname></link> <link linkend="cv-DLIBFLAGPREFIX"><varname>$DLIBFLAGPREFIX</varname></link> <link linkend="cv-DLIBFLAGSUFFIX"><varname>$DLIBFLAGSUFFIX</varname></link> <link linkend="cv-DLIBLINKPREFIX"><varname>$DLIBLINKPREFIX</varname></link> <link linkend="cv-DLIBLINKSUFFIX"><varname>$DLIBLINKSUFFIX</varname></link> <link linkend="cv-DLINK"><varname>$DLINK</varname></link> <link linkend="cv-DLINKCOM"><varname>$DLINKCOM</varname></link> <link linkend="cv-DLINKFLAGPREFIX"><varname>$DLINKFLAGPREFIX</varname></link> <link linkend="cv-DLINKFLAGS"><varname>$DLINKFLAGS</varname></link> <link linkend="cv-DLINKFLAGSUFFIX"><varname>$DLINKFLAGSUFFIX</varname></link> <link linkend="cv-DPATH"><varname>$DPATH</varname></link> <link linkend="cv-DRPATHPREFIX"><varname>$DRPATHPREFIX</varname></link> <link linkend="cv-DRPATHSUFFIX"><varname>$DRPATHSUFFIX</varname></link> <link linkend="cv-DShLibSonameGenerator"><varname>$DShLibSonameGenerator</varname></link> <link linkend="cv-DVERPREFIX"><varname>$DVERPREFIX</varname></link> <link linkend="cv-DVERSIONS"><varname>$DVERSIONS</varname></link> <link linkend="cv-DVERSUFFIX"><varname>$DVERSUFFIX</varname></link> <link linkend="cv-SHDC"><varname>$SHDC</varname></link> <link linkend="cv-SHDCOM"><varname>$SHDCOM</varname></link> <link linkend="cv-SHDLIBVERSION"><varname>$SHDLIBVERSION</varname></link> <link linkend="cv-SHDLIBVERSIONFLAGS"><varname>$SHDLIBVERSIONFLAGS</varname></link> <link linkend="cv-SHDLINK"><varname>$SHDLINK</varname></link> <link linkend="cv-SHDLINKCOM"><varname>$SHDLINKCOM</varname></link> <link linkend="cv-SHDLINKFLAGS"><varname>$SHDLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-docbook"> <term>docbook</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0">This tool tries to make working with Docbook in SCons a little easier. + <listitem><para>This tool tries to make working with Docbook in SCons a little easier. It provides several toolchains for creating different output formats, like HTML or PDF. Contained in the package is a distribution of the Docbook XSL stylesheets as of version 1.76.1. @@ -245,27 +226,27 @@ As long as you don't specify your own stylesheets for customization, these official versions are picked as default...which should reduce the inevitable setup hassles for you. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Implicit dependencies to images and XIncludes are detected automatically +<para>Implicit dependencies to images and XIncludes are detected automatically if you meet the HTML requirements. The additional stylesheet <filename>utils/xmldepend.xsl</filename> by Paul DuBois is used for this purpose. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Note, that there is no support for XML catalog resolving offered! This tool calls +<para>Note, that there is no support for XML catalog resolving offered! This tool calls the XSLT processors and PDF renderers with the stylesheets you specified, that's it. The rest lies in your hands and you still have to know what you're doing when resolving names via a catalog. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">For activating the tool "docbook", you have to add its name to the Environment constructor, +<para>For activating the tool "docbook", you have to add its name to the Environment constructor, like this </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">On its startup, the Docbook tool tries to find a required <literal>xsltproc</literal> processor, and +<para>On its startup, the Docbook tool tries to find a required <literal>xsltproc</literal> processor, and a PDF renderer, e.g. <literal>fop</literal>. So make sure that these are added to your system's environment <literal>PATH</literal> and can be called directly, without specifying their full path. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">For the most basic processing of Docbook to HTML, you need to have installed +<para>For the most basic processing of Docbook to HTML, you need to have installed </para> -<itemizedlist xmlns="http://www.scons.org/dbxsd/v1.0"><listitem><para>the Python <literal>lxml</literal> binding to <literal>libxml2</literal>, or +<itemizedlist><listitem><para>the Python <literal>lxml</literal> binding to <literal>libxml2</literal>, or </para> </listitem> <listitem><para>the direct Python bindings for <literal>libxml2/libxslt</literal>, or @@ -276,49 +257,49 @@ and <literal>xalan</literal>. </para> </listitem> </itemizedlist> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Rendering to PDF requires you to have one of the applications +<para>Rendering to PDF requires you to have one of the applications <literal>fop</literal> or <literal>xep</literal> installed. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Creating a HTML or PDF document is very simple and straightforward. Say +<para>Creating a HTML or PDF document is very simple and straightforward. Say </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtml('manual.html', 'manual.xml') env.DocbookPdf('manual.pdf', 'manual.xml') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">to get both outputs from your XML source <filename>manual.xml</filename>. As a shortcut, you can +<para>to get both outputs from your XML source <filename>manual.xml</filename>. As a shortcut, you can give the stem of the filenames alone, like this: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtml('manual') env.DocbookPdf('manual') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">and get the same result. Target and source lists are also supported: +<para>and get the same result. Target and source lists are also supported: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtml(['manual.html','reference.html'], ['manual.xml','reference.xml']) </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">or even +<para>or even </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtml(['manual','reference']) </screen> -<important xmlns="http://www.scons.org/dbxsd/v1.0"><para>Whenever you leave out the list of sources, you may not specify a file extension! The +<important><para>Whenever you leave out the list of sources, you may not specify a file extension! The Tool uses the given names as file stems, and adds the suffixes for target and source files accordingly. </para> </important> -<para xmlns="http://www.scons.org/dbxsd/v1.0">The rules given above are valid for the Builders <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtml"><function>DocbookHtml</function></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookPdf"><function>DocbookPdf</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookEpub"><function>DocbookEpub</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookXInclude"><function>DocbookXInclude</function></link>. For the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookMan"><function>DocbookMan</function></link> transformation you +<para>The rules given above are valid for the Builders <link linkend="b-DocbookHtml"><function>DocbookHtml</function></link>, +<link linkend="b-DocbookPdf"><function>DocbookPdf</function></link>, <link linkend="b-DocbookEpub"><function>DocbookEpub</function></link>, <link linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> and <link linkend="b-DocbookXInclude"><function>DocbookXInclude</function></link>. For the +<link linkend="b-DocbookMan"><function>DocbookMan</function></link> transformation you can specify a target name, but the actual output names are automatically set from the <literal>refname</literal> entries in your XML source. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0">The Builders <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> are special, in that: +<para>The Builders <link linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link>, <link linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> and +<link linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> are special, in that: </para> -<orderedlist xmlns="http://www.scons.org/dbxsd/v1.0"><listitem><para>they create a large set of files, where the exact names and their number depend +<orderedlist><listitem><para>they create a large set of files, where the exact names and their number depend on the content of the source file, and </para> </listitem> @@ -327,24 +308,24 @@ XSL transformation is not picked up by the stylesheets. </para> </listitem> </orderedlist> -<para xmlns="http://www.scons.org/dbxsd/v1.0">As a result, there is simply no use in specifying a target HTML name. +<para>As a result, there is simply no use in specifying a target HTML name. So the basic syntax for these builders is always: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook']) +<screen>env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">If you want to use a specific XSL file, you can set the +<para>If you want to use a specific XSL file, you can set the additional <literal>xsl</literal> parameter to your Builder call as follows: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') +<screen>env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">Since this may get tedious if you always use the same local naming for your customized XSL files, +<para>Since this may get tedious if you always use the same local naming for your customized XSL files, e.g. <filename>html.xsl</filename> for HTML and <filename>pdf.xsl</filename> for PDF output, a set of variables for setting the default XSL name is provided. These are: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">DOCBOOK_DEFAULT_XSL_HTML +<screen>DOCBOOK_DEFAULT_XSL_HTML DOCBOOK_DEFAULT_XSL_HTMLCHUNKED DOCBOOK_DEFAULT_XSL_HTMLHELP DOCBOOK_DEFAULT_XSL_PDF @@ -353,735 +334,665 @@ DOCBOOK_DEFAULT_XSL_MAN DOCBOOK_DEFAULT_XSL_SLIDESPDF DOCBOOK_DEFAULT_XSL_SLIDESHTML </screen> -<para xmlns="http://www.scons.org/dbxsd/v1.0">and you can set them when constructing your environment: +<para>and you can set them when constructing your environment: </para> -<screen xmlns="http://www.scons.org/dbxsd/v1.0">env = Environment(tools=['docbook'], +<screen>env = Environment(tools=['docbook'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') env.DocbookHtml('manual') # now uses html.xsl </screen> -<para>Sets: &cv-link-DOCBOOK_DEFAULT_XSL_EPUB;, &cv-link-DOCBOOK_DEFAULT_XSL_HTML;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLHELP;, &cv-link-DOCBOOK_DEFAULT_XSL_MAN;, &cv-link-DOCBOOK_DEFAULT_XSL_PDF;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESHTML;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESPDF;, &cv-link-DOCBOOK_FOP;, &cv-link-DOCBOOK_FOPCOM;, &cv-link-DOCBOOK_FOPFLAGS;, &cv-link-DOCBOOK_XMLLINT;, &cv-link-DOCBOOK_XMLLINTCOM;, &cv-link-DOCBOOK_XMLLINTFLAGS;, &cv-link-DOCBOOK_XSLTPROC;, &cv-link-DOCBOOK_XSLTPROCCOM;, &cv-link-DOCBOOK_XSLTPROCFLAGS;, &cv-link-DOCBOOK_XSLTPROCPARAMS;.</para><para>Uses: &cv-link-DOCBOOK_FOPCOMSTR;, &cv-link-DOCBOOK_XMLLINTCOMSTR;, &cv-link-DOCBOOK_XSLTPROCCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-DOCBOOK_DEFAULT_XSL_EPUB"><varname>$DOCBOOK_DEFAULT_XSL_EPUB</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_HTML"><varname>$DOCBOOK_DEFAULT_XSL_HTML</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED"><varname>$DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_HTMLHELP"><varname>$DOCBOOK_DEFAULT_XSL_HTMLHELP</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_MAN"><varname>$DOCBOOK_DEFAULT_XSL_MAN</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_PDF"><varname>$DOCBOOK_DEFAULT_XSL_PDF</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_SLIDESHTML"><varname>$DOCBOOK_DEFAULT_XSL_SLIDESHTML</varname></link> <link linkend="cv-DOCBOOK_DEFAULT_XSL_SLIDESPDF"><varname>$DOCBOOK_DEFAULT_XSL_SLIDESPDF</varname></link> <link linkend="cv-DOCBOOK_FOP"><varname>$DOCBOOK_FOP</varname></link> <link linkend="cv-DOCBOOK_FOPCOM"><varname>$DOCBOOK_FOPCOM</varname></link> <link linkend="cv-DOCBOOK_FOPFLAGS"><varname>$DOCBOOK_FOPFLAGS</varname></link> <link linkend="cv-DOCBOOK_XMLLINT"><varname>$DOCBOOK_XMLLINT</varname></link> <link linkend="cv-DOCBOOK_XMLLINTCOM"><varname>$DOCBOOK_XMLLINTCOM</varname></link> <link linkend="cv-DOCBOOK_XMLLINTFLAGS"><varname>$DOCBOOK_XMLLINTFLAGS</varname></link> <link linkend="cv-DOCBOOK_XSLTPROC"><varname>$DOCBOOK_XSLTPROC</varname></link> <link linkend="cv-DOCBOOK_XSLTPROCCOM"><varname>$DOCBOOK_XSLTPROCCOM</varname></link> <link linkend="cv-DOCBOOK_XSLTPROCFLAGS"><varname>$DOCBOOK_XSLTPROCFLAGS</varname></link> <link linkend="cv-DOCBOOK_XSLTPROCPARAMS"><varname>$DOCBOOK_XSLTPROCPARAMS</varname></link> </para><para>Uses: <link linkend="cv-DOCBOOK_FOPCOMSTR"><varname>$DOCBOOK_FOPCOMSTR</varname></link> <link linkend="cv-DOCBOOK_XMLLINTCOMSTR"><varname>$DOCBOOK_XMLLINTCOMSTR</varname></link> <link linkend="cv-DOCBOOK_XSLTPROCCOMSTR"><varname>$DOCBOOK_XSLTPROCCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-dvi"> <term>dvi</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Attaches the <function xmlns="http://www.scons.org/dbxsd/v1.0">DVI</function> builder to the + <listitem><para> +Attaches the <function>DVI</function> builder to the construction environment. </para> </listitem> </varlistentry> <varlistentry id="t-dvipdf"> <term>dvipdf</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the dvipdf utility. </para> -<para>Sets: &cv-link-DVIPDF;, &cv-link-DVIPDFCOM;, &cv-link-DVIPDFFLAGS;.</para><para>Uses: &cv-link-DVIPDFCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-DVIPDF"><varname>$DVIPDF</varname></link> <link linkend="cv-DVIPDFCOM"><varname>$DVIPDFCOM</varname></link> <link linkend="cv-DVIPDFFLAGS"><varname>$DVIPDFFLAGS</varname></link> </para><para>Uses: <link linkend="cv-DVIPDFCOMSTR"><varname>$DVIPDFCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-dvips"> <term>dvips</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the dvips utility. </para> -<para>Sets: &cv-link-DVIPS;, &cv-link-DVIPSFLAGS;, &cv-link-PSCOM;, &cv-link-PSPREFIX;, &cv-link-PSSUFFIX;.</para><para>Uses: &cv-link-PSCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-DVIPS"><varname>$DVIPS</varname></link> <link linkend="cv-DVIPSFLAGS"><varname>$DVIPSFLAGS</varname></link> <link linkend="cv-PSCOM"><varname>$PSCOM</varname></link> <link linkend="cv-PSPREFIX"><varname>$PSPREFIX</varname></link> <link linkend="cv-PSSUFFIX"><varname>$PSSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-PSCOMSTR"><varname>$PSCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-f03"> <term>f03</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran 03 compilers. </para> -<para>Sets: &cv-link-F03;, &cv-link-F03COM;, &cv-link-F03FLAGS;, &cv-link-F03PPCOM;, &cv-link-SHF03;, &cv-link-SHF03COM;, &cv-link-SHF03FLAGS;, &cv-link-SHF03PPCOM;, &cv-link-_F03INCFLAGS;.</para><para>Uses: &cv-link-F03COMSTR;, &cv-link-F03PPCOMSTR;, &cv-link-SHF03COMSTR;, &cv-link-SHF03PPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-F03"><varname>$F03</varname></link> <link linkend="cv-F03COM"><varname>$F03COM</varname></link> <link linkend="cv-F03FLAGS"><varname>$F03FLAGS</varname></link> <link linkend="cv-F03PPCOM"><varname>$F03PPCOM</varname></link> <link linkend="cv-SHF03"><varname>$SHF03</varname></link> <link linkend="cv-SHF03COM"><varname>$SHF03COM</varname></link> <link linkend="cv-SHF03FLAGS"><varname>$SHF03FLAGS</varname></link> <link linkend="cv-SHF03PPCOM"><varname>$SHF03PPCOM</varname></link> <link linkend="cv-_F03INCFLAGS"><varname>$_F03INCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-F03COMSTR"><varname>$F03COMSTR</varname></link> <link linkend="cv-F03PPCOMSTR"><varname>$F03PPCOMSTR</varname></link> <link linkend="cv-SHF03COMSTR"><varname>$SHF03COMSTR</varname></link> <link linkend="cv-SHF03PPCOMSTR"><varname>$SHF03PPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-f08"> <term>f08</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran 08 compilers. </para> -<para>Sets: &cv-link-F08;, &cv-link-F08COM;, &cv-link-F08FLAGS;, &cv-link-F08PPCOM;, &cv-link-SHF08;, &cv-link-SHF08COM;, &cv-link-SHF08FLAGS;, &cv-link-SHF08PPCOM;, &cv-link-_F08INCFLAGS;.</para><para>Uses: &cv-link-F08COMSTR;, &cv-link-F08PPCOMSTR;, &cv-link-SHF08COMSTR;, &cv-link-SHF08PPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-F08"><varname>$F08</varname></link> <link linkend="cv-F08COM"><varname>$F08COM</varname></link> <link linkend="cv-F08FLAGS"><varname>$F08FLAGS</varname></link> <link linkend="cv-F08PPCOM"><varname>$F08PPCOM</varname></link> <link linkend="cv-SHF08"><varname>$SHF08</varname></link> <link linkend="cv-SHF08COM"><varname>$SHF08COM</varname></link> <link linkend="cv-SHF08FLAGS"><varname>$SHF08FLAGS</varname></link> <link linkend="cv-SHF08PPCOM"><varname>$SHF08PPCOM</varname></link> <link linkend="cv-_F08INCFLAGS"><varname>$_F08INCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-F08COMSTR"><varname>$F08COMSTR</varname></link> <link linkend="cv-F08PPCOMSTR"><varname>$F08PPCOMSTR</varname></link> <link linkend="cv-SHF08COMSTR"><varname>$SHF08COMSTR</varname></link> <link linkend="cv-SHF08PPCOMSTR"><varname>$SHF08PPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-f77"> <term>f77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran 77 compilers. </para> -<para>Sets: &cv-link-F77;, &cv-link-F77COM;, &cv-link-F77FILESUFFIXES;, &cv-link-F77FLAGS;, &cv-link-F77PPCOM;, &cv-link-F77PPFILESUFFIXES;, &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANFLAGS;, &cv-link-SHF77;, &cv-link-SHF77COM;, &cv-link-SHF77FLAGS;, &cv-link-SHF77PPCOM;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANFLAGS;, &cv-link-SHFORTRANPPCOM;, &cv-link-_F77INCFLAGS;.</para><para>Uses: &cv-link-F77COMSTR;, &cv-link-F77PPCOMSTR;, &cv-link-FORTRANCOMSTR;, &cv-link-FORTRANPPCOMSTR;, &cv-link-SHF77COMSTR;, &cv-link-SHF77PPCOMSTR;, &cv-link-SHFORTRANCOMSTR;, &cv-link-SHFORTRANPPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-F77"><varname>$F77</varname></link> <link linkend="cv-F77COM"><varname>$F77COM</varname></link> <link linkend="cv-F77FILESUFFIXES"><varname>$F77FILESUFFIXES</varname></link> <link linkend="cv-F77FLAGS"><varname>$F77FLAGS</varname></link> <link linkend="cv-F77PPCOM"><varname>$F77PPCOM</varname></link> <link linkend="cv-F77PPFILESUFFIXES"><varname>$F77PPFILESUFFIXES</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-FORTRANCOM"><varname>$FORTRANCOM</varname></link> <link linkend="cv-FORTRANFLAGS"><varname>$FORTRANFLAGS</varname></link> <link linkend="cv-SHF77"><varname>$SHF77</varname></link> <link linkend="cv-SHF77COM"><varname>$SHF77COM</varname></link> <link linkend="cv-SHF77FLAGS"><varname>$SHF77FLAGS</varname></link> <link linkend="cv-SHF77PPCOM"><varname>$SHF77PPCOM</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANCOM"><varname>$SHFORTRANCOM</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> <link linkend="cv-SHFORTRANPPCOM"><varname>$SHFORTRANPPCOM</varname></link> <link linkend="cv-_F77INCFLAGS"><varname>$_F77INCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-F77COMSTR"><varname>$F77COMSTR</varname></link> <link linkend="cv-F77PPCOMSTR"><varname>$F77PPCOMSTR</varname></link> <link linkend="cv-FORTRANCOMSTR"><varname>$FORTRANCOMSTR</varname></link> <link linkend="cv-FORTRANPPCOMSTR"><varname>$FORTRANPPCOMSTR</varname></link> <link linkend="cv-SHF77COMSTR"><varname>$SHF77COMSTR</varname></link> <link linkend="cv-SHF77PPCOMSTR"><varname>$SHF77PPCOMSTR</varname></link> <link linkend="cv-SHFORTRANCOMSTR"><varname>$SHFORTRANCOMSTR</varname></link> <link linkend="cv-SHFORTRANPPCOMSTR"><varname>$SHFORTRANPPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-f90"> <term>f90</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran 90 compilers. </para> -<para>Sets: &cv-link-F90;, &cv-link-F90COM;, &cv-link-F90FLAGS;, &cv-link-F90PPCOM;, &cv-link-SHF90;, &cv-link-SHF90COM;, &cv-link-SHF90FLAGS;, &cv-link-SHF90PPCOM;, &cv-link-_F90INCFLAGS;.</para><para>Uses: &cv-link-F90COMSTR;, &cv-link-F90PPCOMSTR;, &cv-link-SHF90COMSTR;, &cv-link-SHF90PPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-F90"><varname>$F90</varname></link> <link linkend="cv-F90COM"><varname>$F90COM</varname></link> <link linkend="cv-F90FLAGS"><varname>$F90FLAGS</varname></link> <link linkend="cv-F90PPCOM"><varname>$F90PPCOM</varname></link> <link linkend="cv-SHF90"><varname>$SHF90</varname></link> <link linkend="cv-SHF90COM"><varname>$SHF90COM</varname></link> <link linkend="cv-SHF90FLAGS"><varname>$SHF90FLAGS</varname></link> <link linkend="cv-SHF90PPCOM"><varname>$SHF90PPCOM</varname></link> <link linkend="cv-_F90INCFLAGS"><varname>$_F90INCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-F90COMSTR"><varname>$F90COMSTR</varname></link> <link linkend="cv-F90PPCOMSTR"><varname>$F90PPCOMSTR</varname></link> <link linkend="cv-SHF90COMSTR"><varname>$SHF90COMSTR</varname></link> <link linkend="cv-SHF90PPCOMSTR"><varname>$SHF90PPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-f95"> <term>f95</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran 95 compilers. </para> -<para>Sets: &cv-link-F95;, &cv-link-F95COM;, &cv-link-F95FLAGS;, &cv-link-F95PPCOM;, &cv-link-SHF95;, &cv-link-SHF95COM;, &cv-link-SHF95FLAGS;, &cv-link-SHF95PPCOM;, &cv-link-_F95INCFLAGS;.</para><para>Uses: &cv-link-F95COMSTR;, &cv-link-F95PPCOMSTR;, &cv-link-SHF95COMSTR;, &cv-link-SHF95PPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-F95"><varname>$F95</varname></link> <link linkend="cv-F95COM"><varname>$F95COM</varname></link> <link linkend="cv-F95FLAGS"><varname>$F95FLAGS</varname></link> <link linkend="cv-F95PPCOM"><varname>$F95PPCOM</varname></link> <link linkend="cv-SHF95"><varname>$SHF95</varname></link> <link linkend="cv-SHF95COM"><varname>$SHF95COM</varname></link> <link linkend="cv-SHF95FLAGS"><varname>$SHF95FLAGS</varname></link> <link linkend="cv-SHF95PPCOM"><varname>$SHF95PPCOM</varname></link> <link linkend="cv-_F95INCFLAGS"><varname>$_F95INCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-F95COMSTR"><varname>$F95COMSTR</varname></link> <link linkend="cv-F95PPCOMSTR"><varname>$F95PPCOMSTR</varname></link> <link linkend="cv-SHF95COMSTR"><varname>$SHF95COMSTR</varname></link> <link linkend="cv-SHF95PPCOMSTR"><varname>$SHF95PPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-fortran"> <term>fortran</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for generic POSIX Fortran compilers. </para> -<para>Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANFLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANFLAGS;, &cv-link-SHFORTRANPPCOM;.</para><para>Uses: &cv-link-FORTRANCOMSTR;, &cv-link-FORTRANPPCOMSTR;, &cv-link-SHFORTRANCOMSTR;, &cv-link-SHFORTRANPPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-FORTRANCOM"><varname>$FORTRANCOM</varname></link> <link linkend="cv-FORTRANFLAGS"><varname>$FORTRANFLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANCOM"><varname>$SHFORTRANCOM</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> <link linkend="cv-SHFORTRANPPCOM"><varname>$SHFORTRANPPCOM</varname></link> </para><para>Uses: <link linkend="cv-FORTRANCOMSTR"><varname>$FORTRANCOMSTR</varname></link> <link linkend="cv-FORTRANPPCOMSTR"><varname>$FORTRANPPCOMSTR</varname></link> <link linkend="cv-SHFORTRANCOMSTR"><varname>$SHFORTRANCOMSTR</varname></link> <link linkend="cv-SHFORTRANPPCOMSTR"><varname>$SHFORTRANPPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gXX"> <term>g++</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">gXX</application> C++ compiler. + <listitem><para> +Set construction variables for the <application>gXX</application> C++ compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXVERSION"><varname>$CXXVERSION</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-g77"> <term>g77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">g77</application> Fortran compiler. -Calls the <literal xmlns="http://www.scons.org/dbxsd/v1.0">f77</literal> Tool module + <listitem><para> +Set construction variables for the <application>g77</application> Fortran compiler. +Calls the <literal>f77</literal> Tool module to set variables. </para> </listitem> </varlistentry> <varlistentry id="t-gas"> <term>gas</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">gas</application> assembler. -Calls the <literal xmlns="http://www.scons.org/dbxsd/v1.0">as</literal> module. + <listitem><para> +Sets construction variables for the <application>gas</application> assembler. +Calls the <literal>as</literal> module. </para> -<para>Sets: &cv-link-AS;.</para></listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gcc"> <term>gcc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">gcc</application> C compiler. + <listitem><para> +Set construction variables for the <application>gcc</application> C compiler. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCVERSION"><varname>$CCVERSION</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gdc"> <term>gdc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the D language compiler GDC. </para> -<para>Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-DC"><varname>$DC</varname></link> <link linkend="cv-DCOM"><varname>$DCOM</varname></link> <link linkend="cv-DDEBUG"><varname>$DDEBUG</varname></link> <link linkend="cv-DDEBUGPREFIX"><varname>$DDEBUGPREFIX</varname></link> <link linkend="cv-DDEBUGSUFFIX"><varname>$DDEBUGSUFFIX</varname></link> <link linkend="cv-DFILESUFFIX"><varname>$DFILESUFFIX</varname></link> <link linkend="cv-DFLAGPREFIX"><varname>$DFLAGPREFIX</varname></link> <link linkend="cv-DFLAGS"><varname>$DFLAGS</varname></link> <link linkend="cv-DFLAGSUFFIX"><varname>$DFLAGSUFFIX</varname></link> <link linkend="cv-DINCPREFIX"><varname>$DINCPREFIX</varname></link> <link linkend="cv-DINCSUFFIX"><varname>$DINCSUFFIX</varname></link> <link linkend="cv-DLIB"><varname>$DLIB</varname></link> <link linkend="cv-DLIBCOM"><varname>$DLIBCOM</varname></link> <link linkend="cv-DLIBDIRPREFIX"><varname>$DLIBDIRPREFIX</varname></link> <link linkend="cv-DLIBDIRSUFFIX"><varname>$DLIBDIRSUFFIX</varname></link> <link linkend="cv-DLIBFLAGPREFIX"><varname>$DLIBFLAGPREFIX</varname></link> <link linkend="cv-DLIBFLAGSUFFIX"><varname>$DLIBFLAGSUFFIX</varname></link> <link linkend="cv-DLIBLINKPREFIX"><varname>$DLIBLINKPREFIX</varname></link> <link linkend="cv-DLIBLINKSUFFIX"><varname>$DLIBLINKSUFFIX</varname></link> <link linkend="cv-DLINK"><varname>$DLINK</varname></link> <link linkend="cv-DLINKCOM"><varname>$DLINKCOM</varname></link> <link linkend="cv-DLINKFLAGPREFIX"><varname>$DLINKFLAGPREFIX</varname></link> <link linkend="cv-DLINKFLAGS"><varname>$DLINKFLAGS</varname></link> <link linkend="cv-DLINKFLAGSUFFIX"><varname>$DLINKFLAGSUFFIX</varname></link> <link linkend="cv-DPATH"><varname>$DPATH</varname></link> <link linkend="cv-DRPATHPREFIX"><varname>$DRPATHPREFIX</varname></link> <link linkend="cv-DRPATHSUFFIX"><varname>$DRPATHSUFFIX</varname></link> <link linkend="cv-DShLibSonameGenerator"><varname>$DShLibSonameGenerator</varname></link> <link linkend="cv-DVERPREFIX"><varname>$DVERPREFIX</varname></link> <link linkend="cv-DVERSIONS"><varname>$DVERSIONS</varname></link> <link linkend="cv-DVERSUFFIX"><varname>$DVERSUFFIX</varname></link> <link linkend="cv-SHDC"><varname>$SHDC</varname></link> <link linkend="cv-SHDCOM"><varname>$SHDCOM</varname></link> <link linkend="cv-SHDLIBVERSION"><varname>$SHDLIBVERSION</varname></link> <link linkend="cv-SHDLIBVERSIONFLAGS"><varname>$SHDLIBVERSIONFLAGS</varname></link> <link linkend="cv-SHDLINK"><varname>$SHDLINK</varname></link> <link linkend="cv-SHDLINKCOM"><varname>$SHDLINKCOM</varname></link> <link linkend="cv-SHDLINKFLAGS"><varname>$SHDLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gettext"> <term>gettext</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is actually a toolset, which supports internationalization and localization of software being constructed with SCons. The toolset loads following tools: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <itemizedlist mark="opencircle"> <listitem><para> - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> - to extract internationalized messages from source code to + <link linkend="t-xgettext"><literal>xgettext</literal></link> - to extract internationalized messages from source code to <literal>POT</literal> file(s), </para></listitem> <listitem><para> - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> - may be optionally used to initialize <literal>PO</literal> + <link linkend="t-msginit"><literal>msginit</literal></link> - may be optionally used to initialize <literal>PO</literal> files, </para></listitem> <listitem><para> - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> - to update <literal>PO</literal> files, that already contain + <link linkend="t-msgmerge"><literal>msgmerge</literal></link> - to update <literal>PO</literal> files, that already contain translated messages,</para></listitem> <listitem><para> - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> - to compile textual <literal>PO</literal> file to binary + <link linkend="t-msgfmt"><literal>msgfmt</literal></link> - to compile textual <literal>PO</literal> file to binary installable <literal>MO</literal> file. </para></listitem> </itemizedlist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -When you enable <literal xmlns="http://www.scons.org/dbxsd/v1.0">gettext</literal>, it internally loads all abovementioned tools, +<para> +When you enable <literal>gettext</literal>, it internally loads all abovementioned tools, so you're encouraged to see their individual documentation. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Each of the above tools provides its own builder(s) which may be used to perform particular activities related to software internationalization. You may be however interested in <emphasis>top-level</emphasis> builder -<function xmlns="http://www.scons.org/dbxsd/v1.0">Translate</function> described few paragraphs later. +<function>Translate</function> described few paragraphs later. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -To use <literal xmlns="http://www.scons.org/dbxsd/v1.0">gettext</literal> tools add <literal>'gettext'</literal> tool to your +<para> +To use <literal>gettext</literal> tools add <literal>'gettext'</literal> tool to your environment: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment( tools = ['default', 'gettext'] ) </example_commands> </listitem> </varlistentry> <varlistentry id="t-gfortran"> <term>gfortran</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the GNU F95/F2003 GNU compiler. </para> -<para>Sets: &cv-link-F77;, &cv-link-F90;, &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-F77"><varname>$F77</varname></link> <link linkend="cv-F90"><varname>$F90</varname></link> <link linkend="cv-F95"><varname>$F95</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-SHF77"><varname>$SHF77</varname></link> <link linkend="cv-SHF77FLAGS"><varname>$SHF77FLAGS</varname></link> <link linkend="cv-SHF90"><varname>$SHF90</varname></link> <link linkend="cv-SHF90FLAGS"><varname>$SHF90FLAGS</varname></link> <link linkend="cv-SHF95"><varname>$SHF95</varname></link> <link linkend="cv-SHF95FLAGS"><varname>$SHF95FLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gnulink"> <term>gnulink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for GNU linker/loader. </para> -<para>Sets: &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLIBVERSIONFLAGS;, &cv-link-SHLINKFLAGS;, &cv-link-_LDMODULESONAME;, &cv-link-_SHLIBSONAME;.</para></listitem> +<para>Sets: <link linkend="cv-LDMODULEVERSIONFLAGS"><varname>$LDMODULEVERSIONFLAGS</varname></link> <link linkend="cv-RPATHPREFIX"><varname>$RPATHPREFIX</varname></link> <link linkend="cv-RPATHSUFFIX"><varname>$RPATHSUFFIX</varname></link> <link linkend="cv-SHLIBVERSIONFLAGS"><varname>$SHLIBVERSIONFLAGS</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-_LDMODULESONAME"><varname>$_LDMODULESONAME</varname></link> <link linkend="cv-_SHLIBSONAME"><varname>$_SHLIBSONAME</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-gs"> <term>gs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This Tool sets the required construction variables for working with the Ghostscript command. It also registers an appropriate Action -with the PDF Builder (<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-PDF"><function>PDF</function></link>), such that the conversion from +with the PDF Builder (<link linkend="b-PDF"><function>PDF</function></link>), such that the conversion from PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain. -Finally, it adds an explicit Ghostscript Builder (<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Gs"><function>Gs</function></link>) to the +Finally, it adds an explicit Ghostscript Builder (<link linkend="b-Gs"><function>Gs</function></link>) to the environment. </para> -<para>Sets: &cv-link-GS;, &cv-link-GSCOM;, &cv-link-GSFLAGS;.</para><para>Uses: &cv-link-GSCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-GS"><varname>$GS</varname></link> <link linkend="cv-GSCOM"><varname>$GSCOM</varname></link> <link linkend="cv-GSFLAGS"><varname>$GSFLAGS</varname></link> </para><para>Uses: <link linkend="cv-GSCOMSTR"><varname>$GSCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-hpcXX"> <term>hpc++</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for the compilers aCC on HP/UX systems. </para> </listitem> </varlistentry> <varlistentry id="t-hpcc"> <term>hpcc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Set construction variables for the <application>aCC</application> on HP/UX systems. -Calls the <literal xmlns="http://www.scons.org/dbxsd/v1.0">cXX</literal> tool for additional variables. +Calls the <literal>cXX</literal> tool for additional variables. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXVERSION"><varname>$CXXVERSION</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-hplink"> <term>hplink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the linker on HP/UX systems. </para> -<para>Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-SHLIBSUFFIX"><varname>$SHLIBSUFFIX</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-icc"> <term>icc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the <application>icc</application> compiler on OS/2 systems. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CFILESUFFIX;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;.</para><para>Uses: &cv-link-CCFLAGS;, &cv-link-CFLAGS;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCCOM"><varname>$CCCOM</varname></link> <link linkend="cv-CFILESUFFIX"><varname>$CFILESUFFIX</varname></link> <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-CXXCOM"><varname>$CXXCOM</varname></link> <link linkend="cv-CXXFILESUFFIX"><varname>$CXXFILESUFFIX</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-CCFLAGS"><varname>$CCFLAGS</varname></link> <link linkend="cv-CFLAGS"><varname>$CFLAGS</varname></link> <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_CPPINCFLAGS"><varname>$_CPPINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-icl"> <term>icl</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Intel C/C++ compiler. -Calls the <literal xmlns="http://www.scons.org/dbxsd/v1.0">intelc</literal> Tool module to set its variables. +Calls the <literal>intelc</literal> Tool module to set its variables. </para> </listitem> </varlistentry> <varlistentry id="t-ifl"> <term>ifl</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Intel Fortran compiler. </para> -<para>Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANPPCOM;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANPPCOM;.</para><para>Uses: &cv-link-CPPFLAGS;, &cv-link-FORTRANFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_FORTRANINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-FORTRANCOM"><varname>$FORTRANCOM</varname></link> <link linkend="cv-FORTRANPPCOM"><varname>$FORTRANPPCOM</varname></link> <link linkend="cv-SHFORTRANCOM"><varname>$SHFORTRANCOM</varname></link> <link linkend="cv-SHFORTRANPPCOM"><varname>$SHFORTRANPPCOM</varname></link> </para><para>Uses: <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-FORTRANFLAGS"><varname>$FORTRANFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_FORTRANINCFLAGS"><varname>$_FORTRANINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-ifort"> <term>ifort</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for newer versions of the Intel Fortran compiler for Linux. </para> -<para>Sets: &cv-link-F77;, &cv-link-F90;, &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-F77"><varname>$F77</varname></link> <link linkend="cv-F90"><varname>$F90</varname></link> <link linkend="cv-F95"><varname>$F95</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-SHF77"><varname>$SHF77</varname></link> <link linkend="cv-SHF77FLAGS"><varname>$SHF77FLAGS</varname></link> <link linkend="cv-SHF90"><varname>$SHF90</varname></link> <link linkend="cv-SHF90FLAGS"><varname>$SHF90FLAGS</varname></link> <link linkend="cv-SHF95"><varname>$SHF95</varname></link> <link linkend="cv-SHF95FLAGS"><varname>$SHF95FLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-ilink"> <term>ilink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the <application>ilink</application> linker on OS/2 systems. </para> -<para>Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-ilink32"> <term>ilink32</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Borland <application>ilink32</application> linker. </para> -<para>Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-install"> <term>install</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for file and directory installation. </para> -<para>Sets: &cv-link-INSTALL;, &cv-link-INSTALLSTR;.</para></listitem> +<para>Sets: <link linkend="cv-INSTALL"><varname>$INSTALL</varname></link> <link linkend="cv-INSTALLSTR"><varname>$INSTALLSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-intelc"> <term>intelc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Intel C/C++ compiler (Linux and Windows, version 7 and later). -Calls the <literal xmlns="http://www.scons.org/dbxsd/v1.0">gcc</literal> or <literal xmlns="http://www.scons.org/dbxsd/v1.0">msvc</literal> +Calls the <literal>gcc</literal> or <literal>msvc</literal> (on Linux and Windows, respectively) to set underlying variables. </para> -<para>Sets: &cv-link-AR;, &cv-link-CC;, &cv-link-CXX;, &cv-link-INTEL_C_COMPILER_VERSION;, &cv-link-LINK;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-INTEL_C_COMPILER_VERSION"><varname>$INTEL_C_COMPILER_VERSION</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-jar"> <term>jar</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">jar</application> utility. + <listitem><para> +Sets construction variables for the <application>jar</application> utility. </para> -<para>Sets: &cv-link-JAR;, &cv-link-JARCOM;, &cv-link-JARFLAGS;, &cv-link-JARSUFFIX;.</para><para>Uses: &cv-link-JARCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-JAR"><varname>$JAR</varname></link> <link linkend="cv-JARCOM"><varname>$JARCOM</varname></link> <link linkend="cv-JARFLAGS"><varname>$JARFLAGS</varname></link> <link linkend="cv-JARSUFFIX"><varname>$JARSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-JARCOMSTR"><varname>$JARCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-javac"> <term>javac</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> compiler. + <listitem><para> + Sets construction variables for the <application>javac</application> compiler. </para> - <para>Sets: &cv-link-JAVABOOTCLASSPATH;, &cv-link-JAVAC;, &cv-link-JAVACCOM;, &cv-link-JAVACFLAGS;, &cv-link-JAVACLASSPATH;, &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAINCLUDES;, &cv-link-JAVASOURCEPATH;, &cv-link-JAVASUFFIX;.</para><para>Uses: &cv-link-JAVACCOMSTR;.</para></listitem> + <para>Sets: <link linkend="cv-JAVABOOTCLASSPATH"><varname>$JAVABOOTCLASSPATH</varname></link> <link linkend="cv-JAVAC"><varname>$JAVAC</varname></link> <link linkend="cv-JAVACCOM"><varname>$JAVACCOM</varname></link> <link linkend="cv-JAVACFLAGS"><varname>$JAVACFLAGS</varname></link> <link linkend="cv-JAVACLASSPATH"><varname>$JAVACLASSPATH</varname></link> <link linkend="cv-JAVACLASSSUFFIX"><varname>$JAVACLASSSUFFIX</varname></link> <link linkend="cv-JAVAINCLUDES"><varname>$JAVAINCLUDES</varname></link> <link linkend="cv-JAVASOURCEPATH"><varname>$JAVASOURCEPATH</varname></link> <link linkend="cv-JAVASUFFIX"><varname>$JAVASUFFIX</varname></link> </para><para>Uses: <link linkend="cv-JAVACCOMSTR"><varname>$JAVACCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-javah"> <term>javah</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">javah</application> tool. + <listitem><para> +Sets construction variables for the <application>javah</application> tool. </para> -<para>Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAH;, &cv-link-JAVAHCOM;, &cv-link-JAVAHFLAGS;.</para><para>Uses: &cv-link-JAVACLASSPATH;, &cv-link-JAVAHCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-JAVACLASSSUFFIX"><varname>$JAVACLASSSUFFIX</varname></link> <link linkend="cv-JAVAH"><varname>$JAVAH</varname></link> <link linkend="cv-JAVAHCOM"><varname>$JAVAHCOM</varname></link> <link linkend="cv-JAVAHFLAGS"><varname>$JAVAHFLAGS</varname></link> </para><para>Uses: <link linkend="cv-JAVACLASSPATH"><varname>$JAVACLASSPATH</varname></link> <link linkend="cv-JAVAHCOMSTR"><varname>$JAVAHCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-latex"> <term>latex</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">latex</application> utility. + <listitem><para> +Sets construction variables for the <application>latex</application> utility. </para> -<para>Sets: &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;.</para><para>Uses: &cv-link-LATEXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LATEX"><varname>$LATEX</varname></link> <link linkend="cv-LATEXCOM"><varname>$LATEXCOM</varname></link> <link linkend="cv-LATEXFLAGS"><varname>$LATEXFLAGS</varname></link> </para><para>Uses: <link linkend="cv-LATEXCOMSTR"><varname>$LATEXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-ldc"> <term>ldc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the D language compiler LDC2. </para> -<para>Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-DC"><varname>$DC</varname></link> <link linkend="cv-DCOM"><varname>$DCOM</varname></link> <link linkend="cv-DDEBUG"><varname>$DDEBUG</varname></link> <link linkend="cv-DDEBUGPREFIX"><varname>$DDEBUGPREFIX</varname></link> <link linkend="cv-DDEBUGSUFFIX"><varname>$DDEBUGSUFFIX</varname></link> <link linkend="cv-DFILESUFFIX"><varname>$DFILESUFFIX</varname></link> <link linkend="cv-DFLAGPREFIX"><varname>$DFLAGPREFIX</varname></link> <link linkend="cv-DFLAGS"><varname>$DFLAGS</varname></link> <link linkend="cv-DFLAGSUFFIX"><varname>$DFLAGSUFFIX</varname></link> <link linkend="cv-DINCPREFIX"><varname>$DINCPREFIX</varname></link> <link linkend="cv-DINCSUFFIX"><varname>$DINCSUFFIX</varname></link> <link linkend="cv-DLIB"><varname>$DLIB</varname></link> <link linkend="cv-DLIBCOM"><varname>$DLIBCOM</varname></link> <link linkend="cv-DLIBDIRPREFIX"><varname>$DLIBDIRPREFIX</varname></link> <link linkend="cv-DLIBDIRSUFFIX"><varname>$DLIBDIRSUFFIX</varname></link> <link linkend="cv-DLIBFLAGPREFIX"><varname>$DLIBFLAGPREFIX</varname></link> <link linkend="cv-DLIBFLAGSUFFIX"><varname>$DLIBFLAGSUFFIX</varname></link> <link linkend="cv-DLIBLINKPREFIX"><varname>$DLIBLINKPREFIX</varname></link> <link linkend="cv-DLIBLINKSUFFIX"><varname>$DLIBLINKSUFFIX</varname></link> <link linkend="cv-DLINK"><varname>$DLINK</varname></link> <link linkend="cv-DLINKCOM"><varname>$DLINKCOM</varname></link> <link linkend="cv-DLINKFLAGPREFIX"><varname>$DLINKFLAGPREFIX</varname></link> <link linkend="cv-DLINKFLAGS"><varname>$DLINKFLAGS</varname></link> <link linkend="cv-DLINKFLAGSUFFIX"><varname>$DLINKFLAGSUFFIX</varname></link> <link linkend="cv-DPATH"><varname>$DPATH</varname></link> <link linkend="cv-DRPATHPREFIX"><varname>$DRPATHPREFIX</varname></link> <link linkend="cv-DRPATHSUFFIX"><varname>$DRPATHSUFFIX</varname></link> <link linkend="cv-DShLibSonameGenerator"><varname>$DShLibSonameGenerator</varname></link> <link linkend="cv-DVERPREFIX"><varname>$DVERPREFIX</varname></link> <link linkend="cv-DVERSIONS"><varname>$DVERSIONS</varname></link> <link linkend="cv-DVERSUFFIX"><varname>$DVERSUFFIX</varname></link> <link linkend="cv-SHDC"><varname>$SHDC</varname></link> <link linkend="cv-SHDCOM"><varname>$SHDCOM</varname></link> <link linkend="cv-SHDLIBVERSION"><varname>$SHDLIBVERSION</varname></link> <link linkend="cv-SHDLIBVERSIONFLAGS"><varname>$SHDLIBVERSIONFLAGS</varname></link> <link linkend="cv-SHDLINK"><varname>$SHDLINK</varname></link> <link linkend="cv-SHDLINKCOM"><varname>$SHDLINKCOM</varname></link> <link linkend="cv-SHDLINKFLAGS"><varname>$SHDLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-lex"> <term>lex</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">lex</application> lexical analyser. + <listitem><para> +Sets construction variables for the <application>lex</application> lexical analyser. </para> -<para>Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;, &cv-link-LEXUNISTD;.</para><para>Uses: &cv-link-LEXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LEX"><varname>$LEX</varname></link> <link linkend="cv-LEXCOM"><varname>$LEXCOM</varname></link> <link linkend="cv-LEXFLAGS"><varname>$LEXFLAGS</varname></link> <link linkend="cv-LEXUNISTD"><varname>$LEXUNISTD</varname></link> </para><para>Uses: <link linkend="cv-LEXCOMSTR"><varname>$LEXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-link"> <term>link</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for generic POSIX linkers. This is a "smart" linker tool which selects a compiler to complete the linking based on the types of source files. </para> -<para>Sets: &cv-link-LDMODULE;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULENOVERSIONSYMLINKS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LDMODULEVERSION;, &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-__LDMODULEVERSIONFLAGS;, &cv-link-__SHLIBVERSIONFLAGS;.</para><para>Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LDMODULE"><varname>$LDMODULE</varname></link> <link linkend="cv-LDMODULECOM"><varname>$LDMODULECOM</varname></link> <link linkend="cv-LDMODULEFLAGS"><varname>$LDMODULEFLAGS</varname></link> <link linkend="cv-LDMODULENOVERSIONSYMLINKS"><varname>$LDMODULENOVERSIONSYMLINKS</varname></link> <link linkend="cv-LDMODULEPREFIX"><varname>$LDMODULEPREFIX</varname></link> <link linkend="cv-LDMODULESUFFIX"><varname>$LDMODULESUFFIX</varname></link> <link linkend="cv-LDMODULEVERSION"><varname>$LDMODULEVERSION</varname></link> <link linkend="cv-LDMODULEVERSIONFLAGS"><varname>$LDMODULEVERSIONFLAGS</varname></link> <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-SHLIBSUFFIX"><varname>$SHLIBSUFFIX</varname></link> <link linkend="cv-SHLINK"><varname>$SHLINK</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-__LDMODULEVERSIONFLAGS"><varname>$__LDMODULEVERSIONFLAGS</varname></link> <link linkend="cv-__SHLIBVERSIONFLAGS"><varname>$__SHLIBVERSIONFLAGS</varname></link> </para><para>Uses: <link linkend="cv-LDMODULECOMSTR"><varname>$LDMODULECOMSTR</varname></link> <link linkend="cv-LINKCOMSTR"><varname>$LINKCOMSTR</varname></link> <link linkend="cv-SHLINKCOMSTR"><varname>$SHLINKCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-linkloc"> <term>linkloc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the <application>LinkLoc</application> linker for the Phar Lap ETS embedded operating system. </para> -<para>Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-SHLINK"><varname>$SHLINK</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para><para>Uses: <link linkend="cv-LINKCOMSTR"><varname>$LINKCOMSTR</varname></link> <link linkend="cv-SHLINKCOMSTR"><varname>$SHLINKCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-m4"> <term>m4</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">m4</application> macro processor. + <listitem><para> +Sets construction variables for the <application>m4</application> macro processor. </para> -<para>Sets: &cv-link-M4;, &cv-link-M4COM;, &cv-link-M4FLAGS;.</para><para>Uses: &cv-link-M4COMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-M4"><varname>$M4</varname></link> <link linkend="cv-M4COM"><varname>$M4COM</varname></link> <link linkend="cv-M4FLAGS"><varname>$M4FLAGS</varname></link> </para><para>Uses: <link linkend="cv-M4COMSTR"><varname>$M4COMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-masm"> <term>masm</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Microsoft assembler. </para> -<para>Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.</para><para>Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> <link linkend="cv-ASCOM"><varname>$ASCOM</varname></link> <link linkend="cv-ASFLAGS"><varname>$ASFLAGS</varname></link> <link linkend="cv-ASPPCOM"><varname>$ASPPCOM</varname></link> <link linkend="cv-ASPPFLAGS"><varname>$ASPPFLAGS</varname></link> </para><para>Uses: <link linkend="cv-ASCOMSTR"><varname>$ASCOMSTR</varname></link> <link linkend="cv-ASPPCOMSTR"><varname>$ASPPCOMSTR</varname></link> <link linkend="cv-CPPFLAGS"><varname>$CPPFLAGS</varname></link> <link linkend="cv-_CPPDEFFLAGS"><varname>$_CPPDEFFLAGS</varname></link> <link linkend="cv-_CPPINCFLAGS"><varname>$_CPPINCFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-midl"> <term>midl</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Microsoft IDL compiler. </para> -<para>Sets: &cv-link-MIDL;, &cv-link-MIDLCOM;, &cv-link-MIDLFLAGS;.</para><para>Uses: &cv-link-MIDLCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-MIDL"><varname>$MIDL</varname></link> <link linkend="cv-MIDLCOM"><varname>$MIDLCOM</varname></link> <link linkend="cv-MIDLFLAGS"><varname>$MIDLFLAGS</varname></link> </para><para>Uses: <link linkend="cv-MIDLCOMSTR"><varname>$MIDLCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mingw"> <term>mingw</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for MinGW (Minimal Gnu on Windows). </para> -<para>Sets: &cv-link-AS;, &cv-link-CC;, &cv-link-CXX;, &cv-link-LDMODULECOM;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-OBJSUFFIX;, &cv-link-RC;, &cv-link-RCCOM;, &cv-link-RCFLAGS;, &cv-link-RCINCFLAGS;, &cv-link-RCINCPREFIX;, &cv-link-RCINCSUFFIX;, &cv-link-SHCCFLAGS;, &cv-link-SHCXXFLAGS;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-SHOBJSUFFIX;, &cv-link-WINDOWSDEFPREFIX;, &cv-link-WINDOWSDEFSUFFIX;.</para><para>Uses: &cv-link-RCCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-LDMODULECOM"><varname>$LDMODULECOM</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> <link linkend="cv-OBJSUFFIX"><varname>$OBJSUFFIX</varname></link> <link linkend="cv-RC"><varname>$RC</varname></link> <link linkend="cv-RCCOM"><varname>$RCCOM</varname></link> <link linkend="cv-RCFLAGS"><varname>$RCFLAGS</varname></link> <link linkend="cv-RCINCFLAGS"><varname>$RCINCFLAGS</varname></link> <link linkend="cv-RCINCPREFIX"><varname>$RCINCPREFIX</varname></link> <link linkend="cv-RCINCSUFFIX"><varname>$RCINCSUFFIX</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> <link linkend="cv-WINDOWSDEFPREFIX"><varname>$WINDOWSDEFPREFIX</varname></link> <link linkend="cv-WINDOWSDEFSUFFIX"><varname>$WINDOWSDEFSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-RCCOMSTR"><varname>$RCCOMSTR</varname></link> <link linkend="cv-SHLINKCOMSTR"><varname>$SHLINKCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-msgfmt"> <term>msgfmt</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This scons tool is a part of scons <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides scons + <listitem><para> +This scons tool is a part of scons <link linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides scons interface to <command>msgfmt(1)</command> command, which generates binary message catalog (<literal>MO</literal>) from a textual translation description (<literal>PO</literal>). </para> -<para>Sets: &cv-link-MOSUFFIX;, &cv-link-MSGFMT;, &cv-link-MSGFMTCOM;, &cv-link-MSGFMTCOMSTR;, &cv-link-MSGFMTFLAGS;, &cv-link-POSUFFIX;.</para><para>Uses: &cv-link-LINGUAS_FILE;.</para></listitem> +<para>Sets: <link linkend="cv-MOSUFFIX"><varname>$MOSUFFIX</varname></link> <link linkend="cv-MSGFMT"><varname>$MSGFMT</varname></link> <link linkend="cv-MSGFMTCOM"><varname>$MSGFMTCOM</varname></link> <link linkend="cv-MSGFMTCOMSTR"><varname>$MSGFMTCOMSTR</varname></link> <link linkend="cv-MSGFMTFLAGS"><varname>$MSGFMTFLAGS</varname></link> <link linkend="cv-POSUFFIX"><varname>$POSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-LINGUAS_FILE"><varname>$LINGUAS_FILE</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-msginit"> <term>msginit</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This scons tool is a part of scons <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides + <listitem><para> +This scons tool is a part of scons <link linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides scons interface to <command>msginit(1)</command> program, which creates new <literal>PO</literal> file, initializing the meta information with values from user's environment (or options). </para> -<para>Sets: &cv-link-MSGINIT;, &cv-link-MSGINITCOM;, &cv-link-MSGINITCOMSTR;, &cv-link-MSGINITFLAGS;, &cv-link-POAUTOINIT;, &cv-link-POCREATE_ALIAS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-_MSGINITLOCALE;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem> +<para>Sets: <link linkend="cv-MSGINIT"><varname>$MSGINIT</varname></link> <link linkend="cv-MSGINITCOM"><varname>$MSGINITCOM</varname></link> <link linkend="cv-MSGINITCOMSTR"><varname>$MSGINITCOMSTR</varname></link> <link linkend="cv-MSGINITFLAGS"><varname>$MSGINITFLAGS</varname></link> <link linkend="cv-POAUTOINIT"><varname>$POAUTOINIT</varname></link> <link linkend="cv-POCREATE_ALIAS"><varname>$POCREATE_ALIAS</varname></link> <link linkend="cv-POSUFFIX"><varname>$POSUFFIX</varname></link> <link linkend="cv-POTSUFFIX"><varname>$POTSUFFIX</varname></link> <link linkend="cv-_MSGINITLOCALE"><varname>$_MSGINITLOCALE</varname></link> </para><para>Uses: <link linkend="cv-LINGUAS_FILE"><varname>$LINGUAS_FILE</varname></link> <link linkend="cv-POAUTOINIT"><varname>$POAUTOINIT</varname></link> <link linkend="cv-POTDOMAIN"><varname>$POTDOMAIN</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-msgmerge"> <term>msgmerge</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This scons tool is a part of scons <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides + <listitem><para> +This scons tool is a part of scons <link linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides scons interface to <command>msgmerge(1)</command> command, which merges two Uniform style <filename>.po</filename> files together. </para> -<para>Sets: &cv-link-MSGMERGE;, &cv-link-MSGMERGECOM;, &cv-link-MSGMERGECOMSTR;, &cv-link-MSGMERGEFLAGS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-POUPDATE_ALIAS;.</para><para>Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;.</para></listitem> +<para>Sets: <link linkend="cv-MSGMERGE"><varname>$MSGMERGE</varname></link> <link linkend="cv-MSGMERGECOM"><varname>$MSGMERGECOM</varname></link> <link linkend="cv-MSGMERGECOMSTR"><varname>$MSGMERGECOMSTR</varname></link> <link linkend="cv-MSGMERGEFLAGS"><varname>$MSGMERGEFLAGS</varname></link> <link linkend="cv-POSUFFIX"><varname>$POSUFFIX</varname></link> <link linkend="cv-POTSUFFIX"><varname>$POTSUFFIX</varname></link> <link linkend="cv-POUPDATE_ALIAS"><varname>$POUPDATE_ALIAS</varname></link> </para><para>Uses: <link linkend="cv-LINGUAS_FILE"><varname>$LINGUAS_FILE</varname></link> <link linkend="cv-POAUTOINIT"><varname>$POAUTOINIT</varname></link> <link linkend="cv-POTDOMAIN"><varname>$POTDOMAIN</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mslib"> <term>mslib</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Microsoft <application>mslib</application> library archiver. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOM"><varname>$ARCOM</varname></link> <link linkend="cv-ARFLAGS"><varname>$ARFLAGS</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-ARCOMSTR"><varname>$ARCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mslink"> <term>mslink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Microsoft linker. </para> -<para>Sets: &cv-link-LDMODULE;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-REGSVR;, &cv-link-REGSVRCOM;, &cv-link-REGSVRFLAGS;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-WIN32DEFPREFIX;, &cv-link-WIN32DEFSUFFIX;, &cv-link-WIN32EXPPREFIX;, &cv-link-WIN32EXPSUFFIX;, &cv-link-WINDOWSDEFPREFIX;, &cv-link-WINDOWSDEFSUFFIX;, &cv-link-WINDOWSEXPPREFIX;, &cv-link-WINDOWSEXPSUFFIX;, &cv-link-WINDOWSPROGMANIFESTPREFIX;, &cv-link-WINDOWSPROGMANIFESTSUFFIX;, &cv-link-WINDOWSSHLIBMANIFESTPREFIX;, &cv-link-WINDOWSSHLIBMANIFESTSUFFIX;, &cv-link-WINDOWS_INSERT_DEF;.</para><para>Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-REGSVRCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LDMODULE"><varname>$LDMODULE</varname></link> <link linkend="cv-LDMODULECOM"><varname>$LDMODULECOM</varname></link> <link linkend="cv-LDMODULEFLAGS"><varname>$LDMODULEFLAGS</varname></link> <link linkend="cv-LDMODULEPREFIX"><varname>$LDMODULEPREFIX</varname></link> <link linkend="cv-LDMODULESUFFIX"><varname>$LDMODULESUFFIX</varname></link> <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-LINKFLAGS"><varname>$LINKFLAGS</varname></link> <link linkend="cv-REGSVR"><varname>$REGSVR</varname></link> <link linkend="cv-REGSVRCOM"><varname>$REGSVRCOM</varname></link> <link linkend="cv-REGSVRFLAGS"><varname>$REGSVRFLAGS</varname></link> <link linkend="cv-SHLINK"><varname>$SHLINK</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> <link linkend="cv-WIN32DEFPREFIX"><varname>$WIN32DEFPREFIX</varname></link> <link linkend="cv-WIN32DEFSUFFIX"><varname>$WIN32DEFSUFFIX</varname></link> <link linkend="cv-WIN32EXPPREFIX"><varname>$WIN32EXPPREFIX</varname></link> <link linkend="cv-WIN32EXPSUFFIX"><varname>$WIN32EXPSUFFIX</varname></link> <link linkend="cv-WINDOWSDEFPREFIX"><varname>$WINDOWSDEFPREFIX</varname></link> <link linkend="cv-WINDOWSDEFSUFFIX"><varname>$WINDOWSDEFSUFFIX</varname></link> <link linkend="cv-WINDOWSEXPPREFIX"><varname>$WINDOWSEXPPREFIX</varname></link> <link linkend="cv-WINDOWSEXPSUFFIX"><varname>$WINDOWSEXPSUFFIX</varname></link> <link linkend="cv-WINDOWSPROGMANIFESTPREFIX"><varname>$WINDOWSPROGMANIFESTPREFIX</varname></link> <link linkend="cv-WINDOWSPROGMANIFESTSUFFIX"><varname>$WINDOWSPROGMANIFESTSUFFIX</varname></link> <link linkend="cv-WINDOWSSHLIBMANIFESTPREFIX"><varname>$WINDOWSSHLIBMANIFESTPREFIX</varname></link> <link linkend="cv-WINDOWSSHLIBMANIFESTSUFFIX"><varname>$WINDOWSSHLIBMANIFESTSUFFIX</varname></link> <link linkend="cv-WINDOWS_INSERT_DEF"><varname>$WINDOWS_INSERT_DEF</varname></link> </para><para>Uses: <link linkend="cv-LDMODULECOMSTR"><varname>$LDMODULECOMSTR</varname></link> <link linkend="cv-LINKCOMSTR"><varname>$LINKCOMSTR</varname></link> <link linkend="cv-REGSVRCOMSTR"><varname>$REGSVRCOMSTR</varname></link> <link linkend="cv-SHLINKCOMSTR"><varname>$SHLINKCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mssdk"> <term>mssdk</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets variables for Microsoft Platform SDK and/or Windows SDK. Note that unlike most other Tool modules, mssdk does not set construction variables, but sets the <emphasis>environment variables</emphasis> -in the environment <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> uses to execute +in the environment <application>SCons</application> uses to execute the Microsoft toolchain: <literal>%INCLUDE%</literal>, <literal>%LIB%</literal>, <literal>%LIBPATH%</literal> and <literal>%PATH%</literal>. </para> -<para>Uses: &cv-link-MSSDK_DIR;, &cv-link-MSSDK_VERSION;, &cv-link-MSVS_VERSION;.</para></listitem> +<para>Uses: <link linkend="cv-MSSDK_DIR"><varname>$MSSDK_DIR</varname></link> <link linkend="cv-MSSDK_VERSION"><varname>$MSSDK_VERSION</varname></link> <link linkend="cv-MSVS_VERSION"><varname>$MSVS_VERSION</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-msvc"> <term>msvc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Microsoft Visual C/C++ compiler. </para> -<para>Sets: &cv-link-BUILDERS;, &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CCPCHFLAGS;, &cv-link-CCPDBFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-CXXFLAGS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-OBJPREFIX;, &cv-link-OBJSUFFIX;, &cv-link-PCHCOM;, &cv-link-PCHPDBFLAGS;, &cv-link-RC;, &cv-link-RCCOM;, &cv-link-RCFLAGS;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.</para><para>Uses: &cv-link-CCCOMSTR;, &cv-link-CXXCOMSTR;, &cv-link-PCH;, &cv-link-PCHSTOP;, &cv-link-PDB;, &cv-link-SHCCCOMSTR;, &cv-link-SHCXXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-BUILDERS"><varname>$BUILDERS</varname></link> <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCCOM"><varname>$CCCOM</varname></link> <link linkend="cv-CCFLAGS"><varname>$CCFLAGS</varname></link> <link linkend="cv-CCPCHFLAGS"><varname>$CCPCHFLAGS</varname></link> <link linkend="cv-CCPDBFLAGS"><varname>$CCPDBFLAGS</varname></link> <link linkend="cv-CFILESUFFIX"><varname>$CFILESUFFIX</varname></link> <link linkend="cv-CFLAGS"><varname>$CFLAGS</varname></link> <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXCOM"><varname>$CXXCOM</varname></link> <link linkend="cv-CXXFILESUFFIX"><varname>$CXXFILESUFFIX</varname></link> <link linkend="cv-CXXFLAGS"><varname>$CXXFLAGS</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> <link linkend="cv-OBJPREFIX"><varname>$OBJPREFIX</varname></link> <link linkend="cv-OBJSUFFIX"><varname>$OBJSUFFIX</varname></link> <link linkend="cv-PCHCOM"><varname>$PCHCOM</varname></link> <link linkend="cv-PCHPDBFLAGS"><varname>$PCHPDBFLAGS</varname></link> <link linkend="cv-RC"><varname>$RC</varname></link> <link linkend="cv-RCCOM"><varname>$RCCOM</varname></link> <link linkend="cv-RCFLAGS"><varname>$RCFLAGS</varname></link> <link linkend="cv-SHCC"><varname>$SHCC</varname></link> <link linkend="cv-SHCCCOM"><varname>$SHCCCOM</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHCFLAGS"><varname>$SHCFLAGS</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHCXXCOM"><varname>$SHCXXCOM</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHOBJPREFIX"><varname>$SHOBJPREFIX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-CCCOMSTR"><varname>$CCCOMSTR</varname></link> <link linkend="cv-CXXCOMSTR"><varname>$CXXCOMSTR</varname></link> <link linkend="cv-PCH"><varname>$PCH</varname></link> <link linkend="cv-PCHSTOP"><varname>$PCHSTOP</varname></link> <link linkend="cv-PDB"><varname>$PDB</varname></link> <link linkend="cv-SHCCCOMSTR"><varname>$SHCCCOMSTR</varname></link> <link linkend="cv-SHCXXCOMSTR"><varname>$SHCXXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-msvs"> <term>msvs</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Sets construction variables for Microsoft Visual Studio.</para> - <para>Sets: &cv-link-MSVSBUILDCOM;, &cv-link-MSVSCLEANCOM;, &cv-link-MSVSENCODING;, &cv-link-MSVSPROJECTCOM;, &cv-link-MSVSREBUILDCOM;, &cv-link-MSVSSCONS;, &cv-link-MSVSSCONSCOM;, &cv-link-MSVSSCONSCRIPT;, &cv-link-MSVSSCONSFLAGS;, &cv-link-MSVSSOLUTIONCOM;.</para></listitem> + <listitem><para>Sets construction variables for Microsoft Visual Studio.</para> + <para>Sets: <link linkend="cv-MSVSBUILDCOM"><varname>$MSVSBUILDCOM</varname></link> <link linkend="cv-MSVSCLEANCOM"><varname>$MSVSCLEANCOM</varname></link> <link linkend="cv-MSVSENCODING"><varname>$MSVSENCODING</varname></link> <link linkend="cv-MSVSPROJECTCOM"><varname>$MSVSPROJECTCOM</varname></link> <link linkend="cv-MSVSREBUILDCOM"><varname>$MSVSREBUILDCOM</varname></link> <link linkend="cv-MSVSSCONS"><varname>$MSVSSCONS</varname></link> <link linkend="cv-MSVSSCONSCOM"><varname>$MSVSSCONSCOM</varname></link> <link linkend="cv-MSVSSCONSCRIPT"><varname>$MSVSSCONSCRIPT</varname></link> <link linkend="cv-MSVSSCONSFLAGS"><varname>$MSVSSCONSFLAGS</varname></link> <link linkend="cv-MSVSSOLUTIONCOM"><varname>$MSVSSOLUTIONCOM</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mwcc"> <term>mwcc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Metrowerks CodeWarrior compiler. </para> -<para>Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CFILESUFFIX;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-MWCW_VERSION;, &cv-link-MWCW_VERSIONS;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;.</para><para>Uses: &cv-link-CCCOMSTR;, &cv-link-CXXCOMSTR;, &cv-link-SHCCCOMSTR;, &cv-link-SHCXXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-CC"><varname>$CC</varname></link> <link linkend="cv-CCCOM"><varname>$CCCOM</varname></link> <link linkend="cv-CFILESUFFIX"><varname>$CFILESUFFIX</varname></link> <link linkend="cv-CPPDEFPREFIX"><varname>$CPPDEFPREFIX</varname></link> <link linkend="cv-CPPDEFSUFFIX"><varname>$CPPDEFSUFFIX</varname></link> <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXCOM"><varname>$CXXCOM</varname></link> <link linkend="cv-CXXFILESUFFIX"><varname>$CXXFILESUFFIX</varname></link> <link linkend="cv-INCPREFIX"><varname>$INCPREFIX</varname></link> <link linkend="cv-INCSUFFIX"><varname>$INCSUFFIX</varname></link> <link linkend="cv-MWCW_VERSION"><varname>$MWCW_VERSION</varname></link> <link linkend="cv-MWCW_VERSIONS"><varname>$MWCW_VERSIONS</varname></link> <link linkend="cv-SHCC"><varname>$SHCC</varname></link> <link linkend="cv-SHCCCOM"><varname>$SHCCCOM</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHCFLAGS"><varname>$SHCFLAGS</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHCXXCOM"><varname>$SHCXXCOM</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> </para><para>Uses: <link linkend="cv-CCCOMSTR"><varname>$CCCOMSTR</varname></link> <link linkend="cv-CXXCOMSTR"><varname>$CXXCOMSTR</varname></link> <link linkend="cv-SHCCCOMSTR"><varname>$SHCCCOMSTR</varname></link> <link linkend="cv-SHCXXCOMSTR"><varname>$SHCXXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-mwld"> <term>mwld</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Metrowerks CodeWarrior linker. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOM"><varname>$ARCOM</varname></link> <link linkend="cv-LIBDIRPREFIX"><varname>$LIBDIRPREFIX</varname></link> <link linkend="cv-LIBDIRSUFFIX"><varname>$LIBDIRSUFFIX</varname></link> <link linkend="cv-LIBLINKPREFIX"><varname>$LIBLINKPREFIX</varname></link> <link linkend="cv-LIBLINKSUFFIX"><varname>$LIBLINKSUFFIX</varname></link> <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-LINKCOM"><varname>$LINKCOM</varname></link> <link linkend="cv-SHLINK"><varname>$SHLINK</varname></link> <link linkend="cv-SHLINKCOM"><varname>$SHLINKCOM</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-nasm"> <term>nasm</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the <application>nasm</application> Netwide Assembler. </para> -<para>Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.</para><para>Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;.</para></listitem> - </varlistentry> - <varlistentry id="t-Packaging"> - <term>Packaging</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <function xmlns="http://www.scons.org/dbxsd/v1.0">Package</function> Builder. -</para> -</listitem> +<para>Sets: <link linkend="cv-AS"><varname>$AS</varname></link> <link linkend="cv-ASCOM"><varname>$ASCOM</varname></link> <link linkend="cv-ASFLAGS"><varname>$ASFLAGS</varname></link> <link linkend="cv-ASPPCOM"><varname>$ASPPCOM</varname></link> <link linkend="cv-ASPPFLAGS"><varname>$ASPPFLAGS</varname></link> </para><para>Uses: <link linkend="cv-ASCOMSTR"><varname>$ASCOMSTR</varname></link> <link linkend="cv-ASPPCOMSTR"><varname>$ASPPCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-packaging"> <term>packaging</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A framework for building binary and source packages. </para> </listitem> </varlistentry> + <varlistentry id="t-Packaging"> + <term>Packaging</term> + <listitem><para> +Sets construction variables for the <function>Package</function> Builder. +</para> +</listitem> + </varlistentry> <varlistentry id="t-pdf"> <term>pdf</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Portable Document Format builder. </para> -<para>Sets: &cv-link-PDFPREFIX;, &cv-link-PDFSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-PDFPREFIX"><varname>$PDFPREFIX</varname></link> <link linkend="cv-PDFSUFFIX"><varname>$PDFSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-pdflatex"> <term>pdflatex</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdflatex</application> utility. + <listitem><para> +Sets construction variables for the <application>pdflatex</application> utility. </para> -<para>Sets: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;.</para><para>Uses: &cv-link-PDFLATEXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LATEXRETRIES"><varname>$LATEXRETRIES</varname></link> <link linkend="cv-PDFLATEX"><varname>$PDFLATEX</varname></link> <link linkend="cv-PDFLATEXCOM"><varname>$PDFLATEXCOM</varname></link> <link linkend="cv-PDFLATEXFLAGS"><varname>$PDFLATEXFLAGS</varname></link> </para><para>Uses: <link linkend="cv-PDFLATEXCOMSTR"><varname>$PDFLATEXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-pdftex"> <term>pdftex</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdftex</application> utility. + <listitem><para> +Sets construction variables for the <application>pdftex</application> utility. </para> -<para>Sets: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;, &cv-link-PDFTEX;, &cv-link-PDFTEXCOM;, &cv-link-PDFTEXFLAGS;.</para><para>Uses: &cv-link-PDFLATEXCOMSTR;, &cv-link-PDFTEXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-LATEXRETRIES"><varname>$LATEXRETRIES</varname></link> <link linkend="cv-PDFLATEX"><varname>$PDFLATEX</varname></link> <link linkend="cv-PDFLATEXCOM"><varname>$PDFLATEXCOM</varname></link> <link linkend="cv-PDFLATEXFLAGS"><varname>$PDFLATEXFLAGS</varname></link> <link linkend="cv-PDFTEX"><varname>$PDFTEX</varname></link> <link linkend="cv-PDFTEXCOM"><varname>$PDFTEXCOM</varname></link> <link linkend="cv-PDFTEXFLAGS"><varname>$PDFTEXFLAGS</varname></link> </para><para>Uses: <link linkend="cv-PDFLATEXCOMSTR"><varname>$PDFLATEXCOMSTR</varname></link> <link linkend="cv-PDFTEXCOMSTR"><varname>$PDFTEXCOMSTR</varname></link> </para></listitem> + </varlistentry> + <varlistentry id="t-python"> + <term>python</term> + <listitem><para> +Loads the Python scanner scanner into the invoking environment. When loaded, the scanner will +attempt to find implicit dependencies for any Python source files in the list of sources +provided to an actual that uses this environment. +</para> +</listitem> </varlistentry> <varlistentry id="t-qt"> <term>qt</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for building Qt applications. </para> -<para>Sets: &cv-link-QTDIR;, &cv-link-QT_AUTOSCAN;, &cv-link-QT_BINPATH;, &cv-link-QT_CPPPATH;, &cv-link-QT_LIB;, &cv-link-QT_LIBPATH;, &cv-link-QT_MOC;, &cv-link-QT_MOCCXXPREFIX;, &cv-link-QT_MOCCXXSUFFIX;, &cv-link-QT_MOCFROMCXXCOM;, &cv-link-QT_MOCFROMCXXFLAGS;, &cv-link-QT_MOCFROMHCOM;, &cv-link-QT_MOCFROMHFLAGS;, &cv-link-QT_MOCHPREFIX;, &cv-link-QT_MOCHSUFFIX;, &cv-link-QT_UIC;, &cv-link-QT_UICCOM;, &cv-link-QT_UICDECLFLAGS;, &cv-link-QT_UICDECLPREFIX;, &cv-link-QT_UICDECLSUFFIX;, &cv-link-QT_UICIMPLFLAGS;, &cv-link-QT_UICIMPLPREFIX;, &cv-link-QT_UICIMPLSUFFIX;, &cv-link-QT_UISUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-QTDIR"><varname>$QTDIR</varname></link> <link linkend="cv-QT_AUTOSCAN"><varname>$QT_AUTOSCAN</varname></link> <link linkend="cv-QT_BINPATH"><varname>$QT_BINPATH</varname></link> <link linkend="cv-QT_CPPPATH"><varname>$QT_CPPPATH</varname></link> <link linkend="cv-QT_LIB"><varname>$QT_LIB</varname></link> <link linkend="cv-QT_LIBPATH"><varname>$QT_LIBPATH</varname></link> <link linkend="cv-QT_MOC"><varname>$QT_MOC</varname></link> <link linkend="cv-QT_MOCCXXPREFIX"><varname>$QT_MOCCXXPREFIX</varname></link> <link linkend="cv-QT_MOCCXXSUFFIX"><varname>$QT_MOCCXXSUFFIX</varname></link> <link linkend="cv-QT_MOCFROMCXXCOM"><varname>$QT_MOCFROMCXXCOM</varname></link> <link linkend="cv-QT_MOCFROMCXXFLAGS"><varname>$QT_MOCFROMCXXFLAGS</varname></link> <link linkend="cv-QT_MOCFROMHCOM"><varname>$QT_MOCFROMHCOM</varname></link> <link linkend="cv-QT_MOCFROMHFLAGS"><varname>$QT_MOCFROMHFLAGS</varname></link> <link linkend="cv-QT_MOCHPREFIX"><varname>$QT_MOCHPREFIX</varname></link> <link linkend="cv-QT_MOCHSUFFIX"><varname>$QT_MOCHSUFFIX</varname></link> <link linkend="cv-QT_UIC"><varname>$QT_UIC</varname></link> <link linkend="cv-QT_UICCOM"><varname>$QT_UICCOM</varname></link> <link linkend="cv-QT_UICDECLFLAGS"><varname>$QT_UICDECLFLAGS</varname></link> <link linkend="cv-QT_UICDECLPREFIX"><varname>$QT_UICDECLPREFIX</varname></link> <link linkend="cv-QT_UICDECLSUFFIX"><varname>$QT_UICDECLSUFFIX</varname></link> <link linkend="cv-QT_UICIMPLFLAGS"><varname>$QT_UICIMPLFLAGS</varname></link> <link linkend="cv-QT_UICIMPLPREFIX"><varname>$QT_UICIMPLPREFIX</varname></link> <link linkend="cv-QT_UICIMPLSUFFIX"><varname>$QT_UICIMPLSUFFIX</varname></link> <link linkend="cv-QT_UISUFFIX"><varname>$QT_UISUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-rmic"> <term>rmic</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">rmic</application> utility. + <listitem><para> +Sets construction variables for the <application>rmic</application> utility. </para> -<para>Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-RMIC;, &cv-link-RMICCOM;, &cv-link-RMICFLAGS;.</para><para>Uses: &cv-link-RMICCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-JAVACLASSSUFFIX"><varname>$JAVACLASSSUFFIX</varname></link> <link linkend="cv-RMIC"><varname>$RMIC</varname></link> <link linkend="cv-RMICCOM"><varname>$RMICCOM</varname></link> <link linkend="cv-RMICFLAGS"><varname>$RMICFLAGS</varname></link> </para><para>Uses: <link linkend="cv-RMICCOMSTR"><varname>$RMICCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-rpcgen"> <term>rpcgen</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for building with RPCGEN. </para> -<para>Sets: &cv-link-RPCGEN;, &cv-link-RPCGENCLIENTFLAGS;, &cv-link-RPCGENFLAGS;, &cv-link-RPCGENHEADERFLAGS;, &cv-link-RPCGENSERVICEFLAGS;, &cv-link-RPCGENXDRFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-RPCGEN"><varname>$RPCGEN</varname></link> <link linkend="cv-RPCGENCLIENTFLAGS"><varname>$RPCGENCLIENTFLAGS</varname></link> <link linkend="cv-RPCGENFLAGS"><varname>$RPCGENFLAGS</varname></link> <link linkend="cv-RPCGENHEADERFLAGS"><varname>$RPCGENHEADERFLAGS</varname></link> <link linkend="cv-RPCGENSERVICEFLAGS"><varname>$RPCGENSERVICEFLAGS</varname></link> <link linkend="cv-RPCGENXDRFLAGS"><varname>$RPCGENXDRFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sgiar"> <term>sgiar</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the SGI library archiver. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOMSTR;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-ARCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOMSTR"><varname>$ARCOMSTR</varname></link> <link linkend="cv-ARFLAGS"><varname>$ARFLAGS</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> <link linkend="cv-SHLINK"><varname>$SHLINK</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para><para>Uses: <link linkend="cv-ARCOMSTR"><varname>$ARCOMSTR</varname></link> <link linkend="cv-SHLINKCOMSTR"><varname>$SHLINKCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sgicXX"> <term>sgic++</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the SGI C++ compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXFLAGS;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXFLAGS"><varname>$CXXFLAGS</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sgicc"> <term>sgicc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the SGI C compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sgilink"> <term>sgilink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the SGI linker. </para> -<para>Sets: &cv-link-LINK;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-LINK"><varname>$LINK</varname></link> <link linkend="cv-RPATHPREFIX"><varname>$RPATHPREFIX</varname></link> <link linkend="cv-RPATHSUFFIX"><varname>$RPATHSUFFIX</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sunar"> <term>sunar</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Sun library archiver. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOM"><varname>$ARCOM</varname></link> <link linkend="cv-ARFLAGS"><varname>$ARFLAGS</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-ARCOMSTR"><varname>$ARCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-suncXX"> <term>sunc++</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Sun C++ compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-CXXVERSION"><varname>$CXXVERSION</varname></link> <link linkend="cv-SHCXX"><varname>$SHCXX</varname></link> <link linkend="cv-SHCXXFLAGS"><varname>$SHCXXFLAGS</varname></link> <link linkend="cv-SHOBJPREFIX"><varname>$SHOBJPREFIX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-suncc"> <term>suncc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Sun C compiler. </para> -<para>Sets: &cv-link-CXX;, &cv-link-SHCCFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.</para></listitem> +<para>Sets: <link linkend="cv-CXX"><varname>$CXX</varname></link> <link linkend="cv-SHCCFLAGS"><varname>$SHCCFLAGS</varname></link> <link linkend="cv-SHOBJPREFIX"><varname>$SHOBJPREFIX</varname></link> <link linkend="cv-SHOBJSUFFIX"><varname>$SHOBJSUFFIX</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sunf77"> <term>sunf77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the Sun <application xmlns="http://www.scons.org/dbxsd/v1.0">f77</application> Fortran compiler. + <listitem><para> +Set construction variables for the Sun <application>f77</application> Fortran compiler. </para> -<para>Sets: &cv-link-F77;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-F77"><varname>$F77</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-SHF77"><varname>$SHF77</varname></link> <link linkend="cv-SHF77FLAGS"><varname>$SHF77FLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sunf90"> <term>sunf90</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the Sun <application xmlns="http://www.scons.org/dbxsd/v1.0">f90</application> Fortran compiler. + <listitem><para> +Set construction variables for the Sun <application>f90</application> Fortran compiler. </para> -<para>Sets: &cv-link-F90;, &cv-link-FORTRAN;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-F90"><varname>$F90</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-SHF90"><varname>$SHF90</varname></link> <link linkend="cv-SHF90FLAGS"><varname>$SHF90FLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sunf95"> <term>sunf95</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the Sun <application xmlns="http://www.scons.org/dbxsd/v1.0">f95</application> Fortran compiler. + <listitem><para> +Set construction variables for the Sun <application>f95</application> Fortran compiler. </para> -<para>Sets: &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-F95"><varname>$F95</varname></link> <link linkend="cv-FORTRAN"><varname>$FORTRAN</varname></link> <link linkend="cv-SHF95"><varname>$SHF95</varname></link> <link linkend="cv-SHF95FLAGS"><varname>$SHF95FLAGS</varname></link> <link linkend="cv-SHFORTRAN"><varname>$SHFORTRAN</varname></link> <link linkend="cv-SHFORTRANFLAGS"><varname>$SHFORTRANFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-sunlink"> <term>sunlink</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Sun linker. </para> -<para>Sets: &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: <link linkend="cv-RPATHPREFIX"><varname>$RPATHPREFIX</varname></link> <link linkend="cv-RPATHSUFFIX"><varname>$RPATHSUFFIX</varname></link> <link linkend="cv-SHLINKFLAGS"><varname>$SHLINKFLAGS</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-swig"> <term>swig</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the SWIG interface generator. </para> -<para>Sets: &cv-link-SWIG;, &cv-link-SWIGCFILESUFFIX;, &cv-link-SWIGCOM;, &cv-link-SWIGCXXFILESUFFIX;, &cv-link-SWIGDIRECTORSUFFIX;, &cv-link-SWIGFLAGS;, &cv-link-SWIGINCPREFIX;, &cv-link-SWIGINCSUFFIX;, &cv-link-SWIGPATH;, &cv-link-SWIGVERSION;, &cv-link-_SWIGINCFLAGS;.</para><para>Uses: &cv-link-SWIGCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-SWIG"><varname>$SWIG</varname></link> <link linkend="cv-SWIGCFILESUFFIX"><varname>$SWIGCFILESUFFIX</varname></link> <link linkend="cv-SWIGCOM"><varname>$SWIGCOM</varname></link> <link linkend="cv-SWIGCXXFILESUFFIX"><varname>$SWIGCXXFILESUFFIX</varname></link> <link linkend="cv-SWIGDIRECTORSUFFIX"><varname>$SWIGDIRECTORSUFFIX</varname></link> <link linkend="cv-SWIGFLAGS"><varname>$SWIGFLAGS</varname></link> <link linkend="cv-SWIGINCPREFIX"><varname>$SWIGINCPREFIX</varname></link> <link linkend="cv-SWIGINCSUFFIX"><varname>$SWIGINCSUFFIX</varname></link> <link linkend="cv-SWIGPATH"><varname>$SWIGPATH</varname></link> <link linkend="cv-SWIGVERSION"><varname>$SWIGVERSION</varname></link> <link linkend="cv-_SWIGINCFLAGS"><varname>$_SWIGINCFLAGS</varname></link> </para><para>Uses: <link linkend="cv-SWIGCOMSTR"><varname>$SWIGCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-tar"> <term>tar</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">tar</application> archiver. + <listitem><para> +Sets construction variables for the <application>tar</application> archiver. </para> -<para>Sets: &cv-link-TAR;, &cv-link-TARCOM;, &cv-link-TARFLAGS;, &cv-link-TARSUFFIX;.</para><para>Uses: &cv-link-TARCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-TAR"><varname>$TAR</varname></link> <link linkend="cv-TARCOM"><varname>$TARCOM</varname></link> <link linkend="cv-TARFLAGS"><varname>$TARFLAGS</varname></link> <link linkend="cv-TARSUFFIX"><varname>$TARSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-TARCOMSTR"><varname>$TARCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-tex"> <term>tex</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the TeX formatter and typesetter. </para> -<para>Sets: &cv-link-BIBTEX;, &cv-link-BIBTEXCOM;, &cv-link-BIBTEXFLAGS;, &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;, &cv-link-MAKEINDEX;, &cv-link-MAKEINDEXCOM;, &cv-link-MAKEINDEXFLAGS;, &cv-link-TEX;, &cv-link-TEXCOM;, &cv-link-TEXFLAGS;.</para><para>Uses: &cv-link-BIBTEXCOMSTR;, &cv-link-LATEXCOMSTR;, &cv-link-MAKEINDEXCOMSTR;, &cv-link-TEXCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-BIBTEX"><varname>$BIBTEX</varname></link> <link linkend="cv-BIBTEXCOM"><varname>$BIBTEXCOM</varname></link> <link linkend="cv-BIBTEXFLAGS"><varname>$BIBTEXFLAGS</varname></link> <link linkend="cv-LATEX"><varname>$LATEX</varname></link> <link linkend="cv-LATEXCOM"><varname>$LATEXCOM</varname></link> <link linkend="cv-LATEXFLAGS"><varname>$LATEXFLAGS</varname></link> <link linkend="cv-MAKEINDEX"><varname>$MAKEINDEX</varname></link> <link linkend="cv-MAKEINDEXCOM"><varname>$MAKEINDEXCOM</varname></link> <link linkend="cv-MAKEINDEXFLAGS"><varname>$MAKEINDEXFLAGS</varname></link> <link linkend="cv-TEX"><varname>$TEX</varname></link> <link linkend="cv-TEXCOM"><varname>$TEXCOM</varname></link> <link linkend="cv-TEXFLAGS"><varname>$TEXFLAGS</varname></link> </para><para>Uses: <link linkend="cv-BIBTEXCOMSTR"><varname>$BIBTEXCOMSTR</varname></link> <link linkend="cv-LATEXCOMSTR"><varname>$LATEXCOMSTR</varname></link> <link linkend="cv-MAKEINDEXCOMSTR"><varname>$MAKEINDEXCOMSTR</varname></link> <link linkend="cv-TEXCOMSTR"><varname>$TEXCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-textfile"> <term>textfile</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Set construction variables for the <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> and <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> builders. + <listitem><para> +Set construction variables for the <function>Textfile</function> and <function>Substfile</function> builders. </para> -<para>Sets: &cv-link-LINESEPARATOR;, &cv-link-SUBSTFILEPREFIX;, &cv-link-SUBSTFILESUFFIX;, &cv-link-TEXTFILEPREFIX;, &cv-link-TEXTFILESUFFIX;.</para><para>Uses: &cv-link-SUBST_DICT;.</para></listitem> +<para>Sets: <link linkend="cv-LINESEPARATOR"><varname>$LINESEPARATOR</varname></link> <link linkend="cv-SUBSTFILEPREFIX"><varname>$SUBSTFILEPREFIX</varname></link> <link linkend="cv-SUBSTFILESUFFIX"><varname>$SUBSTFILESUFFIX</varname></link> <link linkend="cv-TEXTFILEPREFIX"><varname>$TEXTFILEPREFIX</varname></link> <link linkend="cv-TEXTFILESUFFIX"><varname>$TEXTFILESUFFIX</varname></link> </para><para>Uses: <link linkend="cv-SUBST_DICT"><varname>$SUBST_DICT</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-tlib"> <term>tlib</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the Borlan <application>tib</application> library archiver. </para> -<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-AR"><varname>$AR</varname></link> <link linkend="cv-ARCOM"><varname>$ARCOM</varname></link> <link linkend="cv-ARFLAGS"><varname>$ARFLAGS</varname></link> <link linkend="cv-LIBPREFIX"><varname>$LIBPREFIX</varname></link> <link linkend="cv-LIBSUFFIX"><varname>$LIBSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-ARCOMSTR"><varname>$ARCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-xgettext"> <term>xgettext</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This scons tool is a part of scons <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides + <listitem><para> +This scons tool is a part of scons <link linkend="t-gettext"><literal>gettext</literal></link> toolset. It provides scons interface to <command>xgettext(1)</command> program, which extracts internationalized messages from source code. The tool -provides <function xmlns="http://www.scons.org/dbxsd/v1.0">POTUpdate</function> builder to make <literal>PO</literal> +provides <function>POTUpdate</function> builder to make <literal>PO</literal> <emphasis>Template</emphasis> files. </para> -<para>Sets: &cv-link-POTSUFFIX;, &cv-link-POTUPDATE_ALIAS;, &cv-link-XGETTEXTCOM;, &cv-link-XGETTEXTCOMSTR;, &cv-link-XGETTEXTFLAGS;, &cv-link-XGETTEXTFROM;, &cv-link-XGETTEXTFROMPREFIX;, &cv-link-XGETTEXTFROMSUFFIX;, &cv-link-XGETTEXTPATH;, &cv-link-XGETTEXTPATHPREFIX;, &cv-link-XGETTEXTPATHSUFFIX;, &cv-link-_XGETTEXTDOMAIN;, &cv-link-_XGETTEXTFROMFLAGS;, &cv-link-_XGETTEXTPATHFLAGS;.</para><para>Uses: &cv-link-POTDOMAIN;.</para></listitem> +<para>Sets: <link linkend="cv-POTSUFFIX"><varname>$POTSUFFIX</varname></link> <link linkend="cv-POTUPDATE_ALIAS"><varname>$POTUPDATE_ALIAS</varname></link> <link linkend="cv-XGETTEXTCOM"><varname>$XGETTEXTCOM</varname></link> <link linkend="cv-XGETTEXTCOMSTR"><varname>$XGETTEXTCOMSTR</varname></link> <link linkend="cv-XGETTEXTFLAGS"><varname>$XGETTEXTFLAGS</varname></link> <link linkend="cv-XGETTEXTFROM"><varname>$XGETTEXTFROM</varname></link> <link linkend="cv-XGETTEXTFROMPREFIX"><varname>$XGETTEXTFROMPREFIX</varname></link> <link linkend="cv-XGETTEXTFROMSUFFIX"><varname>$XGETTEXTFROMSUFFIX</varname></link> <link linkend="cv-XGETTEXTPATH"><varname>$XGETTEXTPATH</varname></link> <link linkend="cv-XGETTEXTPATHPREFIX"><varname>$XGETTEXTPATHPREFIX</varname></link> <link linkend="cv-XGETTEXTPATHSUFFIX"><varname>$XGETTEXTPATHSUFFIX</varname></link> <link linkend="cv-_XGETTEXTDOMAIN"><varname>$_XGETTEXTDOMAIN</varname></link> <link linkend="cv-_XGETTEXTFROMFLAGS"><varname>$_XGETTEXTFROMFLAGS</varname></link> <link linkend="cv-_XGETTEXTPATHFLAGS"><varname>$_XGETTEXTPATHFLAGS</varname></link> </para><para>Uses: <link linkend="cv-POTDOMAIN"><varname>$POTDOMAIN</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-yacc"> <term>yacc</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">yacc</application> parse generator. + <listitem><para> +Sets construction variables for the <application>yacc</application> parse generator. </para> -<para>Sets: &cv-link-YACC;, &cv-link-YACCCOM;, &cv-link-YACCFLAGS;, &cv-link-YACCHFILESUFFIX;, &cv-link-YACCHXXFILESUFFIX;, &cv-link-YACCVCGFILESUFFIX;.</para><para>Uses: &cv-link-YACCCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-YACC"><varname>$YACC</varname></link> <link linkend="cv-YACCCOM"><varname>$YACCCOM</varname></link> <link linkend="cv-YACCFLAGS"><varname>$YACCFLAGS</varname></link> <link linkend="cv-YACCHFILESUFFIX"><varname>$YACCHFILESUFFIX</varname></link> <link linkend="cv-YACCHXXFILESUFFIX"><varname>$YACCHXXFILESUFFIX</varname></link> <link linkend="cv-YACCVCGFILESUFFIX"><varname>$YACCVCGFILESUFFIX</varname></link> </para><para>Uses: <link linkend="cv-YACCCOMSTR"><varname>$YACCCOMSTR</varname></link> </para></listitem> </varlistentry> <varlistentry id="t-zip"> <term>zip</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Sets construction variables for the <application xmlns="http://www.scons.org/dbxsd/v1.0">zip</application> archiver. + <listitem><para> +Sets construction variables for the <application>zip</application> archiver. </para> -<para>Sets: &cv-link-ZIP;, &cv-link-ZIPCOM;, &cv-link-ZIPCOMPRESSION;, &cv-link-ZIPFLAGS;, &cv-link-ZIPSUFFIX;.</para><para>Uses: &cv-link-ZIPCOMSTR;.</para></listitem> +<para>Sets: <link linkend="cv-ZIP"><varname>$ZIP</varname></link> <link linkend="cv-ZIPCOM"><varname>$ZIPCOM</varname></link> <link linkend="cv-ZIPCOMPRESSION"><varname>$ZIPCOMPRESSION</varname></link> <link linkend="cv-ZIPFLAGS"><varname>$ZIPFLAGS</varname></link> <link linkend="cv-ZIPSUFFIX"><varname>$ZIPSUFFIX</varname></link> </para><para>Uses: <link linkend="cv-ZIPCOMSTR"><varname>$ZIPCOMSTR</varname></link> </para></listitem> </varlistentry> </variablelist> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 21e0b1f..30103ef 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -1,4 +1,3 @@ -<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,125 +11,135 @@ %variables-mod; ]> -<variablelist 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 http://www.scons.org/dbxsd/v1.0/scons.xsd"> +<variablelist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.scons.org/dbxsd/v1.0" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> <varlistentry id="cv-__LDMODULEVERSIONFLAGS"> - <term>__LDMODULEVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This construction variable automatically introduces <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LDMODULEVERSIONFLAGS"><envar>$_LDMODULEVERSIONFLAGS</envar></link> -if <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is set. Othervise it evaluates to an empty string. + <term> + <envar>__LDMODULEVERSIONFLAGS</envar> + </term> + <listitem><para> +This construction variable automatically introduces <link linkend="cv-_LDMODULEVERSIONFLAGS"><envar>$_LDMODULEVERSIONFLAGS</envar></link> +if <link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is set. Othervise it evaluates to an empty string. </para> </listitem> </varlistentry> <varlistentry id="cv-__SHLIBVERSIONFLAGS"> - <term>__SHLIBVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This construction variable automatically introduces <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_SHLIBVERSIONFLAGS"><envar>$_SHLIBVERSIONFLAGS</envar></link> -if <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is set. Othervise it evaluates to an empty string. + <term> + <envar>__SHLIBVERSIONFLAGS</envar> + </term> + <listitem><para> +This construction variable automatically introduces <link linkend="cv-_SHLIBVERSIONFLAGS"><envar>$_SHLIBVERSIONFLAGS</envar></link> +if <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is set. Othervise it evaluates to an empty string. </para> </listitem> </varlistentry> - <varlistentry id="cv-_APPLELINK_COMPATIBILITY_VERSION"> - <term>_APPLELINK_COMPATIBILITY_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - A macro (by default a generator function) used to create the linker flags to specify - apple's linker's -compatibility_version flag. - The default generator uses <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_COMPATIBILITY_VERSION"><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link> - and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_NO_COMPATIBILITY_VERSION"><envar>$APPLELINK_NO_COMPATIBILITY_VERSION</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> - to determine the correct flag. - </para> - </listitem> - </varlistentry> <varlistentry id="cv-APPLELINK_COMPATIBILITY_VERSION"> - <term>APPLELINK_COMPATIBILITY_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>APPLELINK_COMPATIBILITY_VERSION</envar> + </term> + <listitem><para> On Mac OS X this is used to set the linker flag: -compatibility_version </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and - 255, Z can be omitted or between 1 and 255. This value will be derived from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> if + 255, Z can be omitted or between 1 and 255. This value will be derived from <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> if not specified. The lowest digit will be dropped and replaced by a 0. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - If the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_NO_COMPATIBILITY_VERSION"><envar>$APPLELINK_NO_COMPATIBILITY_VERSION</envar></link> is set then no -compatibility_version will be + <para> + If the <link linkend="cv-APPLELINK_NO_COMPATIBILITY_VERSION"><envar>$APPLELINK_NO_COMPATIBILITY_VERSION</envar></link> is set then no -compatibility_version will be output. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0">See MacOS's ld manpage for more details</para> + <para>See MacOS's ld manpage for more details</para> </listitem> </varlistentry> - <varlistentry id="cv-_APPLELINK_CURRENT_VERSION"> - <term>_APPLELINK_CURRENT_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - A macro (by default a generator function) used to create the linker flags to specify apple's linker's - -current_version flag. The default generator uses <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_CURRENT_VERSION"><envar>$APPLELINK_CURRENT_VERSION</envar></link> and - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_NO_CURRENT_VERSION"><envar>$APPLELINK_NO_CURRENT_VERSION</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> to determine the correct flag. + <varlistentry id="cv-_APPLELINK_COMPATIBILITY_VERSION"> + <term> + <envar>_APPLELINK_COMPATIBILITY_VERSION</envar> + </term> + <listitem><para> + A macro (by default a generator function) used to create the linker flags to specify + apple's linker's -compatibility_version flag. + The default generator uses <link linkend="cv-APPLELINK_COMPATIBILITY_VERSION"><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link> + and <link linkend="cv-APPLELINK_NO_COMPATIBILITY_VERSION"><envar>$APPLELINK_NO_COMPATIBILITY_VERSION</envar></link> and <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> + to determine the correct flag. </para> </listitem> </varlistentry> <varlistentry id="cv-APPLELINK_CURRENT_VERSION"> - <term>APPLELINK_CURRENT_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>APPLELINK_CURRENT_VERSION</envar> + </term> + <listitem><para> On Mac OS X this is used to set the linker flag: -current_version </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and - 255, Z can be omitted or between 1 and 255. This value will be set to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> if not + 255, Z can be omitted or between 1 and 255. This value will be set to <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> if not specified. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - If the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_NO_CURRENT_VERSION"><envar>$APPLELINK_NO_CURRENT_VERSION</envar></link> is set then no -current_version will be + <para> + If the <link linkend="cv-APPLELINK_NO_CURRENT_VERSION"><envar>$APPLELINK_NO_CURRENT_VERSION</envar></link> is set then no -current_version will be output. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0">See MacOS's ld manpage for more details</para> + <para>See MacOS's ld manpage for more details</para> </listitem> </varlistentry> + <varlistentry id="cv-_APPLELINK_CURRENT_VERSION"> + <term> + <envar>_APPLELINK_CURRENT_VERSION</envar> + </term> + <listitem><para> + A macro (by default a generator function) used to create the linker flags to specify apple's linker's + -current_version flag. The default generator uses <link linkend="cv-APPLELINK_CURRENT_VERSION"><envar>$APPLELINK_CURRENT_VERSION</envar></link> and + <link linkend="cv-APPLELINK_NO_CURRENT_VERSION"><envar>$APPLELINK_NO_CURRENT_VERSION</envar></link> and <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> to determine the correct flag. + </para> + </listitem> + </varlistentry> <varlistentry id="cv-APPLELINK_NO_COMPATIBILITY_VERSION"> - <term>APPLELINK_NO_COMPATIBILITY_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>APPLELINK_NO_COMPATIBILITY_VERSION</envar> + </term> + <listitem><para> Set this to any True (1|True|non-empty string) value to disable adding -compatibility_version flag when generating versioned shared libraries. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This overrides <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_COMPATIBILITY_VERSION"><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link>. + <para> + This overrides <link linkend="cv-APPLELINK_COMPATIBILITY_VERSION"><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-APPLELINK_NO_CURRENT_VERSION"> - <term>APPLELINK_NO_CURRENT_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>APPLELINK_NO_CURRENT_VERSION</envar> + </term> + <listitem><para> Set this to any True (1|True|non-empty string) value to disable adding -current_version flag when generating versioned shared libraries. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This overrides <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-APPLELINK_CURRENT_VERSION"><envar>$APPLELINK_CURRENT_VERSION</envar></link>. + <para> + This overrides <link linkend="cv-APPLELINK_CURRENT_VERSION"><envar>$APPLELINK_CURRENT_VERSION</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-AR"> - <term>AR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>AR</envar> + </term> + <listitem><para> The static library archiver. </para> </listitem> </varlistentry> <varlistentry id="cv-ARCHITECTURE"> - <term>ARCHITECTURE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ARCHITECTURE</envar> + </term> + <listitem><para> Specifies the system architecture for which the package is being built. The default is the system architecture @@ -146,126 +155,138 @@ as well as forming part of the name of a generated RPM package file. </listitem> </varlistentry> <varlistentry id="cv-ARCOM"> - <term>ARCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ARCOM</envar> + </term> + <listitem><para> The command line used to generate a static library from object files. </para> </listitem> </varlistentry> <varlistentry id="cv-ARCOMSTR"> - <term>ARCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when an object file -is generated from an assembly-language source file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ARCOM"><envar>$ARCOM</envar></link> (the command line) is displayed. + <term> + <envar>ARCOMSTR</envar> + </term> + <listitem><para> +The string displayed when a static library is +generated from object files. +If this is not set, then <link linkend="cv-ARCOM"><envar>$ARCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(ARCOMSTR = "Archiving $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-ARFLAGS"> - <term>ARFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ARFLAGS</envar> + </term> + <listitem><para> General options passed to the static library archiver. </para> </listitem> </varlistentry> <varlistentry id="cv-AS"> - <term>AS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>AS</envar> + </term> + <listitem><para> The assembler. </para> </listitem> </varlistentry> <varlistentry id="cv-ASCOM"> - <term>ASCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASCOM</envar> + </term> + <listitem><para> The command line used to generate an object file from an assembly-language source file. </para> </listitem> </varlistentry> <varlistentry id="cv-ASCOMSTR"> - <term>ASCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASCOMSTR</envar> + </term> + <listitem><para> The string displayed when an object file is generated from an assembly-language source file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ASCOM"><envar>$ASCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-ASCOM"><envar>$ASCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(ASCOMSTR = "Assembling $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-ASFLAGS"> - <term>ASFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASFLAGS</envar> + </term> + <listitem><para> General options passed to the assembler. </para> </listitem> </varlistentry> <varlistentry id="cv-ASPPCOM"> - <term>ASPPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASPPCOM</envar> + </term> + <listitem><para> The command line used to assemble an assembly-language source file into an object file after first running the file through the C preprocessor. Any options specified -in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ASFLAGS"><envar>$ASFLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +in the <link linkend="cv-ASFLAGS"><envar>$ASFLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-ASPPCOMSTR"> - <term>ASPPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASPPCOMSTR</envar> + </term> + <listitem><para> The string displayed when an object file is generated from an assembly-language source file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ASPPCOM"><envar>$ASPPCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-ASPPCOM"><envar>$ASPPCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(ASPPCOMSTR = "Assembling $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-ASPPFLAGS"> - <term>ASPPFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ASPPFLAGS</envar> + </term> + <listitem><para> General options when an assembling an assembly-language source file into an object file after first running the file through the C preprocessor. -The default is to use the value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ASFLAGS"><envar>$ASFLAGS</envar></link>. +The default is to use the value of <link linkend="cv-ASFLAGS"><envar>$ASFLAGS</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-BIBTEX"> - <term>BIBTEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>BIBTEX</envar> + </term> + <listitem><para> The bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-BIBTEXCOM"> - <term>BIBTEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>BIBTEXCOM</envar> + </term> + <listitem><para> The command line used to call the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -273,32 +294,35 @@ typesetter. </listitem> </varlistentry> <varlistentry id="cv-BIBTEXCOMSTR"> - <term>BIBTEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>BIBTEXCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a bibliography for TeX or LaTeX. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-BIBTEXCOM"><envar>$BIBTEXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-BIBTEXCOM"><envar>$BIBTEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-BIBTEXFLAGS"> - <term>BIBTEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>BIBTEXFLAGS</envar> + </term> + <listitem><para> General options passed to the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-BUILDERS"> - <term>BUILDERS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>BUILDERS</envar> + </term> + <listitem><para> A dictionary mapping the names of the builders available through this environment to underlying Builder objects. @@ -309,97 +333,105 @@ If you initialize this variable when an Environment is created: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(BUILDERS = {'NewBuilder' : foo}) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> the default Builders will no longer be available. To use a new Builder object in addition to the default Builders, add your new Builder object like this: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() env.Append(BUILDERS = {'NewBuilder' : foo}) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> or this: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() env['BUILDERS']['NewBuilder'] = foo </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CC"> - <term>CC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CC</envar> + </term> + <listitem><para> The C compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-CCCOM"> - <term>CCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CCCOM</envar> + </term> + <listitem><para> The command line used to compile a C source file to a (static) object -file. Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CFLAGS"><envar>$CFLAGS</envar></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command -line. +file. Any options specified in the <link linkend="cv-CFLAGS"><envar>$CFLAGS</envar></link>, <link linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link> and +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. +See also <link linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link> for compiling to shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-CCCOMSTR"> - <term>CCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a C source file + <term> + <envar>CCCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a C source file is compiled to a (static) object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCCOM"><envar>$CCCOM</envar></link> (the command line) is displayed. +If not set, then <link linkend="cv-CCCOM"><envar>$CCCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-SHCCCOMSTR"><envar>$SHCCCOMSTR</envar></link> for compiling to shared objects. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(CCCOMSTR = "Compiling static object $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CCFLAGS"> - <term>CCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CCFLAGS</envar> + </term> + <listitem><para> General options that are passed to the C and C++ compilers. +See also <link linkend="cv-SHCCFLAGS"><envar>$SHCCFLAGS</envar></link> for compiling to shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-CCPCHFLAGS"> - <term>CCPCHFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CCPCHFLAGS</envar> + </term> + <listitem><para> Options added to the compiler command line to support building with precompiled headers. The default value expands expands to the appropriate Microsoft Visual C++ command-line options -when the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PCH"><envar>$PCH</envar></link> construction variable is set. +when the <link linkend="cv-PCH"><envar>$PCH</envar></link> construction variable is set. </para> </listitem> </varlistentry> <varlistentry id="cv-CCPDBFLAGS"> - <term>CCPDBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CCPDBFLAGS</envar> + </term> + <listitem><para> Options added to the compiler command line to support storing debugging information in a Microsoft Visual C++ PDB file. The default value expands expands to appropriate Microsoft Visual C++ command-line options -when the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PDB"><envar>$PDB</envar></link> construction variable is set. +when the <link linkend="cv-PDB"><envar>$PDB</envar></link> construction variable is set. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The Visual C++ compiler option that SCons uses by default to generate PDB information is <option>/Z7</option>. This works correctly with parallel (<option>-j</option>) builds @@ -412,31 +444,32 @@ link-time performance, although parallel builds will no longer work. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> You can generate PDB files with the <option>/Zi</option> -switch by overriding the default <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable as follows: +switch by overriding the default <link linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable as follows: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['CCPDBFLAGS'] = ['${(PDB and "/Zi /Fd%s" % File(PDB)) or ""}'] </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> An alternative would be to use the <option>/Zi</option> to put the debugging information in a separate <filename>.pdb</filename> file for each object file by overriding -the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable as follows: +the <link linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable as follows: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['CCPDBFLAGS'] = '/Zi /Fd${TARGET}.pdb' </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CCVERSION"> - <term>CCVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CCVERSION</envar> + </term> + <listitem><para> The version number of the C compiler. This may or may not be set, depending on the specific C compiler being used. @@ -444,9 +477,10 @@ depending on the specific C compiler being used. </listitem> </varlistentry> <varlistentry id="cv-CFILESUFFIX"> - <term>CFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CFILESUFFIX</envar> + </term> + <listitem><para> The suffix for C source files. This is used by the internal CFile builder when generating C files from Lex (.l) or YACC (.y) input files. @@ -462,17 +496,20 @@ as C files. </listitem> </varlistentry> <varlistentry id="cv-CFLAGS"> - <term>CFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CFLAGS</envar> + </term> + <listitem><para> General options that are passed to the C compiler (C only; not C++). +See also <link linkend="cv-SHCFLAGS"><envar>$SHCFLAGS</envar></link> for compiling to shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-CHANGE_SPECFILE"> - <term>CHANGE_SPECFILE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CHANGE_SPECFILE</envar> + </term> + <listitem><para> A hook for modifying the file that controls the packaging build (the <filename>.spec</filename> for RPM, the <filename>control</filename> for Ipkg, @@ -483,9 +520,10 @@ after the SCons template for the file has been written. </listitem> </varlistentry> <varlistentry id="cv-CHANGED_SOURCES"> - <term>CHANGED_SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CHANGED_SOURCES</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -494,9 +532,10 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-CHANGED_TARGETS"> - <term>CHANGED_TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CHANGED_TARGETS</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -505,9 +544,10 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-CHANGELOG"> - <term>CHANGELOG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CHANGELOG</envar> + </term> + <listitem><para> The name of a file containing the change log text to be included in the package. This is included as the @@ -518,10 +558,11 @@ section of the RPM </listitem> </varlistentry> <varlistentry id="cv-_concat"> - <term>_concat</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A function used to produce variables like <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar>. It takes + <term> + <envar>_concat</envar> + </term> + <listitem><para> +A function used to produce variables like <envar>$_CPPINCFLAGS</envar>. It takes four or five arguments: a prefix to concatenate onto each element, a list of elements, a suffix to concatenate onto each element, an environment @@ -529,15 +570,16 @@ for variable interpolation, and an optional function that will be called to transform the list before concatenation. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['_CPPINCFLAGS'] = '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs)} $)', </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CONFIGUREDIR"> - <term>CONFIGUREDIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CONFIGUREDIR</envar> + </term> + <listitem><para> The name of the directory in which Configure context test files are written. The default is @@ -550,9 +592,10 @@ file. </listitem> </varlistentry> <varlistentry id="cv-CONFIGURELOG"> - <term>CONFIGURELOG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CONFIGURELOG</envar> + </term> + <listitem><para> The name of the Configure context log file. The default is <filename>config.log</filename> @@ -564,51 +607,53 @@ file. </listitem> </varlistentry> <varlistentry id="cv-_CPPDEFFLAGS"> - <term>_CPPDEFFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_CPPDEFFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the C preprocessor command-line options to define values. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPDEFFLAGS</envar> is created +The value of <envar>$_CPPDEFFLAGS</envar> is created by respectively prepending and appending -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFSUFFIX</envar> +<envar>$CPPDEFPREFIX</envar> and <envar>$CPPDEFSUFFIX</envar> to the beginning and end -of each definition in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar>. +of each definition in <envar>$CPPDEFINES</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-CPPDEFINES"> - <term>CPPDEFINES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPDEFINES</envar> + </term> + <listitem><para> A platform independent specification of C preprocessor definitions. The definitions will be added to command lines through the automatically-generated -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPDEFFLAGS</envar> construction variable (see above), +<envar>$_CPPDEFFLAGS</envar> construction variable (see above), which is constructed according to -the type of value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar>: +the type of value of <envar>$CPPDEFINES</envar>: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar> is a string, +<para> +If <envar>$CPPDEFINES</envar> is a string, the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFSUFFIX</envar> +<envar>$CPPDEFPREFIX</envar> and <envar>$CPPDEFSUFFIX</envar> construction variables will be respectively prepended and appended to the beginning and end -of each definition in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar>. +of each definition in <envar>$CPPDEFINES</envar>. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Will add -Dxyz to POSIX compiler command lines, # and /Dxyz to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES='xyz') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar> is a list, +<para> +If <envar>$CPPDEFINES</envar> is a list, the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFSUFFIX</envar> +<envar>$CPPDEFPREFIX</envar> and <envar>$CPPDEFSUFFIX</envar> construction variables will be respectively prepended and appended to the beginning and end of each element in the list. @@ -617,16 +662,16 @@ then the first item is the name being defined and the second item is its value: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Will add -DB=2 -DA to POSIX compiler command lines, # and /DB=2 /DA to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES=[('B', 2), 'A']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar> is a dictionary, +<para> +If <envar>$CPPDEFINES</envar> is a dictionary, the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFSUFFIX</envar> +<envar>$CPPDEFPREFIX</envar> and <envar>$CPPDEFSUFFIX</envar> construction variables will be respectively prepended and appended to the beginning and end of each item from the dictionary. @@ -639,11 +684,11 @@ then the name is defined without an explicit value. Note that the resulting flags are sorted by keyword to ensure that the order of the options on the command line is consistent each time -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> is run. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> # Will add -DA -DB=2 to POSIX compiler command lines, # and /DA /DB=2 to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES={'B':2, 'A':None}) @@ -651,46 +696,49 @@ env = Environment(CPPDEFINES={'B':2, 'A':None}) </listitem> </varlistentry> <varlistentry id="cv-CPPDEFPREFIX"> - <term>CPPDEFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPDEFPREFIX</envar> + </term> + <listitem><para> The prefix used to specify preprocessor definitions on the C compiler command line. This will be prepended to the beginning of each definition -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPDEFFLAGS</envar> variable is automatically generated. +in the <envar>$CPPDEFINES</envar> construction variable +when the <envar>$_CPPDEFFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-CPPDEFSUFFIX"> - <term>CPPDEFSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPDEFSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify preprocessor definitions on the C compiler command line. This will be appended to the end of each definition -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFINES</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPDEFFLAGS</envar> variable is automatically generated. +in the <envar>$CPPDEFINES</envar> construction variable +when the <envar>$_CPPDEFFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-CPPFLAGS"> - <term>CPPFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPFLAGS</envar> + </term> + <listitem><para> User-specified C preprocessor options. These will be included in any command that uses the C preprocessor, including not just compilation of C and C++ source files -via the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCCOM"><envar>$CCCOM</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> command lines, -but also the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> command lines +via the <link linkend="cv-CCCOM"><envar>$CCCOM</envar></link>, +<link linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link>, +<link linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> and +<link linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> command lines, +but also the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link>, +<link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link>, +<link linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> and +<link linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> command lines used to compile a Fortran source file, -and the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ASPPCOM"><envar>$ASPPCOM</envar></link> command line +and the <link linkend="cv-ASPPCOM"><envar>$ASPPCOM</envar></link> command line used to assemble an assembly language source file, after first running each file through the C preprocessor. Note that this variable does @@ -698,30 +746,32 @@ Note that this variable does contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_CPPINCFLAGS"><envar>$_CPPINCFLAGS</envar></link>, below, +that scons generates automatically from <link linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>. +See <link linkend="cv-_CPPINCFLAGS"><envar>$_CPPINCFLAGS</envar></link>, below, for the variable that expands to those options. </para> </listitem> </varlistentry> <varlistentry id="cv-_CPPINCFLAGS"> - <term>_CPPINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_CPPINCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the C preprocessor command-line options for specifying directories to be searched for include files. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar> is created -by respectively prepending and appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$INCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$INCSUFFIX</envar> +The value of <envar>$_CPPINCFLAGS</envar> is created +by respectively prepending and appending <envar>$INCPREFIX</envar> and <envar>$INCSUFFIX</envar> to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar>. +of each directory in <envar>$CPPPATH</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-CPPPATH"> - <term>CPPPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPPATH</envar> + </term> + <listitem><para> The list of directories that the C preprocessor will search for include directories. The C/C++ implicit dependency scanner will search these directories for include files. Don't explicitly put include directory @@ -729,57 +779,58 @@ arguments in CCFLAGS or CXXFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in CPPPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(CPPPATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(CPPPATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar> +<envar>$_CPPINCFLAGS</envar> construction variable, which is constructed by respectively prepending and appending the value of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$INCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$INCSUFFIX</envar> +<envar>$INCPREFIX</envar> and <envar>$INCSUFFIX</envar> construction variables to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar>. +of each directory in <envar>$CPPPATH</envar>. Any command lines you define that need the CPPPATH directory list should -include <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar>: +include <envar>$_CPPINCFLAGS</envar>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(CCCOM="my_compiler $_CPPINCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CPPSUFFIXES"> - <term>CPPSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CPPSUFFIXES</envar> + </term> + <listitem><para> The list of suffixes of files that will be scanned for C preprocessor implicit dependencies (#include lines). The default list is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> [".c", ".C", ".cxx", ".cpp", ".c++", ".cc", ".h", ".H", ".hxx", ".hpp", ".hh", ".F", ".fpp", ".FPP", @@ -789,42 +840,49 @@ The default list is: </listitem> </varlistentry> <varlistentry id="cv-CXX"> - <term>CXX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CXX</envar> + </term> + <listitem><para> The C++ compiler. +See also <link linkend="cv-SHCXX"><envar>$SHCXX</envar></link> for compiling to shared objects.. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXCOM"> - <term>CXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CXXCOM</envar> + </term> + <listitem><para> The command line used to compile a C++ source file to an object file. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFLAGS"><envar>$CXXFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-CXXFLAGS"><envar>$CXXFLAGS</envar></link> and +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. +See also <link linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> for compiling to shared objects.. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXCOMSTR"> - <term>CXXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a C++ source file + <term> + <envar>CXXCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a C++ source file is compiled to a (static) object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> (the command line) is displayed. +If not set, then <link linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-SHCXXCOMSTR"><envar>$SHCXXCOMSTR</envar></link> for compiling to shared objects.. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(CXXCOMSTR = "Compiling static object $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-CXXFILESUFFIX"> - <term>CXXFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CXXFILESUFFIX</envar> + </term> + <listitem><para> The suffix for C++ source files. This is used by the internal CXXFile builder when generating C++ files from Lex (.ll) or YACC (.yy) input files. @@ -849,21 +907,24 @@ as C++ files. </listitem> </varlistentry> <varlistentry id="cv-CXXFLAGS"> - <term>CXXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CXXFLAGS</envar> + </term> + <listitem><para> General options that are passed to the C++ compiler. -By default, this includes the value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link>, -so that setting <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CCFLAGS</envar> affects both C and C++ compilation. +By default, this includes the value of <link linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link>, +so that setting <envar>$CCFLAGS</envar> affects both C and C++ compilation. If you want to add C++-specific flags, -you must set or override the value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFLAGS"><envar>$CXXFLAGS</envar></link>. +you must set or override the value of <link linkend="cv-CXXFLAGS"><envar>$CXXFLAGS</envar></link>. +See also <link linkend="cv-SHCXXFLAGS"><envar>$SHCXXFLAGS</envar></link> for compiling to shared objects.. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXVERSION"> - <term>CXXVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>CXXVERSION</envar> + </term> + <listitem><para> The version number of the C++ compiler. This may or may not be set, depending on the specific C++ compiler being used. @@ -871,51 +932,71 @@ depending on the specific C++ compiler being used. </listitem> </varlistentry> <varlistentry id="cv-DC"> - <term>DC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DC</envar> + </term> + <listitem><para> The D compiler to use. +See also <link linkend="cv-SHDC"><envar>$SHDC</envar></link> for compiling to shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-DCOM"> - <term>DCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DCOM</envar> + </term> + <listitem><para> The command line used to compile a D file to an object file. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable +Any options specified in the <link linkend="cv-DFLAGS"><envar>$DFLAGS</envar></link> construction variable is included on this command line. +See also <link linkend="cv-SHDCOM"><envar>$SHDCOM</envar></link> for compiling to shared objects. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-DCOMSTR"> + <term> + <envar>DCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a D source file +is compiled to a (static) object file. +If not set, then <link linkend="cv-DCOM"><envar>$DCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-SHDCOMSTR"><envar>$SHDCOMSTR</envar></link> for compiling to shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUG"> - <term>DDEBUG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DDEBUG</envar> + </term> + <listitem><para> List of debug tags to enable when compiling. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUGPREFIX"> - <term>DDEBUGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DDEBUGPREFIX</envar> + </term> + <listitem><para> DDEBUGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUGSUFFIX"> - <term>DDEBUGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DDEBUGSUFFIX</envar> + </term> + <listitem><para> DDEBUGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DESCRIPTION"> - <term>DESCRIPTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DESCRIPTION</envar> + </term> + <listitem><para> A long description of the project being packaged. This is included in the relevant section of the file that controls the packaging build. @@ -923,9 +1004,10 @@ of the file that controls the packaging build. </listitem> </varlistentry> <varlistentry id="cv-DESCRIPTION_lang"> - <term>DESCRIPTION_lang</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DESCRIPTION_lang</envar> + </term> + <listitem><para> A language-specific long description for the specified <varname>lang</varname>. This is used to populate a @@ -936,292 +1018,324 @@ section of an RPM </listitem> </varlistentry> <varlistentry id="cv-DFILESUFFIX"> - <term>DFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DFILESUFFIX</envar> + </term> + <listitem><para> DFILESUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DFLAGPREFIX"> - <term>DFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DFLAGPREFIX</envar> + </term> + <listitem><para> DFLAGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DFLAGS"> - <term>DFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DFLAGS</envar> + </term> + <listitem><para> General options that are passed to the D compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-DFLAGSUFFIX"> - <term>DFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DFLAGSUFFIX</envar> + </term> + <listitem><para> DFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DINCPREFIX"> - <term>DINCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DINCPREFIX</envar> + </term> + <listitem><para> DINCPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DINCSUFFIX"> - <term>DINCSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DINCSUFFIX</envar> + </term> + <listitem><para> DLIBFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-Dir"> - <term>Dir</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A function that converts a string -into a Dir instance relative to the target being built. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>Dir</envar> + </term> + <listitem><para> A function that converts a string into a Dir instance relative to the target being built. </para> </listitem> </varlistentry> <varlistentry id="cv-Dirs"> - <term>Dirs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>Dirs</envar> + </term> + <listitem><para> A function that converts a list of strings into a list of Dir instances relative to the target being built. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIB"> - <term>DLIB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIB</envar> + </term> + <listitem><para> Name of the lib tool to use for D codes. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBCOM"> - <term>DLIBCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBCOM</envar> + </term> + <listitem><para> The command line to use when creating libraries. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBDIRPREFIX"> - <term>DLIBDIRPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBDIRPREFIX</envar> + </term> + <listitem><para> DLIBLINKPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBDIRSUFFIX"> - <term>DLIBDIRSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBDIRSUFFIX</envar> + </term> + <listitem><para> DLIBLINKSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGPREFIX"> - <term>DLIBFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBFLAGPREFIX</envar> + </term> + <listitem><para> DLIBFLAGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGSUFFIX"> - <term>DLIBFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBFLAGSUFFIX</envar> + </term> + <listitem><para> DLIBFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBLINKPREFIX"> - <term>DLIBLINKPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBLINKPREFIX</envar> + </term> + <listitem><para> DLIBLINKPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBLINKSUFFIX"> - <term>DLIBLINKSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLIBLINKSUFFIX</envar> + </term> + <listitem><para> DLIBLINKSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINK"> - <term>DLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLINK</envar> + </term> + <listitem><para> Name of the linker to use for linking systems including D sources. +See also <link linkend="cv-SHDLINK"><envar>$SHDLINK</envar></link> for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKCOM"> - <term>DLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLINKCOM</envar> + </term> + <listitem><para> The command line to use when linking systems including D sources. +See also <link linkend="cv-SHDLINKCOM"><envar>$SHDLINKCOM</envar></link> for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGPREFIX"> - <term>DLINKFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLINKFLAGPREFIX</envar> + </term> + <listitem><para> DLINKFLAGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGS"> - <term>DLINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLINKFLAGS</envar> + </term> + <listitem><para> List of linker flags. +See also <link linkend="cv-SHDLINKFLAGS"><envar>$SHDLINKFLAGS</envar></link> for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGSUFFIX"> - <term>DLINKFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DLINKFLAGSUFFIX</envar> + </term> + <listitem><para> DLINKFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_EPUB"> - <term>DOCBOOK_DEFAULT_XSL_EPUB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookEpub"><function>DocbookEpub</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_EPUB</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookEpub"><function>DocbookEpub</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTML"> - <term>DOCBOOK_DEFAULT_XSL_HTML</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtml"><function>DocbookHtml</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_HTML</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookHtml"><function>DocbookHtml</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED"> - <term>DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_HTMLCHUNKED</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookHtmlChunked"><function>DocbookHtmlChunked</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_HTMLHELP"> - <term>DOCBOOK_DEFAULT_XSL_HTMLHELP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_HTMLHELP</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookHtmlhelp"><function>DocbookHtmlhelp</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_MAN"> - <term>DOCBOOK_DEFAULT_XSL_MAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookMan"><function>DocbookMan</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_MAN</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookMan"><function>DocbookMan</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_PDF"> - <term>DOCBOOK_DEFAULT_XSL_PDF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookPdf"><function>DocbookPdf</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_PDF</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookPdf"><function>DocbookPdf</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_SLIDESHTML"> - <term>DOCBOOK_DEFAULT_XSL_SLIDESHTML</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_SLIDESHTML</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookSlidesHtml"><function>DocbookSlidesHtml</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_DEFAULT_XSL_SLIDESPDF"> - <term>DOCBOOK_DEFAULT_XSL_SLIDESPDF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The default XSLT file for the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> builder within the + <term> + <envar>DOCBOOK_DEFAULT_XSL_SLIDESPDF</envar> + </term> + <listitem><para> +The default XSLT file for the <link linkend="b-DocbookSlidesPdf"><function>DocbookSlidesPdf</function></link> builder within the current environment, if no other XSLT gets specified via keyword. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_FOP"> - <term>DOCBOOK_FOP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_FOP</envar> + </term> + <listitem><para> The path to the PDF renderer <literal>fop</literal> or <literal>xep</literal>, if one of them is installed (<literal>fop</literal> gets checked first). </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_FOPCOM"> - <term>DOCBOOK_FOPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_FOPCOM</envar> + </term> + <listitem><para> The full command-line for the PDF renderer <literal>fop</literal> or <literal>xep</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_FOPCOMSTR"> - <term>DOCBOOK_FOPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_FOPCOMSTR</envar> + </term> + <listitem><para> The string displayed when a renderer like <literal>fop</literal> or <literal>xep</literal> is used to create PDF output from an XML file. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_FOPFLAGS"> - <term>DOCBOOK_FOPFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_FOPFLAGS</envar> + </term> + <listitem><para> Additonal command-line flags for the PDF renderer <literal>fop</literal> or <literal>xep</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINT"> - <term>DOCBOOK_XMLLINT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XMLLINT</envar> + </term> + <listitem><para> The path to the external executable <literal>xmllint</literal>, if it's installed. Note, that this is only used as last fallback for resolving XIncludes, if no libxml2 or lxml Python binding can be imported @@ -1230,36 +1344,40 @@ in the current system. </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTCOM"> - <term>DOCBOOK_XMLLINTCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XMLLINTCOM</envar> + </term> + <listitem><para> The full command-line for the external executable <literal>xmllint</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTCOMSTR"> - <term>DOCBOOK_XMLLINTCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XMLLINTCOMSTR</envar> + </term> + <listitem><para> The string displayed when <literal>xmllint</literal> is used to resolve XIncludes for a given XML file. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTFLAGS"> - <term>DOCBOOK_XMLLINTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XMLLINTFLAGS</envar> + </term> + <listitem><para> Additonal command-line flags for the external executable <literal>xmllint</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROC"> - <term>DOCBOOK_XSLTPROC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XSLTPROC</envar> + </term> + <listitem><para> The path to the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>), if one of them is installed. @@ -1269,9 +1387,10 @@ no libxml2 or lxml Python binding can be imported in the current system. </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCCOM"> - <term>DOCBOOK_XSLTPROCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XSLTPROCCOM</envar> + </term> + <listitem><para> The full command-line for the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). @@ -1279,18 +1398,20 @@ The full command-line for the external executable </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCCOMSTR"> - <term>DOCBOOK_XSLTPROCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XSLTPROCCOMSTR</envar> + </term> + <listitem><para> The string displayed when <literal>xsltproc</literal> is used to transform an XML file via a given XSLT stylesheet. </para> </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCFLAGS"> - <term>DOCBOOK_XSLTPROCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XSLTPROCFLAGS</envar> + </term> + <listitem><para> Additonal command-line flags for the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). @@ -1298,9 +1419,10 @@ Additonal command-line flags for the external executable </listitem> </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCPARAMS"> - <term>DOCBOOK_XSLTPROCPARAMS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DOCBOOK_XSLTPROCPARAMS</envar> + </term> + <listitem><para> Additonal parameters that are not intended for the XSLT processor executable, but the XSL processing itself. By default, they get appended at the end of the command line for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. @@ -1308,150 +1430,161 @@ for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. </listitem> </varlistentry> <varlistentry id="cv-DPATH"> - <term>DPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DPATH</envar> + </term> + <listitem><para> List of paths to search for import modules. </para> </listitem> </varlistentry> <varlistentry id="cv-DRPATHPREFIX"> - <term>DRPATHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DRPATHPREFIX</envar> + </term> + <listitem><para> DRPATHPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DRPATHSUFFIX"> - <term>DRPATHSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DRPATHSUFFIX</envar> + </term> + <listitem><para> DRPATHSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DShLibSonameGenerator"> - <term>DShLibSonameGenerator</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DShLibSonameGenerator</envar> + </term> + <listitem><para> DShLibSonameGenerator. </para> </listitem> </varlistentry> <varlistentry id="cv-DSUFFIXES"> - <term>DSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DSUFFIXES</envar> + </term> + <listitem><para> The list of suffixes of files that will be scanned for imported D package files. -The default list is: +The default list is <literal>['.d']</literal>. </para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -['.d'] -</example_commands> </listitem> </varlistentry> <varlistentry id="cv-DVERPREFIX"> - <term>DVERPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVERPREFIX</envar> + </term> + <listitem><para> DVERPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERSIONS"> - <term>DVERSIONS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVERSIONS</envar> + </term> + <listitem><para> List of version tags to enable when compiling. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERSUFFIX"> - <term>DVERSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVERSUFFIX</envar> + </term> + <listitem><para> DVERSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPDF"> - <term>DVIPDF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPDF</envar> + </term> + <listitem><para> The TeX DVI file to PDF file converter. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPDFCOM"> - <term>DVIPDFCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPDFCOM</envar> + </term> + <listitem><para> The command line used to convert TeX DVI files into a PDF file. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPDFCOMSTR"> - <term>DVIPDFCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPDFCOMSTR</envar> + </term> + <listitem><para> The string displayed when a TeX DVI file is converted into a PDF file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DVIPDFCOM"><envar>$DVIPDFCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-DVIPDFCOM"><envar>$DVIPDFCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPDFFLAGS"> - <term>DVIPDFFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPDFFLAGS</envar> + </term> + <listitem><para> General options passed to the TeX DVI file to PDF file converter. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPS"> - <term>DVIPS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPS</envar> + </term> + <listitem><para> The TeX DVI file to PostScript converter. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPSFLAGS"> - <term>DVIPSFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>DVIPSFLAGS</envar> + </term> + <listitem><para> General options passed to the TeX DVI file to PostScript converter. </para> </listitem> </varlistentry> <varlistentry id="cv-ENV"> - <term>ENV</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ENV</envar> + </term> + <listitem><para> A dictionary of environment variables to use when invoking commands. When -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$ENV</envar> is used in a command all list +<envar>$ENV</envar> is used in a command all list values will be joined using the path separator and any other non-string values will simply be coerced to a string. Note that, by default, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> does <emphasis>not</emphasis> propagate the environment in force when you execute -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to the commands used to build target files. This is so that builds will be guaranteed repeatable regardless of the environment variables set at the time -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> is invoked. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If you want to propagate your environment variables to the commands executed @@ -1459,12 +1592,12 @@ to build target files, you must do so explicitly: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import os env = Environment(ENV = os.environ) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that you can choose only to propagate certain environment variables. A common example is @@ -1472,21 +1605,22 @@ the system <envar>PATH</envar> environment variable, so that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> uses the same utilities as the invoking shell (or other process): </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import os env = Environment(ENV = {'PATH' : os.environ['PATH']}) </example_commands> </listitem> </varlistentry> <varlistentry id="cv-ESCAPE"> - <term>ESCAPE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ESCAPE</envar> + </term> + <listitem><para> A function that will be called to escape shell special characters in command lines. The function should take one argument: the command line string to escape; and should return the escaped command line. @@ -1494,69 +1628,74 @@ string to escape; and should return the escaped command line. </listitem> </varlistentry> <varlistentry id="cv-F03"> - <term>F03</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03</envar> + </term> + <listitem><para> The Fortran 03 compiler. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03"><envar>$F03</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-F03"><envar>$F03</envar></link> if you need to use a specific compiler or compiler version for Fortran 03 files. </para> </listitem> </varlistentry> <varlistentry id="cv-F03COM"> - <term>F03COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 03 source file to an object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03COM"><envar>$F03COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F03COM"><envar>$F03COM</envar></link> if you need to use a specific command line for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F03COMSTR"> - <term>F03COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 03 source file + <term> + <envar>F03COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 03 source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03COM"><envar>$F03COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-F03COM"><envar>$F03COM</envar></link> or <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F03FILESUFFIXES"> - <term>F03FILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03FILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the F03 dialect will be used. By default, this is ['.f03'] </para> </listitem> </varlistentry> <varlistentry id="cv-F03FLAGS"> - <term>F03FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03FLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran 03 compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. +that scons generates automatically from <link linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> +<link linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> below, for the variable that expands to those options. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> if you need to define specific user options for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1564,177 +1703,187 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-_F03INCFLAGS"> - <term>_F03INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_F03INCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran 03 compiler command-line options for specifying directories to be searched for include files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> is created -by appending <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +The value of <link linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> is created +by appending <link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. +of each directory in <link linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-F03PATH"> - <term>F03PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03PATH</envar> + </term> + <listitem><para> The list of directories that the Fortran 03 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> because the result will be non-portable +arguments in <link linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PATH"><envar>$F03PATH</envar></link> will be looked-up relative to the SConscript +directory names in <link linkend="cv-F03PATH"><envar>$F03PATH</envar></link> will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PATH"><envar>$F03PATH</envar></link> if you need to define a specific +You only need to set <link linkend="cv-F03PATH"><envar>$F03PATH</envar></link> if you need to define a specific include path for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, which specifies the include path for the default Fortran compiler for all Fortran versions. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F03PATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(F03PATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> +<link linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link> construction variable, which is constructed by appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. +of each directory in <link linkend="cv-F03PATH"><envar>$F03PATH</envar></link>. Any command lines you define that need the F03PATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link>: +include <link linkend="cv-_F03INCFLAGS"><envar>$_F03INCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-F03PPCOM"> - <term>F03PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 03 source file to an object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-F03FLAGS"><envar>$F03FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PPCOM"><envar>$F03PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F03PPCOM"><envar>$F03PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F03PPCOMSTR"> - <term>F03PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 03 source file + <term> + <envar>F03PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 03 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F03PPCOM"><envar>$F03PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-F03PPCOM"><envar>$F03PPCOM</envar></link> or <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F03PPFILESUFFIXES"> - <term>F03PPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F03PPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for F03 dialect will be used. By default, this is empty </para> </listitem> </varlistentry> <varlistentry id="cv-F08"> - <term>F08</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08</envar> + </term> + <listitem><para> The Fortran 08 compiler. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08"><envar>$F08</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-F08"><envar>$F08</envar></link> if you need to use a specific compiler or compiler version for Fortran 08 files. </para> </listitem> </varlistentry> <varlistentry id="cv-F08COM"> - <term>F08COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 08 source file to an object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08COM"><envar>$F08COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F08COM"><envar>$F08COM</envar></link> if you need to use a specific command line for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F08COMSTR"> - <term>F08COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 08 source file + <term> + <envar>F08COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 08 source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08COM"><envar>$F08COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-F08COM"><envar>$F08COM</envar></link> or <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F08FILESUFFIXES"> - <term>F08FILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08FILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the F08 dialect will be used. By default, this is ['.f08'] </para> </listitem> </varlistentry> <varlistentry id="cv-F08FLAGS"> - <term>F08FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08FLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran 08 compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. +that scons generates automatically from <link linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> +<link linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> below, for the variable that expands to those options. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> if you need to define specific user options for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1742,177 +1891,187 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-_F08INCFLAGS"> - <term>_F08INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_F08INCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran 08 compiler command-line options for specifying directories to be searched for include files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> is created -by appending <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +The value of <link linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> is created +by appending <link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. +of each directory in <link linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-F08PATH"> - <term>F08PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08PATH</envar> + </term> + <listitem><para> The list of directories that the Fortran 08 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> because the result will be non-portable +arguments in <link linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PATH"><envar>$F08PATH</envar></link> will be looked-up relative to the SConscript +directory names in <link linkend="cv-F08PATH"><envar>$F08PATH</envar></link> will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PATH"><envar>$F08PATH</envar></link> if you need to define a specific +You only need to set <link linkend="cv-F08PATH"><envar>$F08PATH</envar></link> if you need to define a specific include path for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, which specifies the include path for the default Fortran compiler for all Fortran versions. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F08PATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(F08PATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> +<link linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link> construction variable, which is constructed by appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. +of each directory in <link linkend="cv-F08PATH"><envar>$F08PATH</envar></link>. Any command lines you define that need the F08PATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link>: +include <link linkend="cv-_F08INCFLAGS"><envar>$_F08INCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F08COM="my_compiler $_F08INCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-F08PPCOM"> - <term>F08PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 08 source file to an object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-F08FLAGS"><envar>$F08FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PPCOM"><envar>$F08PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F08PPCOM"><envar>$F08PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F08PPCOMSTR"> - <term>F08PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 08 source file + <term> + <envar>F08PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 08 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F08PPCOM"><envar>$F08PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-F08PPCOM"><envar>$F08PPCOM</envar></link> or <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F08PPFILESUFFIXES"> - <term>F08PPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F08PPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for F08 dialect will be used. By default, this is empty </para> </listitem> </varlistentry> <varlistentry id="cv-F77"> - <term>F77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77</envar> + </term> + <listitem><para> The Fortran 77 compiler. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77"><envar>$F77</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-F77"><envar>$F77</envar></link> if you need to use a specific compiler or compiler version for Fortran 77 files. </para> </listitem> </varlistentry> <varlistentry id="cv-F77COM"> - <term>F77COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 77 source file to an object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77COM"><envar>$F77COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F77COM"><envar>$F77COM</envar></link> if you need to use a specific command line for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F77COMSTR"> - <term>F77COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 77 source file + <term> + <envar>F77COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 77 source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77COM"><envar>$F77COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-F77COM"><envar>$F77COM</envar></link> or <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F77FILESUFFIXES"> - <term>F77FILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77FILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the F77 dialect will be used. By default, this is ['.f77'] </para> </listitem> </varlistentry> <varlistentry id="cv-F77FLAGS"> - <term>F77FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77FLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran 77 compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. +that scons generates automatically from <link linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> +<link linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> below, for the variable that expands to those options. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> if you need to define specific user options for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1920,177 +2079,187 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-_F77INCFLAGS"> - <term>_F77INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_F77INCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran 77 compiler command-line options for specifying directories to be searched for include files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> is created -by appending <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +The value of <link linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> is created +by appending <link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. +of each directory in <link linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-F77PATH"> - <term>F77PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77PATH</envar> + </term> + <listitem><para> The list of directories that the Fortran 77 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> because the result will be non-portable +arguments in <link linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PATH"><envar>$F77PATH</envar></link> will be looked-up relative to the SConscript +directory names in <link linkend="cv-F77PATH"><envar>$F77PATH</envar></link> will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PATH"><envar>$F77PATH</envar></link> if you need to define a specific +You only need to set <link linkend="cv-F77PATH"><envar>$F77PATH</envar></link> if you need to define a specific include path for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, which specifies the include path for the default Fortran compiler for all Fortran versions. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F77PATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(F77PATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> +<link linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link> construction variable, which is constructed by appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. +of each directory in <link linkend="cv-F77PATH"><envar>$F77PATH</envar></link>. Any command lines you define that need the F77PATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link>: +include <link linkend="cv-_F77INCFLAGS"><envar>$_F77INCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-F77PPCOM"> - <term>F77PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 77 source file to an object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-F77FLAGS"><envar>$F77FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F77PPCOMSTR"> - <term>F77PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 77 source file + <term> + <envar>F77PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 77 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-F77PPCOM"><envar>$F77PPCOM</envar></link> or <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F77PPFILESUFFIXES"> - <term>F77PPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F77PPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for F77 dialect will be used. By default, this is empty </para> </listitem> </varlistentry> <varlistentry id="cv-F90"> - <term>F90</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90</envar> + </term> + <listitem><para> The Fortran 90 compiler. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90"><envar>$F90</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-F90"><envar>$F90</envar></link> if you need to use a specific compiler or compiler version for Fortran 90 files. </para> </listitem> </varlistentry> <varlistentry id="cv-F90COM"> - <term>F90COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 90 source file to an object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90COM"><envar>$F90COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F90COM"><envar>$F90COM</envar></link> if you need to use a specific command line for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F90COMSTR"> - <term>F90COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 90 source file + <term> + <envar>F90COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 90 source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90COM"><envar>$F90COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-F90COM"><envar>$F90COM</envar></link> or <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F90FILESUFFIXES"> - <term>F90FILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90FILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the F90 dialect will be used. By default, this is ['.f90'] </para> </listitem> </varlistentry> <varlistentry id="cv-F90FLAGS"> - <term>F90FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90FLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran 90 compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. +that scons generates automatically from <link linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> +<link linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> below, for the variable that expands to those options. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> if you need to define specific user options for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2098,176 +2267,186 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-_F90INCFLAGS"> - <term>_F90INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_F90INCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran 90 compiler command-line options for specifying directories to be searched for include files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> is created -by appending <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +The value of <link linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> is created +by appending <link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. +of each directory in <link linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-F90PATH"> - <term>F90PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90PATH</envar> + </term> + <listitem><para> The list of directories that the Fortran 90 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> because the result will be non-portable +arguments in <link linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PATH"><envar>$F90PATH</envar></link> will be looked-up relative to the SConscript +directory names in <link linkend="cv-F90PATH"><envar>$F90PATH</envar></link> will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PATH"><envar>$F90PATH</envar></link> if you need to define a specific +You only need to set <link linkend="cv-F90PATH"><envar>$F90PATH</envar></link> if you need to define a specific include path for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, which specifies the include path for the default Fortran compiler for all Fortran versions. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F90PATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(F90PATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> +<link linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link> construction variable, which is constructed by appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. +of each directory in <link linkend="cv-F90PATH"><envar>$F90PATH</envar></link>. Any command lines you define that need the F90PATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link>: +include <link linkend="cv-_F90INCFLAGS"><envar>$_F90INCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F90COM="my_compiler $_F90INCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-F90PPCOM"> - <term>F90PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 90 source file to an object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-F90FLAGS"><envar>$F90FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PPCOM"><envar>$F90PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F90PPCOM"><envar>$F90PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F90PPCOMSTR"> - <term>F90PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 90 source file + <term> + <envar>F90PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 90 source file is compiled after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F90PPCOM"><envar>$F90PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-F90PPCOM"><envar>$F90PPCOM</envar></link> or <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F90PPFILESUFFIXES"> - <term>F90PPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F90PPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for F90 dialect will be used. By default, this is empty </para> </listitem> </varlistentry> <varlistentry id="cv-F95"> - <term>F95</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95</envar> + </term> + <listitem><para> The Fortran 95 compiler. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-FORTRAN"><envar>$FORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95"><envar>$F95</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-F95"><envar>$F95</envar></link> if you need to use a specific compiler or compiler version for Fortran 95 files. </para> </listitem> </varlistentry> <varlistentry id="cv-F95COM"> - <term>F95COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 95 source file to an object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95COM"><envar>$F95COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F95COM"><envar>$F95COM</envar></link> if you need to use a specific command line for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F95COMSTR"> - <term>F95COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 95 source file + <term> + <envar>F95COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 95 source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95COM"><envar>$F95COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-F95COM"><envar>$F95COM</envar></link> or <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F95FILESUFFIXES"> - <term>F95FILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95FILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the F95 dialect will be used. By default, this is ['.f95'] </para> </listitem> </varlistentry> <varlistentry id="cv-F95FLAGS"> - <term>F95FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95FLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran 95 compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. +that scons generates automatically from <link linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> +<link linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> below, for the variable that expands to those options. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> if you need to define specific user options for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2275,209 +2454,217 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-_F95INCFLAGS"> - <term>_F95INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_F95INCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran 95 compiler command-line options for specifying directories to be searched for include files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> is created -by appending <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +The value of <link linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> is created +by appending <link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. +of each directory in <link linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-F95PATH"> - <term>F95PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95PATH</envar> + </term> + <listitem><para> The list of directories that the Fortran 95 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> because the result will be non-portable +arguments in <link linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PATH"><envar>$F95PATH</envar></link> will be looked-up relative to the SConscript +directory names in <link linkend="cv-F95PATH"><envar>$F95PATH</envar></link> will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PATH"><envar>$F95PATH</envar></link> if you need to define a specific +You only need to set <link linkend="cv-F95PATH"><envar>$F95PATH</envar></link> if you need to define a specific include path for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link> variable, which specifies the include path for the default Fortran compiler for all Fortran versions. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F95PATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(F95PATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> +<link linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link> construction variable, which is constructed by appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. +of each directory in <link linkend="cv-F95PATH"><envar>$F95PATH</envar></link>. Any command lines you define that need the F95PATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link>: +include <link linkend="cv-_F95INCFLAGS"><envar>$_F95INCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-F95PPCOM"> - <term>F95PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 95 source file to an object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-F95FLAGS"><envar>$F95FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PPCOM"><envar>$F95PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-F95PPCOM"><envar>$F95PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-F95PPCOMSTR"> - <term>F95PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 95 source file + <term> + <envar>F95PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 95 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-F95PPCOM"><envar>$F95PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-F95PPCOM"><envar>$F95PPCOM</envar></link> or <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-F95PPFILESUFFIXES"> - <term>F95PPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>F95PPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for F95 dialect will be used. By default, this is empty </para> </listitem> </varlistentry> <varlistentry id="cv-File"> - <term>File</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A function that converts a string into a File instance relative to the -target being built. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>File</envar> + </term> + <listitem><para> A function that converts a string into a File instance relative to the target being built. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRAN"> - <term>FORTRAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRAN</envar> + </term> + <listitem><para> The default Fortran compiler for all versions of Fortran. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANCOM"> - <term>FORTRANCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran source file to an object file. By default, any options specified -in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_CPPDEFFLAGS"><envar>$_CPPDEFFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> construction variables +in the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link>, +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link>, +<link linkend="cv-_CPPDEFFLAGS"><envar>$_CPPDEFFLAGS</envar></link>, +<link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, and +<link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> construction variables are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANCOMSTR"> - <term>FORTRANCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran source file + <term> + <envar>FORTRANCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran source file is compiled to an object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> +If not set, then <link linkend="cv-FORTRANCOM"><envar>$FORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANFILESUFFIXES"> - <term>FORTRANFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the FORTRAN dialect will be used. By default, this is ['.f', '.for', '.ftn'] </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANFLAGS"> - <term>FORTRANFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANFLAGS</envar> + </term> + <listitem><para> General user-specified options that are passed to the Fortran compiler. Note that this variable does <emphasis>not</emphasis> contain <option>-I</option> (or similar) include or module search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. +that scons generates automatically from <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, +<link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> and <link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, below, for the variables that expand those options. </para> </listitem> </varlistentry> <varlistentry id="cv-_FORTRANINCFLAGS"> - <term>_FORTRANINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_FORTRANINCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran compiler command-line options for specifying directories to be searched for include files and module files. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> is created +The value of <link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> is created by respectively prepending and appending -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. +of each directory in <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANMODDIR"> - <term>FORTRANMODDIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANMODDIR</envar> + </term> + <listitem><para> Directory location where the Fortran compiler should place any module files it generates. This variable is empty, by default. Some Fortran compilers will internally append this directory in the search path @@ -2486,49 +2673,53 @@ for module files, as well. </listitem> </varlistentry> <varlistentry id="cv-FORTRANMODDIRPREFIX"> - <term>FORTRANMODDIRPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANMODDIRPREFIX</envar> + </term> + <listitem><para> The prefix used to specify a module directory on the Fortran compiler command line. This will be prepended to the beginning of the directory -in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link> construction variables -when the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> variables is automatically generated. +in the <link linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link> construction variables +when the <link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> variables is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANMODDIRSUFFIX"> - <term>FORTRANMODDIRSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANMODDIRSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify a module directory on the Fortran compiler command line. This will be appended to the end of the directory -in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link> construction variables -when the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> variables is automatically generated. +in the <link linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link> construction variables +when the <link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> variables is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-_FORTRANMODFLAG"> - <term>_FORTRANMODFLAG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_FORTRANMODFLAG</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the Fortran compiler command-line option for specifying the directory location where the Fortran compiler should place any module files that happen to get generated during compilation. -The value of <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> is created +The value of <link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> is created by respectively prepending and appending -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANMODDIRPREFIX"><envar>$FORTRANMODDIRPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANMODDIRSUFFIX"><envar>$FORTRANMODDIRSUFFIX</envar></link> -to the beginning and end of the directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link>. +<link linkend="cv-FORTRANMODDIRPREFIX"><envar>$FORTRANMODDIRPREFIX</envar></link> and <link linkend="cv-FORTRANMODDIRSUFFIX"><envar>$FORTRANMODDIRSUFFIX</envar></link> +to the beginning and end of the directory in <link linkend="cv-FORTRANMODDIR"><envar>$FORTRANMODDIR</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANMODPREFIX"> - <term>FORTRANMODPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANMODPREFIX</envar> + </term> + <listitem><para> The module file prefix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of @@ -2541,9 +2732,10 @@ module file name as scons attempts to resolve dependencies. </listitem> </varlistentry> <varlistentry id="cv-FORTRANMODSUFFIX"> - <term>FORTRANMODSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANMODSUFFIX</envar> + </term> + <listitem><para> The module file suffix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of @@ -2556,9 +2748,10 @@ module file name as scons attempts to resolve dependencies. </listitem> </varlistentry> <varlistentry id="cv-FORTRANPATH"> - <term>FORTRANPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANPATH</envar> + </term> + <listitem><para> The list of directories that the Fortran compiler will search for include files and (for some compilers) module files. The Fortran implicit dependency scanner will search these directories for include files (but @@ -2568,234 +2761,249 @@ include directory arguments in FORTRANFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in FORTRANPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(FORTRANPATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(FORTRANPATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> +<link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> construction variable, which is constructed by respectively prepending and appending the values of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> +<link linkend="cv-INCPREFIX"><envar>$INCPREFIX</envar></link> and <link linkend="cv-INCSUFFIX"><envar>$INCSUFFIX</envar></link> construction variables to the beginning and end -of each directory in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. +of each directory in <link linkend="cv-FORTRANPATH"><envar>$FORTRANPATH</envar></link>. Any command lines you define that need the FORTRANPATH directory list should -include <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link>: +include <link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-FORTRANPPCOM"> - <term>FORTRANPPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANPPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran source file to an object file after first running the file through the C preprocessor. -By default, any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_CPPDEFFLAGS"><envar>$_CPPDEFFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> +By default, any options specified in the <link linkend="cv-FORTRANFLAGS"><envar>$FORTRANFLAGS</envar></link>, +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link>, +<link linkend="cv-_CPPDEFFLAGS"><envar>$_CPPDEFFLAGS</envar></link>, +<link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link>, and +<link linkend="cv-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> construction variables are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANPPCOMSTR"> - <term>FORTRANPPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran source file + <term> + <envar>FORTRANPPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-FORTRANPPCOM"><envar>$FORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANPPFILESUFFIXES"> - <term>FORTRANPPFILESUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANPPFILESUFFIXES</envar> + </term> + <listitem><para> The list of file extensions for which the compilation + preprocessor pass for FORTRAN dialect will be used. By default, this is ['.fpp', '.FPP'] </para> </listitem> </varlistentry> <varlistentry id="cv-FORTRANSUFFIXES"> - <term>FORTRANSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FORTRANSUFFIXES</envar> + </term> + <listitem><para> The list of suffixes of files that will be scanned for Fortran implicit dependencies (INCLUDE lines and USE statements). The default list is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> [".f", ".F", ".for", ".FOR", ".ftn", ".FTN", ".fpp", ".FPP", ".f77", ".F77", ".f90", ".F90", ".f95", ".F95"] </example_commands> </listitem> </varlistentry> <varlistentry id="cv-FRAMEWORKPATH"> - <term>FRAMEWORKPATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FRAMEWORKPATH</envar> + </term> + <listitem><para> On Mac OS X with gcc, a list containing the paths to search for frameworks. Used by the compiler to find framework-style includes like #include <Fmwk/Header.h>. Used by the linker to find user-specified frameworks when linking (see - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link>). + <link linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link>). For example: </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') + <example_commands> +env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> will add </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - ... -Fmyframeworkdir + <example_commands> +... -Fmyframeworkdir </example_commands> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> to the compiler and linker command lines. </para> </listitem> </varlistentry> <varlistentry id="cv-_FRAMEWORKPATH"> - <term>_FRAMEWORKPATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_FRAMEWORKPATH</envar> + </term> + <listitem><para> On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options corresponding to - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>. + <link linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-FRAMEWORKPATHPREFIX"> - <term>FRAMEWORKPATHPREFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FRAMEWORKPATHPREFIX</envar> + </term> + <listitem><para> On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries. - (see <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>). + (see <link linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>). The default value is <option>-F</option>. </para> </listitem> </varlistentry> <varlistentry id="cv-FRAMEWORKPREFIX"> - <term>FRAMEWORKPREFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FRAMEWORKPREFIX</envar> + </term> + <listitem><para> On Mac OS X with gcc, the prefix to be used for linking in frameworks - (see <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link>). + (see <link linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link>). The default value is <option>-framework</option>. </para> </listitem> </varlistentry> - <varlistentry id="cv-_FRAMEWORKS"> - <term>_FRAMEWORKS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - On Mac OS X with gcc, - an automatically-generated construction variable - containing the linker command-line options - for linking with FRAMEWORKS. - </para> - </listitem> - </varlistentry> <varlistentry id="cv-FRAMEWORKS"> - <term>FRAMEWORKS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FRAMEWORKS</envar> + </term> + <listitem><para> On Mac OS X with gcc, a list of the framework names to be linked into a program or shared library or bundle. The default value is the empty list. For example: </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) + <example_commands> +env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) </example_commands> </listitem> </varlistentry> + <varlistentry id="cv-_FRAMEWORKS"> + <term> + <envar>_FRAMEWORKS</envar> + </term> + <listitem><para> + On Mac OS X with gcc, + an automatically-generated construction variable + containing the linker command-line options + for linking with FRAMEWORKS. + </para> + </listitem> + </varlistentry> <varlistentry id="cv-FRAMEWORKSFLAGS"> - <term>FRAMEWORKSFLAGS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>FRAMEWORKSFLAGS</envar> + </term> + <listitem><para> On Mac OS X with gcc, general user-supplied frameworks options to be added at the end of a command line building a loadable module. (This has been largely superseded by - the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKPATHPREFIX"><envar>$FRAMEWORKPATHPREFIX</envar></link>, - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKPREFIX"><envar>$FRAMEWORKPREFIX</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link> variables + the <link linkend="cv-FRAMEWORKPATH"><envar>$FRAMEWORKPATH</envar></link>, <link linkend="cv-FRAMEWORKPATHPREFIX"><envar>$FRAMEWORKPATHPREFIX</envar></link>, + <link linkend="cv-FRAMEWORKPREFIX"><envar>$FRAMEWORKPREFIX</envar></link> and <link linkend="cv-FRAMEWORKS"><envar>$FRAMEWORKS</envar></link> variables described above.) </para> </listitem> </varlistentry> <varlistentry id="cv-GS"> - <term>GS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>GS</envar> + </term> + <listitem><para> The Ghostscript program used, e.g. to convert PostScript to PDF files. </para> </listitem> </varlistentry> <varlistentry id="cv-GSCOM"> - <term>GSCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>GSCOM</envar> + </term> + <listitem><para> The full Ghostscript command line used for the conversion process. Its default value is <quote><literal>$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES</literal></quote>. </para> </listitem> </varlistentry> <varlistentry id="cv-GSCOMSTR"> - <term>GSCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>GSCOMSTR</envar> + </term> + <listitem><para> The string displayed when Ghostscript is called for the conversion process. -If this is not set (the default), then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-GSCOM"><envar>$GSCOM</envar></link> (the command line) is displayed. +If this is not set (the default), then <link linkend="cv-GSCOM"><envar>$GSCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-GSFLAGS"> - <term>GSFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>GSFLAGS</envar> + </term> + <listitem><para> General options passed to the Ghostscript program, when converting PostScript to PDF files for example. Its default value is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> @@ -2803,9 +3011,10 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> </listitem> </varlistentry> <varlistentry id="cv-HOST_ARCH"> - <term>HOST_ARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>HOST_ARCH</envar> + </term> + <listitem><para> The name of the host hardware architecture used to create the Environment. If a platform is specified when creating the Environment, then that Platform's logic will handle setting this value. @@ -2813,8 +3022,7 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> the Environment is initialized. Currently only set for Win32. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Sets the host architecture for Visual Studio compiler. If not set, default to the detected host architecture: note that this may depend on the python you are using. @@ -2822,20 +3030,21 @@ This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Valid values are the same as for <envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET_ARCH</envar>. +<para> +Valid values are the same as for <envar>$TARGET_ARCH</envar>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This is currently only used on Windows, but in the future it will be used on other OSes as well. </para> </listitem> </varlistentry> <varlistentry id="cv-HOST_OS"> - <term>HOST_OS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>HOST_OS</envar> + </term> + <listitem><para> The name of the host operating system used to create the Environment. If a platform is specified when creating the Environment, then that Platform's logic will handle setting this value. @@ -2846,137 +3055,203 @@ used on other OSes as well. </listitem> </varlistentry> <varlistentry id="cv-IDLSUFFIXES"> - <term>IDLSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>IDLSUFFIXES</envar> + </term> + <listitem><para> The list of suffixes of files that will be scanned for IDL implicit dependencies (#include or import lines). The default list is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> [".idl", ".IDL"] </example_commands> </listitem> </varlistentry> <varlistentry id="cv-IMPLIBNOVERSIONSYMLINKS"> - <term>IMPLIBNOVERSIONSYMLINKS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Used to override <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBNOVERSIONSYMLINKS"><envar>$SHLIBNOVERSIONSYMLINKS</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULENOVERSIONSYMLINKS"><envar>$LDMODULENOVERSIONSYMLINKS</envar></link> when + <term> + <envar>IMPLIBNOVERSIONSYMLINKS</envar> + </term> + <listitem><para> +Used to override <link linkend="cv-SHLIBNOVERSIONSYMLINKS"><envar>$SHLIBNOVERSIONSYMLINKS</envar></link>/<link linkend="cv-LDMODULENOVERSIONSYMLINKS"><envar>$LDMODULENOVERSIONSYMLINKS</envar></link> when creating versioned import library for a shared library/loadable module. If not defined, -then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBNOVERSIONSYMLINKS"><envar>$SHLIBNOVERSIONSYMLINKS</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULENOVERSIONSYMLINKS"><envar>$LDMODULENOVERSIONSYMLINKS</envar></link> is used to determine +then <link linkend="cv-SHLIBNOVERSIONSYMLINKS"><envar>$SHLIBNOVERSIONSYMLINKS</envar></link>/<link linkend="cv-LDMODULENOVERSIONSYMLINKS"><envar>$LDMODULENOVERSIONSYMLINKS</envar></link> is used to determine whether to disable symlink generation or not. </para> </listitem> </varlistentry> <varlistentry id="cv-IMPLIBPREFIX"> - <term>IMPLIBPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>IMPLIBPREFIX</envar> + </term> + <listitem><para> The prefix used for import library names. For example, cygwin uses import libraries (<literal>libfoo.dll.a</literal>) in pair with dynamic libraries -(<literal>cygfoo.dll</literal>). The <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-cyglink"><literal>cyglink</literal></link> linker sets -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-IMPLIBPREFIX"><envar>$IMPLIBPREFIX</envar></link> to <literal>'lib'</literal> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link> +(<literal>cygfoo.dll</literal>). The <link linkend="t-cyglink"><literal>cyglink</literal></link> linker sets +<link linkend="cv-IMPLIBPREFIX"><envar>$IMPLIBPREFIX</envar></link> to <literal>'lib'</literal> and <link linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link> to <literal>'cyg'</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-IMPLIBSUFFIX"> - <term>IMPLIBSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>IMPLIBSUFFIX</envar> + </term> + <listitem><para> The suffix used for import library names. For example, cygwin uses import libraries (<literal>libfoo.dll.a</literal>) in pair with dynamic libraries -(<literal>cygfoo.dll</literal>). The <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-cyglink"><literal>cyglink</literal></link> linker sets -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-IMPLIBSUFFIX"><envar>$IMPLIBSUFFIX</envar></link> to <literal>'.dll.a'</literal> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBSUFFIX"><envar>$SHLIBSUFFIX</envar></link> +(<literal>cygfoo.dll</literal>). The <link linkend="t-cyglink"><literal>cyglink</literal></link> linker sets +<link linkend="cv-IMPLIBSUFFIX"><envar>$IMPLIBSUFFIX</envar></link> to <literal>'.dll.a'</literal> and <link linkend="cv-SHLIBSUFFIX"><envar>$SHLIBSUFFIX</envar></link> to <literal>'.dll'</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-IMPLIBVERSION"> - <term>IMPLIBVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Used to override <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> when + <term> + <envar>IMPLIBVERSION</envar> + </term> + <listitem><para> +Used to override <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> when generating versioned import library for a shared library/loadable module. If -undefined, the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is used to +undefined, the <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>/<link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is used to determine the version of versioned import library. </para> </listitem> </varlistentry> <varlistentry id="cv-IMPLICIT_COMMAND_DEPENDENCIES"> - <term>IMPLICIT_COMMAND_DEPENDENCIES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>IMPLICIT_COMMAND_DEPENDENCIES</envar> + </term> + <listitem><para> Controls whether or not SCons will add implicit dependencies for the commands executed to build targets. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> By default, SCons will add to each target an implicit dependency on the command -represented by the first argument on any -command line it executes. +represented by the first argument of any +command line it executes (which is typically +the command itself). By setting such +a dependency, <application>SCons</application> can determine that +a target should be rebuilt if the command changes, +such as when a compiler is upgraded to a new version. The specific file for the dependency is found by searching the <varname>PATH</varname> variable in the -<varname>ENV</varname> -environment used to execute the command. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If the construction variable -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$IMPLICIT_COMMAND_DEPENDENCIES</envar> -is set to a false value -(<literal>None</literal>, -<literal>False</literal>, -<literal>0</literal>, +<varname>ENV</varname> dictionary +in the <phrase>construction environment</phrase> used to execute the command. +The default is the same as +setting the <phrase>construction variable</phrase> +<envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> +to a True-like value (<quote>true</quote>, +<quote>yes</quote>, +or <quote>1</quote> - but not a number +greater than one, as that has a different meaning). +</para> + +<para> +Action strings can be segmented by the +use of an AND operator, <literal>&&</literal>. +In a segemented string, each segment is a separate +<quote>command line</quote>, these are run +sequentially until one fails or the entire +sequence has been executed. If an +action string is segmented, then the selected +behavior of <envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> +is applied to each segment. +</para> + +<para> +If <envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> +is set to a False-like value +(<quote>none</quote>, +<quote>false</quote>, +<quote>no</quote>, +<quote>0</quote>, etc.), then the implicit dependency will not be added to the targets -built with that construction environment. +built with that <phrase>construction environment</phrase>. +</para> + +<para> +If <envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> +is set to <quote>2</quote> or higher, +then that number of arguments in the command line +will be scanned for relative or absolute paths. +If any are present, they will be added as +implicit dependencies to the targets built +with that <phrase>construction environment</phrase>. +The first argument in the command line will be +searched for using the <varname>PATH</varname> +variable in the <varname>ENV</varname> dictionary +in the <phrase>construction environment</phrase> used to execute the command. +The other arguments will only be found if they +are absolute paths or valid paths relative +to the working directory. +</para> + +<para> +If <envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> +is set to <quote>all</quote>, +then all arguments in the command line will be +scanned for relative or absolute paths. +If any are present, they will be added as +implicit dependencies to the targets built +with that <phrase>construction environment</phrase>. +The first argument in the command line will be +searched for using the <varname>PATH</varname> +variable in the <varname>ENV</varname> dictionary +in the <phrase>construction environment</phrase> used to execute the command. +The other arguments will only be found if they +are absolute paths or valid paths relative +to the working directory. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(IMPLICIT_COMMAND_DEPENDENCIES = 0) +<example_commands> +env = Environment(IMPLICIT_COMMAND_DEPENDENCIES=False) </example_commands> </listitem> </varlistentry> <varlistentry id="cv-INCPREFIX"> - <term>INCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>INCPREFIX</envar> + </term> + <listitem><para> The prefix used to specify an include directory on the C compiler command line. This will be prepended to the beginning of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$FORTRANPATH</envar> construction variables -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_FORTRANINCFLAGS</envar> +in the <envar>$CPPPATH</envar> and <envar>$FORTRANPATH</envar> construction variables +when the <envar>$_CPPINCFLAGS</envar> and <envar>$_FORTRANINCFLAGS</envar> variables are automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-INCSUFFIX"> - <term>INCSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>INCSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify an include directory on the C compiler command line. This will be appended to the end of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$FORTRANPATH</envar> construction variables -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_CPPINCFLAGS</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_FORTRANINCFLAGS</envar> +in the <envar>$CPPPATH</envar> and <envar>$FORTRANPATH</envar> construction variables +when the <envar>$_CPPINCFLAGS</envar> and <envar>$_FORTRANINCFLAGS</envar> variables are automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-INSTALL"> - <term>INSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>INSTALL</envar> + </term> + <listitem><para> A function to be called to install a file into a destination file name. The default function copies the file into the destination @@ -2985,11 +3260,11 @@ to match the source file's). The function takes the following arguments: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def install(dest, source, env): </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <varname>dest</varname> is the path name of the destination file. <varname>source</varname> @@ -3002,22 +3277,24 @@ in force for this file installation. </listitem> </varlistentry> <varlistentry id="cv-INSTALLSTR"> - <term>INSTALLSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>INSTALLSTR</envar> + </term> + <listitem><para> The string displayed when a file is installed into a destination file name. The default is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Install file: "$SOURCE" as "$TARGET" </example_commands> </listitem> </varlistentry> <varlistentry id="cv-INTEL_C_COMPILER_VERSION"> - <term>INTEL_C_COMPILER_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>INTEL_C_COMPILER_VERSION</envar> + </term> + <listitem><para> Set by the "intelc" Tool to the major version number of the Intel C compiler selected for use. @@ -3025,28 +3302,19 @@ selected for use. </listitem> </varlistentry> <varlistentry id="cv-JAR"> - <term>JAR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The Java archive tool. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAR</envar> + </term> + <listitem><para> The Java archive tool. </para> </listitem> </varlistentry> <varlistentry id="cv-JARCHDIR"> - <term>JARCHDIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The directory to which the Java archive tool should change -(using the -<option>-C</option> -option). -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JARCHDIR</envar> + </term> + <listitem><para> The directory to which the Java archive tool should change (using the <option>-C</option> @@ -3055,54 +3323,34 @@ option). </listitem> </varlistentry> <varlistentry id="cv-JARCOM"> - <term>JARCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The command line used to call the Java archive tool. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JARCOM</envar> + </term> + <listitem><para> The command line used to call the Java archive tool. </para> </listitem> </varlistentry> <varlistentry id="cv-JARCOMSTR"> - <term>JARCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when the Java archive tool -is called -If this is not set, then <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JARCOM</envar> (the command line) is displayed. -</para> - -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") -</example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JARCOMSTR</envar> + </term> + <listitem><para> The string displayed when the Java archive tool is called -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JARCOM"><envar>$JARCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-JARCOM"><envar>$JARCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") +<example_commands> +env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-JARFLAGS"> - <term>JARFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -General options passed to the Java archive tool. -By default this is set to -<option>cf</option> -to create the necessary -<command>jar</command> -file. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JARFLAGS</envar> + </term> + <listitem><para> General options passed to the Java archive tool. By default this is set to <option>cf</option> @@ -3113,15 +3361,10 @@ file. </listitem> </varlistentry> <varlistentry id="cv-JARSUFFIX"> - <term>JARSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The suffix for Java archives: -<filename>.jar</filename> -by default. -</para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JARSUFFIX</envar> + </term> + <listitem><para> The suffix for Java archives: <filename>.jar</filename> by default. @@ -3129,12 +3372,13 @@ by default. </listitem> </varlistentry> <varlistentry id="cv-JAVABOOTCLASSPATH"> - <term>JAVABOOTCLASSPATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVABOOTCLASSPATH</envar> + </term> + <listitem><para> Specifies the list of directories that will be added to the - <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> command line + <application>javac</application> command line via the <option>-bootclasspath</option> option. The individual directory names will be separated by the operating system's path separate character @@ -3145,52 +3389,57 @@ by default. </listitem> </varlistentry> <varlistentry id="cv-JAVAC"> - <term>JAVAC</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAC</envar> + </term> + <listitem><para> The Java compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVACCOM"> - <term>JAVACCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACCOM</envar> + </term> + <listitem><para> The command line used to compile a directory tree containing Java source files to corresponding Java class files. - Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVACFLAGS"><envar>$JAVACFLAGS</envar></link> construction variable + Any options specified in the <link linkend="cv-JAVACFLAGS"><envar>$JAVACFLAGS</envar></link> construction variable are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVACCOMSTR"> - <term>JAVACCOMSTR</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACCOMSTR</envar> + </term> + <listitem><para> The string displayed when compiling a directory tree of Java source files to corresponding Java class files. - If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVACCOM"><envar>$JAVACCOM</envar></link> (the command line) is displayed. + If this is not set, then <link linkend="cv-JAVACCOM"><envar>$JAVACCOM</envar></link> (the command line) is displayed. </para> - <example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> - env = Environment(JAVACCOMSTR = "Compiling class files $TARGETS from $SOURCES") + <example_commands> +env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-JAVACFLAGS"> - <term>JAVACFLAGS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACFLAGS</envar> + </term> + <listitem><para> General options that are passed to the Java compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVACLASSDIR"> - <term>JAVACLASSDIR</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACLASSDIR</envar> + </term> + <listitem><para> The directory in which Java class files may be found. This is stripped from the beginning of any Java .class file names supplied to the @@ -3200,15 +3449,16 @@ by default. </listitem> </varlistentry> <varlistentry id="cv-JAVACLASSPATH"> - <term>JAVACLASSPATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACLASSPATH</envar> + </term> + <listitem><para> Specifies the list of directories that will be searched for Java <filename>.class</filename> file. The directories in this list will be added to the - <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> and <application xmlns="http://www.scons.org/dbxsd/v1.0">javah</application> command lines + <application>javac</application> and <application>javah</application> command lines via the <option>-classpath</option> option. The individual directory names will be separated by the operating system's path separate character @@ -3217,20 +3467,21 @@ by default. on Windows). </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Note that this currently just adds the specified directory via the <option>-classpath</option> option. - <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> does not currently search the - <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JAVACLASSPATH</envar> directories for dependency + <application>SCons</application> does not currently search the + <envar>$JAVACLASSPATH</envar> directories for dependency <filename>.class</filename> files. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVACLASSSUFFIX"> - <term>JAVACLASSSUFFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVACLASSSUFFIX</envar> + </term> + <listitem><para> The suffix for Java class files; <filename>.class</filename> by default. @@ -3238,65 +3489,71 @@ by default. </listitem> </varlistentry> <varlistentry id="cv-JAVAH"> - <term>JAVAH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAH</envar> + </term> + <listitem><para> The Java generator for C header and stub files. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVAHCOM"> - <term>JAVAHCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAHCOM</envar> + </term> + <listitem><para> The command line used to generate C header and stub files from Java classes. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVAHFLAGS"><envar>$JAVAHFLAGS</envar></link> construction variable +Any options specified in the <link linkend="cv-JAVAHFLAGS"><envar>$JAVAHFLAGS</envar></link> construction variable are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVAHCOMSTR"> - <term>JAVAHCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAHCOMSTR</envar> + </term> + <listitem><para> The string displayed when C header and stub files are generated from Java classes. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-JAVAHCOM"><envar>$JAVAHCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-JAVAHCOM"><envar>$JAVAHCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> -env = Environment(JAVAHCOMSTR = "Generating header/stub file(s) $TARGETS from $SOURCES") +<example_commands> +env = Environment(JAVAHCOMSTR="Generating header/stub file(s) $TARGETS from $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-JAVAHFLAGS"> - <term>JAVAHFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAHFLAGS</envar> + </term> + <listitem><para> General options passed to the C header and stub file generator for Java classes. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVAINCLUDES"> - <term>JAVAINCLUDES</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVAINCLUDES</envar> + </term> + <listitem><para> Include path for Java header files (such as jni.h) </para> </listitem> </varlistentry> <varlistentry id="cv-JAVASOURCEPATH"> - <term>JAVASOURCEPATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVASOURCEPATH</envar> + </term> + <listitem><para> Specifies the list of directories that will be searched for input <filename>.java</filename> file. The directories in this list will be added to the - <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> command line + <application>javac</application> command line via the <option>-sourcepath</option> option. The individual directory names will be separated by the operating system's path separate character @@ -3305,20 +3562,21 @@ for Java classes. on Windows). </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Note that this currently just adds the specified directory via the <option>-sourcepath</option> option. - <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> does not currently search the - <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JAVASOURCEPATH</envar> directories for dependency + <application>SCons</application> does not currently search the + <envar>$JAVASOURCEPATH</envar> directories for dependency <filename>.java</filename> files. </para> </listitem> </varlistentry> <varlistentry id="cv-JAVASUFFIX"> - <term>JAVASUFFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>JAVASUFFIX</envar> + </term> + <listitem><para> The suffix for Java files; <filename>.java</filename> by default. @@ -3326,77 +3584,83 @@ for Java classes. </listitem> </varlistentry> <varlistentry id="cv-JAVAVERSION"> - <term>JAVAVERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - Specifies the Java version being used by the <function xmlns="http://www.scons.org/dbxsd/v1.0">Java</function> builder. + <term> + <envar>JAVAVERSION</envar> + </term> + <listitem><para> + Specifies the Java version being used by the <function>Java</function> builder. This is <emphasis>not</emphasis> currently used to select one version of the Java compiler vs. another. Instead, you should set this to specify the version of Java - supported by your <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> compiler. + supported by your <application>javac</application> compiler. The default is <literal>1.4</literal>. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> This is sometimes necessary because Java 1.5 changed the file names that are created for nested anonymous inner classes, which can cause a mismatch with the files - that <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> expects will be generated by the <application xmlns="http://www.scons.org/dbxsd/v1.0">javac</application> compiler. - Setting <envar xmlns="http://www.scons.org/dbxsd/v1.0">$JAVAVERSION</envar> to + that <application>SCons</application> expects will be generated by the <application>javac</application> compiler. + Setting <envar>$JAVAVERSION</envar> to <literal>1.5</literal> (or <literal>1.6</literal>, as appropriate) - can make <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> realize that a Java 1.5 or 1.6 + can make <application>SCons</application> realize that a Java 1.5 or 1.6 build is actually up to date. </para> </listitem> </varlistentry> <varlistentry id="cv-LATEX"> - <term>LATEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEX</envar> + </term> + <listitem><para> The LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-LATEXCOM"> - <term>LATEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEXCOM</envar> + </term> + <listitem><para> The command line used to call the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-LATEXCOMSTR"> - <term>LATEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEXCOMSTR</envar> + </term> + <listitem><para> The string displayed when calling the LaTeX structured formatter and typesetter. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-LATEXFLAGS"> - <term>LATEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEXFLAGS</envar> + </term> + <listitem><para> General options passed to the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-LATEXRETRIES"> - <term>LATEXRETRIES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEXRETRIES</envar> + </term> + <listitem><para> The maximum number of times that LaTeX will be re-run if the <filename>.log</filename> -generated by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command +generated by the <link linkend="cv-LATEXCOM"><envar>$LATEXCOM</envar></link> command indicates that there are undefined references. The default is to try to resolve undefined references by re-running LaTeX up to three times. @@ -3404,92 +3668,113 @@ by re-running LaTeX up to three times. </listitem> </varlistentry> <varlistentry id="cv-LATEXSUFFIXES"> - <term>LATEXSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LATEXSUFFIXES</envar> + </term> + <listitem><para> The list of suffixes of files that will be scanned for LaTeX implicit dependencies (<literal>\include</literal> or <literal>\import</literal> files). The default list is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> [".tex", ".ltx", ".latex"] </example_commands> </listitem> </varlistentry> <varlistentry id="cv-LDMODULE"> - <term>LDMODULE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULE</envar> + </term> + <listitem><para> The linker for building loadable modules. -By default, this is the same as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINK"><envar>$SHLINK</envar></link>. +By default, this is the same as <link linkend="cv-SHLINK"><envar>$SHLINK</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULECOM"> - <term>LDMODULECOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULECOM</envar> + </term> + <listitem><para> The command line for building loadable modules. -On Mac OS X, this uses the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULE"><envar>$LDMODULE</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEFLAGS"><envar>$LDMODULEFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-FRAMEWORKSFLAGS"><envar>$FRAMEWORKSFLAGS</envar></link> variables. -On other systems, this is the same as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINK"><envar>$SHLINK</envar></link>. +On Mac OS X, this uses the <link linkend="cv-LDMODULE"><envar>$LDMODULE</envar></link>, +<link linkend="cv-LDMODULEFLAGS"><envar>$LDMODULEFLAGS</envar></link> and +<link linkend="cv-FRAMEWORKSFLAGS"><envar>$FRAMEWORKSFLAGS</envar></link> variables. +On other systems, this is the same as <link linkend="cv-SHLINK"><envar>$SHLINK</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULECOMSTR"> - <term>LDMODULECOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when building loadable modules. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> (the command line) is displayed. + <term> + <envar>LDMODULECOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when building loadable modules. +If not set, then <link linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> (the command line) is displayed. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-LDMODULEEMITTER"> + <term> + <envar>LDMODULEEMITTER</envar> + </term> + <listitem><para> +Contains the emitter specification for the +<link linkend="b-LoadableModule"><function>LoadableModule</function></link> builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULEFLAGS"> - <term>LDMODULEFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULEFLAGS</envar> + </term> + <listitem><para> General user options passed to the linker for building loadable modules. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULENOVERSIONSYMLINKS"> - <term>LDMODULENOVERSIONSYMLINKS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Instructs the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link> builder to not automatically create symlinks + <term> + <envar>LDMODULENOVERSIONSYMLINKS</envar> + </term> + <listitem><para> +Instructs the <link linkend="b-LoadableModule"><function>LoadableModule</function></link> builder to not automatically create symlinks for versioned modules. Defaults to <literal>$SHLIBNOVERSIONSYMLINKS</literal> </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULEPREFIX"> - <term>LDMODULEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULEPREFIX</envar> + </term> + <listitem><para> The prefix used for loadable module file names. On Mac OS X, this is null; on other systems, this is -the same as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link>. +the same as <link linkend="cv-SHLIBPREFIX"><envar>$SHLIBPREFIX</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-_LDMODULESONAME"> - <term>_LDMODULESONAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_LDMODULESONAME</envar> + </term> + <listitem><para> A macro that automatically generates loadable module's SONAME based on $TARGET, -$LDMODULEVERSION and $LDMODULESUFFIX. Used by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link> builder -when the linker tool supports SONAME (e.g. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gnulink"><literal>gnulink</literal></link>). +$LDMODULEVERSION and $LDMODULESUFFIX. Used by <link linkend="b-LoadableModule"><function>LoadableModule</function></link> builder +when the linker tool supports SONAME (e.g. <link linkend="t-gnulink"><literal>gnulink</literal></link>). </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULESUFFIX"> - <term>LDMODULESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULESUFFIX</envar> + </term> + <listitem><para> The suffix used for loadable module file names. On Mac OS X, this is null; on other systems, this is @@ -3498,227 +3783,244 @@ the same as $SHLIBSUFFIX. </listitem> </varlistentry> <varlistentry id="cv-LDMODULEVERSION"> - <term>LDMODULEVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LDMODULEVERSION</envar> + </term> + <listitem><para> When this construction variable is defined, a versioned loadable module -is created by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link> builder. This activates the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LDMODULEVERSIONFLAGS"><envar>$_LDMODULEVERSIONFLAGS</envar></link> and thus modifies the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> as +is created by <link linkend="b-LoadableModule"><function>LoadableModule</function></link> builder. This activates the +<link linkend="cv-_LDMODULEVERSIONFLAGS"><envar>$_LDMODULEVERSIONFLAGS</envar></link> and thus modifies the <link linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> as required, adds the version number to the library name, and creates the symlinks -that are needed. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> versions should exist in the same -format as <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>. -</para> -</listitem> - </varlistentry> - <varlistentry id="cv-LDMODULEVERSIONFLAGS"> - <term>LDMODULEVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Extra flags added to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> when building versioned -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link>. These flags are only used when <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is -set. +that are needed. <link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> versions should exist in the same +format as <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-_LDMODULEVERSIONFLAGS"> - <term>_LDMODULEVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This macro automatically introduces extra flags to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> when -building versioned <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-LoadableModule"><function>LoadableModule</function></link> (that is when -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is set). <literal>_LDMODULEVERSIONFLAGS</literal> -usually adds <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSIONFLAGS"><envar>$SHLIBVERSIONFLAGS</envar></link> and some extra dynamically generated + <term> + <envar>_LDMODULEVERSIONFLAGS</envar> + </term> + <listitem><para> +This macro automatically introduces extra flags to <link linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> when +building versioned <link linkend="b-LoadableModule"><function>LoadableModule</function></link> (that is when +<link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is set). <literal>_LDMODULEVERSIONFLAGS</literal> +usually adds <link linkend="cv-SHLIBVERSIONFLAGS"><envar>$SHLIBVERSIONFLAGS</envar></link> and some extra dynamically generated options (such as <literal>-Wl,-soname=$_LDMODULESONAME</literal>). It is unused by plain (unversioned) loadable modules. </para> </listitem> </varlistentry> + <varlistentry id="cv-LDMODULEVERSIONFLAGS"> + <term> + <envar>LDMODULEVERSIONFLAGS</envar> + </term> + <listitem><para> +Extra flags added to <link linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> when building versioned +<link linkend="b-LoadableModule"><function>LoadableModule</function></link>. These flags are only used when <link linkend="cv-LDMODULEVERSION"><envar>$LDMODULEVERSION</envar></link> is +set. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-LEX"> - <term>LEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LEX</envar> + </term> + <listitem><para> The lexical analyzer generator. </para> </listitem> </varlistentry> <varlistentry id="cv-LEXCOM"> - <term>LEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LEXCOM</envar> + </term> + <listitem><para> The command line used to call the lexical analyzer generator to generate a source file. </para> </listitem> </varlistentry> <varlistentry id="cv-LEXCOMSTR"> - <term>LEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LEXCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a source file using the lexical analyzer generator. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LEXCOM"><envar>$LEXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-LEXCOM"><envar>$LEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-LEXFLAGS"> - <term>LEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LEXFLAGS</envar> + </term> + <listitem><para> General options passed to the lexical analyzer generator. </para> </listitem> </varlistentry> <varlistentry id="cv-LEXUNISTD"> - <term>LEXUNISTD</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LEXUNISTD</envar> + </term> + <listitem><para> Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'. </para> </listitem> </varlistentry> <varlistentry id="cv-_LIBDIRFLAGS"> - <term>_LIBDIRFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_LIBDIRFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the linker command-line options for specifying directories to be searched for library. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar> is created -by respectively prepending and appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBDIRPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBDIRSUFFIX</envar> +The value of <envar>$_LIBDIRFLAGS</envar> is created +by respectively prepending and appending <envar>$LIBDIRPREFIX</envar> and <envar>$LIBDIRSUFFIX</envar> to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBPATH</envar>. +of each directory in <envar>$LIBPATH</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBDIRPREFIX"> - <term>LIBDIRPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBDIRPREFIX</envar> + </term> + <listitem><para> The prefix used to specify a library directory on the linker command line. This will be prepended to the beginning of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar> variable is automatically generated. +in the <envar>$LIBPATH</envar> construction variable +when the <envar>$_LIBDIRFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBDIRSUFFIX"> - <term>LIBDIRSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBDIRSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify a library directory on the linker command line. This will be appended to the end of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar> variable is automatically generated. +in the <envar>$LIBPATH</envar> construction variable +when the <envar>$_LIBDIRFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBEMITTER"> - <term>LIBEMITTER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBEMITTER</envar> + </term> + <listitem><para> Contains the emitter specification for the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-StaticLibrary"><function>StaticLibrary</function></link> builder. +<link linkend="b-StaticLibrary"><function>StaticLibrary</function></link> builder. The manpage section "Builder Objects" contains general information on specifying emitters. </para> </listitem> </varlistentry> <varlistentry id="cv-_LIBFLAGS"> - <term>_LIBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_LIBFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the linker command-line options for specifying libraries to be linked with the resulting target. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar> is created -by respectively prepending and appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKSUFFIX</envar> +The value of <envar>$_LIBFLAGS</envar> is created +by respectively prepending and appending <envar>$LIBLINKPREFIX</envar> and <envar>$LIBLINKSUFFIX</envar> to the beginning and end -of each filename in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar>. +of each filename in <envar>$LIBS</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBLINKPREFIX"> - <term>LIBLINKPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBLINKPREFIX</envar> + </term> + <listitem><para> The prefix used to specify a library to link on the linker command line. This will be prepended to the beginning of each library -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar> variable is automatically generated. +in the <envar>$LIBS</envar> construction variable +when the <envar>$_LIBFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBLINKSUFFIX"> - <term>LIBLINKSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBLINKSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify a library to link on the linker command line. This will be appended to the end of each library -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar> variable is automatically generated. +in the <envar>$LIBS</envar> construction variable +when the <envar>$_LIBFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBPATH"> - <term>LIBPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBPATH</envar> + </term> + <listitem><para> The list of directories that will be searched for libraries. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINKFLAGS</envar> or <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SHLINKFLAGS</envar> +arguments in <envar>$LINKFLAGS</envar> or <envar>$SHLINKFLAGS</envar> because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in LIBPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LIBPATH='#/libs') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> libs = Dir('libs') env = Environment(LIBPATH=libs) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar> +<envar>$_LIBDIRFLAGS</envar> construction variable, which is constructed by respectively prepending and appending the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBDIRPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBDIRSUFFIX</envar> +<envar>$LIBDIRPREFIX</envar> and <envar>$LIBDIRSUFFIX</envar> construction variables to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBPATH</envar>. +of each directory in <envar>$LIBPATH</envar>. Any command lines you define that need the LIBPATH directory list should -include <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBDIRFLAGS</envar>: +include <envar>$_LIBDIRFLAGS</envar>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-LIBPREFIX"> - <term>LIBPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBPREFIX</envar> + </term> + <listitem><para> The prefix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3729,75 +4031,78 @@ to reflect the names of the libraries they create. </listitem> </varlistentry> <varlistentry id="cv-LIBPREFIXES"> - <term>LIBPREFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBPREFIXES</envar> + </term> + <listitem><para> A list of all legal prefixes for library file names. When searching for library dependencies, SCons will look for files with these prefixes, the base library name, -and suffixes in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBSUFFIXES</envar> list. +and suffixes in the <envar>$LIBSUFFIXES</envar> list. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBS"> - <term>LIBS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBS</envar> + </term> + <listitem><para> A list of one or more libraries that will be linked with any executable programs created by this environment. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The library list will be added to command lines through the automatically-generated -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar> +<envar>$_LIBFLAGS</envar> construction variable, which is constructed by respectively prepending and appending the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKSUFFIX</envar> +<envar>$LIBLINKPREFIX</envar> and <envar>$LIBLINKSUFFIX</envar> construction variables to the beginning and end -of each filename in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar>. +of each filename in <envar>$LIBS</envar>. Any command lines you define that need the LIBS library list should -include <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar>: +include <envar>$_LIBFLAGS</envar>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE") </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If you add a File object to the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar> +<envar>$LIBS</envar> list, the name of that file will be added to -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_LIBFLAGS</envar>, +<envar>$_LIBFLAGS</envar>, and thus the link line, as is, without -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKPREFIX</envar> +<envar>$LIBLINKPREFIX</envar> or -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBLINKSUFFIX</envar>. +<envar>$LIBLINKSUFFIX</envar>. For example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Append(LIBS=File('/tmp/mylib.so')) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> In all cases, scons will add dependencies from the executable program to all the libraries in this list. </para> </listitem> </varlistentry> <varlistentry id="cv-LIBSUFFIX"> - <term>LIBSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBSUFFIX</envar> + </term> + <listitem><para> The suffix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3808,21 +4113,23 @@ to reflect the names of the libraries they create. </listitem> </varlistentry> <varlistentry id="cv-LIBSUFFIXES"> - <term>LIBSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LIBSUFFIXES</envar> + </term> + <listitem><para> A list of all legal suffixes for library file names. When searching for library dependencies, -SCons will look for files with prefixes, in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBPREFIXES</envar> list, +SCons will look for files with prefixes, in the <envar>$LIBPREFIXES</envar> list, the base library name, and these suffixes. </para> </listitem> </varlistentry> <varlistentry id="cv-LICENSE"> - <term>LICENSE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LICENSE</envar> + </term> + <listitem><para> The abbreviated name, preferably the SPDX code, of the license under which this project is released (GPL-3.0, LGPL-2.1, BSD-2-Clause etc.). See http://www.opensource.org/licenses/alphabetical @@ -3831,24 +4138,26 @@ for a list of license names and SPDX codes. </listitem> </varlistentry> <varlistentry id="cv-LINESEPARATOR"> - <term>LINESEPARATOR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The separator used by the <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> and <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> builders. + <term> + <envar>LINESEPARATOR</envar> + </term> + <listitem><para> +The separator used by the <function>Substfile</function> and <function>Textfile</function> builders. This value is used between sources when constructing the target. It defaults to the current system line separator. </para> </listitem> </varlistentry> <varlistentry id="cv-LINGUAS_FILE"> - <term>LINGUAS_FILE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINGUAS_FILE</envar> defines file(s) containing list of additional linguas -to be processed by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> -builders. It also affects <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Translate"><function>Translate</function></link> builder. If the variable contains -a string, it defines name of the list file. The <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINGUAS_FILE</envar> may be a -list of file names as well. If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$LINGUAS_FILE</envar> is set to + <term> + <envar>LINGUAS_FILE</envar> + </term> + <listitem><para> +The <envar>$LINGUAS_FILE</envar> defines file(s) containing list of additional linguas +to be processed by <link linkend="b-POInit"><function>POInit</function></link>, <link linkend="b-POUpdate"><function>POUpdate</function></link> or <link linkend="b-MOFiles"><function>MOFiles</function></link> +builders. It also affects <link linkend="b-Translate"><function>Translate</function></link> builder. If the variable contains +a string, it defines name of the list file. The <envar>$LINGUAS_FILE</envar> may be a +list of file names as well. If <envar>$LINGUAS_FILE</envar> is set to <literal>True</literal> (or non-zero numeric value), the list will be read from default file named <filename>LINGUAS</filename>. @@ -3857,107 +4166,121 @@ default file named </listitem> </varlistentry> <varlistentry id="cv-LINK"> - <term>LINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LINK</envar> + </term> + <listitem><para> The linker. +See also <link linkend="cv-SHLINK"><envar>$SHLINK</envar></link> for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-LINKCOM"> - <term>LINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LINKCOM</envar> + </term> + <listitem><para> The command line used to link object files into an executable. +See also <link linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-LINKCOMSTR"> - <term>LINKCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when object files + <term> + <envar>LINKCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when object files are linked into an executable. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LINKCOM"><envar>$LINKCOM</envar></link> (the command line) is displayed. +If not set, then <link linkend="cv-LINKCOM"><envar>$LINKCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-SHLINKCOMSTR"><envar>$SHLINKCOMSTR</envar></link>. for linking shared objects. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(LINKCOMSTR = "Linking $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-LINKFLAGS"> - <term>LINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>LINKFLAGS</envar> + </term> + <listitem><para> General user options passed to the linker. Note that this variable should <emphasis>not</emphasis> contain <option>-l</option> -(or similar) options for linking with the libraries listed in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBS"><envar>$LIBS</envar></link>, +(or similar) options for linking with the libraries listed in <link linkend="cv-LIBS"><envar>$LIBS</envar></link>, nor <option>-L</option> (or similar) library search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>. +that scons generates automatically from <link linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LIBFLAGS"><envar>$_LIBFLAGS</envar></link> +<link linkend="cv-_LIBFLAGS"><envar>$_LIBFLAGS</envar></link> above, for the variable that expands to library-link options, and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LIBDIRFLAGS"><envar>$_LIBDIRFLAGS</envar></link> +<link linkend="cv-_LIBDIRFLAGS"><envar>$_LIBDIRFLAGS</envar></link> above, for the variable that expands to library search path options. +See also <link linkend="cv-SHLINKFLAGS"><envar>$SHLINKFLAGS</envar></link>. for linking shared objects. </para> </listitem> </varlistentry> <varlistentry id="cv-M4"> - <term>M4</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>M4</envar> + </term> + <listitem><para> The M4 macro preprocessor. </para> </listitem> </varlistentry> <varlistentry id="cv-M4COM"> - <term>M4COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>M4COM</envar> + </term> + <listitem><para> The command line used to pass files through the M4 macro preprocessor. </para> </listitem> </varlistentry> <varlistentry id="cv-M4COMSTR"> - <term>M4COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>M4COMSTR</envar> + </term> + <listitem><para> The string displayed when a file is passed through the M4 macro preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-M4COM"><envar>$M4COM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-M4COM"><envar>$M4COM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-M4FLAGS"> - <term>M4FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>M4FLAGS</envar> + </term> + <listitem><para> General options passed to the M4 macro preprocessor. </para> </listitem> </varlistentry> <varlistentry id="cv-MAKEINDEX"> - <term>MAKEINDEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MAKEINDEX</envar> + </term> + <listitem><para> The makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-MAKEINDEXCOM"> - <term>MAKEINDEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MAKEINDEXCOM</envar> + </term> + <listitem><para> The command line used to call the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -3965,29 +4288,32 @@ typesetter. </listitem> </varlistentry> <varlistentry id="cv-MAKEINDEXCOMSTR"> - <term>MAKEINDEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MAKEINDEXCOMSTR</envar> + </term> + <listitem><para> The string displayed when calling the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MAKEINDEXCOM"><envar>$MAKEINDEXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-MAKEINDEXCOM"><envar>$MAKEINDEXCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-MAKEINDEXFLAGS"> - <term>MAKEINDEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MAKEINDEXFLAGS</envar> + </term> + <listitem><para> General options passed to the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-MAXLINELENGTH"> - <term>MAXLINELENGTH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MAXLINELENGTH</envar> + </term> + <listitem><para> The maximum number of characters allowed on an external command line. On Win32 systems, link lines longer than this many characters @@ -3996,179 +4322,198 @@ are linked via a temporary file name. </listitem> </varlistentry> <varlistentry id="cv-MIDL"> - <term>MIDL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MIDL</envar> + </term> + <listitem><para> The Microsoft IDL compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-MIDLCOM"> - <term>MIDLCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MIDLCOM</envar> + </term> + <listitem><para> The command line used to pass files to the Microsoft IDL compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-MIDLCOMSTR"> - <term>MIDLCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MIDLCOMSTR</envar> + </term> + <listitem><para> The string displayed when the Microsoft IDL compiler is called. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MIDLCOM"><envar>$MIDLCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-MIDLCOM"><envar>$MIDLCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-MIDLFLAGS"> - <term>MIDLFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MIDLFLAGS</envar> + </term> + <listitem><para> General options passed to the Microsoft IDL compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-MOSUFFIX"> - <term>MOSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MOSUFFIX</envar> + </term> + <listitem><para> Suffix used for <literal>MO</literal> files (default: <literal>'.mo'</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> builder. +See <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link linkend="b-MOFiles"><function>MOFiles</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGFMT"> - <term>MSGFMT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGFMT</envar> + </term> + <listitem><para> Absolute path to <command>msgfmt(1)</command> binary, found by <function>Detect()</function>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> builder. +See <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link linkend="b-MOFiles"><function>MOFiles</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGFMTCOM"> - <term>MSGFMTCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGFMTCOM</envar> + </term> + <listitem><para> Complete command line to run <command>msgfmt(1)</command> program. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> builder. +See <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link linkend="b-MOFiles"><function>MOFiles</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGFMTCOMSTR"> - <term>MSGFMTCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGFMTCOMSTR</envar> + </term> + <listitem><para> String to display when <command>msgfmt(1)</command> is invoked -(default: <literal>''</literal>, which means ``print <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSGFMTCOM"><envar>$MSGFMTCOM</envar></link>''). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> builder. +(default: <literal>''</literal>, which means ``print <link linkend="cv-MSGFMTCOM"><envar>$MSGFMTCOM</envar></link>''). +See <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link linkend="b-MOFiles"><function>MOFiles</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGFMTFLAGS"> - <term>MSGFMTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGFMTFLAGS</envar> + </term> + <listitem><para> Additional flags to <command>msgfmt(1)</command>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-MOFiles"><function>MOFiles</function></link> builder. +See <link linkend="t-msgfmt"><literal>msgfmt</literal></link> tool and <link linkend="b-MOFiles"><function>MOFiles</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGINIT"> - <term>MSGINIT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGINIT</envar> + </term> + <listitem><para> Path to <command>msginit(1)</command> program (found via <literal>Detect()</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGINITCOM"> - <term>MSGINITCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGINITCOM</envar> + </term> + <listitem><para> Complete command line to run <command>msginit(1)</command> program. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGINITCOMSTR"> - <term>MSGINITCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGINITCOMSTR</envar> + </term> + <listitem><para> String to display when <command>msginit(1)</command> is invoked -(default: <literal>''</literal>, which means ``print <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSGINITCOM"><envar>$MSGINITCOM</envar></link>''). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +(default: <literal>''</literal>, which means ``print <link linkend="cv-MSGINITCOM"><envar>$MSGINITCOM</envar></link>''). +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGINITFLAGS"> - <term>MSGINITFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGINITFLAGS</envar> + </term> + <listitem><para> List of additional flags to <command>msginit(1)</command> (default: <literal>[]</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-_MSGINITLOCALE"> - <term>_MSGINITLOCALE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_MSGINITLOCALE</envar> + </term> + <listitem><para> Internal ``macro''. Computes locale (language) name based on target filename (default: <literal>'${TARGET.filebase}' </literal>). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +<para> +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGMERGE"> - <term>MSGMERGE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGMERGE</envar> + </term> + <listitem><para> Absolute path to <command>msgmerge(1)</command> binary as found by <function>Detect()</function>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder. +See <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link linkend="b-POUpdate"><function>POUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGMERGECOM"> - <term>MSGMERGECOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGMERGECOM</envar> + </term> + <listitem><para> Complete command line to run <command>msgmerge(1)</command> command. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder. +See <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link linkend="b-POUpdate"><function>POUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGMERGECOMSTR"> - <term>MSGMERGECOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGMERGECOMSTR</envar> + </term> + <listitem><para> String to be displayed when <command>msgmerge(1)</command> is invoked -(default: <literal>''</literal>, which means ``print <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSGMERGECOM"><envar>$MSGMERGECOM</envar></link>''). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder. +(default: <literal>''</literal>, which means ``print <link linkend="cv-MSGMERGECOM"><envar>$MSGMERGECOM</envar></link>''). +See <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link linkend="b-POUpdate"><function>POUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSGMERGEFLAGS"> - <term>MSGMERGEFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSGMERGEFLAGS</envar> + </term> + <listitem><para> Additional flags to <command>msgmerge(1)</command> command. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder. +See <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link linkend="b-POUpdate"><function>POUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-MSSDK_DIR"> - <term>MSSDK_DIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSSDK_DIR</envar> + </term> + <listitem><para> The directory containing the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4176,9 +4521,10 @@ to be used for compilation. </listitem> </varlistentry> <varlistentry id="cv-MSSDK_VERSION"> - <term>MSSDK_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSSDK_VERSION</envar> + </term> + <listitem><para> The version string of the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4193,9 +4539,10 @@ and </listitem> </varlistentry> <varlistentry id="cv-MSVC_BATCH"> - <term>MSVC_BATCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVC_BATCH</envar> + </term> + <listitem><para> When set to any true value, specifies that SCons should batch compilation of object files @@ -4206,7 +4553,7 @@ and were configured in SCons using the same construction environment will be built in a single call to the compiler. Only source files that have changed since their object files were built will be passed to each compiler invocation -(via the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CHANGED_SOURCES"><envar>$CHANGED_SOURCES</envar></link> construction variable). +(via the <link linkend="cv-CHANGED_SOURCES"><envar>$CHANGED_SOURCES</envar></link> construction variable). Any compilations where the object (target) file base name (minus the <filename>.obj</filename>) does not match the source file base name @@ -4215,14 +4562,15 @@ will be compiled separately. </listitem> </varlistentry> <varlistentry id="cv-MSVC_USE_SCRIPT"> - <term>MSVC_USE_SCRIPT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVC_USE_SCRIPT</envar> + </term> + <listitem><para> Use a batch script to set up Microsoft Visual Studio compiler </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_USE_SCRIPT</envar> overrides <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_VERSION</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET_ARCH</envar>. +<para> +<envar>$MSVC_USE_SCRIPT</envar> overrides <envar>$MSVC_VERSION</envar> and <envar>$TARGET_ARCH</envar>. If set to the name of a Visual Studio .bat file (e.g. vcvars.bat), SCons will run that bat file and extract the relevant variables from the result (typically %INCLUDE%, %LIB%, and %PATH%). Setting @@ -4233,14 +4581,15 @@ window and importing the shell's environment variables. </listitem> </varlistentry> <varlistentry id="cv-MSVC_UWP_APP"> - <term>MSVC_UWP_APP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVC_UWP_APP</envar> + </term> + <listitem><para> Build libraries for a Universal Windows Platform (UWP) Application. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_UWP_APP</envar> is set, the Visual Studio environment will be set up to point +<para> +If <envar>$MSVC_UWP_APP</envar> is set, the Visual Studio environment will be set up to point to the Windows Store compatible libraries and Visual Studio runtimes. In doing so, any libraries that are built will be able to be used in a UWP App and published to the Windows Store. @@ -4249,31 +4598,33 @@ This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Valid values are '1' or '0' </para> </listitem> </varlistentry> <varlistentry id="cv-MSVC_VERSION"> - <term>MSVC_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVC_VERSION</envar> + </term> + <listitem><para> Sets the preferred version of Microsoft Visual C/C++ to use. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_VERSION</envar> is not set, SCons will (by default) select the +<para> +If <envar>$MSVC_VERSION</envar> is not set, SCons will (by default) select the latest version of Visual C/C++ installed on your system. If the specified version isn't installed, tool initialization will fail. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Valid values for Windows are <literal>14.2</literal>, <literal>14.1</literal>, +<literal>14.1Exp</literal>, <literal>14.0</literal>, <literal>14.0Exp</literal>, <literal>12.0</literal>, @@ -4296,17 +4647,18 @@ Versions ending in <literal>Exp</literal> refer to "Express" or </listitem> </varlistentry> <varlistentry id="cv-MSVS"> - <term>MSVS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS</envar> + </term> + <listitem><para> When the Microsoft Visual Studio tools are initialized, they set up this dictionary with the following keys: </para> - <variablelist xmlns="http://www.scons.org/dbxsd/v1.0"> + <variablelist> <varlistentry> <term>VERSION</term> <listitem> <para>the version of MSVS being used (can be set via - <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link>)</para> + <link linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link>)</para> </listitem> </varlistentry> <varlistentry> <term>VERSIONS</term> <listitem> @@ -4362,29 +4714,31 @@ Versions ending in <literal>Exp</literal> refer to "Express" or </listitem> </varlistentry> </variablelist> - <para xmlns="http://www.scons.org/dbxsd/v1.0">If a value is not set, it was not available in the registry.</para> + <para>If a value is not set, it was not available in the registry.</para> </listitem> </varlistentry> <varlistentry id="cv-MSVS_ARCH"> - <term>MSVS_ARCH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Sets the architecture for which the generated project(s) should build.</para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_ARCH</envar> + </term> + <listitem><para>Sets the architecture for which the generated project(s) should build.</para> + <para> The default value is <literal>x86</literal>. - <literal>amd64</literal> is also supported by <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> for + <literal>amd64</literal> is also supported by <application>SCons</application> for most Visual Studio versions. Since Visual Studio 2015 <literal>arm</literal> is supported, and since Visual Studio 2017 <literal>arm64</literal> is supported. - Trying to set <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVS_ARCH</envar> + Trying to set <envar>$MSVS_ARCH</envar> to an architecture that's not supported for a given Visual Studio version will generate an error. </para> </listitem> </varlistentry> <varlistentry id="cv-MSVS_PROJECT_GUID"> - <term>MSVS_PROJECT_GUID</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_PROJECT_GUID</envar> + </term> + <listitem><para> The string placed in a generated Microsoft Visual Studio project file as the value of the <literal>ProjectGUID</literal> attribute. There is no default @@ -4395,9 +4749,10 @@ defined, a new GUID is generated. </listitem> </varlistentry> <varlistentry id="cv-MSVS_SCC_AUX_PATH"> - <term>MSVS_SCC_AUX_PATH</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_SCC_AUX_PATH</envar> + </term> + <listitem><para> The path name placed in a generated Microsoft Visual Studio project file as the value of the <literal>SccAuxPath</literal> attribute if the @@ -4409,9 +4764,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVS_SCC_CONNECTION_ROOT"> - <term>MSVS_SCC_CONNECTION_ROOT</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_SCC_CONNECTION_ROOT</envar> + </term> + <listitem><para> The root path of projects in your SCC workspace, i.e the path under which all project and solution files will be generated. It is used as a reference path from which the @@ -4434,9 +4790,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVS_SCC_PROJECT_NAME"> - <term>MSVS_SCC_PROJECT_NAME</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_SCC_PROJECT_NAME</envar> + </term> + <listitem><para> The project name placed in a generated Microsoft Visual Studio project file as the value of the <literal>SccProjectName</literal> attribute if the @@ -4450,9 +4807,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVS_SCC_PROVIDER"> - <term>MSVS_SCC_PROVIDER</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVS_SCC_PROVIDER</envar> + </term> + <listitem><para> The string placed in a generated Microsoft Visual Studio project file as the value of the <literal>SccProvider</literal> attribute. The string is @@ -4464,11 +4822,12 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVS_VERSION"> - <term>MSVS_VERSION</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">Sets the preferred version of Microsoft Visual Studio to use.</para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - If <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVS_VERSION</envar> is not set, <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application> will (by default) + <term> + <envar>MSVS_VERSION</envar> + </term> + <listitem><para>Sets the preferred version of Microsoft Visual Studio to use.</para> + <para> + If <envar>$MSVS_VERSION</envar> is not set, <application>SCons</application> will (by default) select the latest version of Visual Studio installed on your system. So, if you have version 6 and version 7 (MSVS .NET) installed, it will prefer version 7. You can override this by @@ -4477,19 +4836,20 @@ no default value. version ('6.0' or '7.0', for example). If the specified version isn't installed, tool initialization will fail. </para> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - This is obsolete: use <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_VERSION</envar> instead. If - <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVS_VERSION</envar> is set and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_VERSION</envar> is - not, <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVC_VERSION</envar> will be set automatically to - <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVS_VERSION</envar>. If both are set to different values, + <para> + This is obsolete: use <envar>$MSVC_VERSION</envar> instead. If + <envar>$MSVS_VERSION</envar> is set and <envar>$MSVC_VERSION</envar> is + not, <envar>$MSVC_VERSION</envar> will be set automatically to + <envar>$MSVS_VERSION</envar>. If both are set to different values, scons will raise an error. </para> </listitem> </varlistentry> <varlistentry id="cv-MSVSBUILDCOM"> - <term>MSVSBUILDCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSBUILDCOM</envar> + </term> + <listitem><para> The build command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with any specified build targets. @@ -4497,9 +4857,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSCLEANCOM"> - <term>MSVSCLEANCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSCLEANCOM</envar> + </term> + <listitem><para> The clean command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with the -c option to remove any specified @@ -4508,9 +4869,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSENCODING"> - <term>MSVSENCODING</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSENCODING</envar> + </term> + <listitem><para> The encoding string placed in a generated Microsoft Visual Studio project file. The default is encoding <literal>Windows-1252</literal>. @@ -4518,15 +4880,17 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSPROJECTCOM"> - <term>MSVSPROJECTCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">The action used to generate Microsoft Visual Studio project files.</para> + <term> + <envar>MSVSPROJECTCOM</envar> + </term> + <listitem><para>The action used to generate Microsoft Visual Studio project files.</para> </listitem> </varlistentry> <varlistentry id="cv-MSVSPROJECTSUFFIX"> - <term>MSVSPROJECTSUFFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSPROJECTSUFFIX</envar> + </term> + <listitem><para> The suffix used for Microsoft Visual Studio project (DSP) files. The default value is <filename>.vcproj</filename> when using Visual Studio version 7.x (.NET) or later version, @@ -4536,9 +4900,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSREBUILDCOM"> - <term>MSVSREBUILDCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSREBUILDCOM</envar> + </term> + <listitem><para> The rebuild command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with any specified rebuild targets. @@ -4547,9 +4912,10 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSSCONS"> - <term>MSVSSCONS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSSCONS</envar> + </term> + <listitem><para> The SCons used in generated Microsoft Visual Studio project files. The default is the version of SCons being used to generate the project file. @@ -4557,44 +4923,49 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MSVSSCONSCOM"> - <term>MSVSSCONSCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSSCONSCOM</envar> + </term> + <listitem><para> The default SCons command used in generated Microsoft Visual Studio project files. </para> </listitem> </varlistentry> <varlistentry id="cv-MSVSSCONSCRIPT"> - <term>MSVSSCONSCRIPT</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> - The sconscript file (that is, <filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> or <filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> + <term> + <envar>MSVSSCONSCRIPT</envar> + </term> + <listitem><para> + The sconscript file (that is, <filename>SConstruct</filename> or <filename>SConscript</filename> file) that will be invoked by Visual Studio project files - (through the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVSSCONSCOM"><envar>$MSVSSCONSCOM</envar></link> variable). The default + (through the <link linkend="cv-MSVSSCONSCOM"><envar>$MSVSSCONSCOM</envar></link> variable). The default is the same sconscript file that contains the call to - <function xmlns="http://www.scons.org/dbxsd/v1.0">MSVSProject</function> to build the project file. + <function>MSVSProject</function> to build the project file. </para> </listitem> </varlistentry> <varlistentry id="cv-MSVSSCONSFLAGS"> - <term>MSVSSCONSFLAGS</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSSCONSFLAGS</envar> + </term> + <listitem><para> The SCons flags used in generated Microsoft Visual Studio project files. </para> </listitem> </varlistentry> <varlistentry id="cv-MSVSSOLUTIONCOM"> - <term>MSVSSOLUTIONCOM</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0">The action used to generate Microsoft Visual Studio solution files.</para> + <term> + <envar>MSVSSOLUTIONCOM</envar> + </term> + <listitem><para>The action used to generate Microsoft Visual Studio solution files.</para> </listitem> </varlistentry> <varlistentry id="cv-MSVSSOLUTIONSUFFIX"> - <term>MSVSSOLUTIONSUFFIX</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MSVSSOLUTIONSUFFIX</envar> + </term> + <listitem><para> The suffix used for Microsoft Visual Studio solution (DSW) files. The default value is <filename>.sln</filename> when using Visual Studio version 7.x (.NET), and @@ -4604,70 +4975,78 @@ no default value. </listitem> </varlistentry> <varlistentry id="cv-MT"> - <term>MT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MT</envar> + </term> + <listitem><para> The program used on Windows systems to embed manifests into DLLs and EXEs. -See also <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWS_EMBED_MANIFEST"><envar>$WINDOWS_EMBED_MANIFEST</envar></link>. +See also <link linkend="cv-WINDOWS_EMBED_MANIFEST"><envar>$WINDOWS_EMBED_MANIFEST</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-MTEXECOM"> - <term>MTEXECOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MTEXECOM</envar> + </term> + <listitem><para> The Windows command line used to embed manifests into executables. -See also <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MTSHLIBCOM"><envar>$MTSHLIBCOM</envar></link>. +See also <link linkend="cv-MTSHLIBCOM"><envar>$MTSHLIBCOM</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-MTFLAGS"> - <term>MTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Flags passed to the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MT"><envar>$MT</envar></link> manifest embedding program (Windows only). + <term> + <envar>MTFLAGS</envar> + </term> + <listitem><para> +Flags passed to the <link linkend="cv-MT"><envar>$MT</envar></link> manifest embedding program (Windows only). </para> </listitem> </varlistentry> <varlistentry id="cv-MTSHLIBCOM"> - <term>MTSHLIBCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MTSHLIBCOM</envar> + </term> + <listitem><para> The Windows command line used to embed manifests into shared libraries (DLLs). -See also <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MTEXECOM"><envar>$MTEXECOM</envar></link>. +See also <link linkend="cv-MTEXECOM"><envar>$MTEXECOM</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-MWCW_VERSION"> - <term>MWCW_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MWCW_VERSION</envar> + </term> + <listitem><para> The version number of the MetroWerks CodeWarrior C compiler to be used. </para> </listitem> </varlistentry> <varlistentry id="cv-MWCW_VERSIONS"> - <term>MWCW_VERSIONS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>MWCW_VERSIONS</envar> + </term> + <listitem><para> A list of installed versions of the MetroWerks CodeWarrior C compiler on this system. </para> </listitem> </varlistentry> <varlistentry id="cv-NAME"> - <term>NAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>NAME</envar> + </term> + <listitem><para> Specfies the name of the project to package. </para> </listitem> </varlistentry> <varlistentry id="cv-no_import_lib"> - <term>no_import_lib</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>no_import_lib</envar> + </term> + <listitem><para> When set to non-zero, suppresses creation of a corresponding Windows static import lib by the <literal>SharedLibrary</literal> @@ -4680,58 +5059,68 @@ when using Microsoft Visual Studio. </listitem> </varlistentry> <varlistentry id="cv-OBJPREFIX"> - <term>OBJPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>OBJPREFIX</envar> + </term> + <listitem><para> The prefix used for (static) object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-OBJSUFFIX"> - <term>OBJSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>OBJSUFFIX</envar> + </term> + <listitem><para> The suffix used for (static) object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PACKAGEROOT"> - <term>PACKAGEROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PACKAGEROOT</envar> + </term> + <listitem><para> Specifies the directory where all files in resulting archive will be placed if applicable. The default value is "$NAME-$VERSION". </para> </listitem> </varlistentry> <varlistentry id="cv-PACKAGETYPE"> - <term>PACKAGETYPE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PACKAGETYPE</envar> + </term> + <listitem><para> Selects the package type to build. Currently these are available: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - * msi - Microsoft Installer - * rpm - Redhat Package Manger - * ipkg - Itsy Package Management System - * tarbz2 - compressed tar - * targz - compressed tar - * zip - zip file - * src_tarbz2 - compressed tar source - * src_targz - compressed tar source - * src_zip - zip file source -</para> +<blockquote> +<simplelist type="vert" columns="1"> +<member><literal>msi</literal> - Microsoft Installer</member> +<member><literal>rpm</literal> - RPM Package Manger</member> +<member><literal>ipkg</literal> - Itsy Package Management System</member> +<member><literal>tarbz2</literal> - bzip2 compressed tar</member> +<member><literal>targz</literal> - gzip compressed tar</member> +<member><literal>tarxz</literal> - xz compressed tar</member> +<member><literal>zip</literal> - zip file</member> +<member><literal>src_tarbz2</literal> - bzip2 compressed tar source</member> +<member><literal>src_targz</literal> - gzip compressed tar source</member> +<member><literal>src_tarxz</literal> - xz compressed tar source</member> +<member><literal>src_zip</literal> - zip file source</member> +</simplelist> +</blockquote> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This may be overridden with the "package_type" command line option. +<para> +This may be overridden with the <option>package_type</option> +command line option. </para> </listitem> </varlistentry> <varlistentry id="cv-PACKAGEVERSION"> - <term>PACKAGEVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PACKAGEVERSION</envar> + </term> + <listitem><para> The version of the package (not the underlying project). This is currently only used by the rpm packager and should reflect changes in the packaging, @@ -4740,9 +5129,10 @@ not the underlying project code itself. </listitem> </varlistentry> <varlistentry id="cv-PCH"> - <term>PCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PCH</envar> + </term> + <listitem><para> The Microsoft Visual C++ precompiled header that will be used when compiling object files. This variable is ignored by tools other than Microsoft Visual C++. When this variable is @@ -4752,44 +5142,48 @@ dependencies for the PCH file. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['PCH'] = 'StdAfx.pch' </example_commands> </listitem> </varlistentry> <varlistentry id="cv-PCHCOM"> - <term>PCHCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PCHCOM</envar> + </term> + <listitem><para> The command line used by the -<function xmlns="http://www.scons.org/dbxsd/v1.0">PCH</function> +<function>PCH</function> builder to generated a precompiled header. </para> </listitem> </varlistentry> <varlistentry id="cv-PCHCOMSTR"> - <term>PCHCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PCHCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a precompiled header. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PCHCOM"><envar>$PCHCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-PCHCOM"><envar>$PCHCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-PCHPDBFLAGS"> - <term>PCHPDBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PCHPDBFLAGS</envar> + </term> + <listitem><para> A construction variable that, when expanded, adds the <literal>/yD</literal> flag to the command line -only if the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$PDB</envar> construction variable is set. +only if the <envar>$PDB</envar> construction variable is set. </para> </listitem> </varlistentry> <varlistentry id="cv-PCHSTOP"> - <term>PCHSTOP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PCHSTOP</envar> + </term> + <listitem><para> This variable specifies how much of a source file is precompiled. This variable is ignored by tools other than Microsoft Visual C++, or when the PCH variable is not being used. When this variable is define it @@ -4798,15 +5192,16 @@ is included at the end of the precompiled portion of the source files, or the empty string if the "#pragma hrdstop" construct is being used: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['PCHSTOP'] = 'StdAfx.h' </example_commands> </listitem> </varlistentry> <varlistentry id="cv-PDB"> - <term>PDB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PDB</envar> + </term> + <listitem><para> The Microsoft Visual C++ PDB file that will store debugging information for object files, shared libraries, and programs. This variable is ignored by tools other than Microsoft Visual C++. @@ -4817,11 +5212,11 @@ dependencies for the PDB file. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env['PDB'] = 'hello.pdb' </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The Visual C++ compiler switch that SCons uses by default to generate PDB information is <option>/Z7</option>. This works correctly with parallel (<option>-j</option>) builds @@ -4833,116 +5228,128 @@ Using the <option>/Zi</option> instead may yield improved link-time performance, although parallel builds will no longer work. You can generate PDB files with the <option>/Zi</option> -switch by overriding the default <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable; +switch by overriding the default <link linkend="cv-CCPDBFLAGS"><envar>$CCPDBFLAGS</envar></link> variable; see the entry for that variable for specific examples. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFCOM"> - <term>PDFCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-DVIPDFCOM"><envar>$DVIPDFCOM</envar></link>. + <term> + <envar>PDFCOM</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-DVIPDFCOM"><envar>$DVIPDFCOM</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFLATEX"> - <term>PDFLATEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <application xmlns="http://www.scons.org/dbxsd/v1.0">pdflatex</application> utility. + <term> + <envar>PDFLATEX</envar> + </term> + <listitem><para> +The <application>pdflatex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFLATEXCOM"> - <term>PDFLATEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The command line used to call the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdflatex</application> utility. + <term> + <envar>PDFLATEXCOM</envar> + </term> + <listitem><para> +The command line used to call the <application>pdflatex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFLATEXCOMSTR"> - <term>PDFLATEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when calling the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdflatex</application> utility. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PDFLATEXCOM"><envar>$PDFLATEXCOM</envar></link> (the command line) is displayed. + <term> + <envar>PDFLATEXCOMSTR</envar> + </term> + <listitem><para> +The string displayed when calling the <application>pdflatex</application> utility. +If this is not set, then <link linkend="cv-PDFLATEXCOM"><envar>$PDFLATEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-PDFLATEXFLAGS"> - <term>PDFLATEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -General options passed to the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdflatex</application> utility. + <term> + <envar>PDFLATEXFLAGS</envar> + </term> + <listitem><para> +General options passed to the <application>pdflatex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFPREFIX"> - <term>PDFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PDFPREFIX</envar> + </term> + <listitem><para> The prefix used for PDF file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFSUFFIX"> - <term>PDFSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PDFSUFFIX</envar> + </term> + <listitem><para> The suffix used for PDF file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFTEX"> - <term>PDFTEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <application xmlns="http://www.scons.org/dbxsd/v1.0">pdftex</application> utility. + <term> + <envar>PDFTEX</envar> + </term> + <listitem><para> +The <application>pdftex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFTEXCOM"> - <term>PDFTEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The command line used to call the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdftex</application> utility. + <term> + <envar>PDFTEXCOM</envar> + </term> + <listitem><para> +The command line used to call the <application>pdftex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PDFTEXCOMSTR"> - <term>PDFTEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when calling the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdftex</application> utility. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PDFTEXCOM"><envar>$PDFTEXCOM</envar></link> (the command line) is displayed. + <term> + <envar>PDFTEXCOMSTR</envar> + </term> + <listitem><para> +The string displayed when calling the <application>pdftex</application> utility. +If this is not set, then <link linkend="cv-PDFTEXCOM"><envar>$PDFTEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-PDFTEXFLAGS"> - <term>PDFTEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -General options passed to the <application xmlns="http://www.scons.org/dbxsd/v1.0">pdftex</application> utility. + <term> + <envar>PDFTEXFLAGS</envar> + </term> + <listitem><para> +General options passed to the <application>pdftex</application> utility. </para> </listitem> </varlistentry> <varlistentry id="cv-PKGCHK"> - <term>PKGCHK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PKGCHK</envar> + </term> + <listitem><para> On Solaris systems, the package-checking program that will -be used (along with <envar xmlns="http://www.scons.org/dbxsd/v1.0">$PKGINFO</envar>) +be used (along with <envar>$PKGINFO</envar>) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -4951,12 +5358,13 @@ The default is </listitem> </varlistentry> <varlistentry id="cv-PKGINFO"> - <term>PKGINFO</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PKGINFO</envar> + </term> + <listitem><para> On Solaris systems, the package information program that will -be used (along with <envar xmlns="http://www.scons.org/dbxsd/v1.0">$PKGCHK</envar>) +be used (along with <envar>$PKGCHK</envar>) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -4965,16 +5373,17 @@ The default is </listitem> </varlistentry> <varlistentry id="cv-PLATFORM"> - <term>PLATFORM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PLATFORM</envar> + </term> + <listitem><para> The name of the platform used to create the Environment. If no platform is specified when the Environment is created, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> autodetects the platform. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(tools = []) if env['PLATFORM'] == 'cygwin': Tool('mingw')(env) @@ -4984,84 +5393,92 @@ else: </listitem> </varlistentry> <varlistentry id="cv-POAUTOINIT"> - <term>POAUTOINIT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <envar xmlns="http://www.scons.org/dbxsd/v1.0">$POAUTOINIT</envar> variable, if set to <literal>True</literal> (on non-zero -numeric value), let the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool to automatically initialize + <term> + <envar>POAUTOINIT</envar> + </term> + <listitem><para> +The <envar>$POAUTOINIT</envar> variable, if set to <literal>True</literal> (on non-zero +numeric value), let the <link linkend="t-msginit"><literal>msginit</literal></link> tool to automatically initialize <emphasis>missing</emphasis> <literal>PO</literal> files with <command>msginit(1)</command>. This applies to both, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builders (and others that use any of +<link linkend="b-POInit"><function>POInit</function></link> and <link linkend="b-POUpdate"><function>POUpdate</function></link> builders (and others that use any of them). </para> </listitem> </varlistentry> <varlistentry id="cv-POCREATE_ALIAS"> - <term>POCREATE_ALIAS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Common alias for all <literal>PO</literal> files created with <function xmlns="http://www.scons.org/dbxsd/v1.0">POInit</function> + <term> + <envar>POCREATE_ALIAS</envar> + </term> + <listitem><para> +Common alias for all <literal>PO</literal> files created with <function>POInit</function> builder (default: <literal>'po-create'</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-POSUFFIX"> - <term>POSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>POSUFFIX</envar> + </term> + <listitem><para> Suffix used for <literal>PO</literal> files (default: <literal>'.po'</literal>) -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msginit"><literal>msginit</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> builder. +See <link linkend="t-msginit"><literal>msginit</literal></link> tool and <link linkend="b-POInit"><function>POInit</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-POTDOMAIN"> - <term>POTDOMAIN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The <envar xmlns="http://www.scons.org/dbxsd/v1.0">$POTDOMAIN</envar> defines default domain, used to generate -<literal>POT</literal> filename as <filename><envar xmlns="http://www.scons.org/dbxsd/v1.0">$POTDOMAIN</envar>.pot</filename> when + <term> + <envar>POTDOMAIN</envar> + </term> + <listitem><para> +The <envar>$POTDOMAIN</envar> defines default domain, used to generate +<literal>POT</literal> filename as <filename><envar>$POTDOMAIN</envar>.pot</filename> when no <literal>POT</literal> file name is provided by the user. This applies to -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POInit"><function>POInit</function></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builders (and -builders, that use them, e.g. <function xmlns="http://www.scons.org/dbxsd/v1.0">Translate</function>). Normally (if <envar xmlns="http://www.scons.org/dbxsd/v1.0">$POTDOMAIN</envar> is +<link linkend="b-POTUpdate"><function>POTUpdate</function></link>, <link linkend="b-POInit"><function>POInit</function></link> and <link linkend="b-POUpdate"><function>POUpdate</function></link> builders (and +builders, that use them, e.g. <function>Translate</function>). Normally (if <envar>$POTDOMAIN</envar> is not defined), the builders use <filename>messages.pot</filename> as default <literal>POT</literal> file name. </para> </listitem> </varlistentry> <varlistentry id="cv-POTSUFFIX"> - <term>POTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>POTSUFFIX</envar> + </term> + <listitem><para> Suffix used for PO Template files (default: <literal>'.pot'</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-POTUPDATE_ALIAS"> - <term>POTUPDATE_ALIAS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>POTUPDATE_ALIAS</envar> + </term> + <listitem><para> Name of the common phony target for all PO Templates created with -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> (default: <literal>'pot-update'</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +<link linkend="b-POUpdate"><function>POUpdate</function></link> (default: <literal>'pot-update'</literal>). +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-POUPDATE_ALIAS"> - <term>POUPDATE_ALIAS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>POUPDATE_ALIAS</envar> + </term> + <listitem><para> Common alias for all <literal>PO</literal> files being defined with -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder (default: <literal>'po-update'</literal>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POUpdate"><function>POUpdate</function></link> builder. +<link linkend="b-POUpdate"><function>POUpdate</function></link> builder (default: <literal>'po-update'</literal>). +See <link linkend="t-msgmerge"><literal>msgmerge</literal></link> tool and <link linkend="b-POUpdate"><function>POUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-PRINT_CMD_LINE_FUNC"> - <term>PRINT_CMD_LINE_FUNC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PRINT_CMD_LINE_FUNC</envar> + </term> + <listitem><para> A Python function used to print the command lines as they are executed (assuming command printing is not disabled by the <option>-q</option> @@ -5079,20 +5496,20 @@ the source(s) used (file node, list, or string name(s)), and the environment being used. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The function must do the printing itself. The default implementation, used if this variable is not set or is None, is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def print_cmd_line(s, target, source, env): sys.stdout.write(s + "\n") </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Here's an example of a more interesting function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def print_cmd_line(s, target, source, env): sys.stdout.write("Building %s -> %s...\n" % (' and '.join([str(x) for x in source]), @@ -5101,7 +5518,7 @@ env=Environment(PRINT_CMD_LINE_FUNC=print_cmd_line) env.Program('foo', 'foo.c') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This just prints "Building <varname>targetname</varname> from <varname>sourcename</varname>..." instead of the actual commands. Such a function could also log the actual commands to a log file, @@ -5110,307 +5527,342 @@ for example. </listitem> </varlistentry> <varlistentry id="cv-PROGEMITTER"> - <term>PROGEMITTER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PROGEMITTER</envar> + </term> + <listitem><para> Contains the emitter specification for the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Program"><function>Program</function></link> builder. +<link linkend="b-Program"><function>Program</function></link> builder. The manpage section "Builder Objects" contains general information on specifying emitters. </para> </listitem> </varlistentry> <varlistentry id="cv-PROGPREFIX"> - <term>PROGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PROGPREFIX</envar> + </term> + <listitem><para> The prefix used for executable file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PROGSUFFIX"> - <term>PROGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PROGSUFFIX</envar> + </term> + <listitem><para> The suffix used for executable file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PSCOM"> - <term>PSCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PSCOM</envar> + </term> + <listitem><para> The command line used to convert TeX DVI files into a PostScript file. </para> </listitem> </varlistentry> <varlistentry id="cv-PSCOMSTR"> - <term>PSCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PSCOMSTR</envar> + </term> + <listitem><para> The string displayed when a TeX DVI file is converted into a PostScript file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PSCOM"><envar>$PSCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-PSCOM"><envar>$PSCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-PSPREFIX"> - <term>PSPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PSPREFIX</envar> + </term> + <listitem><para> The prefix used for PostScript file names. </para> </listitem> </varlistentry> <varlistentry id="cv-PSSUFFIX"> - <term>PSSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>PSSUFFIX</envar> + </term> + <listitem><para> The prefix used for PostScript file names. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_AUTOSCAN"> - <term>QT_AUTOSCAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_AUTOSCAN</envar> + </term> + <listitem><para> Turn off scanning for mocable files. Use the Moc Builder to explicitly specify files to run moc on. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_BINPATH"> - <term>QT_BINPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_BINPATH</envar> + </term> + <listitem><para> The path where the qt binaries are installed. -The default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/bin'. +The default value is '<link linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/bin'. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_CPPPATH"> - <term>QT_CPPPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_CPPPATH</envar> + </term> + <listitem><para> The path where the qt header files are installed. -The default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/include'. +The default value is '<link linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/include'. Note: If you set this variable to None, -the tool won't change the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link> +the tool won't change the <link linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_DEBUG"> - <term>QT_DEBUG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_DEBUG</envar> + </term> + <listitem><para> Prints lots of debugging information while scanning for moc files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_LIB"> - <term>QT_LIB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_LIB</envar> + </term> + <listitem><para> Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set -this variable to None, the tool won't change the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBS"><envar>$LIBS</envar></link> variable. +this variable to None, the tool won't change the <link linkend="cv-LIBS"><envar>$LIBS</envar></link> variable. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_LIBPATH"> - <term>QT_LIBPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_LIBPATH</envar> + </term> + <listitem><para> The path where the qt libraries are installed. -The default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/lib'. +The default value is '<link linkend="cv-QTDIR"><envar>$QTDIR</envar></link>/lib'. Note: If you set this variable to None, -the tool won't change the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link> +the tool won't change the <link linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOC"> - <term>QT_MOC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QT_BINPATH"><envar>$QT_BINPATH</envar></link>/moc'. + <term> + <envar>QT_MOC</envar> + </term> + <listitem><para> +Default value is '<link linkend="cv-QT_BINPATH"><envar>$QT_BINPATH</envar></link>/moc'. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCCXXPREFIX"> - <term>QT_MOCCXXPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCCXXPREFIX</envar> + </term> + <listitem><para> Default value is ''. Prefix for moc output files, when source is a cxx file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCCXXSUFFIX"> - <term>QT_MOCCXXSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCCXXSUFFIX</envar> + </term> + <listitem><para> Default value is '.moc'. Suffix for moc output files, when source is a cxx file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMCXXCOM"> - <term>QT_MOCFROMCXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMCXXCOM</envar> + </term> + <listitem><para> Command to generate a moc file from a cpp file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMCXXCOMSTR"> - <term>QT_MOCFROMCXXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMCXXCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a moc file from a cpp file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QT_MOCFROMCXXCOM"><envar>$QT_MOCFROMCXXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-QT_MOCFROMCXXCOM"><envar>$QT_MOCFROMCXXCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMCXXFLAGS"> - <term>QT_MOCFROMCXXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMCXXFLAGS</envar> + </term> + <listitem><para> Default value is '-i'. These flags are passed to moc, when moccing a C++ file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMHCOM"> - <term>QT_MOCFROMHCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMHCOM</envar> + </term> + <listitem><para> Command to generate a moc file from a header. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMHCOMSTR"> - <term>QT_MOCFROMHCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMHCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a moc file from a cpp file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QT_MOCFROMHCOM"><envar>$QT_MOCFROMHCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-QT_MOCFROMHCOM"><envar>$QT_MOCFROMHCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCFROMHFLAGS"> - <term>QT_MOCFROMHFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCFROMHFLAGS</envar> + </term> + <listitem><para> Default value is ''. These flags are passed to moc, when moccing a header file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCHPREFIX"> - <term>QT_MOCHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_MOCHPREFIX</envar> + </term> + <listitem><para> Default value is 'moc_'. Prefix for moc output files, when source is a header. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_MOCHSUFFIX"> - <term>QT_MOCHSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link>'. Suffix for moc output files, when source is + <term> + <envar>QT_MOCHSUFFIX</envar> + </term> + <listitem><para> +Default value is '<link linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link>'. Suffix for moc output files, when source is a header. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UIC"> - <term>QT_UIC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QT_BINPATH"><envar>$QT_BINPATH</envar></link>/uic'. + <term> + <envar>QT_UIC</envar> + </term> + <listitem><para> +Default value is '<link linkend="cv-QT_BINPATH"><envar>$QT_BINPATH</envar></link>/uic'. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICCOM"> - <term>QT_UICCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICCOM</envar> + </term> + <listitem><para> Command to generate header files from .ui files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICCOMSTR"> - <term>QT_UICCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating header files from .ui files. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-QT_UICCOM"><envar>$QT_UICCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-QT_UICCOM"><envar>$QT_UICCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICDECLFLAGS"> - <term>QT_UICDECLFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICDECLFLAGS</envar> + </term> + <listitem><para> Default value is ''. These flags are passed to uic, when creating a a h file from a .ui file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICDECLPREFIX"> - <term>QT_UICDECLPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICDECLPREFIX</envar> + </term> + <listitem><para> Default value is ''. Prefix for uic generated header files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICDECLSUFFIX"> - <term>QT_UICDECLSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICDECLSUFFIX</envar> + </term> + <listitem><para> Default value is '.h'. Suffix for uic generated header files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICIMPLFLAGS"> - <term>QT_UICIMPLFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICIMPLFLAGS</envar> + </term> + <listitem><para> Default value is ''. These flags are passed to uic, when creating a cxx file from a .ui file. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICIMPLPREFIX"> - <term>QT_UICIMPLPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UICIMPLPREFIX</envar> + </term> + <listitem><para> Default value is 'uic_'. Prefix for uic generated implementation files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UICIMPLSUFFIX"> - <term>QT_UICIMPLSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Default value is '<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link>'. Suffix for uic generated implementation + <term> + <envar>QT_UICIMPLSUFFIX</envar> + </term> + <listitem><para> +Default value is '<link linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link>'. Suffix for uic generated implementation files. </para> </listitem> </varlistentry> <varlistentry id="cv-QT_UISUFFIX"> - <term>QT_UISUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QT_UISUFFIX</envar> + </term> + <listitem><para> Default value is '.ui'. Suffix of designer input files. </para> </listitem> </varlistentry> <varlistentry id="cv-QTDIR"> - <term>QTDIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>QTDIR</envar> + </term> + <listitem><para> The qt tool tries to take this from os.environ. It also initializes all QT_* construction variables listed below. @@ -5419,24 +5871,24 @@ with python's os.path.join() method, but are listed here with the '/' separator for easier reading.) In addition, the construction environment -variables <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBS"><envar>$LIBS</envar></link> may be modified +variables <link linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>, +<link linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link> and +<link linkend="cv-LIBS"><envar>$LIBS</envar></link> may be modified and the variables -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-PROGEMITTER"><envar>$PROGEMITTER</envar></link>, <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBEMITTER"><envar>$SHLIBEMITTER</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBEMITTER"><envar>$LIBEMITTER</envar></link> +<link linkend="cv-PROGEMITTER"><envar>$PROGEMITTER</envar></link>, <link linkend="cv-SHLIBEMITTER"><envar>$SHLIBEMITTER</envar></link> and <link linkend="cv-LIBEMITTER"><envar>$LIBEMITTER</envar></link> are modified. Because the build-performance is affected when using this tool, you have to explicitly specify it at Environment creation: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Environment(tools=['default','qt']) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The qt tool supports the following operations: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis role="strong">Automatic moc file generation from header files.</emphasis> You do not have to specify moc files explicitly, the tool does it for you. However, there are a few preconditions to do so: Your header file must have @@ -5444,11 +5896,11 @@ the same filebase as your implementation file and must stay in the same directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. See also the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">Moc</function>() +<function>Moc</function>() builder method. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis role="strong">Automatic moc file generation from cxx files.</emphasis> As stated in the qt documentation, include the moc file at the end of the cxx file. Note that you have to include the file, which is generated @@ -5457,11 +5909,11 @@ by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by d do not include the correct file. If you are using VariantDir, you may need to specify duplicate=1. You can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. See also the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">Moc</function> +<function>Moc</function> builder method. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <emphasis role="strong">Automatic handling of .ui files.</emphasis> The implementation files generated from .ui files are handled much the same as yacc or lex files. Each .ui file given as a source of Program, Library or @@ -5469,168 +5921,184 @@ SharedLibrary will generate three files, the declaration file, the implementation file and a moc file. Because there are also generated headers, you may need to specify duplicate=1 in calls to VariantDir. See also the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">Uic</function> +<function>Uic</function> builder method. </para> </listitem> </varlistentry> <varlistentry id="cv-RANLIB"> - <term>RANLIB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RANLIB</envar> + </term> + <listitem><para> The archive indexer. </para> </listitem> </varlistentry> <varlistentry id="cv-RANLIBCOM"> - <term>RANLIBCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RANLIBCOM</envar> + </term> + <listitem><para> The command line used to index a static library archive. </para> </listitem> </varlistentry> <varlistentry id="cv-RANLIBCOMSTR"> - <term>RANLIBCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RANLIBCOMSTR</envar> + </term> + <listitem><para> The string displayed when a static library archive is indexed. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RANLIBCOM"><envar>$RANLIBCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-RANLIBCOM"><envar>$RANLIBCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(RANLIBCOMSTR = "Indexing $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-RANLIBFLAGS"> - <term>RANLIBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RANLIBFLAGS</envar> + </term> + <listitem><para> General options passed to the archive indexer. </para> </listitem> </varlistentry> <varlistentry id="cv-RC"> - <term>RC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RC</envar> + </term> + <listitem><para> The resource compiler used to build a Microsoft Visual C++ resource file. </para> </listitem> </varlistentry> <varlistentry id="cv-RCCOM"> - <term>RCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCCOM</envar> + </term> + <listitem><para> The command line used to build a Microsoft Visual C++ resource file. </para> </listitem> </varlistentry> <varlistentry id="cv-RCCOMSTR"> - <term>RCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCCOMSTR</envar> + </term> + <listitem><para> The string displayed when invoking the resource compiler to build a Microsoft Visual C++ resource file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RCCOM"><envar>$RCCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-RCCOM"><envar>$RCCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-RCFLAGS"> - <term>RCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCFLAGS</envar> + </term> + <listitem><para> The flags passed to the resource compiler by the RES builder. </para> </listitem> </varlistentry> <varlistentry id="cv-RCINCFLAGS"> - <term>RCINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCINCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the command-line options for specifying directories to be searched by the resource compiler. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCFLAGS</envar> is created +The value of <envar>$RCINCFLAGS</envar> is created by respectively prepending and appending -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCSUFFIX</envar> +<envar>$RCINCPREFIX</envar> and <envar>$RCINCSUFFIX</envar> to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar>. +of each directory in <envar>$CPPPATH</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-RCINCPREFIX"> - <term>RCINCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCINCPREFIX</envar> + </term> + <listitem><para> The prefix (flag) used to specify an include directory on the resource compiler command line. This will be prepended to the beginning of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCFLAGS</envar> variable is expanded. +in the <envar>$CPPPATH</envar> construction variable +when the <envar>$RCINCFLAGS</envar> variable is expanded. </para> </listitem> </varlistentry> <varlistentry id="cv-RCINCSUFFIX"> - <term>RCINCSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RCINCSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify an include directory on the resource compiler command line. This will be appended to the end of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCFLAGS</envar> variable is expanded. +in the <envar>$CPPPATH</envar> construction variable +when the <envar>$RCINCFLAGS</envar> variable is expanded. </para> </listitem> </varlistentry> <varlistentry id="cv-RDirs"> - <term>RDirs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RDirs</envar> + </term> + <listitem><para> A function that converts a string into a list of Dir instances by searching the repositories. </para> </listitem> </varlistentry> <varlistentry id="cv-REGSVR"> - <term>REGSVR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>REGSVR</envar> + </term> + <listitem><para> The program used on Windows systems to register a newly-built DLL library -whenever the <function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function> builder +whenever the <function>SharedLibrary</function> builder is passed a keyword argument of <literal>register=1</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-REGSVRCOM"> - <term>REGSVRCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>REGSVRCOM</envar> + </term> + <listitem><para> The command line used on Windows systems to register a newly-built DLL library -whenever the <function xmlns="http://www.scons.org/dbxsd/v1.0">SharedLibrary</function> builder +whenever the <function>SharedLibrary</function> builder is passed a keyword argument of <literal>register=1</literal>. </para> </listitem> </varlistentry> <varlistentry id="cv-REGSVRCOMSTR"> - <term>REGSVRCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>REGSVRCOMSTR</envar> + </term> + <listitem><para> The string displayed when registering a newly-built DLL file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-REGSVRCOM"><envar>$REGSVRCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-REGSVRCOM"><envar>$REGSVRCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-REGSVRFLAGS"> - <term>REGSVRFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>REGSVRFLAGS</envar> + </term> + <listitem><para> Flags passed to the DLL registration program on Windows systems when a newly-built DLL library is registered. By default, @@ -5641,170 +6109,185 @@ and requiring user attention. </listitem> </varlistentry> <varlistentry id="cv-RMIC"> - <term>RMIC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RMIC</envar> + </term> + <listitem><para> The Java RMI stub compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-RMICCOM"> - <term>RMICCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RMICCOM</envar> + </term> + <listitem><para> The command line used to compile stub and skeleton class files from Java classes that contain RMI implementations. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RMICFLAGS"><envar>$RMICFLAGS</envar></link> construction variable +Any options specified in the <link linkend="cv-RMICFLAGS"><envar>$RMICFLAGS</envar></link> construction variable are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-RMICCOMSTR"> - <term>RMICCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RMICCOMSTR</envar> + </term> + <listitem><para> The string displayed when compiling stub and skeleton class files from Java classes that contain RMI implementations. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RMICCOM"><envar>$RMICCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-RMICCOM"><envar>$RMICCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(RMICCOMSTR = "Generating stub/skeleton class files $TARGETS from $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-RMICFLAGS"> - <term>RMICFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RMICFLAGS</envar> + </term> + <listitem><para> General options passed to the Java RMI stub compiler. </para> </listitem> </varlistentry> - <varlistentry id="cv-_RPATH"> - <term>_RPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -An automatically-generated construction variable -containing the rpath flags to be used when linking -a program with shared libraries. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_RPATH</envar> is created -by respectively prepending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATHPREFIX</envar> and appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATHSUFFIX</envar> -to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATH</envar>. -</para> -</listitem> - </varlistentry> <varlistentry id="cv-RPATH"> - <term>RPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPATH</envar> + </term> + <listitem><para> A list of paths to search for shared libraries when running programs. Currently only used in the GNU (gnulink), IRIX (sgilink) and Sun (sunlink) linkers. Ignored on platforms and toolchains that don't support it. Note that the paths added to RPATH are not transformed by -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> in any way: if you want an absolute path, you must make it absolute yourself. </para> </listitem> </varlistentry> + <varlistentry id="cv-_RPATH"> + <term> + <envar>_RPATH</envar> + </term> + <listitem><para> +An automatically-generated construction variable +containing the rpath flags to be used when linking +a program with shared libraries. +The value of <envar>$_RPATH</envar> is created +by respectively prepending <envar>$RPATHPREFIX</envar> and appending <envar>$RPATHSUFFIX</envar> +to the beginning and end +of each directory in <envar>$RPATH</envar>. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-RPATHPREFIX"> - <term>RPATHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPATHPREFIX</envar> + </term> + <listitem><para> The prefix used to specify a directory to be searched for shared libraries when running programs. This will be prepended to the beginning of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_RPATH</envar> variable is automatically generated. +in the <envar>$RPATH</envar> construction variable +when the <envar>$_RPATH</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-RPATHSUFFIX"> - <term>RPATHSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPATHSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify a directory to be searched for shared libraries when running programs. This will be appended to the end of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_RPATH</envar> variable is automatically generated. +in the <envar>$RPATH</envar> construction variable +when the <envar>$_RPATH</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGEN"> - <term>RPCGEN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGEN</envar> + </term> + <listitem><para> The RPC protocol compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGENCLIENTFLAGS"> - <term>RPCGENCLIENTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGENCLIENTFLAGS</envar> + </term> + <listitem><para> Options passed to the RPC protocol compiler when generating client side stubs. These are in addition to any flags specified in the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> +<link linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGENFLAGS"> - <term>RPCGENFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGENFLAGS</envar> + </term> + <listitem><para> General options passed to the RPC protocol compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGENHEADERFLAGS"> - <term>RPCGENHEADERFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGENHEADERFLAGS</envar> + </term> + <listitem><para> Options passed to the RPC protocol compiler when generating a header file. These are in addition to any flags specified in the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> +<link linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGENSERVICEFLAGS"> - <term>RPCGENSERVICEFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGENSERVICEFLAGS</envar> + </term> + <listitem><para> Options passed to the RPC protocol compiler when generating server side stubs. These are in addition to any flags specified in the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> +<link linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-RPCGENXDRFLAGS"> - <term>RPCGENXDRFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>RPCGENXDRFLAGS</envar> + </term> + <listitem><para> Options passed to the RPC protocol compiler when generating XDR routines. These are in addition to any flags specified in the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> +<link linkend="cv-RPCGENFLAGS"><envar>$RPCGENFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-SCANNERS"> - <term>SCANNERS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SCANNERS</envar> + </term> + <listitem><para> A list of the available implicit dependency scanners. New file scanners may be added by appending to this list, @@ -5818,231 +6301,279 @@ for more information. </listitem> </varlistentry> <varlistentry id="cv-SCONS_HOME"> - <term>SCONS_HOME</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SCONS_HOME</envar> + </term> + <listitem><para> The (optional) path to the SCons library directory, initialized from the external environment. If set, this is used to construct a shorter and more efficient search path in - the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MSVSSCONS"><envar>$MSVSSCONS</envar></link> command line executed from Microsoft + the <link linkend="cv-MSVSSCONS"><envar>$MSVSSCONS</envar></link> command line executed from Microsoft Visual Studio project files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCC"> - <term>SHCC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCC</envar> + </term> + <listitem><para> The C compiler used for generating shared-library objects. +See also <link linkend="cv-CC"><envar>$CC</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCCCOM"> - <term>SHCCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCCCOM</envar> + </term> + <listitem><para> The command line used to compile a C source file to a shared-library object file. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCFLAGS"><envar>$SHCFLAGS</envar></link>, -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCCFLAGS"><envar>$SHCCFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHCFLAGS"><envar>$SHCFLAGS</envar></link>, +<link linkend="cv-SHCCFLAGS"><envar>$SHCCFLAGS</envar></link> and +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. +See also <link linkend="cv-CCCOM"><envar>$CCCOM</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCCCOMSTR"> - <term>SHCCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a C source file + <term> + <envar>SHCCCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a C source file is compiled to a shared object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link> (the command line) is displayed. +If not set, then <link linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-CCCOMSTR"><envar>$CCCOMSTR</envar></link> for compiling to static objects. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-SHCCFLAGS"> - <term>SHCCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCCFLAGS</envar> + </term> + <listitem><para> Options that are passed to the C and C++ compilers to generate shared-library objects. +See also <link linkend="cv-CCFLAGS"><envar>$CCFLAGS</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCFLAGS"> - <term>SHCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCFLAGS</envar> + </term> + <listitem><para> Options that are passed to the C compiler (only; not C++) to generate shared-library objects. +See also <link linkend="cv-CFLAGS"><envar>$CFLAGS</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCXX"> - <term>SHCXX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCXX</envar> + </term> + <listitem><para> The C++ compiler used for generating shared-library objects. +See also <link linkend="cv-CXX"><envar>$CXX</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCXXCOM"> - <term>SHCXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCXXCOM</envar> + </term> + <listitem><para> The command line used to compile a C++ source file to a shared-library object file. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCXXFLAGS"><envar>$SHCXXFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHCXXFLAGS"><envar>$SHCXXFLAGS</envar></link> and +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. +See also <link linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCXXCOMSTR"> - <term>SHCXXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a C++ source file + <term> + <envar>SHCXXCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a C++ source file is compiled to a shared object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> (the command line) is displayed. +If not set, then <link linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-CXXCOMSTR"><envar>$CXXCOMSTR</envar></link> for compiling to static objects. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-SHCXXFLAGS"> - <term>SHCXXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHCXXFLAGS</envar> + </term> + <listitem><para> Options that are passed to the C++ compiler to generate shared-library objects. +See also <link linkend="cv-CXXFLAGS"><envar>$CXXFLAGS</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDC"> - <term>SHDC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDC</envar> + </term> + <listitem><para> The name of the compiler to use when compiling D source destined to be in a shared objects. +See also <link linkend="cv-DC"><envar>$DC</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDCOM"> - <term>SHDCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDCOM</envar> + </term> + <listitem><para> The command line to use when compiling code to be part of shared objects. +See also <link linkend="cv-DCOM"><envar>$DCOM</envar></link> for compiling to static objects. +</para> +</listitem> + </varlistentry> + <varlistentry id="cv-SHDCOMSTR"> + <term> + <envar>SHDCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a D source file +is compiled to a (shared) object file. +If not set, then <link linkend="cv-SHDCOM"><envar>$SHDCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-DCOMSTR"><envar>$DCOMSTR</envar></link> for compiling to static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLIBVERSION"> - <term>SHDLIBVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDLIBVERSION</envar> + </term> + <listitem><para> SHDLIBVERSION. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLIBVERSIONFLAGS"> - <term>SHDLIBVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDLIBVERSIONFLAGS</envar> + </term> + <listitem><para> SHDLIBVERSIONFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINK"> - <term>SHDLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDLINK</envar> + </term> + <listitem><para> The linker to use when creating shared objects for code bases include D sources. +See also <link linkend="cv-DLINK"><envar>$DLINK</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINKCOM"> - <term>SHDLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDLINKCOM</envar> + </term> + <listitem><para> The command line to use when generating shared objects. +See also <link linkend="cv-DLINKCOM"><envar>$DLINKCOM</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINKFLAGS"> - <term>SHDLINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHDLINKFLAGS</envar> + </term> + <listitem><para> The list of flags to use when generating a shared object. +See also <link linkend="cv-DLINKFLAGS"><envar>$DLINKFLAGS</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHELL"> - <term>SHELL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHELL</envar> + </term> + <listitem><para> A string naming the shell program that will be passed to the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SPAWN</envar> +<envar>$SPAWN</envar> function. See the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SPAWN</envar> +<envar>$SPAWN</envar> construction variable for more information. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF03"> - <term>SHF03</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF03</envar> + </term> + <listitem><para> The Fortran 03 compiler used for generating shared-library objects. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03"><envar>$SHF03</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-SHF03"><envar>$SHF03</envar></link> if you need to use a specific compiler or compiler version for Fortran 03 files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF03COM"> - <term>SHF03COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF03COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 03 source file to a shared-library object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03COM"><envar>$SHF03COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF03COM"><envar>$SHF03COM</envar></link> if you need to use a specific command line for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF03COMSTR"> - <term>SHF03COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 03 source file + <term> + <envar>SHF03COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03COM"><envar>$SHF03COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHF03COM"><envar>$SHF03COM</envar></link> or <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF03FLAGS"> - <term>SHF03FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF03FLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran 03 compiler to generated shared-library objects. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03FLAGS"><envar>$SHF03FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-SHF03FLAGS"><envar>$SHF03FLAGS</envar></link> if you need to define specific user options for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6050,81 +6581,87 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-SHF03PPCOM"> - <term>SHF03PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF03PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 03 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03FLAGS"><envar>$SHF03FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHF03FLAGS"><envar>$SHF03FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03PPCOM"><envar>$SHF03PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF03PPCOM"><envar>$SHF03PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 03 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF03PPCOMSTR"> - <term>SHF03PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 03 source file + <term> + <envar>SHF03PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF03PPCOM"><envar>$SHF03PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHF03PPCOM"><envar>$SHF03PPCOM</envar></link> or <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF08"> - <term>SHF08</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF08</envar> + </term> + <listitem><para> The Fortran 08 compiler used for generating shared-library objects. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08"><envar>$SHF08</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-SHF08"><envar>$SHF08</envar></link> if you need to use a specific compiler or compiler version for Fortran 08 files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF08COM"> - <term>SHF08COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF08COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 08 source file to a shared-library object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08COM"><envar>$SHF08COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF08COM"><envar>$SHF08COM</envar></link> if you need to use a specific command line for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF08COMSTR"> - <term>SHF08COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 08 source file + <term> + <envar>SHF08COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 08 source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08COM"><envar>$SHF08COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHF08COM"><envar>$SHF08COM</envar></link> or <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF08FLAGS"> - <term>SHF08FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF08FLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran 08 compiler to generated shared-library objects. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08FLAGS"><envar>$SHF08FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-SHF08FLAGS"><envar>$SHF08FLAGS</envar></link> if you need to define specific user options for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6132,81 +6669,87 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-SHF08PPCOM"> - <term>SHF08PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF08PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 08 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08FLAGS"><envar>$SHF08FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHF08FLAGS"><envar>$SHF08FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08PPCOM"><envar>$SHF08PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF08PPCOM"><envar>$SHF08PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 08 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF08PPCOMSTR"> - <term>SHF08PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 08 source file + <term> + <envar>SHF08PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 08 source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF08PPCOM"><envar>$SHF08PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHF08PPCOM"><envar>$SHF08PPCOM</envar></link> or <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF77"> - <term>SHF77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF77</envar> + </term> + <listitem><para> The Fortran 77 compiler used for generating shared-library objects. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77"><envar>$SHF77</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-SHF77"><envar>$SHF77</envar></link> if you need to use a specific compiler or compiler version for Fortran 77 files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF77COM"> - <term>SHF77COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF77COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 77 source file to a shared-library object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77COM"><envar>$SHF77COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF77COM"><envar>$SHF77COM</envar></link> if you need to use a specific command line for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF77COMSTR"> - <term>SHF77COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 77 source file + <term> + <envar>SHF77COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77COM"><envar>$SHF77COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHF77COM"><envar>$SHF77COM</envar></link> or <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF77FLAGS"> - <term>SHF77FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF77FLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran 77 compiler to generated shared-library objects. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77FLAGS"><envar>$SHF77FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-SHF77FLAGS"><envar>$SHF77FLAGS</envar></link> if you need to define specific user options for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6214,81 +6757,87 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-SHF77PPCOM"> - <term>SHF77PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF77PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 77 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77FLAGS"><envar>$SHF77FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHF77FLAGS"><envar>$SHF77FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 77 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF77PPCOMSTR"> - <term>SHF77PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 77 source file + <term> + <envar>SHF77PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHF77PPCOM"><envar>$SHF77PPCOM</envar></link> or <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF90"> - <term>SHF90</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF90</envar> + </term> + <listitem><para> The Fortran 90 compiler used for generating shared-library objects. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90"><envar>$SHF90</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-SHF90"><envar>$SHF90</envar></link> if you need to use a specific compiler or compiler version for Fortran 90 files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF90COM"> - <term>SHF90COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF90COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 90 source file to a shared-library object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90COM"><envar>$SHF90COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF90COM"><envar>$SHF90COM</envar></link> if you need to use a specific command line for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF90COMSTR"> - <term>SHF90COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 90 source file + <term> + <envar>SHF90COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90COM"><envar>$SHF90COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHF90COM"><envar>$SHF90COM</envar></link> or <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF90FLAGS"> - <term>SHF90FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF90FLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran 90 compiler to generated shared-library objects. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90FLAGS"><envar>$SHF90FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-SHF90FLAGS"><envar>$SHF90FLAGS</envar></link> if you need to define specific user options for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6296,81 +6845,87 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-SHF90PPCOM"> - <term>SHF90PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF90PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 90 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90FLAGS"><envar>$SHF90FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHF90FLAGS"><envar>$SHF90FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90PPCOM"><envar>$SHF90PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF90PPCOM"><envar>$SHF90PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 90 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF90PPCOMSTR"> - <term>SHF90PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 90 source file + <term> + <envar>SHF90PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF90PPCOM"><envar>$SHF90PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHF90PPCOM"><envar>$SHF90PPCOM</envar></link> or <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF95"> - <term>SHF95</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF95</envar> + </term> + <listitem><para> The Fortran 95 compiler used for generating shared-library objects. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRAN"><envar>$SHFORTRAN</envar></link> variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95"><envar>$SHF95</envar></link> if you need to use a specific compiler +You only need to set <link linkend="cv-SHF95"><envar>$SHF95</envar></link> if you need to use a specific compiler or compiler version for Fortran 95 files. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF95COM"> - <term>SHF95COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF95COM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 95 source file to a shared-library object file. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95COM"><envar>$SHF95COM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF95COM"><envar>$SHF95COM</envar></link> if you need to use a specific command line for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> variable, which specifies the default command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF95COMSTR"> - <term>SHF95COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 95 source file + <term> + <envar>SHF95COMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95COM"><envar>$SHF95COM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHF95COM"><envar>$SHF95COM</envar></link> or <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF95FLAGS"> - <term>SHF95FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF95FLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran 95 compiler to generated shared-library objects. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95FLAGS"><envar>$SHF95FLAGS</envar></link> if you need to define specific +You only need to set <link linkend="cv-SHF95FLAGS"><envar>$SHF95FLAGS</envar></link> if you need to define specific user options for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6378,164 +6933,179 @@ for all Fortran versions. </listitem> </varlistentry> <varlistentry id="cv-SHF95PPCOM"> - <term>SHF95PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHF95PPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran 95 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95FLAGS"><envar>$SHF95FLAGS</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +Any options specified in the <link linkend="cv-SHF95FLAGS"><envar>$SHF95FLAGS</envar></link> and <link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. -You only need to set <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95PPCOM"><envar>$SHF95PPCOM</envar></link> if you need to use a specific +You only need to set <link linkend="cv-SHF95PPCOM"><envar>$SHF95PPCOM</envar></link> if you need to use a specific C-preprocessor command line for Fortran 95 files. -You should normally set the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, +You should normally set the <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> variable, which specifies the default C-preprocessor command line for all Fortran versions. </para> </listitem> </varlistentry> <varlistentry id="cv-SHF95PPCOMSTR"> - <term>SHF95PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran 95 source file + <term> + <envar>SHF95PPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHF95PPCOM"><envar>$SHF95PPCOM</envar></link> or <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHF95PPCOM"><envar>$SHF95PPCOM</envar></link> or <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRAN"> - <term>SHFORTRAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHFORTRAN</envar> + </term> + <listitem><para> The default Fortran compiler used for generating shared-library objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRANCOM"> - <term>SHFORTRANCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHFORTRANCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran source file to a shared-library object file. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRANCOMSTR"> - <term>SHFORTRANCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran source file + <term> + <envar>SHFORTRANCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran source file is compiled to a shared-library object file. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> +If not set, then <link linkend="cv-SHFORTRANCOM"><envar>$SHFORTRANCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRANFLAGS"> - <term>SHFORTRANFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHFORTRANFLAGS</envar> + </term> + <listitem><para> Options that are passed to the Fortran compiler to generate shared-library objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRANPPCOM"> - <term>SHFORTRANPPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHFORTRANPPCOM</envar> + </term> + <listitem><para> The command line used to compile a Fortran source file to a shared-library object file after first running the file through the C preprocessor. Any options specified -in the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables +in the <link linkend="cv-SHFORTRANFLAGS"><envar>$SHFORTRANFLAGS</envar></link> and +<link linkend="cv-CPPFLAGS"><envar>$CPPFLAGS</envar></link> construction variables are included on this command line. </para> </listitem> </varlistentry> <varlistentry id="cv-SHFORTRANPPCOMSTR"> - <term>SHFORTRANPPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string displayed when a Fortran source file + <term> + <envar>SHFORTRANPPCOMSTR</envar> + </term> + <listitem><para> +If set, the string displayed when a Fortran source file is compiled to a shared-library object file after first running the file through the C preprocessor. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> +If not set, then <link linkend="cv-SHFORTRANPPCOM"><envar>$SHFORTRANPPCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBEMITTER"> - <term>SHLIBEMITTER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLIBEMITTER</envar> + </term> + <listitem><para> Contains the emitter specification for the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. +<link linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. The manpage section "Builder Objects" contains general information on specifying emitters. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBNOVERSIONSYMLINKS"> - <term>SHLIBNOVERSIONSYMLINKS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Instructs the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder to not create symlinks for versioned + <term> + <envar>SHLIBNOVERSIONSYMLINKS</envar> + </term> + <listitem><para> +Instructs the <link linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder to not create symlinks for versioned shared libraries. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBPREFIX"> - <term>SHLIBPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLIBPREFIX</envar> + </term> + <listitem><para> The prefix used for shared library file names. </para> </listitem> </varlistentry> <varlistentry id="cv-_SHLIBSONAME"> - <term>_SHLIBSONAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_SHLIBSONAME</envar> + </term> + <listitem><para> A macro that automatically generates shared library's SONAME based on $TARGET, -$SHLIBVERSION and $SHLIBSUFFIX. Used by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder when -the linker tool supports SONAME (e.g. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gnulink"><literal>gnulink</literal></link>). +$SHLIBVERSION and $SHLIBSUFFIX. Used by <link linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder when +the linker tool supports SONAME (e.g. <link linkend="t-gnulink"><literal>gnulink</literal></link>). </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBSUFFIX"> - <term>SHLIBSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLIBSUFFIX</envar> + </term> + <listitem><para> The suffix used for shared library file names. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBVERSION"> - <term>SHLIBVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLIBVERSION</envar> + </term> + <listitem><para> When this construction variable is defined, a versioned shared library -is created by the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. This activates the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_SHLIBVERSIONFLAGS"><envar>$_SHLIBVERSIONFLAGS</envar></link> and thus modifies the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> as +is created by the <link linkend="b-SharedLibrary"><function>SharedLibrary</function></link> builder. This activates the +<link linkend="cv-_SHLIBVERSIONFLAGS"><envar>$_SHLIBVERSIONFLAGS</envar></link> and thus modifies the <link linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> as required, adds the version number to the library name, and creates the symlinks -that are needed. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> versions should exist as alpha-numeric, +that are needed. <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> versions should exist as alpha-numeric, decimal-delimited values as defined by the regular expression "\w+[\.\w+]*". -Example <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> values include '1', '1.2.3', and '1.2.gitaa412c8b'. +Example <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> values include '1', '1.2.3', and '1.2.gitaa412c8b'. </para> </listitem> </varlistentry> <varlistentry id="cv-_SHLIBVERSIONFLAGS"> - <term>_SHLIBVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This macro automatically introduces extra flags to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when -building versioned <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link> (that is when <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> -is set). <literal>_SHLIBVERSIONFLAGS</literal> usually adds <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSIONFLAGS"><envar>$SHLIBVERSIONFLAGS</envar></link> + <term> + <envar>_SHLIBVERSIONFLAGS</envar> + </term> + <listitem><para> +This macro automatically introduces extra flags to <link linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when +building versioned <link linkend="b-SharedLibrary"><function>SharedLibrary</function></link> (that is when <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> +is set). <literal>_SHLIBVERSIONFLAGS</literal> usually adds <link linkend="cv-SHLIBVERSIONFLAGS"><envar>$SHLIBVERSIONFLAGS</envar></link> and some extra dynamically generated options (such as <literal>-Wl,-soname=$_SHLIBSONAME</literal>. It is unused by "plain" (unversioned) shared libraries. @@ -6543,101 +7113,114 @@ and some extra dynamically generated options (such as </listitem> </varlistentry> <varlistentry id="cv-SHLIBVERSIONFLAGS"> - <term>SHLIBVERSIONFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Extra flags added to <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when building versioned -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-SharedLibrary"><function>SharedLibrary</function></link>. These flags are only used when <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is + <term> + <envar>SHLIBVERSIONFLAGS</envar> + </term> + <listitem><para> +Extra flags added to <link linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> when building versioned +<link linkend="b-SharedLibrary"><function>SharedLibrary</function></link>. These flags are only used when <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is set. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLINK"> - <term>SHLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLINK</envar> + </term> + <listitem><para> The linker for programs that use shared libraries. +See also <link linkend="cv-LINK"><envar>$LINK</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLINKCOM"> - <term>SHLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLINKCOM</envar> + </term> + <listitem><para> The command line used to link programs using shared libraries. +See also <link linkend="cv-LINKCOM"><envar>$LINKCOM</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLINKCOMSTR"> - <term>SHLINKCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLINKCOMSTR</envar> + </term> + <listitem><para> The string displayed when programs using shared libraries are linked. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-SHLINKCOM"><envar>$SHLINKCOM</envar></link> (the command line) is displayed. +See also <link linkend="cv-LINKCOMSTR"><envar>$LINKCOMSTR</envar></link> for linking static objects. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(SHLINKCOMSTR = "Linking shared $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-SHLINKFLAGS"> - <term>SHLINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHLINKFLAGS</envar> + </term> + <listitem><para> General user options passed to the linker for programs using shared libraries. Note that this variable should <emphasis>not</emphasis> contain <option>-l</option> -(or similar) options for linking with the libraries listed in <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBS"><envar>$LIBS</envar></link>, +(or similar) options for linking with the libraries listed in <link linkend="cv-LIBS"><envar>$LIBS</envar></link>, nor <option>-L</option> (or similar) include search path options -that scons generates automatically from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>. +that scons generates automatically from <link linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>. See -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LIBFLAGS"><envar>$_LIBFLAGS</envar></link> +<link linkend="cv-_LIBFLAGS"><envar>$_LIBFLAGS</envar></link> above, for the variable that expands to library-link options, and -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-_LIBDIRFLAGS"><envar>$_LIBDIRFLAGS</envar></link> +<link linkend="cv-_LIBDIRFLAGS"><envar>$_LIBDIRFLAGS</envar></link> above, for the variable that expands to library search path options. +See also <link linkend="cv-LINKFLAGS"><envar>$LINKFLAGS</envar></link> for linking static objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHOBJPREFIX"> - <term>SHOBJPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHOBJPREFIX</envar> + </term> + <listitem><para> The prefix used for shared object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-SHOBJSUFFIX"> - <term>SHOBJSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SHOBJSUFFIX</envar> + </term> + <listitem><para> The suffix used for shared object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-SONAME"> - <term>SONAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SONAME</envar> + </term> + <listitem><para> Variable used to hard-code SONAME for versioned shared library/loadable module. <example_commands> env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SONAME='libtest.so.2') </example_commands> -The variable is used, for example, by <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-gnulink"><literal>gnulink</literal></link> linker tool. +The variable is used, for example, by <link linkend="t-gnulink"><literal>gnulink</literal></link> linker tool. </para> </listitem> </varlistentry> <varlistentry id="cv-SOURCE"> - <term>SOURCE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SOURCE</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -6646,9 +7229,10 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-SOURCE_URL"> - <term>SOURCE_URL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SOURCE_URL</envar> + </term> + <listitem><para> The URL (web address) of the location from which the project was retrieved. @@ -6659,9 +7243,10 @@ field in the controlling information for Ipkg and RPM packages. </listitem> </varlistentry> <varlistentry id="cv-SOURCES"> - <term>SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SOURCES</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -6670,18 +7255,19 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-SPAWN"> - <term>SPAWN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SPAWN</envar> + </term> + <listitem><para> A command interpreter function that will be called to execute command line strings. The function must expect the following arguments: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> def spawn(shell, escape, cmd, args, env): </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <varname>sh</varname> is a string naming the shell program to use. <varname>escape</varname> @@ -6698,18 +7284,20 @@ in which the command should be executed. </listitem> </varlistentry> <varlistentry id="cv-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"> - <term>STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</term> - <listitem> - <para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</envar> + </term> + <listitem><para> When this variable is true, static objects and shared objects are assumed to be the same; that is, SCons does not check for linking static objects into a shared library. </para> </listitem> </varlistentry> <varlistentry id="cv-SUBST_DICT"> - <term>SUBST_DICT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The dictionary used by the <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> or <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> builders + <term> + <envar>SUBST_DICT</envar> + </term> + <listitem><para> +The dictionary used by the <function>Substfile</function> or <function>Textfile</function> builders for substitution values. It can be anything acceptable to the dict() constructor, so in addition to a dictionary, @@ -6718,27 +7306,30 @@ lists of tuples are also acceptable. </listitem> </varlistentry> <varlistentry id="cv-SUBSTFILEPREFIX"> - <term>SUBSTFILEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The prefix used for <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> file names, -the null string by default. + <term> + <envar>SUBSTFILEPREFIX</envar> + </term> + <listitem><para> +The prefix used for <function>Substfile</function> file names, +an empty string by default. </para> </listitem> </varlistentry> <varlistentry id="cv-SUBSTFILESUFFIX"> - <term>SUBSTFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The suffix used for <function xmlns="http://www.scons.org/dbxsd/v1.0">Substfile</function> file names, -the null string by default. + <term> + <envar>SUBSTFILESUFFIX</envar> + </term> + <listitem><para> +The suffix used for <function>Substfile</function> file names, +an empty string by default. </para> </listitem> </varlistentry> <varlistentry id="cv-SUMMARY"> - <term>SUMMARY</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SUMMARY</envar> + </term> + <listitem><para> A short summary of what the project is about. This is used to fill in the <literal>Summary:</literal> @@ -6750,72 +7341,78 @@ field in MSI packages. </listitem> </varlistentry> <varlistentry id="cv-SWIG"> - <term>SWIG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIG</envar> + </term> + <listitem><para> The scripting language wrapper and interface generator. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGCFILESUFFIX"> - <term>SWIGCFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGCFILESUFFIX</envar> + </term> + <listitem><para> The suffix that will be used for intermediate C source files generated by the scripting language wrapper and interface generator. The default value is -<filename>_wrap</filename><link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link>. +<filename>_wrap</filename><link linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link>. By default, this value is used whenever the <option>-c++</option> option is <emphasis>not</emphasis> specified as part of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SWIGFLAGS"><envar>$SWIGFLAGS</envar></link> +<link linkend="cv-SWIGFLAGS"><envar>$SWIGFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGCOM"> - <term>SWIGCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGCOM</envar> + </term> + <listitem><para> The command line used to call the scripting language wrapper and interface generator. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGCOMSTR"> - <term>SWIGCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGCOMSTR</envar> + </term> + <listitem><para> The string displayed when calling the scripting language wrapper and interface generator. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SWIGCOM"><envar>$SWIGCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-SWIGCOM"><envar>$SWIGCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGCXXFILESUFFIX"> - <term>SWIGCXXFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGCXXFILESUFFIX</envar> + </term> + <listitem><para> The suffix that will be used for intermediate C++ source files generated by the scripting language wrapper and interface generator. The default value is -<filename>_wrap</filename><link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link>. +<filename>_wrap</filename><link linkend="cv-CFILESUFFIX"><envar>$CFILESUFFIX</envar></link>. By default, this value is used whenever the <filename>-c++</filename> option is specified as part of the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SWIGFLAGS"><envar>$SWIGFLAGS</envar></link> +<link linkend="cv-SWIGFLAGS"><envar>$SWIGFLAGS</envar></link> construction variable. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGDIRECTORSUFFIX"> - <term>SWIGDIRECTORSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGDIRECTORSUFFIX</envar> + </term> + <listitem><para> The suffix that will be used for intermediate C++ header files generated by the scripting language wrapper and interface generator. These are only generated for C++ code when the SWIG 'directors' feature is @@ -6826,9 +7423,10 @@ The default value is </listitem> </varlistentry> <varlistentry id="cv-SWIGFLAGS"> - <term>SWIGFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGFLAGS</envar> + </term> + <listitem><para> General options passed to the scripting language wrapper and interface generator. This is where you should set @@ -6839,77 +7437,82 @@ or whatever other options you want to specify to SWIG. If you set the <option>-c++</option> option in this variable, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will, by default, generate a C++ intermediate source file with the extension that is specified as the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link> +<link linkend="cv-CXXFILESUFFIX"><envar>$CXXFILESUFFIX</envar></link> variable. </para> </listitem> </varlistentry> <varlistentry id="cv-_SWIGINCFLAGS"> - <term>_SWIGINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_SWIGINCFLAGS</envar> + </term> + <listitem><para> An automatically-generated construction variable containing the SWIG command-line options for specifying directories to be searched for included files. -The value of <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_SWIGINCFLAGS</envar> is created +The value of <envar>$_SWIGINCFLAGS</envar> is created by respectively prepending and appending -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCSUFFIX</envar> +<envar>$SWIGINCPREFIX</envar> and <envar>$SWIGINCSUFFIX</envar> to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGPATH</envar>. +of each directory in <envar>$SWIGPATH</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGINCPREFIX"> - <term>SWIGINCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGINCPREFIX</envar> + </term> + <listitem><para> The prefix used to specify an include directory on the SWIG command line. This will be prepended to the beginning of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_SWIGINCFLAGS</envar> variable is automatically generated. +in the <envar>$SWIGPATH</envar> construction variable +when the <envar>$_SWIGINCFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGINCSUFFIX"> - <term>SWIGINCSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGINCSUFFIX</envar> + </term> + <listitem><para> The suffix used to specify an include directory on the SWIG command line. This will be appended to the end of each directory -in the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGPATH</envar> construction variable -when the <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_SWIGINCFLAGS</envar> variable is automatically generated. +in the <envar>$SWIGPATH</envar> construction variable +when the <envar>$_SWIGINCFLAGS</envar> variable is automatically generated. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGOUTDIR"> - <term>SWIGOUTDIR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGOUTDIR</envar> + </term> + <listitem><para> Specifies the output directory in which the scripting language wrapper and interface generator should place generated language-specific files. This will be used by SCons to identify -the files that will be generated by the <application xmlns="http://www.scons.org/dbxsd/v1.0">swig</application> call, +the files that will be generated by the <application>swig</application> call, and translated into the <literal>swig -outdir</literal> option on the command line. </para> </listitem> </varlistentry> <varlistentry id="cv-SWIGPATH"> - <term>SWIGPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGPATH</envar> + </term> + <listitem><para> The list of directories that the scripting language wrapper and interface generate will search for included files. The SWIG implicit dependency scanner will search these directories for include files. The default value is an empty list. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Don't explicitly put include directory arguments in SWIGFLAGS; the result will be non-portable @@ -6917,96 +7520,102 @@ and the directories will not be searched by the dependency scanner. Note: directory names in SWIGPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> to look-up a directory relative to the root of the source tree use #: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(SWIGPATH='#/include') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory look-up can also be forced using the -<function xmlns="http://www.scons.org/dbxsd/v1.0">Dir</function>() +<function>Dir</function>() function: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> include = Dir('include') env = Environment(SWIGPATH=include) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The directory list will be added to command lines through the automatically-generated -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$_SWIGINCFLAGS</envar> +<envar>$_SWIGINCFLAGS</envar> construction variable, which is constructed by respectively prepending and appending the values of the -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCSUFFIX</envar> +<envar>$SWIGINCPREFIX</envar> and <envar>$SWIGINCSUFFIX</envar> construction variables to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGPATH</envar>. +of each directory in <envar>$SWIGPATH</envar>. Any command lines you define that need the SWIGPATH directory list should -include <envar xmlns="http://www.scons.org/dbxsd/v1.0">$_SWIGINCFLAGS</envar>: +include <envar>$_SWIGINCFLAGS</envar>: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(SWIGCOM="my_swig -o $TARGET $_SWIGINCFLAGS $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-SWIGVERSION"> - <term>SWIGVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>SWIGVERSION</envar> + </term> + <listitem><para> The version number of the SWIG tool. </para> </listitem> </varlistentry> <varlistentry id="cv-TAR"> - <term>TAR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TAR</envar> + </term> + <listitem><para> The tar archiver. </para> </listitem> </varlistentry> <varlistentry id="cv-TARCOM"> - <term>TARCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARCOM</envar> + </term> + <listitem><para> The command line used to call the tar archiver. </para> </listitem> </varlistentry> <varlistentry id="cv-TARCOMSTR"> - <term>TARCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARCOMSTR</envar> + </term> + <listitem><para> The string displayed when archiving files using the tar archiver. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TARCOM"><envar>$TARCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-TARCOM"><envar>$TARCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(TARCOMSTR = "Archiving $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-TARFLAGS"> - <term>TARFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARFLAGS</envar> + </term> + <listitem><para> General options passed to the tar archiver. </para> </listitem> </varlistentry> <varlistentry id="cv-TARGET"> - <term>TARGET</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARGET</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7015,19 +7624,19 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-TARGET_ARCH"> - <term>TARGET_ARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARGET_ARCH</envar> + </term> + <listitem><para> The name of the target hardware architecture for the compiled objects created by this Environment. This defaults to the value of HOST_ARCH, and the user can override it. Currently only set for Win32. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <para> Sets the target architecture for Visual Studio compiler (i.e. the arch of the binaries generated by the compiler). If not set, default to -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$HOST_ARCH</envar>, or, if that is unset, to the architecture of the +<envar>$HOST_ARCH</envar>, or, if that is unset, to the architecture of the running machine's OS (note that the python build or architecture has no effect). This variable must be passed as an argument to the Environment() @@ -7039,7 +7648,7 @@ all installed MSVC's that support the TARGET_ARCH, selecting the latest version for use. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Valid values for Windows are <literal>x86</literal>, <literal>arm</literal>, @@ -7058,9 +7667,10 @@ For example, if you want to compile 64-bit binaries, you would set </listitem> </varlistentry> <varlistentry id="cv-TARGET_OS"> - <term>TARGET_OS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARGET_OS</envar> + </term> + <listitem><para> The name of the target operating system for the compiled objects created by this Environment. This defaults to the value of HOST_OS, and the user can override it. @@ -7069,9 +7679,10 @@ For example, if you want to compile 64-bit binaries, you would set </listitem> </varlistentry> <varlistentry id="cv-TARGETS"> - <term>TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARGETS</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7080,27 +7691,30 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-TARSUFFIX"> - <term>TARSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TARSUFFIX</envar> + </term> + <listitem><para> The suffix used for tar file names. </para> </listitem> </varlistentry> <varlistentry id="cv-TEMPFILEARGJOIN"> - <term>TEMPFILEARGJOIN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The string (or character) to be used to join the arguments passed to TEMPFILE when command line exceeds the limit set by <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MAXLINELENGTH</envar>. + <term> + <envar>TEMPFILEARGJOIN</envar> + </term> + <listitem><para> +The string (or character) to be used to join the arguments passed to TEMPFILE when command line exceeds the limit set by <envar>$MAXLINELENGTH</envar>. The default value is a space. However for MSVC, MSLINK the default is a line seperator characters as defined by os.linesep. Note this value is used literally and not expanded by the subst logic. </para> </listitem> </varlistentry> <varlistentry id="cv-TEMPFILEPREFIX"> - <term>TEMPFILEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEMPFILEPREFIX</envar> + </term> + <listitem><para> The prefix for a temporary file used to store lines lines longer than $MAXLINELENGTH as operations which call out to a shell will fail @@ -7115,9 +7729,10 @@ or '-via' for ARM toolchain. </listitem> </varlistentry> <varlistentry id="cv-TEMPFILESUFFIX"> - <term>TEMPFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEMPFILESUFFIX</envar> + </term> + <listitem><para> The suffix used for the temporary file name used for long command lines. The name should include the dot ('.') if one is wanted as @@ -7127,47 +7742,52 @@ The default is '.lnk'. </listitem> </varlistentry> <varlistentry id="cv-TEX"> - <term>TEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEX</envar> + </term> + <listitem><para> The TeX formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-TEXCOM"> - <term>TEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEXCOM</envar> + </term> + <listitem><para> The command line used to call the TeX formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-TEXCOMSTR"> - <term>TEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEXCOMSTR</envar> + </term> + <listitem><para> The string displayed when calling the TeX formatter and typesetter. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TEXCOM"><envar>$TEXCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-TEXCOM"><envar>$TEXCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-TEXFLAGS"> - <term>TEXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEXFLAGS</envar> + </term> + <listitem><para> General options passed to the TeX formatter and typesetter. </para> </listitem> </varlistentry> <varlistentry id="cv-TEXINPUTS"> - <term>TEXINPUTS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TEXINPUTS</envar> + </term> + <listitem><para> List of directories that the LaTeX program will search for include directories. The LaTeX implicit dependency scanner will search these @@ -7176,36 +7796,40 @@ directories for \include and \import files. </listitem> </varlistentry> <varlistentry id="cv-TEXTFILEPREFIX"> - <term>TEXTFILEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The prefix used for <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> file names, -the null string by default. + <term> + <envar>TEXTFILEPREFIX</envar> + </term> + <listitem><para> +The prefix used for <function>Textfile</function> file names, +an empty string by default. </para> </listitem> </varlistentry> <varlistentry id="cv-TEXTFILESUFFIX"> - <term>TEXTFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The suffix used for <function xmlns="http://www.scons.org/dbxsd/v1.0">Textfile</function> file names; + <term> + <envar>TEXTFILESUFFIX</envar> + </term> + <listitem><para> +The suffix used for <function>Textfile</function> file names; <filename>.txt</filename> by default. </para> </listitem> </varlistentry> <varlistentry id="cv-TOOLS"> - <term>TOOLS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>TOOLS</envar> + </term> + <listitem><para> A list of the names of the Tool specifications that are part of this construction environment. </para> </listitem> </varlistentry> <varlistentry id="cv-UNCHANGED_SOURCES"> - <term>UNCHANGED_SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>UNCHANGED_SOURCES</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7214,9 +7838,10 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-UNCHANGED_TARGETS"> - <term>UNCHANGED_TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>UNCHANGED_TARGETS</envar> + </term> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7225,9 +7850,10 @@ for more information). </listitem> </varlistentry> <varlistentry id="cv-VENDOR"> - <term>VENDOR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>VENDOR</envar> + </term> + <listitem><para> The person or organization who supply the packaged software. This is used to fill in the <literal>Vendor:</literal> @@ -7239,69 +7865,127 @@ field in the controlling information for MSI packages. </listitem> </varlistentry> <varlistentry id="cv-VERSION"> - <term>VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>VERSION</envar> + </term> + <listitem><para> The version of the project, specified as a string. </para> </listitem> </varlistentry> + <varlistentry id="cv-VSWHERE"> + <term> + <envar>VSWHERE</envar> + </term> + <listitem><para> +Specify the location of <filename>vswhere.exe</filename>. +</para> + +<para> + The <filename>vswhere.exe</filename> executable is distributed with Microsoft Visual Studio and Build + Tools since the 2017 edition, but is also available standalone. + It provides full information about installations of 2017 and later editions. + With the <option>-legacy</option> argument, <filename>vswhere.exe</filename> can detect installations of the 2010 through 2015 + editions with limited data returned. +If <envar>VSWHERE</envar> is set, SCons will use that location. +</para> +<para> + Otherwise SCons will look in the following locations and set <envar>VSWHERE</envar> to the path of the first <filename>vswhere.exe</filename> +located. +</para> + +<itemizedlist> +<listitem><para><literal>%ProgramFiles(x86)%\Microsoft Visual Studio\Installer</literal></para></listitem> +<listitem><para><literal>%ProgramFiles%\Microsoft Visual Studio\Installer</literal></para></listitem> +<listitem><para><literal>%ChocolateyInstall%\bin</literal></para></listitem> +</itemizedlist> + +<para> + Note that <envar>VSWHERE</envar> must be set at the same time or prior to any of <link linkend="t-msvc"><literal>msvc</literal></link>, <link linkend="t-msvs"><literal>msvs</literal></link> , and/or <link linkend="t-mslink"><literal>mslink</literal></link> <link linkend="f-Tool"><function>Tool</function></link> being initialized. + + Either set it as follows +<programlisting> +env = Environment(VSWHERE='c:/my/path/to/vswhere') +</programlisting> + +or if your <phrase>construction environment</phrase> is created specifying an empty tools list +(or a list of tools which omits all of default, msvs, msvc, and mslink), +and also before <link linkend="f-Tool"><function>env.Tool</function></link> is called to ininitialize any of those tools: + +<programlisting> + env = Environment(tools=[]) + env['VSWHERE'] = r'c:/my/vswhere/install/location/vswhere.exe' + env.Tool('msvc') + env.Tool('mslink') + env.Tool('msvs') + </programlisting> +</para> + +</listitem> + </varlistentry> <varlistentry id="cv-WIN32_INSERT_DEF"> - <term>WIN32_INSERT_DEF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWS_INSERT_DEF"><envar>$WINDOWS_INSERT_DEF</envar></link>. + <term> + <envar>WIN32_INSERT_DEF</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-WINDOWS_INSERT_DEF"><envar>$WINDOWS_INSERT_DEF</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WIN32DEFPREFIX"> - <term>WIN32DEFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWSDEFPREFIX"><envar>$WINDOWSDEFPREFIX</envar></link>. + <term> + <envar>WIN32DEFPREFIX</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-WINDOWSDEFPREFIX"><envar>$WINDOWSDEFPREFIX</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WIN32DEFSUFFIX"> - <term>WIN32DEFSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWSDEFSUFFIX"><envar>$WINDOWSDEFSUFFIX</envar></link>. + <term> + <envar>WIN32DEFSUFFIX</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-WINDOWSDEFSUFFIX"><envar>$WINDOWSDEFSUFFIX</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WIN32EXPPREFIX"> - <term>WIN32EXPPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWSEXPSUFFIX"><envar>$WINDOWSEXPSUFFIX</envar></link>. + <term> + <envar>WIN32EXPPREFIX</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-WINDOWSEXPSUFFIX"><envar>$WINDOWSEXPSUFFIX</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WIN32EXPSUFFIX"> - <term>WIN32EXPSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -A deprecated synonym for <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-WINDOWSEXPSUFFIX"><envar>$WINDOWSEXPSUFFIX</envar></link>. + <term> + <envar>WIN32EXPSUFFIX</envar> + </term> + <listitem><para> +A deprecated synonym for <link linkend="cv-WINDOWSEXPSUFFIX"><envar>$WINDOWSEXPSUFFIX</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWS_EMBED_MANIFEST"> - <term>WINDOWS_EMBED_MANIFEST</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWS_EMBED_MANIFEST</envar> + </term> + <listitem><para> Set this variable to True or 1 to embed the compiler-generated manifest (normally <literal>${TARGET}.manifest</literal>) into all Windows exes and DLLs built with this environment, as a resource during their link step. -This is done using <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MT"><envar>$MT</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MTEXECOM"><envar>$MTEXECOM</envar></link> and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-MTSHLIBCOM"><envar>$MTSHLIBCOM</envar></link>. +This is done using <link linkend="cv-MT"><envar>$MT</envar></link> and <link linkend="cv-MTEXECOM"><envar>$MTEXECOM</envar></link> and <link linkend="cv-MTSHLIBCOM"><envar>$MTSHLIBCOM</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWS_INSERT_DEF"> - <term>WINDOWS_INSERT_DEF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWS_INSERT_DEF</envar> + </term> + <listitem><para> When this is set to true, a library build of a Windows shared library (<filename>.dll</filename> file) @@ -7314,11 +7998,12 @@ The default is 0 (do not build a <filename>.def</filename> file). </listitem> </varlistentry> <varlistentry id="cv-WINDOWS_INSERT_MANIFEST"> - <term>WINDOWS_INSERT_MANIFEST</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWS_INSERT_MANIFEST</envar> + </term> + <listitem><para> When this is set to true, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<command>scons</command> will be aware of the <filename>.manifest</filename> files generated by Microsoft Visua C/C++ 8. @@ -7326,77 +8011,86 @@ files generated by Microsoft Visua C/C++ 8. </listitem> </varlistentry> <varlistentry id="cv-WINDOWSDEFPREFIX"> - <term>WINDOWSDEFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSDEFPREFIX</envar> + </term> + <listitem><para> The prefix used for Windows <filename>.def</filename> file names. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSDEFSUFFIX"> - <term>WINDOWSDEFSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSDEFSUFFIX</envar> + </term> + <listitem><para> The suffix used for Windows <filename>.def</filename> file names. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSEXPPREFIX"> - <term>WINDOWSEXPPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSEXPPREFIX</envar> + </term> + <listitem><para> The prefix used for Windows <filename>.exp</filename> file names. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSEXPSUFFIX"> - <term>WINDOWSEXPSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSEXPSUFFIX</envar> + </term> + <listitem><para> The suffix used for Windows <filename>.exp</filename> file names. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSPROGMANIFESTPREFIX"> - <term>WINDOWSPROGMANIFESTPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSPROGMANIFESTPREFIX</envar> + </term> + <listitem><para> The prefix used for executable program <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSPROGMANIFESTSUFFIX"> - <term>WINDOWSPROGMANIFESTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSPROGMANIFESTSUFFIX</envar> + </term> + <listitem><para> The suffix used for executable program <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSSHLIBMANIFESTPREFIX"> - <term>WINDOWSSHLIBMANIFESTPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSSHLIBMANIFESTPREFIX</envar> + </term> + <listitem><para> The prefix used for shared library <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> </listitem> </varlistentry> <varlistentry id="cv-WINDOWSSHLIBMANIFESTSUFFIX"> - <term>WINDOWSSHLIBMANIFESTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>WINDOWSSHLIBMANIFESTSUFFIX</envar> + </term> + <listitem><para> The suffix used for shared library <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> </listitem> </varlistentry> <varlistentry id="cv-X_IPK_DEPENDS"> - <term>X_IPK_DEPENDS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_IPK_DEPENDS</envar> + </term> + <listitem><para> This is used to fill in the <literal>Depends:</literal> field in the controlling information for Ipkg packages. @@ -7404,9 +8098,10 @@ field in the controlling information for Ipkg packages. </listitem> </varlistentry> <varlistentry id="cv-X_IPK_DESCRIPTION"> - <term>X_IPK_DESCRIPTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_IPK_DESCRIPTION</envar> + </term> + <listitem><para> This is used to fill in the <literal>Description:</literal> field in the controlling information for Ipkg packages. @@ -7416,9 +8111,10 @@ The default value is </listitem> </varlistentry> <varlistentry id="cv-X_IPK_MAINTAINER"> - <term>X_IPK_MAINTAINER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_IPK_MAINTAINER</envar> + </term> + <listitem><para> This is used to fill in the <literal>Maintainer:</literal> field in the controlling information for Ipkg packages. @@ -7426,9 +8122,10 @@ field in the controlling information for Ipkg packages. </listitem> </varlistentry> <varlistentry id="cv-X_IPK_PRIORITY"> - <term>X_IPK_PRIORITY</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_IPK_PRIORITY</envar> + </term> + <listitem><para> This is used to fill in the <literal>Priority:</literal> field in the controlling information for Ipkg packages. @@ -7436,9 +8133,10 @@ field in the controlling information for Ipkg packages. </listitem> </varlistentry> <varlistentry id="cv-X_IPK_SECTION"> - <term>X_IPK_SECTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_IPK_SECTION</envar> + </term> + <listitem><para> This is used to fill in the <literal>Section:</literal> field in the controlling information for Ipkg packages. @@ -7446,9 +8144,10 @@ field in the controlling information for Ipkg packages. </listitem> </varlistentry> <varlistentry id="cv-X_MSI_LANGUAGE"> - <term>X_MSI_LANGUAGE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_MSI_LANGUAGE</envar> + </term> + <listitem><para> This is used to fill in the <literal>Language:</literal> attribute in the controlling information for MSI packages. @@ -7456,9 +8155,10 @@ attribute in the controlling information for MSI packages. </listitem> </varlistentry> <varlistentry id="cv-X_MSI_LICENSE_TEXT"> - <term>X_MSI_LICENSE_TEXT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_MSI_LICENSE_TEXT</envar> + </term> + <listitem><para> The text of the software license in RTF format. Carriage return characters will be replaced with the RTF equivalent \\par. @@ -7466,17 +8166,19 @@ replaced with the RTF equivalent \\par. </listitem> </varlistentry> <varlistentry id="cv-X_MSI_UPGRADE_CODE"> - <term>X_MSI_UPGRADE_CODE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_MSI_UPGRADE_CODE</envar> + </term> + <listitem><para> TODO </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_AUTOREQPROV"> - <term>X_RPM_AUTOREQPROV</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_AUTOREQPROV</envar> + </term> + <listitem><para> This is used to fill in the <literal>AutoReqProv:</literal> field in the RPM @@ -7485,17 +8187,19 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_BUILD"> - <term>X_RPM_BUILD</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_BUILD</envar> + </term> + <listitem><para> internal, but overridable </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_BUILDREQUIRES"> - <term>X_RPM_BUILDREQUIRES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_BUILDREQUIRES</envar> + </term> + <listitem><para> This is used to fill in the <literal>BuildRequires:</literal> field in the RPM @@ -7505,25 +8209,28 @@ Note this should only be used on a host managed by rpm as the dependencies will </listitem> </varlistentry> <varlistentry id="cv-X_RPM_BUILDROOT"> - <term>X_RPM_BUILDROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_BUILDROOT</envar> + </term> + <listitem><para> internal, but overridable </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_CLEAN"> - <term>X_RPM_CLEAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_CLEAN</envar> + </term> + <listitem><para> internal, but overridable </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_CONFLICTS"> - <term>X_RPM_CONFLICTS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_CONFLICTS</envar> + </term> + <listitem><para> This is used to fill in the <literal>Conflicts:</literal> field in the RPM @@ -7532,9 +8239,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_DEFATTR"> - <term>X_RPM_DEFATTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_DEFATTR</envar> + </term> + <listitem><para> This value is used as the default attributes for the files in the RPM package. The default value is @@ -7543,9 +8251,10 @@ The default value is </listitem> </varlistentry> <varlistentry id="cv-X_RPM_DISTRIBUTION"> - <term>X_RPM_DISTRIBUTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_DISTRIBUTION</envar> + </term> + <listitem><para> This is used to fill in the <literal>Distribution:</literal> field in the RPM @@ -7554,9 +8263,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_EPOCH"> - <term>X_RPM_EPOCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_EPOCH</envar> + </term> + <listitem><para> This is used to fill in the <literal>Epoch:</literal> field in the RPM @@ -7565,9 +8275,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_EXCLUDEARCH"> - <term>X_RPM_EXCLUDEARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_EXCLUDEARCH</envar> + </term> + <listitem><para> This is used to fill in the <literal>ExcludeArch:</literal> field in the RPM @@ -7576,9 +8287,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_EXLUSIVEARCH"> - <term>X_RPM_EXLUSIVEARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_EXLUSIVEARCH</envar> + </term> + <listitem><para> This is used to fill in the <literal>ExclusiveArch:</literal> field in the RPM @@ -7587,9 +8299,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_EXTRADEFS"> - <term>X_RPM_EXTRADEFS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_EXTRADEFS</envar> + </term> + <listitem><para> A list used to supply extra defintions or flags to be added to the RPM <filename>.spec</filename> file. Each item is added as-is with a carriage return appended. @@ -7605,23 +8318,25 @@ list that does not include the default line. Added in version 3.1. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Package( - NAME = 'foo', -... - X_RPM_EXTRADEFS = [ - '%define _unpackaged_files_terminate_build 0' - '%define _missing_doc_files_terminate_build 0' + NAME="foo", + ... + X_RPM_EXTRADEFS=[ + "%define _unpackaged_files_terminate_build 0" + "%define _missing_doc_files_terminate_build 0" ], -... ) + ... +) </example_commands> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_GROUP"> - <term>X_RPM_GROUP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_GROUP</envar> + </term> + <listitem><para> This is used to fill in the <literal>Group:</literal> field in the RPM @@ -7630,9 +8345,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_GROUP_lang"> - <term>X_RPM_GROUP_lang</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_GROUP_lang</envar> + </term> + <listitem><para> This is used to fill in the <literal>Group(lang):</literal> field in the RPM @@ -7646,9 +8362,10 @@ the appropriate language code. </listitem> </varlistentry> <varlistentry id="cv-X_RPM_ICON"> - <term>X_RPM_ICON</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_ICON</envar> + </term> + <listitem><para> This is used to fill in the <literal>Icon:</literal> field in the RPM @@ -7657,17 +8374,19 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_INSTALL"> - <term>X_RPM_INSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_INSTALL</envar> + </term> + <listitem><para> internal, but overridable </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PACKAGER"> - <term>X_RPM_PACKAGER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PACKAGER</envar> + </term> + <listitem><para> This is used to fill in the <literal>Packager:</literal> field in the RPM @@ -7676,9 +8395,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_POSTINSTALL"> - <term>X_RPM_POSTINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_POSTINSTALL</envar> + </term> + <listitem><para> This is used to fill in the <literal>%post:</literal> section in the RPM @@ -7687,9 +8407,10 @@ section in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_POSTUNINSTALL"> - <term>X_RPM_POSTUNINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_POSTUNINSTALL</envar> + </term> + <listitem><para> This is used to fill in the <literal>%postun:</literal> section in the RPM @@ -7698,9 +8419,10 @@ section in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PREFIX"> - <term>X_RPM_PREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PREFIX</envar> + </term> + <listitem><para> This is used to fill in the <literal>Prefix:</literal> field in the RPM @@ -7709,9 +8431,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PREINSTALL"> - <term>X_RPM_PREINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PREINSTALL</envar> + </term> + <listitem><para> This is used to fill in the <literal>%pre:</literal> section in the RPM @@ -7720,17 +8443,19 @@ section in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PREP"> - <term>X_RPM_PREP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PREP</envar> + </term> + <listitem><para> internal, but overridable </para> </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PREUNINSTALL"> - <term>X_RPM_PREUNINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PREUNINSTALL</envar> + </term> + <listitem><para> This is used to fill in the <literal>%preun:</literal> section in the RPM @@ -7739,9 +8464,10 @@ section in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_PROVIDES"> - <term>X_RPM_PROVIDES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_PROVIDES</envar> + </term> + <listitem><para> This is used to fill in the <literal>Provides:</literal> field in the RPM @@ -7750,9 +8476,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_REQUIRES"> - <term>X_RPM_REQUIRES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_REQUIRES</envar> + </term> + <listitem><para> This is used to fill in the <literal>Requires:</literal> field in the RPM @@ -7761,9 +8488,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_SERIAL"> - <term>X_RPM_SERIAL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_SERIAL</envar> + </term> + <listitem><para> This is used to fill in the <literal>Serial:</literal> field in the RPM @@ -7772,9 +8500,10 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-X_RPM_URL"> - <term>X_RPM_URL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>X_RPM_URL</envar> + </term> + <listitem><para> This is used to fill in the <literal>Url:</literal> field in the RPM @@ -7783,118 +8512,130 @@ field in the RPM </listitem> </varlistentry> <varlistentry id="cv-XGETTEXT"> - <term>XGETTEXT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXT</envar> + </term> + <listitem><para> Path to <command>xgettext(1)</command> program (found via <function>Detect()</function>). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTCOM"> - <term>XGETTEXTCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTCOM</envar> + </term> + <listitem><para> Complete xgettext command line. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTCOMSTR"> - <term>XGETTEXTCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTCOMSTR</envar> + </term> + <listitem><para> A string that is shown when <command>xgettext(1)</command> command is invoked -(default: <literal>''</literal>, which means "print <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTCOM"><envar>$XGETTEXTCOM</envar></link>"). -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +(default: <literal>''</literal>, which means "print <link linkend="cv-XGETTEXTCOM"><envar>$XGETTEXTCOM</envar></link>"). +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-_XGETTEXTDOMAIN"> - <term>_XGETTEXTDOMAIN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_XGETTEXTDOMAIN</envar> + </term> + <listitem><para> Internal "macro". Generates <command>xgettext</command> domain name form source and target (default: <literal>'${TARGET.filebase}'</literal>). </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTFLAGS"> - <term>XGETTEXTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTFLAGS</envar> + </term> + <listitem><para> Additional flags to <command>xgettext(1)</command>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTFROM"> - <term>XGETTEXTFROM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTFROM</envar> + </term> + <listitem><para> Name of file containing list of <command>xgettext(1)</command>'s source files. Autotools' users know this as <filename>POTFILES.in</filename> so they will in most cases set <literal>XGETTEXTFROM="POTFILES.in"</literal> here. -The <envar xmlns="http://www.scons.org/dbxsd/v1.0">$XGETTEXTFROM</envar> files have same syntax and semantics as the well known +The <envar>$XGETTEXTFROM</envar> files have same syntax and semantics as the well known GNU <filename>POTFILES.in</filename>. -See <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-_XGETTEXTFROMFLAGS"> - <term>_XGETTEXTFROMFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_XGETTEXTFROMFLAGS</envar> + </term> + <listitem><para> Internal "macro". Genrates list of <literal>-D<dir></literal> flags -from the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTPATH"><envar>$XGETTEXTPATH</envar></link> list. +from the <link linkend="cv-XGETTEXTPATH"><envar>$XGETTEXTPATH</envar></link> list. </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTFROMPREFIX"> - <term>XGETTEXTFROMPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -This flag is used to add single <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link> file to + <term> + <envar>XGETTEXTFROMPREFIX</envar> + </term> + <listitem><para> +This flag is used to add single <link linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link> file to <command>xgettext(1)</command>'s commandline (default: <literal>'-f'</literal>). </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTFROMSUFFIX"> - <term>XGETTEXTFROMSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTFROMSUFFIX</envar> + </term> + <listitem><para> (default: <literal>''</literal>) </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTPATH"> - <term>XGETTEXTPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTPATH</envar> + </term> + <listitem><para> List of directories, there <command>xgettext(1)</command> will look for source files (default: <literal>[]</literal>). <note><para> -This variable works only together with <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link> +This variable works only together with <link linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link> </para></note> -See also <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. +See also <link linkend="t-xgettext"><literal>xgettext</literal></link> tool and <link linkend="b-POTUpdate"><function>POTUpdate</function></link> builder. </para> </listitem> </varlistentry> <varlistentry id="cv-_XGETTEXTPATHFLAGS"> - <term>_XGETTEXTPATHFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>_XGETTEXTPATHFLAGS</envar> + </term> + <listitem><para> Internal "macro". Generates list of <literal>-f<file></literal> flags -from <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link>. +from <link linkend="cv-XGETTEXTFROM"><envar>$XGETTEXTFROM</envar></link>. </para> </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTPATHPREFIX"> - <term>XGETTEXTPATHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTPATHPREFIX</envar> + </term> + <listitem><para> This flag is used to add single search path to <command>xgettext(1)</command>'s commandline (default: <literal>'-D'</literal>). @@ -7902,50 +8643,55 @@ This flag is used to add single search path to </listitem> </varlistentry> <varlistentry id="cv-XGETTEXTPATHSUFFIX"> - <term>XGETTEXTPATHSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>XGETTEXTPATHSUFFIX</envar> + </term> + <listitem><para> (default: <literal>''</literal>) </para> </listitem> </varlistentry> <varlistentry id="cv-YACC"> - <term>YACC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACC</envar> + </term> + <listitem><para> The parser generator. </para> </listitem> </varlistentry> <varlistentry id="cv-YACCCOM"> - <term>YACCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCCOM</envar> + </term> + <listitem><para> The command line used to call the parser generator to generate a source file. </para> </listitem> </varlistentry> <varlistentry id="cv-YACCCOMSTR"> - <term>YACCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCCOMSTR</envar> + </term> + <listitem><para> The string displayed when generating a source file using the parser generator. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-YACCCOM"><envar>$YACCCOM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-YACCCOM"><envar>$YACCCOM</envar></link> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-YACCFLAGS"> - <term>YACCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCFLAGS</envar> + </term> + <listitem><para> General options passed to the parser generator. -If <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-YACCFLAGS"><envar>$YACCFLAGS</envar></link> contains a <option>-d</option> option, +If <link linkend="cv-YACCFLAGS"><envar>$YACCFLAGS</envar></link> contains a <option>-d</option> option, SCons assumes that the call will also create a .h file (if the yacc source file ends in a .y suffix) or a .hpp file @@ -7954,9 +8700,10 @@ or a .hpp file </listitem> </varlistentry> <varlistentry id="cv-YACCHFILESUFFIX"> - <term>YACCHFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCHFILESUFFIX</envar> + </term> + <listitem><para> The suffix of the C header file generated by the parser generator when the @@ -7973,9 +8720,10 @@ The default value is </listitem> </varlistentry> <varlistentry id="cv-YACCHXXFILESUFFIX"> - <term>YACCHXXFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCHXXFILESUFFIX</envar> + </term> + <listitem><para> The suffix of the C++ header file generated by the parser generator when the @@ -7991,16 +8739,17 @@ The default value is except on Mac OS X, where the default is <filename>${TARGET.suffix}.h</filename>. -because the default <application xmlns="http://www.scons.org/dbxsd/v1.0">bison</application> parser generator just +because the default <application>bison</application> parser generator just appends <filename>.h</filename> to the name of the generated C++ file. </para> </listitem> </varlistentry> <varlistentry id="cv-YACCVCGFILESUFFIX"> - <term>YACCVCGFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>YACCVCGFILESUFFIX</envar> + </term> + <listitem><para> The suffix of the file containing the VCG grammar automaton definition when the @@ -8017,17 +8766,19 @@ The default value is </listitem> </varlistentry> <varlistentry id="cv-ZIP"> - <term>ZIP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIP</envar> + </term> + <listitem><para> The zip compression and file packaging utility. </para> </listitem> </varlistentry> <varlistentry id="cv-ZIPCOM"> - <term>ZIPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPCOM</envar> + </term> + <listitem><para> The command line used to call the zip utility, or the internal Python function used to create a zip archive. @@ -8035,9 +8786,10 @@ zip archive. </listitem> </varlistentry> <varlistentry id="cv-ZIPCOMPRESSION"> - <term>ZIPCOMPRESSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPCOMPRESSION</envar> + </term> + <listitem><para> The <varname>compression</varname> flag @@ -8056,43 +8808,46 @@ module is unavailable. </listitem> </varlistentry> <varlistentry id="cv-ZIPCOMSTR"> - <term>ZIPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPCOMSTR</envar> + </term> + <listitem><para> The string displayed when archiving files using the zip utility. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ZIPCOM"><envar>$ZIPCOM</envar></link> +If this is not set, then <link linkend="cv-ZIPCOM"><envar>$ZIPCOM</envar></link> (the command line or internal Python function) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(ZIPCOMSTR = "Zipping $TARGET") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-ZIPFLAGS"> - <term>ZIPFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPFLAGS</envar> + </term> + <listitem><para> General options passed to the zip utility. </para> </listitem> </varlistentry> <varlistentry id="cv-ZIPROOT"> - <term>ZIPROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPROOT</envar> + </term> + <listitem><para> An optional zip root directory (default empty). The filenames stored in the zip file will be relative to this directory, if given. Otherwise the filenames are relative to the current directory of the command. For instance: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> will produce a zip file <literal>foo.zip</literal> containing a file with the name <literal>subdir2/file1</literal> rather than @@ -8101,9 +8856,10 @@ containing a file with the name </listitem> </varlistentry> <varlistentry id="cv-ZIPSUFFIX"> - <term>ZIPSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <term> + <envar>ZIPSUFFIX</envar> + </term> + <listitem><para> The suffix used for zip file names. </para> </listitem> diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index ff44a23..a7aa197 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -10,10 +10,10 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-__LDMODULEVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$__LDMODULEVERSIONFLAGS</envar>"> <!ENTITY cv-__SHLIBVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$__SHLIBVERSIONFLAGS</envar>"> -<!ENTITY cv-_APPLELINK_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_APPLELINK_COMPATIBILITY_VERSION</envar>"> <!ENTITY cv-APPLELINK_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$APPLELINK_COMPATIBILITY_VERSION</envar>"> -<!ENTITY cv-_APPLELINK_CURRENT_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_APPLELINK_CURRENT_VERSION</envar>"> +<!ENTITY cv-_APPLELINK_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_APPLELINK_COMPATIBILITY_VERSION</envar>"> <!ENTITY cv-APPLELINK_CURRENT_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$APPLELINK_CURRENT_VERSION</envar>"> +<!ENTITY cv-_APPLELINK_CURRENT_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_APPLELINK_CURRENT_VERSION</envar>"> <!ENTITY cv-APPLELINK_NO_COMPATIBILITY_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$APPLELINK_NO_COMPATIBILITY_VERSION</envar>"> <!ENTITY cv-APPLELINK_NO_CURRENT_VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$APPLELINK_NO_CURRENT_VERSION</envar>"> <!ENTITY cv-AR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$AR</envar>"> @@ -201,8 +201,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-_FRAMEWORKPATH "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_FRAMEWORKPATH</envar>"> <!ENTITY cv-FRAMEWORKPATHPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$FRAMEWORKPATHPREFIX</envar>"> <!ENTITY cv-FRAMEWORKPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$FRAMEWORKPREFIX</envar>"> -<!ENTITY cv-_FRAMEWORKS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_FRAMEWORKS</envar>"> <!ENTITY cv-FRAMEWORKS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$FRAMEWORKS</envar>"> +<!ENTITY cv-_FRAMEWORKS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_FRAMEWORKS</envar>"> <!ENTITY cv-FRAMEWORKSFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$FRAMEWORKSFLAGS</envar>"> <!ENTITY cv-GS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$GS</envar>"> <!ENTITY cv-GSCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$GSCOM</envar>"> @@ -259,8 +259,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-_LDMODULESONAME "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_LDMODULESONAME</envar>"> <!ENTITY cv-LDMODULESUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULESUFFIX</envar>"> <!ENTITY cv-LDMODULEVERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEVERSION</envar>"> -<!ENTITY cv-LDMODULEVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEVERSIONFLAGS</envar>"> <!ENTITY cv-_LDMODULEVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_LDMODULEVERSIONFLAGS</envar>"> +<!ENTITY cv-LDMODULEVERSIONFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LDMODULEVERSIONFLAGS</envar>"> <!ENTITY cv-LEX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LEX</envar>"> <!ENTITY cv-LEXCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LEXCOM</envar>"> <!ENTITY cv-LEXCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$LEXCOMSTR</envar>"> @@ -435,8 +435,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-RMICCOM "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RMICCOM</envar>"> <!ENTITY cv-RMICCOMSTR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RMICCOMSTR</envar>"> <!ENTITY cv-RMICFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RMICFLAGS</envar>"> -<!ENTITY cv-_RPATH "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_RPATH</envar>"> <!ENTITY cv-RPATH "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RPATH</envar>"> +<!ENTITY cv-_RPATH "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_RPATH</envar>"> <!ENTITY cv-RPATHPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RPATHPREFIX</envar>"> <!ENTITY cv-RPATHSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RPATHSUFFIX</envar>"> <!ENTITY cv-RPCGEN "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$RPCGEN</envar>"> @@ -562,6 +562,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-UNCHANGED_TARGETS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$UNCHANGED_TARGETS</envar>"> <!ENTITY cv-VENDOR "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$VENDOR</envar>"> <!ENTITY cv-VERSION "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$VERSION</envar>"> +<!ENTITY cv-VSWHERE "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$VSWHERE</envar>"> <!ENTITY cv-WIN32_INSERT_DEF "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$WIN32_INSERT_DEF</envar>"> <!ENTITY cv-WIN32DEFPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$WIN32DEFPREFIX</envar>"> <!ENTITY cv-WIN32DEFSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$WIN32DEFSUFFIX</envar>"> @@ -653,10 +654,10 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-__LDMODULEVERSIONFLAGS "<link linkend='cv-__LDMODULEVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$__LDMODULEVERSIONFLAGS</envar></link>"> <!ENTITY cv-link-__SHLIBVERSIONFLAGS "<link linkend='cv-__SHLIBVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$__SHLIBVERSIONFLAGS</envar></link>"> -<!ENTITY cv-link-_APPLELINK_COMPATIBILITY_VERSION "<link linkend='cv-_APPLELINK_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_APPLELINK_COMPATIBILITY_VERSION</envar></link>"> <!ENTITY cv-link-APPLELINK_COMPATIBILITY_VERSION "<link linkend='cv-APPLELINK_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$APPLELINK_COMPATIBILITY_VERSION</envar></link>"> -<!ENTITY cv-link-_APPLELINK_CURRENT_VERSION "<link linkend='cv-_APPLELINK_CURRENT_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_APPLELINK_CURRENT_VERSION</envar></link>"> +<!ENTITY cv-link-_APPLELINK_COMPATIBILITY_VERSION "<link linkend='cv-_APPLELINK_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_APPLELINK_COMPATIBILITY_VERSION</envar></link>"> <!ENTITY cv-link-APPLELINK_CURRENT_VERSION "<link linkend='cv-APPLELINK_CURRENT_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$APPLELINK_CURRENT_VERSION</envar></link>"> +<!ENTITY cv-link-_APPLELINK_CURRENT_VERSION "<link linkend='cv-_APPLELINK_CURRENT_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_APPLELINK_CURRENT_VERSION</envar></link>"> <!ENTITY cv-link-APPLELINK_NO_COMPATIBILITY_VERSION "<link linkend='cv-APPLELINK_NO_COMPATIBILITY_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$APPLELINK_NO_COMPATIBILITY_VERSION</envar></link>"> <!ENTITY cv-link-APPLELINK_NO_CURRENT_VERSION "<link linkend='cv-APPLELINK_NO_CURRENT_VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$APPLELINK_NO_CURRENT_VERSION</envar></link>"> <!ENTITY cv-link-AR "<link linkend='cv-AR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$AR</envar></link>"> @@ -844,8 +845,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-_FRAMEWORKPATH "<link linkend='cv-_FRAMEWORKPATH' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_FRAMEWORKPATH</envar></link>"> <!ENTITY cv-link-FRAMEWORKPATHPREFIX "<link linkend='cv-FRAMEWORKPATHPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$FRAMEWORKPATHPREFIX</envar></link>"> <!ENTITY cv-link-FRAMEWORKPREFIX "<link linkend='cv-FRAMEWORKPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$FRAMEWORKPREFIX</envar></link>"> -<!ENTITY cv-link-_FRAMEWORKS "<link linkend='cv-_FRAMEWORKS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_FRAMEWORKS</envar></link>"> <!ENTITY cv-link-FRAMEWORKS "<link linkend='cv-FRAMEWORKS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$FRAMEWORKS</envar></link>"> +<!ENTITY cv-link-_FRAMEWORKS "<link linkend='cv-_FRAMEWORKS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_FRAMEWORKS</envar></link>"> <!ENTITY cv-link-FRAMEWORKSFLAGS "<link linkend='cv-FRAMEWORKSFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$FRAMEWORKSFLAGS</envar></link>"> <!ENTITY cv-link-GS "<link linkend='cv-GS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$GS</envar></link>"> <!ENTITY cv-link-GSCOM "<link linkend='cv-GSCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$GSCOM</envar></link>"> @@ -902,8 +903,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-_LDMODULESONAME "<link linkend='cv-_LDMODULESONAME' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_LDMODULESONAME</envar></link>"> <!ENTITY cv-link-LDMODULESUFFIX "<link linkend='cv-LDMODULESUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULESUFFIX</envar></link>"> <!ENTITY cv-link-LDMODULEVERSION "<link linkend='cv-LDMODULEVERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEVERSION</envar></link>"> -<!ENTITY cv-link-LDMODULEVERSIONFLAGS "<link linkend='cv-LDMODULEVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEVERSIONFLAGS</envar></link>"> <!ENTITY cv-link-_LDMODULEVERSIONFLAGS "<link linkend='cv-_LDMODULEVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_LDMODULEVERSIONFLAGS</envar></link>"> +<!ENTITY cv-link-LDMODULEVERSIONFLAGS "<link linkend='cv-LDMODULEVERSIONFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LDMODULEVERSIONFLAGS</envar></link>"> <!ENTITY cv-link-LEX "<link linkend='cv-LEX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LEX</envar></link>"> <!ENTITY cv-link-LEXCOM "<link linkend='cv-LEXCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LEXCOM</envar></link>"> <!ENTITY cv-link-LEXCOMSTR "<link linkend='cv-LEXCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$LEXCOMSTR</envar></link>"> @@ -1078,8 +1079,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-RMICCOM "<link linkend='cv-RMICCOM' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RMICCOM</envar></link>"> <!ENTITY cv-link-RMICCOMSTR "<link linkend='cv-RMICCOMSTR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RMICCOMSTR</envar></link>"> <!ENTITY cv-link-RMICFLAGS "<link linkend='cv-RMICFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RMICFLAGS</envar></link>"> -<!ENTITY cv-link-_RPATH "<link linkend='cv-_RPATH' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_RPATH</envar></link>"> <!ENTITY cv-link-RPATH "<link linkend='cv-RPATH' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RPATH</envar></link>"> +<!ENTITY cv-link-_RPATH "<link linkend='cv-_RPATH' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_RPATH</envar></link>"> <!ENTITY cv-link-RPATHPREFIX "<link linkend='cv-RPATHPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RPATHPREFIX</envar></link>"> <!ENTITY cv-link-RPATHSUFFIX "<link linkend='cv-RPATHSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RPATHSUFFIX</envar></link>"> <!ENTITY cv-link-RPCGEN "<link linkend='cv-RPCGEN' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$RPCGEN</envar></link>"> @@ -1205,6 +1206,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-UNCHANGED_TARGETS "<link linkend='cv-UNCHANGED_TARGETS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$UNCHANGED_TARGETS</envar></link>"> <!ENTITY cv-link-VENDOR "<link linkend='cv-VENDOR' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$VENDOR</envar></link>"> <!ENTITY cv-link-VERSION "<link linkend='cv-VERSION' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$VERSION</envar></link>"> +<!ENTITY cv-link-VSWHERE "<link linkend='cv-VSWHERE' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$VSWHERE</envar></link>"> <!ENTITY cv-link-WIN32_INSERT_DEF "<link linkend='cv-WIN32_INSERT_DEF' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$WIN32_INSERT_DEF</envar></link>"> <!ENTITY cv-link-WIN32DEFPREFIX "<link linkend='cv-WIN32DEFPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$WIN32DEFPREFIX</envar></link>"> <!ENTITY cv-link-WIN32DEFSUFFIX "<link linkend='cv-WIN32DEFSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$WIN32DEFSUFFIX</envar></link>"> |