doc/user/main.xml

   1 <?xml version="1.0"?>
   2 <!--
   3
   4   MIT License
   5
   6   Copyright The SCons Foundation
   7
   8   Permission is hereby granted, free of charge, to any person obtaining
   9   a copy of this software and associated documentation files (the
  10   "Software"), to deal in the Software without restriction, including
  11   without limitation the rights to use, copy, modify, merge, publish,
  12   distribute, sublicense, and/or sell copies of the Software, and to
  13   permit persons to whom the Software is furnished to do so, subject to
  14   the following conditions:
  15
  16   The above copyright notice and this permission notice shall be included
  17   in all copies or substantial portions of the Software.
  18
  19   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  20   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  21   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  23   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  24   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  25   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26
  27 -->
  28
  29 <!DOCTYPE sconsdoc [
  30
  31     <!ENTITY % version SYSTEM "../version.xml">
  32     %version;
  33
  34     <!ENTITY % scons SYSTEM "../scons.mod">
  35     %scons;
  36
  37     <!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
  38     %builders-mod;
  39     <!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
  40     %functions-mod;
  41     <!ENTITY % tools-mod SYSTEM "../generated/tools.mod">
  42     %tools-mod;
  43     <!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
  44     %variables-mod;
  45
  46 ]>
  47
  48 <book xmlns="http://www.scons.org/dbxsd/v1.0"
  49       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  50       xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  51   <bookinfo>
  52     <title>SCons &buildversion;</title>
  53     <subtitle>User Guide</subtitle>
  54
  55     <corpauthor>The SCons Development Team</corpauthor>
  56
  57     <pubdate>Released: Mon, 21 Mar 2023 12:25:39 -0400</pubdate>
  58
  59     <copyright>
  60         <year>2004 - 2023</year>
  61         <holder>The SCons Foundation</holder>
  62     </copyright>
  63
  64     <releaseinfo>Version &buildversion;</releaseinfo>
  65
  66     <mediaobject role="cover"><imageobject><imagedata fileref="cover.jpg" format="JPG"/></imageobject></mediaobject>
  67   </bookinfo>
  68
  69   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="preface.xml"/>
  70   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="build-install.xml"/>
  71   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="simple.xml"/>
  72   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="less-simple.xml"/>
  73   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="libraries.xml"/>
  74   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nodes.xml"/>
  75   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="depends.xml"/>
  76   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="environments.xml"/>
  77
  78   <chapter id="chap-manip-options">
  79     <title>Automatically Putting Command-line Options into their Construction Variables</title>
  80     <!-- TODO:  combine this into a chapter document.
  81     This intro paragraph should describe at a high-level
  82     what these things do.  People are likely to use the intro as a
  83     (brief) overview of *what* these functions do to decide if this
  84     chapter is where they should read in more detail.  -->
  85     <para>
  86     This chapter describes the &MergeFlags;, &ParseFlags;, and &ParseConfig;
  87     methods of a &consenv;, as well as the <parameter>parse_flags</parameter>
  88     keyword argument to methods that construct environments.
  89     </para>
  90     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="mergeflags.xml"/>
  91     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parse_flags_arg.xml"/>
  92     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseflags.xml"/>
  93     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseconfig.xml"/>
  94   </chapter>
  95
  96   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="output.xml"/>
  97   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="command-line.xml"/>
  98   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="install.xml"/>
  99   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="factories.xml"/>
 100   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="file-removal.xml"/>
 101   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hierarchy.xml"/>
 102   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="separate.xml"/>
 103   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="repositories.xml"/>
 104   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-built-in.xml"/> -->
 105   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-writing.xml"/>
 106   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-commands.xml"/>
 107   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="add-method.xml"/>
 108   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="actions.xml"/> -->
 109   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="scanners.xml"/>
 110   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sconf.xml"/>
 111   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="caching.xml"/>
 112   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="alias.xml"/>
 113   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="java.xml"/>
 114   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gettext.xml"/>
 115   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="run.xml"/> -->
 116   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="misc.xml"/>
 117   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="external.xml"/>
 118   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshoot.xml"/>
 119
 120   <!--   Appendix below here -->
 121   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="variables.xml"/>
 122   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders.xml"/>
 123   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.xml"/>
 124   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="functions.xml"/>
 125   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tasks.xml"/>
 126
 127   <!-- These sections are only sekeletons: -->
 128   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="python.xml"/> -->
 129   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="example.xml"/> -->
 130   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="make.xml"/> -->
 131   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ant.xml"/> -->
 132
 133 </book>