summaryrefslogtreecommitdiff
path: root/doc/user/main.xml
blob: 01470ccf998b1042ddfa49fa0d186fd1877b706f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
<?xml version="1.0"?>
<!--

  Copyright (c) 2001 - 2019 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 - 2019</pubdate>

    <copyright>
      <year>2004 - 2019</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>