diff options
Diffstat (limited to 'doc/user/main.xml')
| -rw-r--r-- | doc/user/main.xml | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/doc/user/main.xml b/doc/user/main.xml new file mode 100644 index 0000000..ebdf35b --- /dev/null +++ b/doc/user/main.xml @@ -0,0 +1,184 @@ +<?xml version="1.0"?> +<!-- + + Copyright (c) 2001 - 2014 The SCons Foundation + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be included + in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY + KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +--> + +<!DOCTYPE sconsdoc [ + + <!ENTITY % version SYSTEM "../version.xml"> + %version; + + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; + + <!ENTITY % builders-mod SYSTEM "../generated/builders.mod"> + %builders-mod; + <!ENTITY % functions-mod SYSTEM "../generated/functions.mod"> + %functions-mod; + <!ENTITY % tools-mod SYSTEM "../generated/tools.mod"> + %tools-mod; + <!ENTITY % variables-mod SYSTEM "../generated/variables.mod"> + %variables-mod; + +]> + + <!-- + + XXX Platform() + XXX Tools() + + XXX GetOption('duplicate') + XXX SetOption('duplicate') + XXX - - duplicate= + + XXX CheckTypeSize() + + XXX - - diskcheck= + + XXX - - warn= + + --> + +<book 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"> + <bookinfo> + <title>SCons &buildversion;</title> + <subtitle>User Guide</subtitle> + + <author> + <firstname>Steven</firstname> + <surname>Knight</surname> + </author> + + <corpauthor>Steven Knight and the SCons Development Team</corpauthor> + + <pubdate>2004 - 2014</pubdate> + + <copyright> + <year>2004 - 2014</year> + <holder>The SCons Foundation</holder> + </copyright> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> + + <releaseinfo>version &buildversion;</releaseinfo> + + <mediaobject role="cover"><imageobject><imagedata fileref="cover.jpg" format="JPG"/></imageobject></mediaobject> + </bookinfo> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="preface.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="build-install.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="simple.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="less-simple.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="libraries.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nodes.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="depends.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="environments.xml"/> + + <chapter id="chap-manip-options"> + <title>Automatically Putting Command-line Options into their Construction Variables</title> + <!-- TODO: This intro paragraph should describe at a high-level + what these things do. People are likely to use the intro as a + (brief) overview of *what* these functions do to decide if this + chapter is where they should read in more detail. --> + <para> + This chapter describes the &MergeFlags;, &ParseFlags;, and &ParseConfig; methods of a &consenv;. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="mergeflags.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseflags.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseconfig.xml"/> + <!-- + XXX parse_flags= option of Environment() + --> + </chapter> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="output.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="command-line.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="install.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="factories.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="file-removal.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hierarchy.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="separate.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="variants.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gettext.xml"/> + + <!-- + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-built-in.xml"/> + + --> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-writing.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-commands.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="add-method.xml"/> + + <!-- + + XXX Action() + XXX AddPostAction() + XXX AddPreAction() + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="actions.xml"/> + + --> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="scanners.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="repositories.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sconf.xml"/> + + <!-- + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sourcecode.xml"/> + + --> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="caching.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="alias.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="java.xml"/> + + <!-- + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="run.xml"/> + + --> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="misc.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshoot.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="variables.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="functions.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tasks.xml"/> + + <!-- + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="python.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="example.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="make.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ant.xml"/> + + --> + +</book> |