doc/user/main.xml

   1 <?xml version="1.0"?>
   2
   3 <!--
   4 SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   5 SPDX-License-Identifier: MIT
   6 SPDX-FileType: DOCUMENTATION
   7
   8 This file is processed by the bin/SConsDoc.py module.
   9 -->
  10
  11 <!DOCTYPE sconsdoc [
  12
  13     <!ENTITY % version SYSTEM "../version.xml">
  14     %version;
  15
  16     <!ENTITY % scons SYSTEM "../scons.mod">
  17     %scons;
  18
  19     <!ENTITY % builders-mod SYSTEM "../generated/builders.mod">
  20     %builders-mod;
  21     <!ENTITY % functions-mod SYSTEM "../generated/functions.mod">
  22     %functions-mod;
  23     <!ENTITY % tools-mod SYSTEM "../generated/tools.mod">
  24     %tools-mod;
  25     <!ENTITY % variables-mod SYSTEM "../generated/variables.mod">
  26     %variables-mod;
  27
  28 ]>
  29
  30 <book xmlns="http://www.scons.org/dbxsd/v1.0"
  31       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  32       xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  33   <bookinfo>
  34     <title>SCons &buildversion;</title>
  35     <subtitle>User Guide</subtitle>
  36
  37     <corpauthor>The SCons Development Team</corpauthor>
  38
  39     <pubdate>Released: Mon, 03 Sep 2024 18:13:57 -0700</pubdate>
  40
  41     <copyright>
  42         <year>2004 - 2024</year>
  43         <holder>The SCons Foundation</holder>
  44     </copyright>
  45
  46     <releaseinfo>Version &buildversion;</releaseinfo>
  47
  48     <mediaobject role="cover"><imageobject><imagedata fileref="cover.jpg" format="JPG"/></imageobject></mediaobject>
  49   </bookinfo>
  50
  51   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="preface.xml"/>
  52   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="build-install.xml"/>
  53   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="simple.xml"/>
  54   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="less-simple.xml"/>
  55   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="libraries.xml"/>
  56   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="nodes.xml"/>
  57   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="depends.xml"/>
  58   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="environments.xml"/>
  59
  60   <chapter id="chap-manip-options">
  61     <title>Automatically Putting Command-line Options into their Construction Variables</title>
  62     <!-- TODO:  combine this into a chapter document.
  63     This intro paragraph should describe at a high-level
  64     what these things do.  People are likely to use the intro as a
  65     (brief) overview of *what* these functions do to decide if this
  66     chapter is where they should read in more detail.  -->
  67     <para>
  68     This chapter describes the &MergeFlags;, &ParseFlags;, and &ParseConfig;
  69     methods of a &consenv;, as well as the <parameter>parse_flags</parameter>
  70     keyword argument to methods that construct environments.
  71     </para>
  72     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="mergeflags.xml"/>
  73     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parse_flags_arg.xml"/>
  74     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseflags.xml"/>
  75     <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="parseconfig.xml"/>
  76   </chapter>
  77
  78   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="output.xml"/>
  79   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="command-line.xml"/>
  80   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="install.xml"/>
  81   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="factories.xml"/>
  82   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="file-removal.xml"/>
  83   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hierarchy.xml"/>
  84   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="separate.xml"/>
  85   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="repositories.xml"/>
  86   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-built-in.xml"/> -->
  87   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-writing.xml"/>
  88   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders-commands.xml"/>
  89   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="add-method.xml"/>
  90   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="actions.xml"/> -->
  91   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="scanners.xml"/>
  92   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="sconf.xml"/>
  93   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="caching.xml"/>
  94   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="alias.xml"/>
  95   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="java.xml"/>
  96   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gettext.xml"/>
  97   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="run.xml"/> -->
  98   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="misc.xml"/>
  99   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="external.xml"/>
 100   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshoot.xml"/>
 101
 102   <!--   Appendix below here -->
 103   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="variables.xml"/>
 104   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="builders.xml"/>
 105   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tools.xml"/>
 106   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="functions.xml"/>
 107   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tasks.xml"/>
 108
 109   <!-- These sections are only sekeletons: -->
 110   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="python.xml"/> -->
 111   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="example.xml"/> -->
 112   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="make.xml"/> -->
 113   <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="ant.xml"/> -->
 114
 115 </book>