diff options
author | William Deegan <bill@baddogconsulting.com> | 2015-03-24 06:05:11 (GMT) |
---|---|---|
committer | William Deegan <bill@baddogconsulting.com> | 2015-03-24 06:05:11 (GMT) |
commit | be0ee2179a7c9db85e518e626612d0ae0918c790 (patch) | |
tree | 32f03b48553087f1f1d37a1ee8356a8906209cc1 | |
parent | 976a3d27a47bf69eb886a92be06a09d7face2f55 (diff) | |
download | SCons-be0ee2179a7c9db85e518e626612d0ae0918c790.zip SCons-be0ee2179a7c9db85e518e626612d0ae0918c790.tar.gz SCons-be0ee2179a7c9db85e518e626612d0ae0918c790.tar.bz2 |
added more info to the section on InstallVersionedLib(). fixed having InstallAs example in the text for InstallVersionedLib()
-rw-r--r-- | doc/generated/builders.gen | 879 | ||||
-rw-r--r-- | doc/generated/functions.gen | 1277 | ||||
-rw-r--r-- | doc/generated/tools.gen | 643 | ||||
-rw-r--r-- | doc/generated/variables.gen | 3409 | ||||
-rw-r--r-- | doc/generated/variables.mod | 4 | ||||
-rw-r--r-- | src/engine/SCons/Tool/install.xml | 2 |
6 files changed, 2676 insertions, 3538 deletions
diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 3d534b0..d08833f 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,7 +12,7 @@ %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> @@ -20,18 +20,17 @@ <term> <function>env.CFile()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -46,13 +45,12 @@ env.CFile(target = 'bar', source = 'bar.y') <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 implemented + <listitem><para> +The <function>Command</function> "Builder" is actually implemented as a function that looks like a Builder, but actually takes an additional argument of the action from which the Builder should be made. -See the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Command"><function>Command</function></link> function description +See the <link linkend="f-Command"><function>Command</function></link> function description for the calling syntax and details. </para> </listitem> @@ -64,19 +62,18 @@ for the calling syntax and details. <term> <function>env.CXXFile()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -91,20 +88,19 @@ env.CXXFile(target = 'bar', source = 'bar.yy') <term> <function>env.DocbookEpub()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -117,17 +113,16 @@ env.DocbookEpub('manual') <term> <function>env.DocbookHtml()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -139,35 +134,34 @@ env.DocbookHtml('manual') <term> <function>env.DocbookHtmlChunked()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -179,35 +173,34 @@ your files get renamed only! <term> <function>env.DocbookHtmlhelp()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -220,16 +213,15 @@ your files get renamed only! <term> <function>env.DocbookMan()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -243,20 +235,19 @@ set from the <literal>refname</literal> entries in your XML source. <term> <function>env.DocbookPdf()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -269,33 +260,32 @@ env.DocbookPdf('manual') <term> <function>env.DocbookSlidesHtml()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -308,20 +298,19 @@ your files get renamed only! <term> <function>env.DocbookSlidesPdf()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -333,12 +322,11 @@ env.DocbookSlidesPdf('manual') <term> <function>env.DocbookXInclude()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -350,16 +338,15 @@ env.DocbookXInclude('manual_xincluded.xml', 'manual.xml') <term> <function>env.DocbookXslt()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -371,41 +358,40 @@ to be set. <term> <function>env.DVI()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<filename>scons</filename> 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 @@ -413,7 +399,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 @@ -430,14 +416,13 @@ env.DVI(target = 'ccc.dvi', source = 'ccc.latex') <term> <function>env.Gs()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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') ) @@ -451,8 +436,7 @@ env.Gs('cover.jpg','scons-scons.pdf', <term> <function>env.Install()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Installs one or more source files or directories in the specified target, which must be a directory. @@ -462,7 +446,7 @@ 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"> +<example_commands> env.Install('/usr/local/bin', source = ['foo', 'bar']) </example_commands> </listitem> @@ -474,8 +458,7 @@ env.Install('/usr/local/bin', source = ['foo', 'bar']) <term> <function>env.InstallAs()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Installs one or more source files or directories to specific names, allowing changing a file or directory name @@ -486,6 +469,14 @@ and source arguments list different numbers of files or directories. </para> + +<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> + </listitem> </varlistentry> <varlistentry id="b-InstallVersionedLib"> @@ -495,19 +486,21 @@ arguments list different numbers of files or directories. <term> <function>env.InstallVersionedLib()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Installs a versioned shared library. The <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> + <listitem><para> +Installs a versioned shared library. The <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> construction variable should be defined in the environment to confirm the version number in the library name. +If <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> is not defined a warning will be issued +and the name of the library will be parsed to derive the version. The symlinks appropriate to the architecture will be generated. </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.InstallVersionedLib(target = '/usr/local/bin/foo', + source = 'libxyz.1.5.2.so') +env.InstallVersionedLib(target = '/usr/local/bin/foo', + source = 'libxyz.1.5.2.so', + SHLIBVERSION='1.5.2') </example_commands> </listitem> </varlistentry> @@ -518,41 +511,40 @@ env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], <term> <function>env.Jar()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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', @@ -567,8 +559,7 @@ env.Jar(target = 'bar.jar', <term> <function>env.Java()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds one or more Java class files. The sources may be any combination of explicit <filename>.java</filename> files, @@ -576,7 +567,7 @@ or directory trees which will be scanned 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) @@ -587,7 +578,7 @@ The class files will be placed underneath 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 @@ -610,17 +601,17 @@ will generate a corresponding 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"> +<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, @@ -632,7 +623,7 @@ so that the compile will work if it is done on a system with a different encoding. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment() env['ENV']['LANG'] = 'en_GB.UTF-8' </example_commands> @@ -645,8 +636,7 @@ env['ENV']['LANG'] = 'en_GB.UTF-8' <term> <function>env.JavaH()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds C header and source files for implementing Java native methods. The target can be either a directory @@ -656,29 +646,29 @@ 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) @@ -701,10 +691,9 @@ env.JavaH(target = 'export', <term> <function>env.Library()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A synonym for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticLibrary</function> +<function>StaticLibrary</function> builder method. </para> </listitem> @@ -716,11 +705,10 @@ builder method. <term> <function>env.LoadableModule()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -733,10 +721,9 @@ this creates a loadable module bundle. <term> <function>env.M4()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -744,7 +731,7 @@ 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> @@ -756,15 +743,14 @@ env.M4(target = 'foo.c', source = 'foo.c.m4') <term> <function>env.Moc()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -777,48 +763,47 @@ env.Moc('foo.cpp') # generates foo.moc <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 + <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() @@ -832,17 +817,16 @@ Compile files for languages defined in <filename>LINGUAS</filename> file <term> <function>env.MSVSProject()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<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> @@ -852,7 +836,7 @@ For Visual Studio 7 (.NET) and later versions, it will generate a file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> By default, this also generates a solution file for the specified project, @@ -865,16 +849,16 @@ file for Visual Studio 7 (.NET). 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>, +<function>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> +<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 +<para> +The <function>MSVSProject</function> builder takes several lists of filenames to be placed into the project file. These are currently limited to @@ -885,24 +869,24 @@ These are currently limited to 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, +lists are added to the <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> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>target</literal>: The name of the target <filename>.dsp</filename> @@ -912,12 +896,12 @@ 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> +<link linkend="cv-MSVSPROJECTSUFFIX"><envar>$MSVSPROJECTSUFFIX</envar></link> construction variable will be defined to the correct value (see example below). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>variant</literal>: The name of this particular variant. For Visual Studio 7 projects, @@ -933,13 +917,13 @@ 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> +<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> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>buildtarget</literal>: An optional string, node, or list of strings or nodes (one per build variant), to tell the Visual Studio debugger @@ -951,7 +935,7 @@ entries must match the number of entries. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>runfile</literal>: The name of the file that Visual Studio 7 and later will run and debug. @@ -964,28 +948,28 @@ the default is the same as the specified value. </para> -<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, +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 +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"> +<para> Example usage: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> barsrcs = ['bar.cpp'], barincs = ['bar.h'], barlocalincs = ['StdAfx.h'] @@ -1013,17 +997,16 @@ env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], <term> <function>env.MSVSSolution()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds a Microsoft Visual Studio solution file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<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> +<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> @@ -1034,19 +1017,19 @@ generate a file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The following values must be specified: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>target</literal>: 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> +<link linkend="cv-MSVSSOLUTIONSUFFIX"><envar>$MSVSSOLUTIONSUFFIX</envar></link> will be defined to the correct value (see example below). </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>variant</literal>: The name of this particular variant, or a list of variant names (the latter is only supported for MSVS 7 solutions). These are @@ -1055,10 +1038,10 @@ you want. For MSVS 7 they may also specify target platform, like this "Debug|Xbox". Default platform is Win32. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>projects</literal>: 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> +<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 @@ -1067,11 +1050,11 @@ is because they represent file names to be added to the solution file, not the source files used to build the solution file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Example Usage: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], projects = ['bar' + env['MSVSPROJECTSUFFIX']], variant = 'Release') @@ -1085,10 +1068,9 @@ env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], <term> <function>env.Object()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A synonym for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">StaticObject</function> +<function>StaticObject</function> builder method. </para> </listitem> @@ -1100,41 +1082,39 @@ builder method. <term> <function>env.Package()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds a Binary Package of the given source files. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<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"> +<para> * msi - Microsoft Installer * rpm - Redhat Package Manger * ipkg - Itsy Package Management System @@ -1146,11 +1126,11 @@ the following packagers available: * src_zip - zip file source </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> 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"> +<example_commands> env = Environment(tools=['default', 'packaging']) env.Install('/bin/', 'my_program') env.Package( NAME = 'foo', @@ -1173,8 +1153,7 @@ env.Package( NAME = 'foo', <term> <function>env.PCH()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1186,7 +1165,7 @@ conjuction 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> @@ -1198,21 +1177,20 @@ env['PCH'] = env.PCH('StdAfx.cpp')[0] <term> <function>env.PDF()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1227,100 +1205,99 @@ env.PDF(target = 'bbb', source = 'bbb.dvi') <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 + <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> @@ -1333,21 +1310,20 @@ which has same efect as: <term> <function>env.PostScript()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1362,24 +1338,23 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') <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 + <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 @@ -1387,38 +1362,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 overriden 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 overriden 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" @@ -1426,49 +1401,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 @@ -1476,48 +1451,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>. @@ -1532,107 +1507,106 @@ then the <filename>messages.pot</filename> will contain <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 + <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 easilly +through the <link linkend="cv-POUPDATE_ALIAS"><envar>$POUPDATE_ALIAS</envar></link> construction variable. You can easilly 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 @@ -1649,29 +1623,28 @@ pre-configured via environment. <term> <function>env.Program()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -1683,8 +1656,7 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) <term> <function>env.RES()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1697,7 +1669,7 @@ 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> @@ -1709,8 +1681,7 @@ env.RES('resource.rc') <term> <function>env.RMIC()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds stub and skeleton class files for remote objects from Java <filename>.class</filename> files. @@ -1719,16 +1690,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 @@ -1736,7 +1707,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) @@ -1756,8 +1727,7 @@ env.RMIC(target = 'outdir3', <term> <function>env.RPCGenClient()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1766,7 +1736,7 @@ 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> @@ -1779,8 +1749,7 @@ env.RPCGenClient('src/rpcif.x') <term> <function>env.RPCGenHeader()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1789,7 +1758,7 @@ 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> @@ -1802,8 +1771,7 @@ env.RPCGenHeader('src/rpcif.x') <term> <function>env.RPCGenService()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1812,7 +1780,7 @@ 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> @@ -1825,8 +1793,7 @@ env.RPCGenClient('src/rpcif.x') <term> <function>env.RPCGenXDR()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1835,7 +1802,7 @@ 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> @@ -1848,8 +1815,7 @@ env.RPCGenClient('src/rpcif.x') <term> <function>env.SharedLibrary()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Builds a shared library (<filename>.so</filename> on a POSIX system, <filename>.dll</filename> on Windows) @@ -1861,24 +1827,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, @@ -1887,9 +1853,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, @@ -1898,34 +1864,39 @@ 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> +<filename>scons</filename> 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. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> needs to be of the form X.Y.Z, where X +are needed. <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> needs to be of the form X.Y.Z, where X and Y are numbers, and Z is a number but can also contain letters to designate alpha, beta, or release candidate patch levels. </para> -<para 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> This builder may create multiple links to the library. On a POSIX system, for the shared library libbar.so.2.3.1, the links created would be libbar.so and libbar.so.2; on a Darwin (OSX) system @@ -1933,28 +1904,28 @@ 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> @@ -1967,13 +1938,12 @@ when it is done linking it. <term> <function>env.SharedObject()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1988,21 +1958,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> @@ -2019,8 +1989,7 @@ below, for more information. <term> <function>env.StaticLibrary()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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, @@ -2029,29 +1998,29 @@ 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> +<filename>scons</filename> will raise an error if there is any mismatch. </para> </listitem> @@ -2063,14 +2032,13 @@ will raise an error if there is any mismatch. <term> <function>env.StaticObject()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2101,24 +2069,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> @@ -2135,28 +2103,27 @@ below, for more information. <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>. + <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 xmlns="http://www.scons.org/dbxsd/v1.0"> +<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 +<para> +The prefix and suffix specified by the <envar>$SUBSTFILEPREFIX</envar> +and <envar>$SUBSTFILESUFFIX</envar> construction variables (the null 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 @@ -2164,7 +2131,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. @@ -2173,7 +2140,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', 'textfile']) env['prefix'] = '/usr/bin' @@ -2225,13 +2192,12 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), <term> <function>env.Tar()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2241,11 +2207,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> +<filename>scons</filename> 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. @@ -2271,29 +2237,28 @@ env.Tar('foo') <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. + <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 +<para> +The prefix and suffix specified by the <envar>$TEXTFILEPREFIX</envar> +and <envar>$TEXTFILESUFFIX</envar> construction variables (the null 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']) @@ -2342,50 +2307,49 @@ blob.txt <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 + <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 @@ -2393,7 +2357,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 @@ -2410,11 +2374,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/ @@ -2425,11 +2389,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) @@ -2437,23 +2401,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 @@ -2463,7 +2427,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 @@ -2480,8 +2444,7 @@ running <command>scons '.'</command>.</para></note> <term> <function>env.TypeLibrary()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 inteface stub and @@ -2490,11 +2453,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>, @@ -2512,22 +2475,21 @@ files. <term> <function>env.Uic()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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'] @@ -2541,13 +2503,12 @@ env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), <term> <function>env.Zip()</function> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2557,11 +2518,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> +<filename>scons</filename> 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/functions.gen b/doc/generated/functions.gen index 62a9ab3..b1f1cbe 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,7 +12,7 @@ %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> @@ -20,8 +20,7 @@ <term> <literal>env.Action(action, [cmd/str/fun, [var, ...]] [option=value, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Creates an Action object for the specified <varname>action</varname>. @@ -29,7 +28,7 @@ See the section "Action Objects," below, 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 @@ -56,8 +55,7 @@ until the Action object is actually used. <term> <literal>env.AddMethod(function, [name])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> When called with the <function>AddMethod</function>() form, @@ -86,11 +84,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 @@ -116,8 +114,7 @@ env.other_method_name('another arg') <term> <literal>AddOption(arguments)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This function adds a new command-line option to be recognized. The specified <varname>arguments</varname> @@ -129,12 +126,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 +143,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,28 +153,28 @@ 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> 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>(). The value may also be set, using -<function xmlns="http://www.scons.org/dbxsd/v1.0">SetOption</function> +<function>SetOption</function> or <function>env.SetOption</function>(), if conditions in a -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> require overriding any default value. Note, however, that a value specified on the command line will @@ -185,7 +182,7 @@ value specified on the command line will override a value set by any SConscript file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Any specified <literal>help=</literal> strings for the new option(s) @@ -197,22 +194,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', @@ -230,8 +227,7 @@ env = Environment(PREFIX = GetOption('prefix')) <term> <literal>env.AddPostAction(target, action)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Arranges for the specified <varname>action</varname> to be performed @@ -244,7 +240,7 @@ can be converted into an Action object (see below). </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 @@ -259,8 +255,7 @@ one or more targets in the list. <term> <literal>env.AddPreAction(target, action)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Arranges for the specified <varname>action</varname> to be performed @@ -273,14 +268,14 @@ can be converted into an Action object (see below). </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 @@ -291,16 +286,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> +<filename>scons</filename> calls the link command that actually generates the executable program binary <filename>foo</filename>, @@ -317,8 +312,7 @@ file into an object file. <term> <literal>env.Alias(alias, [targets, [action]])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Creates one or more phony targets that expand to one or more other targets. An optional @@ -332,17 +326,17 @@ 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. </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') @@ -358,8 +352,7 @@ env.Alias('update', ['file1', 'file2'], "update_database $SOURCES") <term> <literal>AllowSubstExceptions([exception, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies the exceptions that will be allowed when expanding construction variables. By default, @@ -375,19 +368,19 @@ 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.) @@ -406,14 +399,13 @@ AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) <term> <literal>env.AlwaysBuild(target, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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, @@ -422,7 +414,7 @@ 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> @@ -430,8 +422,7 @@ Multiple targets can be passed in to a single call to <term> <literal>env.Append(key=val, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -447,11 +438,11 @@ and the lists are added together. (See also the Prepend method, below.) </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> @@ -460,8 +451,7 @@ env.Append(CCFLAGS = ' -g', FOO = ['foo.yyy']) <term> <literal>env.AppendENVPath(name, newpath, [envname, sep, delete_existing])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This appends new path elements to the given path in the specified external environment (<literal>ENV</literal> @@ -479,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) @@ -506,8 +496,7 @@ after: /biz:/foo/bar:/foo <term> <literal>env.AppendUnique(key=val, [...], delete_existing=0)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -523,11 +512,11 @@ 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> @@ -536,29 +525,28 @@ env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) <term> <literal>env.BitKeeper()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A factory function that returns a Builder object to be used to fetch source files using BitKeeper. The returned Builder is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</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.SourceCode('.', env.BitKeeper()) </example_commands> </listitem> @@ -570,10 +558,9 @@ env.SourceCode('.', env.BitKeeper()) <term> <literal>env.BuildDir(build_dir, src_dir, [duplicate])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Deprecated synonyms for -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<function>VariantDir</function> and <function>env.VariantDir</function>(). The @@ -581,7 +568,7 @@ The argument becomes the <varname>variant_dir</varname> argument of -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<function>VariantDir</function> or <function>env.VariantDir</function>(). </para> @@ -594,8 +581,7 @@ or <term> <literal>env.Builder(action, [arguments])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Creates a Builder object for the specified <varname>action</varname>. @@ -603,7 +589,7 @@ See the section "Builder Objects," below, 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 @@ -618,7 +604,7 @@ 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> @@ -631,15 +617,14 @@ until after the Builder object is actually called. <term> <literal>env.CacheDir(cache_dir)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> 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> @@ -648,13 +633,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 @@ -665,21 +650,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> +<filename>scons</filename> 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> +<filename>scons</filename> 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> +<filename>scons</filename> will rebuild it and then place a copy of the built file in the cache (identified by its MD5 build signature), @@ -688,20 +673,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> +<filename>scons</filename> will place a copy of <emphasis>all</emphasis> derived files in the cache, @@ -709,17 +694,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>, +<filename>scons</filename> will report, "Retrieved `file' from cache," unless the @@ -728,7 +713,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> +<filename>scons</filename> will print the action that <emphasis>would</emphasis> have been used to build the file, @@ -740,9 +725,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. @@ -756,8 +741,7 @@ predict or prohibitively large. <term> <literal>env.Clean(targets, files_or_dirs)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This specifies a list of files or directories which should be removed whenever the targets are specified with the <option>-c</option> @@ -765,28 +749,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> @@ -795,23 +779,23 @@ 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> @@ -820,8 +804,7 @@ Clean(docdir, os.path.join(docdir, projectname)) <term> <literal>env.Clone([key=val, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a separate copy of a construction environment. If there are any keyword arguments specified, they are added to the returned copy, @@ -829,32 +812,32 @@ 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: </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: </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> @@ -867,8 +850,7 @@ wx_env = env.Clone(parse_flags = '!wx-config --cflags --cxxflags') <term> <literal>env.Command(target, source, action, [key=val, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Executes a specific action (or list of actions) to build a target file or files. @@ -877,7 +859,7 @@ than defining a separate Builder object for a single special-case build. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> As a special case, the <varname>source_scanner</varname> keyword argument can @@ -893,12 +875,12 @@ changes to files that aren't already specified in other Builder of function calls.) </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; @@ -915,11 +897,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") @@ -937,9 +919,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 @@ -948,24 +930,24 @@ If necessary, you can explicitly specify that targets or source nodes should be treated as directoriese 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.) @@ -979,8 +961,7 @@ so you normally don't need to create directories by hand.) <term> <literal>env.Configure([custom_tests, conf_dir, log_file, config_h])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Creates a Configure object for integrated functionality similar to GNU autoconf. See the section "Configure Contexts," @@ -992,8 +973,7 @@ below, for a complete explanation of the arguments and behavior. <term> <literal>env.Copy([key=val, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A now-deprecated synonym for <function>env.Clone</function>(). </para> @@ -1003,8 +983,7 @@ A now-deprecated synonym for <term> <literal>env.CVS(repository, module)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A factory function that returns a Builder object to be used to fetch source files @@ -1013,17 +992,17 @@ CVS <varname>repository</varname>. The returned Builder is intended to be passed to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link> +<link linkend="f-SourceCode"><function>SourceCode</function></link> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional specified <varname>module</varname> will be added to the beginning @@ -1037,11 +1016,11 @@ directory hierarchy in your local build directory. </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> # Will fetch foo/bar/src.c # from /usr/local/CVSROOT/foo/bar/src.c. env.SourceCode('.', env.CVS('/usr/local/CVSROOT')) @@ -1063,8 +1042,7 @@ env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo/bar')) <term> <literal>env.Decider(function)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies that all up-to-date decisions for targets built through this construction environment will be handled by the specified @@ -1076,7 +1054,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> @@ -1159,11 +1137,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') @@ -1172,7 +1150,7 @@ Decider('timestamp-match') env.Decider('content') </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> In addition to the above already-available functions, the <varname>function</varname> @@ -1180,7 +1158,7 @@ argument may be an actual Python function that takes the following three arguments: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <variablelist> <varlistentry> <term><parameter>dependency</parameter></term> @@ -1228,7 +1206,7 @@ size, or content signature. </variablelist> </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The <varname>function</varname> should return a @@ -1256,11 +1234,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): return not os.path.exists(str(target)) @@ -1275,55 +1253,54 @@ env.Decider(my_decider) <term> <literal>env.Default(targets)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<filename>scons</filename> 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. </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; @@ -1335,8 +1312,7 @@ see below. <term> <literal>DefaultEnvironment([args])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Creates and returns a default construction environment object. This construction environment is used internally by SCons in order to execute many of the global functions in this list, @@ -1352,8 +1328,7 @@ from source code management systems. <term> <literal>env.Depends(target, dependency)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies an explicit dependency; the <varname>target</varname> @@ -1376,11 +1351,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') @@ -1401,8 +1376,7 @@ env.Depends(bar, installed_lib) <term> <literal>env.Dictionary([vars])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a dictionary object containing copies of all of the construction variables in the environment. @@ -1411,11 +1385,11 @@ only the specified construction variables are returned in the dictionary. </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> dict = env.Dictionary() cc_dict = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') </example_commands> @@ -1428,8 +1402,7 @@ cc_dict = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') <term> <literal>env.Dir(name, [directory])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This returns a Directory Node, an object that represents the specified directory <varname>name</varname>. @@ -1442,7 +1415,7 @@ 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. @@ -1450,7 +1423,7 @@ 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. @@ -1464,8 +1437,7 @@ see "File and Directory Nodes," below. <term> <literal>env.Dump([key])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a pretty printable representation of the environment. <varname>key</varname>, if not @@ -1473,36 +1445,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'], @@ -1520,8 +1492,7 @@ will print: <term> <literal>env.EnsurePythonVersion(major, minor)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Ensure that the Python version is at least <varname>major</varname>.<varname>minor</varname>. This function will @@ -1529,11 +1500,11 @@ 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> @@ -1545,8 +1516,7 @@ EnsurePythonVersion(2,2) <term> <literal>env.EnsureSConsVersion(major, minor, [revision])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Ensure that the SCons version is at least <varname>major.minor</varname>, or @@ -1559,11 +1529,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) @@ -1577,8 +1547,7 @@ EnsureSConsVersion(0,96,90) <term> <literal>env.Environment([key=value, ...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Return a new construction environment initialized with the specified <varname>key</varname><literal>=</literal><varname>value</varname> @@ -1593,8 +1562,7 @@ pairs. <term> <literal>env.Execute(action, [strfunction, varlist])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Executes an Action object. The specified <varname>action</varname> @@ -1612,14 +1580,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> +<filename>scons</filename> 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> +<filename>scons</filename> will <emphasis>not</emphasis>, however, @@ -1628,12 +1596,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"): @@ -1649,10 +1617,9 @@ if Execute("mkdir sub/dir/ectory"): <term> <literal>env.Exit([value])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> to exit immediately with the specified <varname>value</varname>. @@ -1670,29 +1637,28 @@ is used if no value is specified. <term> <literal>env.Export(vars)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>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> +<function>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> +<function>Export</function> as separate arguments or as a list. 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. 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") @@ -1711,15 +1677,15 @@ 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>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>SConscript</function> function, below. </para> </listitem> @@ -1731,8 +1697,7 @@ function, below. <term> <literal>env.File(name, [directory])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This returns a File Node, an object that represents the specified file @@ -1743,7 +1708,7 @@ can be a relative or absolute path. is an optional directory that will be used as the parent directory. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>name</varname> is a list, SCons returns a list of File nodes. @@ -1751,7 +1716,7 @@ 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. @@ -1768,8 +1733,7 @@ see "File and Directory Nodes," below. <term> <literal>env.FindFile(file, dirs)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Search for <varname>file</varname> in the path specified by @@ -1781,11 +1745,11 @@ 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> @@ -1797,25 +1761,24 @@ foo = env.FindFile('foo', ['dir1', 'dir2']) <term> <literal>env.FindInstalledFiles()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1834,8 +1797,7 @@ FindInstalledFiles() <term> <literal>FindPathDirs(variable)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a function (actually a callable Python object) intended to be used as the @@ -1847,14 +1809,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> @@ -1862,11 +1824,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). @@ -1878,11 +1840,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 @@ -1900,8 +1862,7 @@ scanner = Scanner(name = 'myscanner', <term> <literal>env.FindSourceFiles(node='"."')</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1911,16 +1872,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' ) @@ -1932,7 +1893,7 @@ 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> @@ -1945,8 +1906,7 @@ will also be returned by this function. <term> <literal>env.Flatten(sequence)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Takes a sequence (that is, a Python list or tuple) that may contain nested sequences and returns a flattened list containing @@ -1959,11 +1919,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') @@ -1986,8 +1946,7 @@ for object in Flatten(objects): <term> <literal>GetBuildFailures()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a list of exceptions for the actions that failed while attempting to build targets. @@ -1999,13 +1958,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 @@ -2013,7 +1972,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. @@ -2023,7 +1982,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. @@ -2046,7 +2005,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 @@ -2056,7 +2015,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 @@ -2065,26 +2024,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 @@ -2096,7 +2055,7 @@ function. Example: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> import atexit def print_build_failures(): @@ -2115,10 +2074,9 @@ atexit.register(print_build_failures) <term> <literal>env.GetBuildPath(file, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> path name (or names) for the specified <varname>file</varname> (or files). @@ -2126,7 +2084,7 @@ The specified <varname>file</varname> or files may be -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> Nodes or strings representing path names. </para> </listitem> @@ -2138,10 +2096,9 @@ Nodes or strings representing path names. <term> <literal>env.GetLaunchDir()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns the absolute path name of the directory from which -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> was initially invoked. This can be useful when using the <option>-u</option>, @@ -2150,7 +2107,7 @@ 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> @@ -2162,17 +2119,16 @@ file is found. <term> <literal>env.GetOption(name)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -2417,7 +2373,7 @@ which corresponds to --warn and --warning. </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 option. @@ -2431,12 +2387,11 @@ option. <term> <literal>env.Glob(pattern, [ondisk, source, strings])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>() @@ -2446,20 +2401,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 @@ -2467,17 +2422,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) @@ -2487,7 +2442,7 @@ 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 @@ -2501,7 +2456,7 @@ 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 @@ -2509,20 +2464,20 @@ argument may be set to (or any equivalent value) 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) 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 @@ -2531,22 +2486,22 @@ 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> Examples: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> Program('foo', Glob('*.c')) Zip('/tmp/everything', Glob('.??*') + Glob('*')) </example_commands> @@ -2559,17 +2514,16 @@ Zip('/tmp/everything', Glob('.??*') + Glob('*')) <term> <literal>env.Help(text)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>. +<filename>scons</filename>. If -<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function> +<function>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> +<function>Help</function> is called. </para> </listitem> @@ -2581,34 +2535,33 @@ is called. <term> <literal>env.Ignore(target, dependency)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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') @@ -2623,31 +2576,30 @@ env.Ignore('bar','bar/foobar.obj') <term> <literal>env.Import(vars)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>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> +<function>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>. +<link linkend="f-SConscript"><function>SConscript</function></link>. Variables exported by -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<function>SConscript</function> have precedence. Multiple variable names can be passed to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Import</function> +<function>Import</function> as separate arguments or as a list. The variable "*" can be used to import all 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"]) @@ -2662,8 +2614,7 @@ Import("*") <term> <literal>env.Literal(string)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The specified <varname>string</varname> will be preserved as-is @@ -2678,8 +2629,7 @@ and not have construction variables expanded. <term> <literal>env.Local(targets)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The specified <varname>targets</varname> will have copies made in the local tree, @@ -2693,8 +2643,7 @@ Returns a list of the target Node or Nodes. <term> <literal>env.MergeFlags(arg, [unique])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Merges the specified <varname>arg</varname> values to the construction environment's construction variables. @@ -2702,7 +2651,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 @@ -2711,10 +2660,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 @@ -2730,11 +2679,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') @@ -2757,39 +2706,38 @@ env.MergeFlags(['-O3', <term> <literal>env.NoCache(target, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -2802,8 +2750,7 @@ NoCache(env.Program('hello', 'hello.c')) <term> <literal>env.NoClean(target, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies a list of files or directories which should <emphasis>not</emphasis> be removed whenever the targets (or their dependencies) @@ -2813,7 +2760,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 @@ -2821,21 +2768,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> @@ -2844,11 +2791,11 @@ 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> @@ -2858,8 +2805,7 @@ NoClean(env.Program('hello', 'hello.c')) <term> <literal>env.ParseConfig(command, [function, unique])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Calls the specified <varname>function</varname> to modify the environment as specified by the output of @@ -2867,7 +2813,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 @@ -2884,11 +2830,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, below, for a table of options and construction variables. @@ -2902,18 +2848,17 @@ for a table of options and construction variables. <term> <literal>env.ParseDepends(filename, [must_exist, only_one])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2929,7 +2874,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 @@ -2951,15 +2896,15 @@ 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> @@ -2968,26 +2913,25 @@ function. <term> <literal>env.ParseFlags(flags, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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, @@ -2996,12 +2940,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 @@ -3025,19 +2969,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']) @@ -3049,33 +2993,32 @@ dict = env.ParseFlags('-O2', '!echo -Dfoo -Dbar=1') <term> <literal>env.Perforce()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A factory function that returns a Builder object to be used to fetch source files from the Perforce source code management system. The returned Builder is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</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.SourceCode('.', env.Perforce()) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Perforce uses a number of external environment variables for its operation. Consequently, this function adds the @@ -3099,39 +3042,38 @@ USERNAME. <term> <literal>Platform(string)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -3140,7 +3082,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 @@ -3158,15 +3100,14 @@ will work on Windows systems. <term> <literal>env.Precious(target, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<filename>scons</filename> 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> @@ -3174,8 +3115,7 @@ Multiple targets can be passed in to a single call to <term> <literal>env.Prepend(key=val, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3191,11 +3131,11 @@ 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> @@ -3204,11 +3144,10 @@ env.Prepend(CCFLAGS = '-g ', FOO = ['foo.yyy']) <term> <literal>env.PrependENVPath(name, newpath, [envname, sep, delete_existing])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -3223,7 +3162,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 @@ -3231,22 +3170,22 @@ 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> @@ -3256,8 +3195,7 @@ after: /foo/bar:/foo:/biz <term> <literal>env.PrependUnique(key=val, delete_existing=0, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3273,11 +3211,11 @@ 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> @@ -3292,14 +3230,13 @@ env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) <term> <literal>Progress(list_of_strings, [interval, file, overwrite])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>() @@ -3321,19 +3258,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. @@ -3344,7 +3281,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 @@ -3354,9 +3291,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 @@ -3372,14 +3309,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> @@ -3397,14 +3334,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 @@ -3414,7 +3351,7 @@ 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> @@ -3426,18 +3363,17 @@ Progress(['-\r', '\\\r', '|\r', '/\r'], interval=5) <term> <literal>env.Pseudo(target, ...)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -3445,35 +3381,34 @@ Multiple targets can be passed in to a single call to <term> <literal>env.RCS()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A factory function that returns a Builder object to be used to fetch source files from RCS. The returned Builder is intended to be passed to the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</function> function: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This function is deprecated. For details, see the entry for the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>SourceCode</function> function. </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.SourceCode('.', env.RCS()) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will fetch source files from RCS subdirectories automatically, so configuring RCS @@ -3492,17 +3427,16 @@ for a specific subdirectory. <term> <literal>env.Replace(key=val, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -3514,21 +3448,20 @@ env.Replace(CCFLAGS = '-g', FOO = 'foo.xxx') <term> <literal>env.Repository(directory)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>, +<filename>scons</filename>, a repository is a copy of the source tree, from the top-level directory on down, which may contain @@ -3539,26 +3472,26 @@ 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>, +<filename>scons</filename>, so that the repository contains the necessary signature information to allow -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> 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> +<filename>scons</filename> 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> @@ -3570,8 +3503,7 @@ method. <term> <literal>env.Requires(target, prerequisite)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies an order-only relationship between the specified target file(s) and the specified prerequisite file(s). @@ -3585,11 +3517,11 @@ 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> @@ -3598,8 +3530,7 @@ env.Requires('foo', 'file-that-must-be-built-before-foo') <term> <literal>Return([vars..., stop=])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> By default, this stops processing the current SConscript file and returns to the calling SConscript file @@ -3607,32 +3538,32 @@ the values of the variables named in the <varname>vars</varname> string arguments. Multiple strings contaning variable names may be passed to -<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function>. +<function>Return</function>. Any strings that contain white space </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The optional <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> +<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> +<function>Return</function> is called. </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> # Returns without returning a value. Return() @@ -3654,8 +3585,7 @@ Return('val1 val2') <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"> + <listitem><para> Creates a Scanner object for the specified <varname>function</varname>. @@ -3668,29 +3598,28 @@ below, for a complete explanation of the arguments and behavior. <term> <literal>env.SCCS()</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A factory function that returns a Builder object to be used to fetch source files from SCCS. The returned Builder is intended to be passed to the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link> +<link linkend="f-SourceCode"><function>SourceCode</function></link> 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.SourceCode('.', env.SCCS()) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will fetch source files from SCCS subdirectories automatically, so configuring SCCS @@ -3718,24 +3647,23 @@ for a specific subdirectory. <term> <literal>env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>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> +<link 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>. +<function>SConscript</function>. There are two ways to call the -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<function>SConscript</function> function. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The first way you can call -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<function>SConscript</function> is to explicitly specify one or more <varname>scripts</varname> as the first argument. @@ -3743,45 +3671,45 @@ 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>). +<function>Split</function>). 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"> +<para> The second way you can call -<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function> +<function>SConscript</function> is to specify a list of (sub)directory names as a <literal>dirs=</literal><varname>subdirs</varname> keyword argument. In this case, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will, by default, 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> 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 @@ -3790,28 +3718,28 @@ named values to export to the 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> +<function>Export</function> function. <!-- If multiple dirs are provided, each script gets a fresh export. --> The subsidiary <varname>script(s)</varname> 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> +<link linkend="f-VariantDir"><function>VariantDir</function></link> method described below. (If <varname>variant_dir</varname> @@ -3828,14 +3756,14 @@ and arguments are interpreted relative to the directory of the calling --> argument is interpreted relative to the directory of the calling -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> file. See the description of the -<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function> +<function>VariantDir</function> function below for additional details and restrictions. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If <varname>variant_dir</varname> is present, @@ -3845,46 +3773,46 @@ but is not, --> the source directory is the directory in which the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> file resides and the -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<filename>SConscript</filename> 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"> +<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"> +<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> @@ -3917,25 +3845,25 @@ TODO??? SConscript('build/SConscript', src_dir='src') --> </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' } @@ -3944,7 +3872,7 @@ 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) @@ -3959,10 +3887,9 @@ SConscript('src/SConscript', variant_dir='build/ppc', duplicate=0) <term> <literal>env.SConscriptChdir(value)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> By default, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> changes its working directory to the directory in which each subsidiary SConscript file lives. @@ -3970,14 +3897,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> +<filename>scons</filename> will stay in the top-level directory while reading all SConscript files. (This may be necessary when building from repositories, @@ -3989,11 +3916,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 @@ -4009,10 +3936,9 @@ SConscript('bar/SConscript') # will chdir to bar <term> <literal>env.SConsignFile([file, dbm_module])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> to store all file signatures in the specified database <varname>file</varname>. @@ -4029,17 +3955,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> +<filename>scons</filename> will store file signatures in a separate <filename>.sconsign</filename> @@ -4049,7 +3975,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 @@ -4061,11 +3987,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). @@ -4088,14 +4014,13 @@ SConsignFile(None) <term> <literal>env.SetDefault(key=val, [...])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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' @@ -4109,13 +4034,12 @@ if 'FOO' not in env: env['FOO'] = 'foo' <term> <literal>env.SetOption(name, value)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -4192,17 +4116,17 @@ 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 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> @@ -4214,8 +4138,7 @@ SetOption('max_drift', 1) <term> <literal>env.SideEffect(side_effect, target)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Declares <varname>side_effect</varname> as a side effect of building @@ -4233,7 +4156,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> +<filename>scons</filename> will ensure that only one set of commands is executed at a time. Consequently, you only need to use this method @@ -4241,7 +4164,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 @@ -4265,9 +4188,9 @@ 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> @@ -4279,17 +4202,16 @@ function. <term> <literal>env.SourceCode(entries, builder)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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>. +Synchronizing with the archive is best done external to <application>SCons</application>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Arrange for non-existent source files to be fetched from a source code management system using the specified @@ -4302,30 +4224,30 @@ source files or directories in which source files can be found. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> For any non-existent source files, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will search up the directory tree and use the first -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function> +<function>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> +<filename>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> +<function>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> +<para> +<filename>scons</filename> will, by default, fetch files from SCCS or RCS subdirectories without explicit configuration. @@ -4337,11 +4259,11 @@ and speed up your build a little by disabling these searches as follows: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.SourceCode('.', None) </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that if the specified <varname>builder</varname> is one you create by hand, @@ -4350,8 +4272,8 @@ 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> +<para> +<filename>scons</filename> provides a set of canned factory functions that return appropriate Builders for various popular @@ -4359,14 +4281,14 @@ source code management systems. Canonical examples of invocation include: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> 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"> +<para> <!-- env.SourceCode('.', env.Subversion('file:///usr/local/Subversion')) --> </para> </listitem> @@ -4378,21 +4300,20 @@ env.SourceCode('no_source.c', None) <term> <literal>env.SourceSignatures(type)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Note: Although it is not yet officially deprecated, use of this function is discouraged. See the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link> +<link linkend="f-Decider"><function>Decider</function></link> function for a more flexible and straightforward way to configure SCons' decision-making. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> function tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> how to decide if a source file (a file that is not built from any other files) has changed since the last time it @@ -4403,7 +4324,7 @@ or <literal>timestamp</literal>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the environment method is used, the specified type of source signature is only used when deciding whether targets @@ -4414,19 +4335,19 @@ used for all decisions about whether targets are up-to-date. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>MD5</literal> means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a source file has changed if the MD5 checksum of its contents has changed since the last time it was used to rebuild a particular target file. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>timestamp</literal> means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a source file has changed if its timestamp (modification time) has changed since the last time it was used to rebuild a particular target file. @@ -4436,14 +4357,14 @@ by default it will also rebuild if the dependency is than the last time it was used to rebuild the target file.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> There is no different between the two behaviors for Python -<function xmlns="http://www.scons.org/dbxsd/v1.0">Value</function> +<function>Value</function> node objects. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>MD5</literal> signatures take longer to compute, but are more accurate than @@ -4453,21 +4374,21 @@ The default value is <literal>MD5</literal>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Note that the default -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-TargetSignatures"><function>TargetSignatures</function></link> +<link linkend="f-TargetSignatures"><function>TargetSignatures</function></link> setting (see below) is to use this -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> setting for any target files that are used to build other target files. Consequently, changing the value of -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> will, by default, affect the up-to-date decision for all files in the build (or all files built with a specific construction environment when -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.SourceSignatures</function> +<function>env.SourceSignatures</function> is used). </para> </listitem> @@ -4479,8 +4400,7 @@ is used). <term> <literal>env.Split(arg)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Returns a list of file names or other objects. If arg is a string, it will be split on strings of white-space characters @@ -4493,11 +4413,11 @@ 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(""" @@ -4512,14 +4432,13 @@ files = Split(""" <term> <literal>env.subst(input, [raw, target, source, conv])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -4551,7 +4470,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 @@ -4559,7 +4478,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 @@ -4568,20 +4487,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 @@ -4599,11 +4518,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): @@ -4620,20 +4539,19 @@ source_nodes = env.subst('$EXPAND_TO_NODELIST', <term> <literal>Tag(node, tags)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 0644 file # access mode Tag( Library( 'lib.c' ), UNIX_ATTR="0644" ) @@ -4650,21 +4568,20 @@ Tag( 'file2.txt', DOC ) <term> <literal>env.TargetSignatures(type)</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Note: Although it is not yet officially deprecated, use of this function is discouraged. See the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link> +<link linkend="f-Decider"><function>Decider</function></link> function for a more flexible and straightforward way to configure SCons' decision-making. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function> +<function>TargetSignatures</function> function tells -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> how to decide if a target file (a file that <emphasis>is</emphasis> @@ -4681,7 +4598,7 @@ or <literal>"source"</literal>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the environment method is used, the specified type of target signature is only used for targets built with that environment. @@ -4692,17 +4609,17 @@ don't have an explicit target signature type specified for their environments. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>"content"</literal> (or its synonym <literal>"MD5"</literal>) means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a target file has changed if the MD5 checksum of its contents has changed since the last time it was used to rebuild some other target file. This means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will open up MD5 sum the contents of target files after they're built, @@ -4711,10 +4628,10 @@ and may decide that it does not need to rebuild rebuilt with exactly the same contents as the last time. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>"timestamp"</literal> means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a target file has changed if its timestamp (modification time) has changed since the last time it was used to rebuild some other target file. @@ -4724,33 +4641,33 @@ by default it will also rebuild if the dependency is than the last time it was used to rebuild the target file.) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>"source"</literal> means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a target file has changed as specified by the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> setting (<literal>"MD5"</literal> or <literal>"timestamp"</literal>). This means that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will treat all input files to a target the same way, regardless of whether they are source files or have been built from other files. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>"build"</literal> means -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> decides that a target file has changed if it has been rebuilt in this invocation or if its content or timestamp have changed as specified by the corresponding -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> setting. This "propagates" the status of a rebuilt file so that other "downstream" target files @@ -4759,7 +4676,7 @@ even if the contents or the timestamp have not changed. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <literal>"build"</literal> signatures are fastest because <literal>"content"</literal> @@ -4781,18 +4698,18 @@ The default value is <literal>"source"</literal>. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Because the default setting is <literal>"source"</literal>, using -<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function> +<function>SourceSignatures</function> is generally preferable to -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function>, +<function>TargetSignatures</function>, so that the up-to-date decision will be consistent for all files (or all files built with a specific construction environment). Use of -<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function> +<function>TargetSignatures</function> provides specific control for how built target files affect their "downstream" dependencies. </para> @@ -4805,10 +4722,9 @@ affect their "downstream" dependencies. <term> <literal>env.Tool(string, [toolpath, **kw])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">Tool</function> +<function>Tool</function> form of the function returns a callable object that can be used to initialize @@ -4820,21 +4736,21 @@ 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> +<link linkend="cv-TOOLS"><envar>$TOOLS</envar></link> construction variable. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Additional keyword arguments are passed to the tool's <function>generate</function>() 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> env = Environment(tools = [ Tool('msvc') ]) env = Environment() @@ -4844,22 +4760,22 @@ u = Tool('opengl', toolpath = ['tools']) u(env) # adds 'opengl' to the TOOLS variable </example_commands> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The -<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Tool</function> +<function>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> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Additional keyword arguments are passed to the tool's <function>generate</function>() method. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env.Tool('gcc') env.Tool('opengl', toolpath = ['build/tools']) </example_commands> @@ -4872,8 +4788,7 @@ env.Tool('opengl', toolpath = ['build/tools']) <term> <literal>env.Value(value, [built_value])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4887,7 +4802,7 @@ When using timestamp source signatures, Value Nodes' timestamps are equal to the system time when the Node is created. </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 @@ -4903,11 +4818,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): @@ -4949,10 +4864,9 @@ env.UpdateValue(target = Value(output), source = Value(input)) <term> <literal>env.VariantDir(variant_dir, src_dir, [duplicate])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -4965,8 +4879,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 @@ -4984,9 +4898,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> +<filename>scons</filename> 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 @@ -4997,7 +4911,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 @@ -5008,14 +4922,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> +<filename>scons</filename> to invoke Builders using the path names of source files in <varname>src_dir</varname> and the path names of derived files within @@ -5026,9 +4940,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 @@ -5036,11 +4950,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> +<filename>scons</filename> 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') @@ -5048,31 +4962,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) @@ -5086,8 +5000,7 @@ SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) <term> <literal>env.WhereIs(program, [path, pathext, reject])</literal> </term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Searches for the specified executable <varname>program</varname>, returning the full path name to the program diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index aea2aa6..2d4e691 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,127 +12,112 @@ %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: &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> </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: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCC;.</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: &cv-link-F77;, &cv-link-SHF77;.</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: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;.</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-FRAMEWORKPATHPREFIX;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LINKCOM;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-_FRAMEWORKPATH;, &cv-link-_FRAMEWORKS;.</para><para>Uses: &cv-link-FRAMEWORKSFLAGS;.</para></listitem> +<para>Sets: &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-_FRAMEWORKPATH;, &cv-link-_FRAMEWORKS;.</para><para>Uses: &cv-link-FRAMEWORKSFLAGS;.</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: &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> </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: &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> </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: &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> </varlistentry> <varlistentry id="t-BitKeeper"> <term>BitKeeper</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the BitKeeper source code control system. </para> -<para>Sets: &cv-link-BITKEEPER;, &cv-link-BITKEEPERCOM;, &cv-link-BITKEEPERGET;, &cv-link-BITKEEPERGETFLAGS;.</para><para>Uses: &cv-link-BITKEEPERCOMSTR;.</para></listitem> +<para>Sets: &cv-link-BITKEEPER;, &cv-link-BITKEEPERCOM;, &cv-link-BITKEEPERGET;, &cv-link-BITKEEPERGETFLAGS;.</para><para>Uses: &cv-link-BITKEEPERCOMSTR;.</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 copmilers. </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: &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> </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: &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> </varlistentry> <varlistentry id="t-CVS"> <term>CVS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the CVS source code management system. </para> -<para>Sets: &cv-link-CVS;, &cv-link-CVSCOFLAGS;, &cv-link-CVSCOM;, &cv-link-CVSFLAGS;.</para><para>Uses: &cv-link-CVSCOMSTR;.</para></listitem> +<para>Sets: &cv-link-CVS;, &cv-link-CVSCOFLAGS;, &cv-link-CVSCOM;, &cv-link-CVSFLAGS;.</para><para>Uses: &cv-link-CVSCOMSTR;.</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: &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> </varlistentry> <varlistentry id="t-default"> <term>default</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets variables by calling a default list of Tool modules for the platform on which SCons is running. </para> @@ -140,16 +125,14 @@ for the platform on which SCons is running. </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-DLINKFLAGS;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem> +<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-DLINKFLAGS;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</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. @@ -157,27 +140,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 @@ -188,49 +171,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> @@ -239,24 +222,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 @@ -265,762 +248,680 @@ 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: &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> </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: &cv-link-DVIPDF;, &cv-link-DVIPDFCOM;, &cv-link-DVIPDFFLAGS;.</para><para>Uses: &cv-link-DVIPDFCOMSTR;.</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: &cv-link-DVIPS;, &cv-link-DVIPSFLAGS;, &cv-link-PSCOM;, &cv-link-PSPREFIX;, &cv-link-PSSUFFIX;.</para><para>Uses: &cv-link-PSCOMSTR;.</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: &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> </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: &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> </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: &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> </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: &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> </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: &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> </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: &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> </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: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-AS;.</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: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;.</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-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem> +<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-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</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 sofware 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: &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> </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-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</para></listitem> +<para>Sets: &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</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: &cv-link-GS;, &cv-link-GSCOM;, &cv-link-GSFLAGS;.</para><para>Uses: &cv-link-GSCOMSTR;.</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: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;.</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: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;.</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: &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> </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: &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> </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: &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> </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: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;.</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: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;.</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: &cv-link-INSTALL;, &cv-link-INSTALLSTR;.</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: &cv-link-AR;, &cv-link-CC;, &cv-link-CXX;, &cv-link-INTEL_C_COMPILER_VERSION;, &cv-link-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: &cv-link-JAR;, &cv-link-JARCOM;, &cv-link-JARFLAGS;, &cv-link-JARSUFFIX;.</para><para>Uses: &cv-link-JARCOMSTR;.</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-JAVASOURCEPATH;, &cv-link-JAVASUFFIX;.</para><para>Uses: &cv-link-JAVACCOMSTR;.</para></listitem> +<para>Sets: &cv-link-JAVABOOTCLASSPATH;, &cv-link-JAVAC;, &cv-link-JAVACCOM;, &cv-link-JAVACFLAGS;, &cv-link-JAVACLASSPATH;, &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVASOURCEPATH;, &cv-link-JAVASUFFIX;.</para><para>Uses: &cv-link-JAVACCOMSTR;.</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: &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAH;, &cv-link-JAVAHCOM;, &cv-link-JAVAHFLAGS;.</para><para>Uses: &cv-link-JAVACLASSPATH;, &cv-link-JAVAHCOMSTR;.</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: &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;.</para><para>Uses: &cv-link-LATEXCOMSTR;.</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-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem> +<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-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</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;.</para><para>Uses: &cv-link-LEXCOMSTR;.</para></listitem> +<para>Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;.</para><para>Uses: &cv-link-LEXCOMSTR;.</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. </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-SHLIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<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-SHLIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;.</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: &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> </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: &cv-link-M4;, &cv-link-M4COM;, &cv-link-M4FLAGS;.</para><para>Uses: &cv-link-M4COMSTR;.</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: &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> </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: &cv-link-MIDL;, &cv-link-MIDLCOM;, &cv-link-MIDLFLAGS;.</para><para>Uses: &cv-link-MIDLCOMSTR;.</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: &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> </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: &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> </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: &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> </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: &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> </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: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</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: &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> </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: &cv-link-MSSDK_DIR;, &cv-link-MSSDK_VERSION;, &cv-link-MSVS_VERSION;.</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: &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> </varlistentry> <varlistentry id="t-msvs"> <term>msvs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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> +<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> </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: &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> </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: &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> </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> +<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"> + <listitem><para> A framework for building binary and source packages. </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. + <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: &cv-link-PDFPREFIX;, &cv-link-PDFSUFFIX;.</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: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;.</para><para>Uses: &cv-link-PDFLATEXCOMSTR;.</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: &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> </varlistentry> <varlistentry id="t-Perforce"> <term>Perforce</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for interacting with the Perforce source code management system. </para> -<para>Sets: &cv-link-P4;, &cv-link-P4COM;, &cv-link-P4FLAGS;.</para><para>Uses: &cv-link-P4COMSTR;.</para></listitem> +<para>Sets: &cv-link-P4;, &cv-link-P4COM;, &cv-link-P4FLAGS;.</para><para>Uses: &cv-link-P4COMSTR;.</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: &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> </varlistentry> <varlistentry id="t-RCS"> <term>RCS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for the interaction with the Revision Control System. </para> -<para>Sets: &cv-link-RCS;, &cv-link-RCS_CO;, &cv-link-RCS_COCOM;, &cv-link-RCS_COFLAGS;.</para><para>Uses: &cv-link-RCS_COCOMSTR;.</para></listitem> +<para>Sets: &cv-link-RCS;, &cv-link-RCS_CO;, &cv-link-RCS_COCOM;, &cv-link-RCS_COFLAGS;.</para><para>Uses: &cv-link-RCS_COCOMSTR;.</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: &cv-link-JAVACLASSSUFFIX;, &cv-link-RMIC;, &cv-link-RMICCOM;, &cv-link-RMICFLAGS;.</para><para>Uses: &cv-link-RMICCOMSTR;.</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: &cv-link-RPCGEN;, &cv-link-RPCGENCLIENTFLAGS;, &cv-link-RPCGENFLAGS;, &cv-link-RPCGENHEADERFLAGS;, &cv-link-RPCGENSERVICEFLAGS;, &cv-link-RPCGENXDRFLAGS;.</para></listitem> </varlistentry> <varlistentry id="t-SCCS"> <term>SCCS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Sets construction variables for interacting with the Source Code Control System. </para> -<para>Sets: &cv-link-SCCS;, &cv-link-SCCSCOM;, &cv-link-SCCSFLAGS;, &cv-link-SCCSGETFLAGS;.</para><para>Uses: &cv-link-SCCSCOMSTR;.</para></listitem> +<para>Sets: &cv-link-SCCS;, &cv-link-SCCSCOM;, &cv-link-SCCSFLAGS;, &cv-link-SCCSGETFLAGS;.</para><para>Uses: &cv-link-SCCSCOMSTR;.</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: &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> </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: &cv-link-CXX;, &cv-link-CXXFLAGS;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-CXX;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-LINK;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</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;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-ARCOMSTR;, &cv-link-SHLINKCOMSTR;.</para></listitem> +<para>Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.</para><para>Uses: &cv-link-ARCOMSTR;, &cv-link-SHLINKCOMSTR;.</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: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-CXX;, &cv-link-SHCCFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.</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: &cv-link-F77;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</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: &cv-link-F90;, &cv-link-FORTRAN;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</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: &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;.</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: &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;.</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: &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> </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: &cv-link-TAR;, &cv-link-TARCOM;, &cv-link-TARFLAGS;, &cv-link-TARSUFFIX;.</para><para>Uses: &cv-link-TARCOMSTR;.</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: &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> </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: &cv-link-LINESEPARATOR;, &cv-link-SUBSTFILEPREFIX;, &cv-link-SUBSTFILESUFFIX;, &cv-link-TEXTFILEPREFIX;, &cv-link-TEXTFILESUFFIX;.</para><para>Uses: &cv-link-SUBST_DICT;.</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: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.</para><para>Uses: &cv-link-ARCOMSTR;.</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: &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> </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: &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> </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: &cv-link-ZIP;, &cv-link-ZIPCOM;, &cv-link-ZIPCOMPRESSION;, &cv-link-ZIPFLAGS;, &cv-link-ZIPSUFFIX;.</para><para>Uses: &cv-link-ZIPCOMSTR;.</para></listitem> </varlistentry> </variablelist> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index d007758..1555a3f 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="UTF-8"?> +<?xml version='1.0' encoding='UTF-8'?> <!DOCTYPE sconsdoc [ <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -12,19 +12,17 @@ %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-AR"> <term>AR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> Specifies the system architecture for which the package is being built. The default is the system architecture @@ -39,46 +37,41 @@ and as part of the name of a generated RPM file. </varlistentry> <varlistentry id="cv-ARCOM"> <term>ARCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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-ARCOM"><envar>$ARCOM</envar></link> (the command line) is displayed. +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"> + <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"> + <listitem><para> The assembler. </para> </listitem> </varlistentry> <varlistentry id="cv-ASCOM"> <term>ASCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to generate an object file from an assembly-language source file. </para> @@ -86,69 +79,63 @@ from an assembly-language source file. </varlistentry> <varlistentry id="cv-ASCOMSTR"> <term>ASCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> The bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> @@ -156,8 +143,7 @@ LaTeX structured formatter and typesetter. </varlistentry> <varlistentry id="cv-BIBTEXCOM"> <term>BIBTEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to call the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -166,22 +152,20 @@ typesetter. </varlistentry> <varlistentry id="cv-BIBTEXCOMSTR"> <term>BIBTEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> General options passed to the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> @@ -189,16 +173,14 @@ and typesetter and the LaTeX structured formatter and typesetter. </varlistentry> <varlistentry id="cv-BITKEEPER"> <term>BITKEEPER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The BitKeeper executable. </para> </listitem> </varlistentry> <varlistentry id="cv-BITKEEPERCOM"> <term>BITKEEPERCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line for fetching source files using BitKeeper. </para> @@ -206,28 +188,25 @@ fetching source files using BitKeeper. </varlistentry> <varlistentry id="cv-BITKEEPERCOMSTR"> <term>BITKEEPERCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when fetching a source file using BitKeeper. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-BITKEEPERCOM"><envar>$BITKEEPERCOM</envar></link> +If this is not set, then <link linkend="cv-BITKEEPERCOM"><envar>$BITKEEPERCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-BITKEEPERGET"> <term>BITKEEPERGET</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -The command (<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-BITKEEPER"><envar>$BITKEEPER</envar></link>) and subcommand + <listitem><para> +The command (<link linkend="cv-BITKEEPER"><envar>$BITKEEPER</envar></link>) and subcommand for fetching source files using BitKeeper. </para> </listitem> </varlistentry> <varlistentry id="cv-BITKEEPERGETFLAGS"> <term>BITKEEPERGETFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Options that are passed to the BitKeeper <command>get</command> subcommand. @@ -236,8 +215,7 @@ subcommand. </varlistentry> <varlistentry id="cv-BUILDERS"> <term>BUILDERS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A dictionary mapping the names of the builders available through this environment to underlying Builder objects. @@ -248,26 +226,26 @@ 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> @@ -275,70 +253,64 @@ env['BUILDERS]['NewBuilder'] = foo </varlistentry> <varlistentry id="cv-CC"> <term>CC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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 +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. </para> </listitem> </varlistentry> <varlistentry id="cv-CCCOMSTR"> <term>CCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is not set, then <link linkend="cv-CCCOM"><envar>$CCCOM</envar></link> (the command line) is displayed. </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"> + <listitem><para> General options that are passed to the C and C++ compilers. </para> </listitem> </varlistentry> <varlistentry id="cv-CCPCHFLAGS"> <term>CCPCHFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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 @@ -351,31 +323,30 @@ 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"> + <listitem><para> The version number of the C compiler. This may or may not be set, depending on the specific C compiler being used. @@ -384,8 +355,7 @@ depending on the specific C compiler being used. </varlistentry> <varlistentry id="cv-CFILESUFFIX"> <term>CFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -402,16 +372,14 @@ as C files. </varlistentry> <varlistentry id="cv-CFLAGS"> <term>CFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General options that are passed to the C compiler (C only; not C++). </para> </listitem> </varlistentry> <varlistentry id="cv-CHANGE_SPECFILE"> <term>CHANGE_SPECFILE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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, @@ -424,8 +392,7 @@ XXX </varlistentry> <varlistentry id="cv-CHANGED_SOURCES"> <term>CHANGED_SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -434,8 +401,7 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-CHANGED_TARGETS"> <term>CHANGED_TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -444,8 +410,7 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-CHANGELOG"> <term>CHANGELOG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The name of a file containing the change log text to be included in the package. This is included as the @@ -457,9 +422,8 @@ section of the RPM </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 + <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 @@ -467,15 +431,14 @@ 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"> + <listitem><para> The name of the directory in which Configure context test files are written. The default is @@ -489,8 +452,7 @@ file. </varlistentry> <varlistentry id="cv-CONFIGURELOG"> <term>CONFIGURELOG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The name of the Configure context log file. The default is <filename>config.log</filename> @@ -503,48 +465,46 @@ file. </varlistentry> <varlistentry id="cv-_CPPDEFFLAGS"> <term>_CPPDEFFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 -by appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPDEFSUFFIX</envar> +The value of <envar>$_CPPDEFFLAGS</envar> is created +by appending <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"> + <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 added to the beginning and end. </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 appended to the beginning and end of each element in the list. @@ -553,16 +513,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 appended to the beginning and end of each item from the dictionary. @@ -575,11 +535,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> +<filename>scons</filename> 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}) @@ -588,45 +548,42 @@ env = Environment(CPPDEFINES={'B':2, 'A':None}) </varlistentry> <varlistentry id="cv-CPPDEFPREFIX"> <term>CPPDEFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used to specify preprocessor definitions on the C compiler command line. This will be appended 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"> + <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"> + <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 @@ -634,30 +591,28 @@ 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"> + <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 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 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"> + <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 @@ -665,57 +620,56 @@ 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> +<filename>scons</filename> 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 appending the values 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"> + <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", @@ -726,24 +680,21 @@ The default list is: </varlistentry> <varlistentry id="cv-CVS"> <term>CVS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The CVS executable. </para> </listitem> </varlistentry> <varlistentry id="cv-CVSCOFLAGS"> <term>CVSCOFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Options that are passed to the CVS checkout subcommand. </para> </listitem> </varlistentry> <varlistentry id="cv-CVSCOM"> <term>CVSCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to fetch source files from a CVS repository. </para> @@ -751,19 +702,17 @@ fetch source files from a CVS repository. </varlistentry> <varlistentry id="cv-CVSCOMSTR"> <term>CVSCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when fetching a source file from a CVS repository. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CVSCOM"><envar>$CVSCOM</envar></link> +If this is not set, then <link linkend="cv-CVSCOM"><envar>$CVSCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-CVSFLAGS"> <term>CVSFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General options that are passed to CVS. By default, this is set to <literal>-d $CVSREPOSITORY</literal> @@ -773,51 +722,46 @@ to specify from where the files must be fetched. </varlistentry> <varlistentry id="cv-CVSREPOSITORY"> <term>CVSREPOSITORY</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The path to the CVS repository. This is referenced in the default -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CVSFLAGS"><envar>$CVSFLAGS</envar></link> value. +<link linkend="cv-CVSFLAGS"><envar>$CVSFLAGS</envar></link> value. </para> </listitem> </varlistentry> <varlistentry id="cv-CXX"> <term>CXX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The C++ compiler. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXCOM"> <term>CXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXCOMSTR"> <term>CXXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is not set, then <link linkend="cv-CXXCOM"><envar>$CXXCOM</envar></link> (the command line) is displayed. </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"> + <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. @@ -843,20 +787,18 @@ as C++ files. </varlistentry> <varlistentry id="cv-CXXFLAGS"> <term>CXXFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>. </para> </listitem> </varlistentry> <varlistentry id="cv-CXXVERSION"> <term>CXXVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The version number of the C++ compiler. This may or may not be set, depending on the specific C++ compiler being used. @@ -865,56 +807,49 @@ depending on the specific C++ compiler being used. </varlistentry> <varlistentry id="cv-DC"> <term>DC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DC. </para> </listitem> </varlistentry> <varlistentry id="cv-DCOM"> <term>DCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DCOM. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUG"> <term>DDEBUG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DDEBUG. </para> </listitem> </varlistentry> <varlistentry id="cv-_DDEBUGFLAGS"> <term>_DDEBUGFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DDEBUGFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUGPREFIX"> <term>DDEBUGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DDEBUGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DDEBUGSUFFIX"> <term>DDEBUGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DDEBUGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DESCRIPTION"> <term>DESCRIPTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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,8 +858,7 @@ of the file that controls the packaging build. </varlistentry> <varlistentry id="cv-DESCRIPTION_lang"> <term>DESCRIPTION_lang</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A language-specific long description for the specified <varname>lang</varname>. This is used to populate a @@ -936,77 +870,67 @@ section of an RPM </varlistentry> <varlistentry id="cv-DFILESUFFIX"> <term>DFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DFILESUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DFLAGPREFIX"> <term>DFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DFLAGPREFIX. </para> </listitem> </varlistentry> - <varlistentry id="cv-DFLAGS"> - <term>DFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -DFLAGS. -</para> -</listitem> - </varlistentry> <varlistentry id="cv-_DFLAGS"> <term>_DFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DFLAGS. </para> </listitem> </varlistentry> + <varlistentry id="cv-DFLAGS"> + <term>DFLAGS</term> + <listitem><para> +DFLAGS. +</para> +</listitem> + </varlistentry> <varlistentry id="cv-DFLAGSUFFIX"> <term>DFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-_DINCFLAGS"> <term>_DINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DINCFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DINCPREFIX"> <term>DINCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DINCPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DINCSUFFIX"> <term>DINCSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DINCSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-Dir"> <term>Dir</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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"> +<para> A function that converts a string into a Dir instance relative to the target being built. </para> @@ -1014,8 +938,7 @@ into a Dir instance relative to the target being built. </varlistentry> <varlistentry id="cv-Dirs"> <term>Dirs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A function that converts a list of strings into a list of Dir instances relative to the target being built. </para> @@ -1023,200 +946,176 @@ into a list of Dir instances relative to the target being built. </varlistentry> <varlistentry id="cv-DLIB"> <term>DLIB</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIB. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBCOM"> <term>DLIBCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBCOM. </para> </listitem> </varlistentry> <varlistentry id="cv-_DLIBDIRFLAGS"> <term>_DLIBDIRFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DLIBDIRFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBDIRPREFIX"> <term>DLIBDIRPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBDIRPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBDIRSUFFIX"> <term>DLIBDIRSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBDIRSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGPREFIX"> <term>DLIBFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBFLAGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-_DLIBFLAGS"> <term>_DLIBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DLIBFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBFLAGSUFFIX"> <term>DLIBFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBFLAGSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBLINKPREFIX"> <term>DLIBLINKPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBLINKPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLIBLINKSUFFIX"> <term>DLIBLINKSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLIBLINKSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINK"> <term>DLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLINK. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKCOM"> <term>DLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLINKCOM. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGPREFIX"> <term>DLINKFLAGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLINKFLAGPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGS"> <term>DLINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DLINKFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DLINKFLAGSUFFIX"> <term>DLINKFLAGSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 + <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 + <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 + <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 + <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 + <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 + <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 + <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 + <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"> + <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> @@ -1224,8 +1123,7 @@ if one of them is installed (<literal>fop</literal> gets checked first). </varlistentry> <varlistentry id="cv-DOCBOOK_FOPCOM"> <term>DOCBOOK_FOPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The full command-line for the PDF renderer <literal>fop</literal> or <literal>xep</literal>. </para> @@ -1233,8 +1131,7 @@ PDF renderer <literal>fop</literal> or <literal>xep</literal>. </varlistentry> <varlistentry id="cv-DOCBOOK_FOPCOMSTR"> <term>DOCBOOK_FOPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -1242,8 +1139,7 @@ The string displayed when a renderer like <literal>fop</literal> or </varlistentry> <varlistentry id="cv-DOCBOOK_FOPFLAGS"> <term>DOCBOOK_FOPFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Additonal command-line flags for the PDF renderer <literal>fop</literal> or <literal>xep</literal>. </para> @@ -1251,8 +1147,7 @@ PDF renderer <literal>fop</literal> or <literal>xep</literal>. </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINT"> <term>DOCBOOK_XMLLINT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -1262,8 +1157,7 @@ in the current system. </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTCOM"> <term>DOCBOOK_XMLLINTCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The full command-line for the external executable <literal>xmllint</literal>. </para> @@ -1271,8 +1165,7 @@ The full command-line for the external executable </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTCOMSTR"> <term>DOCBOOK_XMLLINTCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when <literal>xmllint</literal> is used to resolve XIncludes for a given XML file. </para> @@ -1280,8 +1173,7 @@ XIncludes for a given XML file. </varlistentry> <varlistentry id="cv-DOCBOOK_XMLLINTFLAGS"> <term>DOCBOOK_XMLLINTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Additonal command-line flags for the external executable <literal>xmllint</literal>. </para> @@ -1289,8 +1181,7 @@ Additonal command-line flags for the external executable </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROC"> <term>DOCBOOK_XSLTPROC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The path to the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>), if one of them is installed. @@ -1301,8 +1192,7 @@ no libxml2 or lxml Python binding can be imported in the current system. </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCCOM"> <term>DOCBOOK_XSLTPROCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The full command-line for the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). @@ -1311,8 +1201,7 @@ The full command-line for the external executable </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCCOMSTR"> <term>DOCBOOK_XSLTPROCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when <literal>xsltproc</literal> is used to transform an XML file via a given XSLT stylesheet. </para> @@ -1320,8 +1209,7 @@ an XML file via a given XSLT stylesheet. </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCFLAGS"> <term>DOCBOOK_XSLTPROCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Additonal command-line flags for the external executable <literal>xsltproc</literal> (or <literal>saxon</literal>, <literal>xalan</literal>). @@ -1330,8 +1218,7 @@ Additonal command-line flags for the external executable </varlistentry> <varlistentry id="cv-DOCBOOK_XSLTPROCPARAMS"> <term>DOCBOOK_XSLTPROCPARAMS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -1340,133 +1227,120 @@ for <literal>saxon</literal> and <literal>saxon-xslt</literal>, respectively. </varlistentry> <varlistentry id="cv-DPATH"> <term>DPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DPATH. </para> </listitem> </varlistentry> <varlistentry id="cv-DSUFFIXES"> <term>DSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The list of suffixes of files that will be scanned for imported D package files. The default list is: </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> ['.d'] </example_commands> </listitem> </varlistentry> <varlistentry id="cv-_DVERFLAGS"> <term>_DVERFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> _DVERFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERPREFIX"> <term>DVERPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DVERPREFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERSIONS"> <term>DVERSIONS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DVERSIONS. </para> </listitem> </varlistentry> <varlistentry id="cv-DVERSUFFIX"> <term>DVERSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> DVERSUFFIX. </para> </listitem> </varlistentry> <varlistentry id="cv-DVIPDF"> <term>DVIPDF</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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> +<filename>scons</filename> does <emphasis>not</emphasis> propagate the environment in force when you execute -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> 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> +<filename>scons</filename> 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 @@ -1474,12 +1348,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 @@ -1487,12 +1361,12 @@ the system <envar>PATH</envar> environment variable, so that -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> 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> @@ -1500,8 +1374,7 @@ env = Environment(ENV = {'PATH' : os.environ['PATH']}) </varlistentry> <varlistentry id="cv-ESCAPE"> <term>ESCAPE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -1510,25 +1383,23 @@ string to escape; and should return the escaped command line. </varlistentry> <varlistentry id="cv-F03"> <term>F03</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -1536,19 +1407,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F03COMSTR"> <term>F03COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the F03 dialect will be used. By default, this is ['.f03'] </para> @@ -1556,22 +1425,21 @@ default, this is ['.f03'] </varlistentry> <varlistentry id="cv-F03FLAGS"> <term>F03FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -1580,86 +1448,83 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-_F03INCFLAGS"> <term>_F03INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> +<filename>scons</filename> 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"> + <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> @@ -1667,20 +1532,18 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F03PPCOMSTR"> <term>F03PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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> @@ -1688,25 +1551,23 @@ F03 dialect will be used. By default, this is empty </varlistentry> <varlistentry id="cv-F08"> <term>F08</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -1714,19 +1575,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F08COMSTR"> <term>F08COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the F08 dialect will be used. By default, this is ['.f08'] </para> @@ -1734,22 +1593,21 @@ default, this is ['.f08'] </varlistentry> <varlistentry id="cv-F08FLAGS"> <term>F08FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -1758,86 +1616,83 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-_F08INCFLAGS"> <term>_F08INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> +<filename>scons</filename> 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"> + <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> @@ -1845,20 +1700,18 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F08PPCOMSTR"> <term>F08PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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> @@ -1866,25 +1719,23 @@ F08 dialect will be used. By default, this is empty </varlistentry> <varlistentry id="cv-F77"> <term>F77</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -1892,19 +1743,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F77COMSTR"> <term>F77COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the F77 dialect will be used. By default, this is ['.f77'] </para> @@ -1912,22 +1761,21 @@ default, this is ['.f77'] </varlistentry> <varlistentry id="cv-F77FLAGS"> <term>F77FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -1936,86 +1784,83 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-_F77INCFLAGS"> <term>_F77INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> +<filename>scons</filename> 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"> + <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> @@ -2023,20 +1868,18 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F77PPCOMSTR"> <term>F77PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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> @@ -2044,25 +1887,23 @@ F77 dialect will be used. By default, this is empty </varlistentry> <varlistentry id="cv-F90"> <term>F90</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -2070,19 +1911,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F90COMSTR"> <term>F90COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the F90 dialect will be used. By default, this is ['.f90'] </para> @@ -2090,22 +1929,21 @@ default, this is ['.f90'] </varlistentry> <varlistentry id="cv-F90FLAGS"> <term>F90FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -2114,86 +1952,83 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-_F90INCFLAGS"> <term>_F90INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> +<filename>scons</filename> 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"> + <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> @@ -2201,19 +2036,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F90PPCOMSTR"> <term>F90PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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> @@ -2221,25 +2054,23 @@ F90 dialect will be used. By default, this is empty </varlistentry> <varlistentry id="cv-F95"> <term>F95</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -2247,19 +2078,17 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F95COMSTR"> <term>F95COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the F95 dialect will be used. By default, this is ['.f95'] </para> @@ -2267,22 +2096,21 @@ default, this is ['.f95'] </varlistentry> <varlistentry id="cv-F95FLAGS"> <term>F95FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -2291,86 +2119,83 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-_F95INCFLAGS"> <term>_F95INCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> +<filename>scons</filename> 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"> + <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> @@ -2378,20 +2203,18 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-F95PPCOMSTR"> <term>F95PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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> @@ -2399,13 +2222,11 @@ F95 dialect will be used. By default, this is empty </varlistentry> <varlistentry id="cv-File"> <term>File</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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"> +<para> A function that converts a string into a File instance relative to the target being built. </para> @@ -2413,8 +2234,7 @@ target being built. </varlistentry> <varlistentry id="cv-FORTRAN"> <term>FORTRAN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The default Fortran compiler for all versions of Fortran. </para> @@ -2422,34 +2242,31 @@ for all versions of Fortran. </varlistentry> <varlistentry id="cv-FORTRANCOM"> <term>FORTRANCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> 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 this is 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"> + <listitem><para> The list of file extensions for which the FORTRAN dialect will be used. By default, this is ['.f', '.for', '.ftn'] </para> @@ -2457,17 +2274,16 @@ default, this is ['.f', '.for', '.ftn'] </varlistentry> <varlistentry id="cv-FORTRANFLAGS"> <term>FORTRANFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -2475,23 +2291,21 @@ for the variables that expand those options. </varlistentry> <varlistentry id="cv-_FORTRANINCFLAGS"> <term>_FORTRANINCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 -by prepending/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-_FORTRANINCFLAGS"><envar>$_FORTRANINCFLAGS</envar></link> is created +by prepending/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-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"> + <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 @@ -2501,48 +2315,44 @@ for module files, as well. </varlistentry> <varlistentry id="cv-FORTRANMODDIRPREFIX"> <term>FORTRANMODDIRPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used to specify a module directory on the Fortran compiler command line. This will be appended 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"> + <listitem><para> The suffix used to specify a module directory on the Fortran compiler command line. This will be appended 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-_FORTRANMODFLAG"> <term>_FORTRANMODFLAG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 -by prepending/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>. +The value of <link linkend="cv-_FORTRANMODFLAG"><envar>$_FORTRANMODFLAG</envar></link> is created +by prepending/appending <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"> + <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 @@ -2556,8 +2366,7 @@ module file name as scons attempts to resolve dependencies. </varlistentry> <varlistentry id="cv-FORTRANMODSUFFIX"> <term>FORTRANMODSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2571,8 +2380,7 @@ module file name as scons attempts to resolve dependencies. </varlistentry> <varlistentry id="cv-FORTRANPATH"> <term>FORTRANPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2582,77 +2390,74 @@ 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> +<filename>scons</filename> 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 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"> + <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"> + <listitem><para> 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 this is 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"> + <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> @@ -2660,15 +2465,14 @@ FORTRAN dialect will be used. By default, this is ['.fpp', '.FPP'] </varlistentry> <varlistentry id="cv-FORTRANSUFFIXES"> <term>FORTRANSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -2676,50 +2480,47 @@ The default list is: </varlistentry> <varlistentry id="cv-FRAMEWORKPATH"> <term>FRAMEWORKPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> +<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"> +<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"> + <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"> + <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> @@ -2727,11 +2528,10 @@ The default value is </varlistentry> <varlistentry id="cv-FRAMEWORKPREFIX"> <term>FRAMEWORKPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -2739,8 +2539,7 @@ The default value is </varlistentry> <varlistentry id="cv-_FRAMEWORKS"> <term>_FRAMEWORKS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options @@ -2750,15 +2549,14 @@ for linking with FRAMEWORKS. </varlistentry> <varlistentry id="cv-FRAMEWORKS"> <term>FRAMEWORKS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> +<example_commands> env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) </example_commands> @@ -2766,31 +2564,28 @@ For example: </varlistentry> <varlistentry id="cv-FRAMEWORKSFLAGS"> <term>FRAMEWORKSFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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> @@ -2798,18 +2593,16 @@ value is <quote><literal>$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES</literal></q </varlistentry> <varlistentry id="cv-GSCOMSTR"> <term>GSCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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> @@ -2818,8 +2611,15 @@ is <quote><literal>-dNOPAUSE -dBATCH -sDEVICE=pdfwrite</literal></quote> </varlistentry> <varlistentry id="cv-HOST_ARCH"> <term>HOST_ARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. + This value is immutable, and should not be changed by the user after + the Environment is initialized. + Currently only set for Win32. +</para> + <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. @@ -2827,29 +2627,19 @@ 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> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - 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. - This value is immutable, and should not be changed by the user after - the Environment is initialized. - Currently only set for Win32. -</para> - </listitem> +</listitem> </varlistentry> <varlistentry id="cv-HOST_OS"> <term>HOST_OS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -2861,29 +2651,27 @@ used on other OSes as well. </varlistentry> <varlistentry id="cv-IDLSUFFIXES"> <term>IDLSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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-IMPLICIT_COMMAND_DEPENDENCIES"> <term>IMPLICIT_COMMAND_DEPENDENCIES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -2897,9 +2685,9 @@ variable in the environment used to execute the command. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If the construction variable -<envar xmlns="http://www.scons.org/dbxsd/v1.0">$IMPLICIT_COMMAND_DEPENDENCIES</envar> +<envar>$IMPLICIT_COMMAND_DEPENDENCIES</envar> is set to a false value (<literal>None</literal>, <literal>False</literal>, @@ -2910,41 +2698,38 @@ not be added to the targets built with that construction environment. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(IMPLICIT_COMMAND_DEPENDENCIES = 0) </example_commands> </listitem> </varlistentry> <varlistentry id="cv-INCPREFIX"> <term>INCPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used to specify an include directory on the C compiler command line. This will be appended 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"> + <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"> + <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 @@ -2953,11 +2738,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> @@ -2971,21 +2756,19 @@ in force for this file installation. </varlistentry> <varlistentry id="cv-INSTALLSTR"> <term>INSTALLSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> Set by the "intelc" Tool to the major version number of the Intel C compiler selected for use. @@ -2994,27 +2777,23 @@ selected for use. </varlistentry> <varlistentry id="cv-JAR"> <term>JAR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The Java archive tool. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<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"> + <listitem><para> 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"> +<para> The directory to which the Java archive tool should change (using the <option>-C</option> @@ -3024,44 +2803,39 @@ option). </varlistentry> <varlistentry id="cv-JARCOM"> <term>JARCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to call the Java archive tool. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<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"> + <listitem><para> 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. +If this is not set, then <envar>$JARCOM</envar> (the command line) is displayed. </para> -<example_commands xmlns="http://www.scons.org/dbxsd/v1.0"> +<example_commands> env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") </example_commands> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<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"> +<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"> + <listitem><para> General options passed to the Java archive tool. By default this is set to <option>cf</option> @@ -3069,8 +2843,7 @@ to create the necessary <command>jar</command> file. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> General options passed to the Java archive tool. By default this is set to <option>cf</option> @@ -3082,14 +2855,12 @@ file. </varlistentry> <varlistentry id="cv-JARSUFFIX"> <term>JARSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix for Java archives: <filename>.jar</filename> by default. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> The suffix for Java archives: <filename>.jar</filename> by default. @@ -3098,11 +2869,10 @@ by default. </varlistentry> <varlistentry id="cv-JAVABOOTCLASSPATH"> <term>JAVABOOTCLASSPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -3113,51 +2883,46 @@ separated by the operating system's path separate character </varlistentry> <varlistentry id="cv-JAVAC"> <term>JAVAC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> +<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"> + <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"> + <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 @@ -3168,13 +2933,12 @@ builder. </varlistentry> <varlistentry id="cv-JAVACLASSPATH"> <term>JAVACLASSPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -3182,19 +2946,18 @@ separated by the operating system's path separate character <filename>;</filename> 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"> + <listitem><para> The suffix for Java class files; <filename>.class</filename> by default. @@ -3203,41 +2966,37 @@ by default. </varlistentry> <varlistentry id="cv-JAVAH"> <term>JAVAH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> +<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"> + <listitem><para> General options passed to the C header and stub file generator for Java classes. </para> @@ -3245,13 +3004,12 @@ for Java classes. </varlistentry> <varlistentry id="cv-JAVASOURCEPATH"> <term>JAVASOURCEPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -3259,19 +3017,18 @@ separated by the operating system's path separate character <filename>;</filename> 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"> + <listitem><para> The suffix for Java files; <filename>.java</filename> by default. @@ -3280,75 +3037,69 @@ by default. </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. + <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 <literal>1.5</literal> +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"> + <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"> + <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"> + <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"> + <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"> + <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. @@ -3357,72 +3108,65 @@ by re-running LaTeX up to three times. </varlistentry> <varlistentry id="cv-LATEXSUFFIXES"> <term>LATEXSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <listitem><para> 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. +If this is not set, then <link linkend="cv-LDMODULECOM"><envar>$LDMODULECOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULEFLAGS"> <term>LDMODULEFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General user options passed to the linker for building loadable modules. </para> </listitem> </varlistentry> <varlistentry id="cv-LDMODULEPREFIX"> <term>LDMODULEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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-LDMODULESUFFIX"> <term>LDMODULESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for loadable module file names. On Mac OS X, this is null; on other systems, this is @@ -3432,16 +3176,14 @@ the same as $SHLIBSUFFIX. </varlistentry> <varlistentry id="cv-LEX"> <term>LEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The command line used to call the lexical analyzer generator to generate a source file. </para> @@ -3449,162 +3191,151 @@ to generate a source file. </varlistentry> <varlistentry id="cv-LEXCOMSTR"> <term>LEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> General options passed to the lexical analyzer generator. </para> </listitem> </varlistentry> <varlistentry id="cv-_LIBDIRFLAGS"> <term>_LIBDIRFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 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 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"> + <listitem><para> The prefix used to specify a library directory on the linker command line. This will be appended 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"> + <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"> + <listitem><para> TODO </para> </listitem> </varlistentry> <varlistentry id="cv-_LIBFLAGS"> <term>_LIBFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 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 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"> + <listitem><para> The prefix used to specify a library to link on the linker command line. This will be appended 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"> + <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"> + <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> +<filename>scons</filename> 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 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"> + <listitem><para> The prefix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3616,65 +3347,63 @@ to reflect the names of the libraries they create. </varlistentry> <varlistentry id="cv-LIBPREFIXES"> <term>LIBPREFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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 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> @@ -3682,8 +3411,7 @@ all the libraries in this list. </varlistentry> <varlistentry id="cv-LIBSUFFIX"> <term>LIBSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3695,11 +3423,10 @@ to reflect the names of the libraries they create. </varlistentry> <varlistentry id="cv-LIBSUFFIXES"> <term>LIBSUFFIXES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -3707,8 +3434,7 @@ and these suffixes. </varlistentry> <varlistentry id="cv-LICENSE"> <term>LICENSE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The abbreviated name of the license under which this project is released (gpl, lpgl, bsd etc.). See http://www.opensource.org/licenses/alphabetical @@ -3718,9 +3444,8 @@ for a list of license names. </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. + <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> @@ -3728,13 +3453,12 @@ It defaults to the current system line separator. </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 + <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>. @@ -3744,54 +3468,50 @@ default file named </varlistentry> <varlistentry id="cv-LINK"> <term>LINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The linker. </para> </listitem> </varlistentry> <varlistentry id="cv-LINKCOM"> <term>LINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to link object files into an executable. </para> </listitem> </varlistentry> <varlistentry id="cv-LINKCOMSTR"> <term>LINKCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is not set, then <link linkend="cv-LINKCOM"><envar>$LINKCOM</envar></link> (the command line) is displayed. </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"> + <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. </para> @@ -3799,42 +3519,37 @@ for the variable that expands to library search path options. </varlistentry> <varlistentry id="cv-M4"> <term>M4</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> The makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> @@ -3842,8 +3557,7 @@ LaTeX structured formatter and typesetter. </varlistentry> <varlistentry id="cv-MAKEINDEXCOM"> <term>MAKEINDEXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to call the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -3852,19 +3566,17 @@ typesetter. </varlistentry> <varlistentry id="cv-MAKEINDEXCOMSTR"> <term>MAKEINDEXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> General options passed to the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. </para> @@ -3872,8 +3584,7 @@ and typesetter and the LaTeX structured formatter and typesetter. </varlistentry> <varlistentry id="cv-MAXLINELENGTH"> <term>MAXLINELENGTH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The maximum number of characters allowed on an external command line. On Win32 systems, link lines longer than this many characters @@ -3883,178 +3594,159 @@ are linked via a temporary file name. </varlistentry> <varlistentry id="cv-MIDL"> <term>MIDL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> The string displayed when the Microsoft IDL copmiler 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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> The directory containing the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4063,8 +3755,7 @@ to be used for compilation. </varlistentry> <varlistentry id="cv-MSSDK_VERSION"> <term>MSSDK_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The version string of the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4080,8 +3771,7 @@ and </varlistentry> <varlistentry id="cv-MSVC_BATCH"> <term>MSVC_BATCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> When set to any true value, specifies that SCons should batch compilation of object files @@ -4092,7 +3782,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 @@ -4102,13 +3792,12 @@ will be compiled separately. </varlistentry> <varlistentry id="cv-MSVC_USE_SCRIPT"> <term>MSVC_USE_SCRIPT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4120,20 +3809,19 @@ window and importing the shell's environment variables. </varlistentry> <varlistentry id="cv-MSVC_VERSION"> <term>MSVC_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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>12.0</literal>, <literal>12.0Exp</literal>, @@ -4156,59 +3844,58 @@ Versions ending in <literal>Exp</literal> refer to "Express" or </varlistentry> <varlistentry id="cv-MSVS"> <term>MSVS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> When the Microsoft Visual Studio tools are initialized, they set up this dictionary with the following keys: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>VERSION</envar>: 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>) +<link linkend="cv-MSVS_VERSION"><envar>$MSVS_VERSION</envar></link>) </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>VERSIONS</envar>: the available versions of MSVS installed </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>VCINSTALLDIR</envar>: installed directory of Visual C++ </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>VSINSTALLDIR</envar>: installed directory of Visual Studio </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>FRAMEWORKDIR</envar>: installed directory of the .NET framework </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>FRAMEWORKVERSIONS</envar>: list of installed versions of the .NET framework, sorted latest to oldest. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>FRAMEWORKVERSION</envar>: latest installed version of the .NET framework </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>FRAMEWORKSDKDIR</envar>: installed location of the .NET SDK. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>PLATFORMSDKDIR</envar>: installed location of the Platform SDK. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> <envar>PLATFORMSDK_MODULES</envar>: dictionary of installed Platform SDK modules, where the dictionary keys are keywords for the various modules, and @@ -4216,23 +3903,22 @@ the values are 2-tuples where the first is the release date, and the second is the version number. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> If a value isn't set, it wasn't 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"> + <listitem><para> Sets the architecture for which the generated project(s) should build. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<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 some Visual Studio versions. -Trying to set <envar xmlns="http://www.scons.org/dbxsd/v1.0">$MSVS_ARCH</envar> to an architecture that's not +by <application>SCons</application> for some Visual Studio versions. +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> @@ -4240,8 +3926,7 @@ will generate an error. </varlistentry> <varlistentry id="cv-MSVS_PROJECT_GUID"> <term>MSVS_PROJECT_GUID</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string placed in a generated Microsoft Visual Studio project file as the value of the @@ -4253,8 +3938,7 @@ There is no default value. If not defined, a new GUID is generated. </varlistentry> <varlistentry id="cv-MSVS_SCC_AUX_PATH"> <term>MSVS_SCC_AUX_PATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The path name placed in a generated Microsoft Visual Studio project file as the value of the @@ -4269,8 +3953,7 @@ There is no default value. </varlistentry> <varlistentry id="cv-MSVS_SCC_CONNECTION_ROOT"> <term>MSVS_SCC_CONNECTION_ROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 relative paths of the generated @@ -4301,8 +3984,7 @@ The default value is the current working directory. </varlistentry> <varlistentry id="cv-MSVS_SCC_PROJECT_NAME"> <term>MSVS_SCC_PROJECT_NAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The project name placed in a generated Microsoft Visual Studio project file as the value of the @@ -4322,8 +4004,7 @@ There is no default value. </varlistentry> <varlistentry id="cv-MSVS_SCC_PROVIDER"> <term>MSVS_SCC_PROVIDER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string placed in a generated Microsoft Visual Studio project file as the value of the @@ -4340,14 +4021,13 @@ There is no default value. </varlistentry> <varlistentry id="cv-MSVS_VERSION"> <term>MSVS_VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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) select the latest version +<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. @@ -4360,17 +4040,16 @@ 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>. +<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"> + <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 @@ -4380,8 +4059,7 @@ build targets. </varlistentry> <varlistentry id="cv-MSVSCLEANCOM"> <term>MSVSCLEANCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4391,8 +4069,7 @@ to remove any specified targets. </varlistentry> <varlistentry id="cv-MSVSENCODING"> <term>MSVSENCODING</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The encoding string placed in a generated Microsoft Visual Studio project file. The default is encoding @@ -4402,16 +4079,14 @@ The default is encoding </varlistentry> <varlistentry id="cv-MSVSPROJECTCOM"> <term>MSVSPROJECTCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The suffix used for Microsoft Visual Studio project (DSP) files. The default value is <filename>.vcproj</filename> @@ -4425,8 +4100,7 @@ when using earlier versions of Visual Studio. </varlistentry> <varlistentry id="cv-MSVSREBUILDCOM"> <term>MSVSREBUILDCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4436,8 +4110,7 @@ rebuild targets. </varlistentry> <varlistentry id="cv-MSVSSCONS"> <term>MSVSSCONS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -4446,8 +4119,7 @@ used to generate the project file. </varlistentry> <varlistentry id="cv-MSVSSCONSCOM"> <term>MSVSSCONSCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The default SCons command used in generated Microsoft Visual Studio project files. </para> @@ -4455,30 +4127,28 @@ project files. </varlistentry> <varlistentry id="cv-MSVSSCONSCRIPT"> <term>MSVSSCONSCRIPT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The sconscript file (that is, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename> +<filename>SConstruct</filename> or -<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename> +<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> +<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> +<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"> + <listitem><para> The SCons flags used in generated Microsoft Visual Studio project files. </para> @@ -4486,16 +4156,14 @@ project files. </varlistentry> <varlistentry id="cv-MSVSSOLUTIONCOM"> <term>MSVSSOLUTIONCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The suffix used for Microsoft Visual Studio solution (DSW) files. The default value is <filename>.sln</filename> @@ -4508,43 +4176,38 @@ when using earlier versions of Visual Studio. </varlistentry> <varlistentry id="cv-MT"> <term>MT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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). + <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"> + <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"> + <listitem><para> The version number of the MetroWerks CodeWarrior C compiler to be used. </para> @@ -4552,8 +4215,7 @@ to be used. </varlistentry> <varlistentry id="cv-MWCW_VERSIONS"> <term>MWCW_VERSIONS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A list of installed versions of the MetroWerks CodeWarrior C compiler on this system. </para> @@ -4561,16 +4223,14 @@ on this system. </varlistentry> <varlistentry id="cv-NAME"> <term>NAME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> When set to non-zero, suppresses creation of a corresponding Windows static import lib by the <literal>SharedLibrary</literal> @@ -4584,32 +4244,28 @@ when using Microsoft Visual Studio. </varlistentry> <varlistentry id="cv-OBJPREFIX"> <term>OBJPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The suffix used for (static) object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-P4"> <term>P4</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The Perforce executable. </para> </listitem> </varlistentry> <varlistentry id="cv-P4COM"> <term>P4COM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to fetch source files from Perforce. </para> @@ -4617,26 +4273,23 @@ fetch source files from Perforce. </varlistentry> <varlistentry id="cv-P4COMSTR"> <term>P4COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when fetching a source file from Perforce. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-P4COM"><envar>$P4COM</envar></link> (the command line) is displayed. +If this is not set, then <link linkend="cv-P4COM"><envar>$P4COM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-P4FLAGS"> <term>P4FLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General options that are passed to Perforce. </para> </listitem> </varlistentry> <varlistentry id="cv-PACKAGEROOT"> <term>PACKAGEROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Specifies the directory where all files in resulting archive will be placed if applicable. The default value is "$NAME-$VERSION". </para> @@ -4644,12 +4297,11 @@ placed if applicable. The default value is "$NAME-$VERSION". </varlistentry> <varlistentry id="cv-PACKAGETYPE"> <term>PACKAGETYPE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Selects the package type to build. Currently these are available: </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> * msi - Microsoft Installer * rpm - Redhat Package Manger * ipkg - Itsy Package Management System @@ -4661,15 +4313,14 @@ Selects the package type to build. Currently these are available: * src_zip - zip file source </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> This may be overridden with the "package_type" command line option. </para> </listitem> </varlistentry> <varlistentry id="cv-PACKAGEVERSION"> <term>PACKAGEVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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, @@ -4679,8 +4330,7 @@ not the underlying project code itself. </varlistentry> <varlistentry id="cv-PCH"> <term>PCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4690,44 +4340,40 @@ 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"> + <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"> + <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"> + <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"> + <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 @@ -4736,15 +4382,14 @@ 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"> + <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++. @@ -4755,11 +4400,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 @@ -4771,116 +4416,104 @@ 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>. + <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. + <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. + <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. + <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. + <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"> + <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"> + <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. + <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. + <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. + <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. + <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"> + <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 @@ -4890,11 +4523,10 @@ The default is </varlistentry> <varlistentry id="cv-PKGINFO"> <term>PKGINFO</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 @@ -4904,15 +4536,14 @@ The default is </varlistentry> <varlistentry id="cv-PLATFORM"> <term>PLATFORM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<filename>scons</filename> 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) @@ -4923,45 +4554,41 @@ else: </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 + <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> + <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"> + <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 + <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> @@ -4969,37 +4596,33 @@ not defined), the builders use <filename>messages.pot</filename> as default </varlistentry> <varlistentry id="cv-POTSUFFIX"> <term>POTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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> @@ -5017,20 +4640,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]), @@ -5039,7 +4662,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, @@ -5049,66 +4672,58 @@ for example. </varlistentry> <varlistentry id="cv-PROGEMITTER"> <term>PROGEMITTER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> TODO </para> </listitem> </varlistentry> <varlistentry id="cv-PROGPREFIX"> <term>PROGPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> Turn off scanning for mocable files. Use the Moc Builder to explicitly specify files to run moc on. </para> @@ -5116,74 +4731,66 @@ specify files to run moc on. </varlistentry> <varlistentry id="cv-QT_BINPATH"> <term>QT_BINPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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'. + <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"> + <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"> + <listitem><para> Default value is '.moc'. Suffix for moc output files, when source is a cxx file. </para> @@ -5191,25 +4798,22 @@ file. </varlistentry> <varlistentry id="cv-QT_MOCFROMCXXCOM"> <term>QT_MOCFROMCXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> Default value is '-i'. These flags are passed to moc, when moccing a C++ file. </para> @@ -5217,25 +4821,22 @@ C++ file. </varlistentry> <varlistentry id="cv-QT_MOCFROMHCOM"> <term>QT_MOCFROMHCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> Default value is ''. These flags are passed to moc, when moccing a header file. </para> @@ -5243,50 +4844,44 @@ file. </varlistentry> <varlistentry id="cv-QT_MOCHPREFIX"> <term>QT_MOCHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 + <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'. + <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"> + <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"> + <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"> + <listitem><para> Default value is ''. These flags are passed to uic, when creating a a h file from a .ui file. </para> @@ -5294,24 +4889,21 @@ file from a .ui file. </varlistentry> <varlistentry id="cv-QT_UICDECLPREFIX"> <term>QT_UICDECLPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> Default value is ''. These flags are passed to uic, when creating a cxx file from a .ui file. </para> @@ -5319,33 +4911,29 @@ file from a .ui file. </varlistentry> <varlistentry id="cv-QT_UICIMPLPREFIX"> <term>QT_UICIMPLPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 + <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"> + <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"> + <listitem><para> The qt tool tries to take this from os.environ. It also initializes all QT_* construction variables listed below. @@ -5354,24 +4942,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 @@ -5379,11 +4967,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 @@ -5392,11 +4980,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 @@ -5404,52 +4992,47 @@ 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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> The resource compiler used to build a Microsoft Visual C++ resource file. </para> @@ -5457,8 +5040,7 @@ a Microsoft Visual C++ resource file. </varlistentry> <varlistentry id="cv-RCCOM"> <term>RCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to build a Microsoft Visual C++ resource file. </para> @@ -5466,78 +5048,71 @@ a Microsoft Visual C++ resource file. </varlistentry> <varlistentry id="cv-RCCOMSTR"> <term>RCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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 -by appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RCINCSUFFIX</envar> +The value of <envar>$RCINCFLAGS</envar> is created +by appending <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"> + <listitem><para> The prefix (flag) used to specify an include directory on the resource compiler command line. This will be appended 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"> + <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-RCS"> <term>RCS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The RCS executable. Note that this variable is not actually used for the command to fetch source files from RCS; see the -<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RCS_CO"><envar>$RCS_CO</envar></link> +<link linkend="cv-RCS_CO"><envar>$RCS_CO</envar></link> construction variable, below. </para> </listitem> </varlistentry> <varlistentry id="cv-RCS_CO"> <term>RCS_CO</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The RCS "checkout" executable, used to fetch source files from RCS. </para> @@ -5545,8 +5120,7 @@ used to fetch source files from RCS. </varlistentry> <varlistentry id="cv-RCS_COCOM"> <term>RCS_COCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to fetch (checkout) source files from RCS. </para> @@ -5554,27 +5128,24 @@ fetch (checkout) source files from RCS. </varlistentry> <varlistentry id="cv-RCS_COCOMSTR"> <term>RCS_COCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when fetching a source file from RCS. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RCS_COCOM"><envar>$RCS_COCOM</envar></link> +If this is not set, then <link linkend="cv-RCS_COCOM"><envar>$RCS_COCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-RCS_COFLAGS"> <term>RCS_COFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> -Options that are passed to the <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-RCS_CO"><envar>$RCS_CO</envar></link> command. + <listitem><para> +Options that are passed to the <link linkend="cv-RCS_CO"><envar>$RCS_CO</envar></link> command. </para> </listitem> </varlistentry> <varlistentry id="cv-RDirs"> <term>RDirs</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A function that converts a string into a list of Dir instances by searching the repositories. </para> @@ -5582,39 +5153,35 @@ searching the repositories. </varlistentry> <varlistentry id="cv-REGSVR"> <term>REGSVR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <listitem><para> Flags passed to the DLL registration program on Windows systems when a newly-built DLL library is registered. By default, @@ -5626,72 +5193,66 @@ and requiring user attention. </varlistentry> <varlistentry id="cv-RMIC"> <term>RMIC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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 xmlns="http://www.scons.org/dbxsd/v1.0">$_RPATH</envar> is created -by appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATHPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATHSUFFIX</envar> +The value of <envar>$_RPATH</envar> is created +by appending <envar>$RPATHPREFIX</envar> and <envar>$RPATHSUFFIX</envar> to the beginning and end -of each directory in <envar xmlns="http://www.scons.org/dbxsd/v1.0">$RPATH</envar>. +of each directory in <envar>$RPATH</envar>. </para> </listitem> </varlistentry> <varlistentry id="cv-RPATH"> <term>RPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<filename>scons</filename> in any way: if you want an absolute path, you must make it absolute yourself. </para> @@ -5699,96 +5260,87 @@ path, you must make it absolute yourself. </varlistentry> <varlistentry id="cv-RPATHPREFIX"> <term>RPATHPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used to specify a directory to be searched for shared libraries when running programs. This will be appended 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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> A list of the available implicit dependency scanners. New file scanners may be added by appending to this list, @@ -5803,16 +5355,14 @@ below, for more information. </varlistentry> <varlistentry id="cv-SCCS"> <term>SCCS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The SCCS executable. </para> </listitem> </varlistentry> <varlistentry id="cv-SCCSCOM"> <term>SCCSCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to fetch source files from SCCS. </para> @@ -5820,27 +5370,24 @@ fetch source files from SCCS. </varlistentry> <varlistentry id="cv-SCCSCOMSTR"> <term>SCCSCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The string displayed when fetching a source file from a CVS repository. -If this is not set, then <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SCCSCOM"><envar>$SCCSCOM</envar></link> +If this is not set, then <link linkend="cv-SCCSCOM"><envar>$SCCSCOM</envar></link> (the command line) is displayed. </para> </listitem> </varlistentry> <varlistentry id="cv-SCCSFLAGS"> <term>SCCSFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General options that are passed to SCCS. </para> </listitem> </varlistentry> <varlistentry id="cv-SCCSGETFLAGS"> <term>SCCSGETFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Options that are passed specifically to the SCCS "get" subcommand. This can be set, for example, to <option>-e</option> @@ -5850,13 +5397,12 @@ to check out editable files from SCCS. </varlistentry> <varlistentry id="cv-SCONS_HOME"> <term>SCONS_HOME</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> +<link linkend="cv-MSVSSCONS"><envar>$MSVSSCONS</envar></link> command line executed from Microsoft Visual Studio project files. </para> @@ -5864,43 +5410,39 @@ from Microsoft Visual Studio project files. </varlistentry> <varlistentry id="cv-SHCC"> <term>SHCC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The C compiler used for generating shared-library objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCCCOM"> <term>SHCCCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCCCOMSTR"> <term>SHCCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is not set, then <link linkend="cv-SHCCCOM"><envar>$SHCCCOM</envar></link> (the command line) is displayed. </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"> + <listitem><para> Options that are passed to the C and C++ compilers to generate shared-library objects. </para> @@ -5908,8 +5450,7 @@ to generate shared-library objects. </varlistentry> <varlistentry id="cv-SHCFLAGS"> <term>SHCFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> Options that are passed to the C compiler (only; not C++) to generate shared-library objects. </para> @@ -5917,42 +5458,38 @@ to generate shared-library objects. </varlistentry> <varlistentry id="cv-SHCXX"> <term>SHCXX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The C++ compiler used for generating shared-library objects. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCXXCOM"> <term>SHCXXCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. </para> </listitem> </varlistentry> <varlistentry id="cv-SHCXXCOMSTR"> <term>SHCXXCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is not set, then <link linkend="cv-SHCXXCOM"><envar>$SHCXXCOM</envar></link> (the command line) is displayed. </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"> + <listitem><para> Options that are passed to the C++ compiler to generate shared-library objects. </para> @@ -5960,79 +5497,71 @@ to generate shared-library objects. </varlistentry> <varlistentry id="cv-SHDC"> <term>SHDC</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> SHDC. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDCOM"> <term>SHDCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> SHDCOM. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINK"> <term>SHDLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> SHDLINK. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINKCOM"> <term>SHDLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> SHDLINKCOM. </para> </listitem> </varlistentry> <varlistentry id="cv-SHDLINKFLAGS"> <term>SHDLINKFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> SHDLINKFLAGS. </para> </listitem> </varlistentry> <varlistentry id="cv-SHELL"> <term>SHELL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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> @@ -6040,24 +5569,22 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF03COMSTR"> <term>SHF03COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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. @@ -6066,16 +5593,15 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF03PPCOM"> <term>SHF03PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6083,38 +5609,35 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF03PPCOMSTR"> <term>SHF03PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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"> + <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> @@ -6122,24 +5645,22 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF08COMSTR"> <term>SHF08COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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. @@ -6148,16 +5669,15 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF08PPCOM"> <term>SHF08PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6165,38 +5685,35 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF08PPCOMSTR"> <term>SHF08PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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"> + <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> @@ -6204,24 +5721,22 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF77COMSTR"> <term>SHF77COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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. @@ -6230,16 +5745,15 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF77PPCOM"> <term>SHF77PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6247,38 +5761,35 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF77PPCOMSTR"> <term>SHF77PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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"> + <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> @@ -6286,24 +5797,22 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF90COMSTR"> <term>SHF90COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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. @@ -6312,16 +5821,15 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF90PPCOM"> <term>SHF90PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6329,38 +5837,35 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF90PPCOMSTR"> <term>SHF90PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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"> + <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> @@ -6368,24 +5873,22 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF95COMSTR"> <term>SHF95COMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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. @@ -6394,16 +5897,15 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF95PPCOM"> <term>SHF95PPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6411,28 +5913,25 @@ for all Fortran versions. </varlistentry> <varlistentry id="cv-SHF95PPCOMSTR"> <term>SHF95PPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <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"> + <listitem><para> The command line used to compile a Fortran source file to a shared-library object file. </para> @@ -6440,19 +5939,17 @@ to a shared-library object file. </varlistentry> <varlistentry id="cv-SHFORTRANCOMSTR"> <term>SHFORTRANCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> 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 this is 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"> + <listitem><para> Options that are passed to the Fortran compiler to generate shared-library objects. </para> @@ -6460,62 +5957,56 @@ to generate shared-library objects. </varlistentry> <varlistentry id="cv-SHFORTRANPPCOM"> <term>SHFORTRANPPCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> 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 this is 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"> + <listitem><para> TODO </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBPREFIX"> <term>SHLIBPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used for shared library file names. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLIBSUFFIX"> <term>SHLIBSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> When this 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, adds +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. <link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> needs to be of the form X.Y.Z, +are needed. <link linkend="cv-SHLIBVERSION"><envar>$SHLIBVERSION</envar></link> needs to be of the form X.Y.Z, where X and Y are numbers, and Z is a number but can also contain letters to designate alpha, beta, or release candidate patch levels. </para> @@ -6523,53 +6014,49 @@ letters to designate alpha, beta, or release candidate patch levels. </varlistentry> <varlistentry id="cv-SHLINK"> <term>SHLINK</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The linker for programs that use shared libraries. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLINKCOM"> <term>SHLINKCOM</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The command line used to link programs using shared libraries. </para> </listitem> </varlistentry> <varlistentry id="cv-SHLINKCOMSTR"> <term>SHLINKCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. </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"> + <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. </para> @@ -6577,24 +6064,21 @@ for the variable that expands to library search path options. </varlistentry> <varlistentry id="cv-SHOBJPREFIX"> <term>SHOBJPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The suffix used for shared object file names. </para> </listitem> </varlistentry> <varlistentry id="cv-SOURCE"> <term>SOURCE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -6603,8 +6087,7 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-SOURCE_URL"> <term>SOURCE_URL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The URL (web address) of the location from which the project was retrieved. @@ -6616,8 +6099,7 @@ field in the controlling information for Ipkg and RPM packages. </varlistentry> <varlistentry id="cv-SOURCES"> <term>SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -6626,17 +6108,16 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-SPAWN"> <term>SPAWN</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> @@ -6654,17 +6135,15 @@ in which the command should be executed. </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"> + <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 + <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, @@ -6674,26 +6153,23 @@ lists of tuples are also acceptable. </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, + <listitem><para> +The prefix used for <function>Substfile</function> file names, the null 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, + <listitem><para> +The suffix used for <function>Substfile</function> file names, the null string by default. </para> </listitem> </varlistentry> <varlistentry id="cv-SUMMARY"> <term>SUMMARY</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A short summary of what the project is about. This is used to fill in the <literal>Summary:</literal> @@ -6706,35 +6182,32 @@ field in MSI packages. </varlistentry> <varlistentry id="cv-SWIG"> <term>SWIG</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> The command line used to call the scripting language wrapper and interface generator. </para> @@ -6742,35 +6215,32 @@ the scripting language wrapper and interface generator. </varlistentry> <varlistentry id="cv-SWIGCOMSTR"> <term>SWIGCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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 @@ -6782,8 +6252,7 @@ The default value is </varlistentry> <varlistentry id="cv-SWIGFLAGS"> <term>SWIGFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> General options passed to the scripting language wrapper and interface generator. This is where you should set @@ -6794,60 +6263,56 @@ 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> +<filename>scons</filename> 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"> + <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 -by appending <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCPREFIX</envar> and <envar xmlns="http://www.scons.org/dbxsd/v1.0">$SWIGINCSUFFIX</envar> +The value of <envar>$_SWIGINCFLAGS</envar> is created +by appending <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"> + <listitem><para> The prefix used to specify an include directory on the SWIG command line. This will be appended 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"> + <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"> + <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> @@ -6855,17 +6320,16 @@ and translated into the </varlistentry> <varlistentry id="cv-SWIGPATH"> <term>SWIGPATH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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 is to use the same path -specified as <envar xmlns="http://www.scons.org/dbxsd/v1.0">$CPPPATH</envar>. +specified as <envar>$CPPPATH</envar>. </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 @@ -6873,96 +6337,90 @@ 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> +<filename>scons</filename> 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 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 $SORUCES") </example_commands> </listitem> </varlistentry> <varlistentry id="cv-SWIGVERSION"> <term>SWIGVERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -6971,11 +6429,16 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-TARGET_ARCH"> <term>TARGET_ARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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> 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() @@ -6984,7 +6447,7 @@ This is currently only used on Windows, but in the future it will be used on other OSes as well. </para> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> +<para> Valid values for Windows are <literal>x86</literal>, <literal>i386</literal> @@ -6997,19 +6460,11 @@ and <literal>ia64</literal> (Itanium). For example, if you want to compile 64-bit binaries, you would set <literal>TARGET_ARCH='x86_64'</literal> in your SCons environment. </para> - -<para xmlns="http://www.scons.org/dbxsd/v1.0"> - 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> - </listitem> +</listitem> </varlistentry> <varlistentry id="cv-TARGET_OS"> <term>TARGET_OS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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. @@ -7019,8 +6474,7 @@ For example, if you want to compile 64-bit binaries, you would set </varlistentry> <varlistentry id="cv-TARGETS"> <term>TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -7029,16 +6483,14 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-TARSUFFIX"> <term>TARSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for tar file names. </para> </listitem> </varlistentry> <varlistentry id="cv-TEMPFILEPREFIX"> <term>TEMPFILEPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix for a temporary file used to execute lines longer than $MAXLINELENGTH. The default is '@'. @@ -7050,46 +6502,41 @@ or '-via' for ARM toolchain. </varlistentry> <varlistentry id="cv-TEX"> <term>TEX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> List of directories that the LaTeX program will search for include directories. The LaTeX implicit dependency scanner will search these @@ -7099,26 +6546,23 @@ directories for \include and \import files. </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, + <listitem><para> +The prefix used for <function>Textfile</function> file names, the null 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; + <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"> + <listitem><para> A list of the names of the Tool specifications that are part of this construction environment. </para> @@ -7126,8 +6570,7 @@ that are part of this construction environment. </varlistentry> <varlistentry id="cv-UNCHANGED_SOURCES"> <term>UNCHANGED_SOURCES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -7136,8 +6579,7 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-UNCHANGED_TARGETS"> <term>UNCHANGED_TARGETS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> A reserved variable name that may not be set or used in a construction environment. (See "Variable Substitution," below.) @@ -7146,8 +6588,7 @@ that may not be set or used in a construction environment. </varlistentry> <varlistentry id="cv-VENDOR"> <term>VENDOR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The person or organization who supply the packaged software. This is used to fill in the <literal>Vendor:</literal> @@ -7160,68 +6601,60 @@ field in the controlling information for MSI packages. </varlistentry> <varlistentry id="cv-VERSION"> <term>VERSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The version of the project, specified as a string. </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>. + <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>. + <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>. + <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>. + <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>. + <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"> + <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"> + <listitem><para> When this is set to true, a library build of a Windows shared library (<filename>.dll</filename> file) @@ -7235,10 +6668,9 @@ The default is 0 (do not build a <filename>.def</filename> file). </varlistentry> <varlistentry id="cv-WINDOWS_INSERT_MANIFEST"> <term>WINDOWS_INSERT_MANIFEST</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> When this is set to true, -<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename> +<filename>scons</filename> will be aware of the <filename>.manifest</filename> files generated by Microsoft Visua C/C++ 8. @@ -7247,40 +6679,35 @@ files generated by Microsoft Visua C/C++ 8. </varlistentry> <varlistentry id="cv-WINDOWSDEFPREFIX"> <term>WINDOWSDEFPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <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"> + <listitem><para> The prefix used for executable program <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> @@ -7288,8 +6715,7 @@ generated by Microsoft Visual C/C++. </varlistentry> <varlistentry id="cv-WINDOWSPROGMANIFESTSUFFIX"> <term>WINDOWSPROGMANIFESTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for executable program <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> @@ -7297,8 +6723,7 @@ generated by Microsoft Visual C/C++. </varlistentry> <varlistentry id="cv-WINDOWSSHLIBMANIFESTPREFIX"> <term>WINDOWSSHLIBMANIFESTPREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The prefix used for shared library <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> @@ -7306,8 +6731,7 @@ generated by Microsoft Visual C/C++. </varlistentry> <varlistentry id="cv-WINDOWSSHLIBMANIFESTSUFFIX"> <term>WINDOWSSHLIBMANIFESTSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for shared library <filename>.manifest</filename> files generated by Microsoft Visual C/C++. </para> @@ -7315,8 +6739,7 @@ generated by Microsoft Visual C/C++. </varlistentry> <varlistentry id="cv-X_IPK_DEPENDS"> <term>X_IPK_DEPENDS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Depends:</literal> field in the controlling information for Ipkg packages. @@ -7325,8 +6748,7 @@ field in the controlling information for Ipkg packages. </varlistentry> <varlistentry id="cv-X_IPK_DESCRIPTION"> <term>X_IPK_DESCRIPTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Description:</literal> field in the controlling information for Ipkg packages. @@ -7337,8 +6759,7 @@ The default value is </varlistentry> <varlistentry id="cv-X_IPK_MAINTAINER"> <term>X_IPK_MAINTAINER</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Maintainer:</literal> field in the controlling information for Ipkg packages. @@ -7347,8 +6768,7 @@ field in the controlling information for Ipkg packages. </varlistentry> <varlistentry id="cv-X_IPK_PRIORITY"> <term>X_IPK_PRIORITY</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Priority:</literal> field in the controlling information for Ipkg packages. @@ -7357,8 +6777,7 @@ field in the controlling information for Ipkg packages. </varlistentry> <varlistentry id="cv-X_IPK_SECTION"> <term>X_IPK_SECTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Section:</literal> field in the controlling information for Ipkg packages. @@ -7367,8 +6786,7 @@ field in the controlling information for Ipkg packages. </varlistentry> <varlistentry id="cv-X_MSI_LANGUAGE"> <term>X_MSI_LANGUAGE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Language:</literal> attribute in the controlling information for MSI packages. @@ -7377,8 +6795,7 @@ attribute in the controlling information for MSI packages. </varlistentry> <varlistentry id="cv-X_MSI_LICENSE_TEXT"> <term>X_MSI_LICENSE_TEXT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The text of the software license in RTF format. Carriage return characters will be replaced with the RTF equivalent \\par. @@ -7387,16 +6804,14 @@ replaced with the RTF equivalent \\par. </varlistentry> <varlistentry id="cv-X_MSI_UPGRADE_CODE"> <term>X_MSI_UPGRADE_CODE</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> This is used to fill in the <literal>AutoReqProv:</literal> field in the RPM @@ -7406,16 +6821,14 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_BUILD"> <term>X_RPM_BUILD</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> This is used to fill in the <literal>BuildRequires:</literal> field in the RPM @@ -7425,24 +6838,21 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_BUILDROOT"> <term>X_RPM_BUILDROOT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> This is used to fill in the <literal>Conflicts:</literal> field in the RPM @@ -7452,8 +6862,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_DEFATTR"> <term>X_RPM_DEFATTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This value is used as the default attributes for the files in the RPM package. The default value is @@ -7463,8 +6872,7 @@ The default value is </varlistentry> <varlistentry id="cv-X_RPM_DISTRIBUTION"> <term>X_RPM_DISTRIBUTION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Distribution:</literal> field in the RPM @@ -7474,8 +6882,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_EPOCH"> <term>X_RPM_EPOCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Epoch:</literal> field in the controlling information for RPM packages. @@ -7484,8 +6891,7 @@ field in the controlling information for RPM packages. </varlistentry> <varlistentry id="cv-X_RPM_EXCLUDEARCH"> <term>X_RPM_EXCLUDEARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>ExcludeArch:</literal> field in the RPM @@ -7495,8 +6901,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_EXLUSIVEARCH"> <term>X_RPM_EXLUSIVEARCH</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>ExclusiveArch:</literal> field in the RPM @@ -7506,8 +6911,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_GROUP"> <term>X_RPM_GROUP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Group:</literal> field in the RPM @@ -7517,8 +6921,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_GROUP_lang"> <term>X_RPM_GROUP_lang</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Group(lang):</literal> field in the RPM @@ -7533,8 +6936,7 @@ the appropriate language code. </varlistentry> <varlistentry id="cv-X_RPM_ICON"> <term>X_RPM_ICON</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Icon:</literal> field in the RPM @@ -7544,16 +6946,14 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_INSTALL"> <term>X_RPM_INSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> This is used to fill in the <literal>Packager:</literal> field in the RPM @@ -7563,8 +6963,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_POSTINSTALL"> <term>X_RPM_POSTINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>%post:</literal> section in the RPM @@ -7574,8 +6973,7 @@ section in the RPM </varlistentry> <varlistentry id="cv-X_RPM_POSTUNINSTALL"> <term>X_RPM_POSTUNINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>%postun:</literal> section in the RPM @@ -7585,8 +6983,7 @@ section in the RPM </varlistentry> <varlistentry id="cv-X_RPM_PREFIX"> <term>X_RPM_PREFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Prefix:</literal> field in the RPM @@ -7596,8 +6993,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_PREINSTALL"> <term>X_RPM_PREINSTALL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>%pre:</literal> section in the RPM @@ -7607,16 +7003,14 @@ section in the RPM </varlistentry> <varlistentry id="cv-X_RPM_PREP"> <term>X_RPM_PREP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> This is used to fill in the <literal>%preun:</literal> section in the RPM @@ -7626,8 +7020,7 @@ section in the RPM </varlistentry> <varlistentry id="cv-X_RPM_PROVIDES"> <term>X_RPM_PROVIDES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Provides:</literal> field in the RPM @@ -7637,8 +7030,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_REQUIRES"> <term>X_RPM_REQUIRES</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Requires:</literal> field in the RPM @@ -7648,8 +7040,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_SERIAL"> <term>X_RPM_SERIAL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Serial:</literal> field in the RPM @@ -7659,8 +7050,7 @@ field in the RPM </varlistentry> <varlistentry id="cv-X_RPM_URL"> <term>X_RPM_URL</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> This is used to fill in the <literal>Url:</literal> field in the RPM @@ -7670,37 +7060,33 @@ field in the RPM </varlistentry> <varlistentry id="cv-XGETTEXT"> <term>XGETTEXT</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <listitem><para> Internal "macro". Generates <command>xgettext</command> domain name form source and target (default: <literal>'${TARGET.filebase}'</literal>). </para> @@ -7708,40 +7094,36 @@ form source and target (default: <literal>'${TARGET.filebase}'</literal>). </varlistentry> <varlistentry id="cv-XGETTEXTFLAGS"> <term>XGETTEXTFLAGS</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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 + <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> @@ -7749,38 +7131,34 @@ This flag is used to add single <link xmlns="http://www.scons.org/dbxsd/v1.0" li </varlistentry> <varlistentry id="cv-XGETTEXTFROMSUFFIX"> <term>XGETTEXTFROMSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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"> + <listitem><para> This flag is used to add single search path to <command>xgettext(1)</command>'s commandline (default: <literal>'-D'</literal>). @@ -7789,24 +7167,21 @@ This flag is used to add single search path to </varlistentry> <varlistentry id="cv-XGETTEXTPATHSUFFIX"> <term>XGETTEXTPATHSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <listitem><para> The command line used to call the parser generator to generate a source file. </para> @@ -7814,24 +7189,22 @@ to generate a source file. </varlistentry> <varlistentry id="cv-YACCCOMSTR"> <term>YACCCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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 @@ -7841,8 +7214,7 @@ or a .hpp file </varlistentry> <varlistentry id="cv-YACCHFILESUFFIX"> <term>YACCHFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix of the C header file generated by the parser generator when the @@ -7860,8 +7232,7 @@ The default value is </varlistentry> <varlistentry id="cv-YACCHXXFILESUFFIX"> <term>YACCHXXFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix of the C++ header file generated by the parser generator when the @@ -7877,7 +7248,7 @@ 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> @@ -7885,8 +7256,7 @@ to the name of the generated C++ file. </varlistentry> <varlistentry id="cv-YACCVCGFILESUFFIX"> <term>YACCVCGFILESUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix of the file containing the VCG grammar automaton definition when the @@ -7904,16 +7274,14 @@ The default value is </varlistentry> <varlistentry id="cv-ZIP"> <term>ZIP</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <listitem><para> The command line used to call the zip utility, or the internal Python function used to create a zip archive. @@ -7922,8 +7290,7 @@ zip archive. </varlistentry> <varlistentry id="cv-ZIPCOMPRESSION"> <term>ZIPCOMPRESSION</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The <varname>compression</varname> flag @@ -7943,42 +7310,39 @@ module is unavailable. </varlistentry> <varlistentry id="cv-ZIPCOMSTR"> <term>ZIPCOMSTR</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <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"> + <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"> + <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 @@ -7988,8 +7352,7 @@ containing a file with the name </varlistentry> <varlistentry id="cv-ZIPSUFFIX"> <term>ZIPSUFFIX</term> - <listitem> -<para xmlns="http://www.scons.org/dbxsd/v1.0"> + <listitem><para> The suffix used for zip file names. </para> </listitem> diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index 3f254a5..fc12a92 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -76,8 +76,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-DESCRIPTION_lang "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DESCRIPTION_lang</envar>"> <!ENTITY cv-DFILESUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DFILESUFFIX</envar>"> <!ENTITY cv-DFLAGPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DFLAGPREFIX</envar>"> -<!ENTITY cv-DFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DFLAGS</envar>"> <!ENTITY cv-_DFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_DFLAGS</envar>"> +<!ENTITY cv-DFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DFLAGS</envar>"> <!ENTITY cv-DFLAGSUFFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DFLAGSUFFIX</envar>"> <!ENTITY cv-_DINCFLAGS "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$_DINCFLAGS</envar>"> <!ENTITY cv-DINCPREFIX "<envar xmlns='http://www.scons.org/dbxsd/v1.0'>$DINCPREFIX</envar>"> @@ -714,8 +714,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. <!ENTITY cv-link-DESCRIPTION_lang "<link linkend='cv-DESCRIPTION_lang' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DESCRIPTION_lang</envar></link>"> <!ENTITY cv-link-DFILESUFFIX "<link linkend='cv-DFILESUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DFILESUFFIX</envar></link>"> <!ENTITY cv-link-DFLAGPREFIX "<link linkend='cv-DFLAGPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DFLAGPREFIX</envar></link>"> -<!ENTITY cv-link-DFLAGS "<link linkend='cv-DFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DFLAGS</envar></link>"> <!ENTITY cv-link-_DFLAGS "<link linkend='cv-_DFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_DFLAGS</envar></link>"> +<!ENTITY cv-link-DFLAGS "<link linkend='cv-DFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DFLAGS</envar></link>"> <!ENTITY cv-link-DFLAGSUFFIX "<link linkend='cv-DFLAGSUFFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DFLAGSUFFIX</envar></link>"> <!ENTITY cv-link-_DINCFLAGS "<link linkend='cv-_DINCFLAGS' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$_DINCFLAGS</envar></link>"> <!ENTITY cv-link-DINCPREFIX "<link linkend='cv-DINCPREFIX' xmlns='http://www.scons.org/dbxsd/v1.0'><envar>$DINCPREFIX</envar></link>"> diff --git a/src/engine/SCons/Tool/install.xml b/src/engine/SCons/Tool/install.xml index da82c6e..0aa9384 100644 --- a/src/engine/SCons/Tool/install.xml +++ b/src/engine/SCons/Tool/install.xml @@ -85,7 +85,7 @@ env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], Installs a versioned shared library. The &cv-link-SHLIBVERSION; construction variable should be defined in the environment to confirm the version number in the library name. -If &cv-link-SHLIBVERSION is not defined a warning will be issued +If &cv-link-SHLIBVERSION; is not defined a warning will be issued and the name of the library will be parsed to derive the version. The symlinks appropriate to the architecture will be generated. </para> |