doc/user/main.in

   1 <?xml version="1.0"?>
   2 <!--
   3
   4   __COPYRIGHT__
   5
   6   Permission is hereby granted, free of charge, to any person obtaining
   7   a copy of this software and associated documentation files (the
   8   "Software"), to deal in the Software without restriction, including
   9   without limitation the rights to use, copy, modify, merge, publish,
  10   distribute, sublicense, and/or sell copies of the Software, and to
  11   permit persons to whom the Software is furnished to do so, subject to
  12   the following conditions:
  13
  14   The above copyright notice and this permission notice shall be included
  15   in all copies or substantial portions of the Software.
  16
  17   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  18   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  19   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24
  25 -->
  26
  27 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  28 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
  29 [
  30
  31     <!ENTITY % version SYSTEM "../version.xml">
  32     %version;
  33
  34     <!ENTITY % scons SYSTEM "../scons.mod">
  35     %scons;
  36
  37     <!ENTITY % builders-mod SYSTEM "builders.mod">
  38     %builders-mod;
  39
  40     <!ENTITY % tools-mod SYSTEM "tools.mod">
  41     %tools-mod;
  42
  43     <!ENTITY % variables-mod SYSTEM "variables.mod">
  44     %variables-mod;
  45
  46     <!ENTITY actions SYSTEM "actions.xml">
  47     <!ENTITY alias SYSTEM "alias.xml">
  48     <!ENTITY ant SYSTEM "ant.xml">
  49     <!ENTITY build-install SYSTEM "build-install.xml">
  50     <!ENTITY builders SYSTEM "builders.xml">
  51     <!ENTITY builders-built-in SYSTEM "builders-built-in.xml">
  52     <!ENTITY builders-commands SYSTEM "builders-commands.xml">
  53     <!ENTITY builders-writing SYSTEM "builders-writing.xml">
  54     <!ENTITY add-method SYSTEM "add-method.xml">
  55     <!ENTITY caching SYSTEM "caching.xml">
  56     <!ENTITY command-line SYSTEM "command-line.xml">
  57     <!ENTITY copyright SYSTEM "copyright.xml">
  58     <!ENTITY depends SYSTEM "depends.xml">
  59     <!ENTITY environments SYSTEM "environments.xml">
  60     <!ENTITY errors SYSTEM "errors.xml">
  61     <!ENTITY example SYSTEM "example.xml">
  62     <!ENTITY factories SYSTEM "factories.xml">
  63     <!ENTITY file-removal SYSTEM "file-removal.xml">
  64     <!ENTITY hierarchy SYSTEM "hierarchy.xml">
  65     <!ENTITY java SYSTEM "java.xml">
  66     <!ENTITY install SYSTEM "install.xml">
  67     <!ENTITY less-simple SYSTEM "less-simple.xml">
  68     <!ENTITY libraries SYSTEM "libraries.xml">
  69     <!ENTITY make SYSTEM "make.xml">
  70     <!ENTITY mergeflags SYSTEM "mergeflags.xml">
  71     <!ENTITY misc SYSTEM "misc.xml">
  72     <!ENTITY nodes SYSTEM "nodes.xml">
  73     <!ENTITY output SYSTEM "output.xml">
  74     <!ENTITY parseconfig SYSTEM "parseconfig.xml">
  75     <!ENTITY parseflags SYSTEM "parseflags.xml">
  76     <!ENTITY preface SYSTEM "preface.xml">
  77     <!ENTITY python SYSTEM "python.xml">
  78     <!ENTITY repositories SYSTEM "repositories.xml">
  79     <!ENTITY run SYSTEM "run.xml">
  80     <!ENTITY scanners SYSTEM "scanners.xml">
  81     <!ENTITY sconf SYSTEM "sconf.xml">
  82     <!ENTITY separate SYSTEM "separate.xml">
  83     <!ENTITY simple SYSTEM "simple.xml">
  84     <!ENTITY sourcecode SYSTEM "sourcecode.xml">
  85     <!ENTITY tasks SYSTEM "tasks.xml">
  86     <!ENTITY tools SYSTEM "tools.xml">
  87     <!ENTITY troubleshoot SYSTEM "troubleshoot.xml">
  88     <!ENTITY variables-xml SYSTEM "variables.xml">
  89     <!ENTITY variants SYSTEM "variants.xml">
  90
  91     <!ENTITY builders-gen SYSTEM "builders.gen">
  92     <!ENTITY tools-gen SYSTEM "tools.gen">
  93     <!ENTITY variables-gen SYSTEM "variables.gen">
  94
  95 ]>
  96
  97   <!--
  98
  99   XXX FindFile()
 100   XXX FindPathDirs()
 101   XXX GetBuildPath()
 102   XXX GetLaunchDir()
 103
 104   XXX ParseDepends()
 105   XXX Platform()
 106   XXX SConsignFile()
 107   XXX Tools()
 108
 109   XXX GetOption('duplicate')
 110   XXX SetOption('duplicate')
 111   XXX - - duplicate=
 112
 113   XXX CheckTypeSize()
 114
 115   XXX - - diskcheck=
 116
 117   XXX - - warn=
 118
 119   -->
 120
 121 <book>
 122   <bookinfo>
 123     <title>SCons User Guide &buildversion;</title>
 124
 125     <author>
 126       <firstname>Steven</firstname>
 127       <surname>Knight</surname>
 128     </author>
 129
 130     <edition>Revision &buildrevision; (&builddate;)</edition>
 131
 132     <pubdate>2004, 2005, 2006, 2007, 2008</pubdate>
 133
 134     <copyright>
 135       <year>2004, 2005, 2006, 2007, 2008</year>
 136       <holder>Steven Knight</holder>
 137     </copyright>
 138
 139     <legalnotice>
 140       &copyright;
 141     </legalnotice>
 142
 143     <releaseinfo>version &buildversion;</releaseinfo>
 144
 145   </bookinfo>
 146
 147   <preface id="chap-preface">
 148     <title>Preface</title>
 149     &preface;
 150   </preface>
 151
 152   <chapter id="chap-build-install">
 153     <title>Building and Installing &SCons;</title>
 154     &build-install;
 155   </chapter>
 156
 157   <chapter id="chap-simple">
 158     <title>Simple Builds</title>
 159     &simple;
 160   </chapter>
 161
 162   <chapter id="chap-less-simple">
 163     <title>Less Simple Things to Do With Builds</title>
 164     &less-simple;
 165   </chapter>
 166
 167   <chapter id="chap-libraries">
 168     <title>Building and Linking with Libraries</title>
 169     &libraries;
 170   </chapter>
 171
 172   <chapter id="chap-nodes">
 173     <title>Node Objects</title>
 174     &nodes;
 175   </chapter>
 176
 177   <chapter id="chap-depends">
 178     <title>Dependencies</title>
 179     &depends;
 180   </chapter>
 181
 182   <chapter id="chap-environments">
 183     <title>Environments</title>
 184     &environments;
 185   </chapter>
 186
 187   <!-- These next three sections should be combined into one chapter -->
 188   <chapter id="chap-mergeflags">
 189     <title>Merging Options into the Environment: the &MergeFlags; Function</title>
 190     &mergeflags;
 191   </chapter>
 192   <chapter id="chap-parseflags">
 193     <title>Separating Compile Arguments into their Variables:  the &ParseFlags; Function</title>
 194     &parseflags;
 195   </chapter>
 196   <chapter id="chap-parseconfig">
 197     <title>Finding Installed Library Information:  the &ParseConfig; Function</title>
 198     &parseconfig;
 199   </chapter>
 200
 201   <chapter id="chap-output">
 202     <title>Controlling Build Output</title>
 203     &output;
 204   </chapter>
 205
 206   <chapter id="chap-command-line">
 207     <title>Controlling a Build From the Command Line</title>
 208     &command-line;
 209   </chapter>
 210
 211   <chapter id="chap-install">
 212     <title>Installing Files in Other Directories:  the &Install; Builder</title>
 213     &install;
 214   </chapter>
 215
 216   <chapter id="chap-factories">
 217     <title>Platform-Independent File System Manipulation</title>
 218     &factories;
 219   </chapter>
 220
 221   <chapter id="chap-file-removal">
 222     <title>Controlling Removal of Targets</title>
 223     &file-removal;
 224   </chapter>
 225
 226   <chapter id="chap-hierarchical">
 227     <title>Hierarchical Builds</title>
 228     &hierarchy;
 229   </chapter>
 230
 231   <chapter id="chap-separate">
 232     <title>Separating Source and Build Directories</title>
 233     &separate;
 234   </chapter>
 235
 236   <chapter id="chap-variants">
 237     <title>Variant Builds</title>
 238     &variants;
 239   </chapter>
 240
 241   <!--
 242
 243   <chapter id="chap-builders-built-in">
 244     <title>Built-In Builders</title>
 245     &builders-built-in;
 246   </chapter>
 247
 248   -->
 249
 250   <chapter id="chap-builders-writing">
 251     <title>Writing Your Own Builders</title>
 252     &builders-writing;
 253   </chapter>
 254
 255   <chapter id="chap-builders-commands">
 256     <title>Not Writing a Builder:  the &Command; Builder</title>
 257     &builders-commands;
 258   </chapter>
 259
 260   <chapter id="chap-add-method">
 261     <title>Pseudo-Builders:  the AddMethod function</title>
 262     &add-method;
 263   </chapter>
 264
 265   <!--
 266
 267   XXX Action()
 268   XXX AddPostAction()
 269   XXX AddPreAction()
 270
 271   <chapter id="chap-actions">
 272     <title>&SCons; Actions</title>
 273     &actions;
 274   </chapter>
 275
 276   -->
 277
 278   <chapter id="chap-scanners">
 279     <title>Writing Scanners</title>
 280     &scanners;
 281   </chapter>
 282
 283   <chapter id="chap-repositories">
 284     <title>Building From Code Repositories</title>
 285     &repositories;
 286   </chapter>
 287
 288   <chapter id="chap-sconf">
 289     <title>Multi-Platform Configuration (&Autoconf; Functionality)</title>
 290     &sconf;
 291   </chapter>
 292
 293   <!--
 294
 295   <chapter id="chap-sourcecode">
 296     <title>Fetching Files From Source Code Management Systems</title>
 297     &sourcecode;
 298   </chapter>
 299
 300   -->
 301
 302   <chapter id="chap-caching">
 303     <title>Caching Built Files</title>
 304     &caching;
 305   </chapter>
 306
 307   <chapter id="chap-alias">
 308     <title>Alias Targets</title>
 309     &alias;
 310   </chapter>
 311
 312   <chapter id="chap-java">
 313     <title>Java Builds</title>
 314     &java;
 315   </chapter>
 316
 317   <!--
 318
 319   <chapter id="chap-run">
 320     <title>How to Run &SCons;</title>
 321     &run;
 322   </chapter>
 323
 324   -->
 325
 326   <chapter id="chap-misc">
 327     <title>Miscellaneous Functionality</title>
 328     &misc;
 329   </chapter>
 330
 331   <chapter id="chap-troubleshooting">
 332     <title>Troubleshooting</title>
 333     &troubleshoot;
 334   </chapter>
 335
 336   <appendix id="app-variables">
 337     <title>Construction Variables</title>
 338     &variables-xml;
 339   </appendix>
 340
 341   <appendix id="app-builders">
 342     <title>Builders</title>
 343     &builders;
 344   </appendix>
 345
 346   <appendix id="app-tools">
 347     <title>Tools</title>
 348     &tools;
 349   </appendix>
 350
 351   <appendix id="app-tasks">
 352     <title>Handling Common Tasks</title>
 353     &tasks;
 354   </appendix>
 355
 356   <!--
 357
 358   <appendix id="app-python">
 359     <title>Python Overview</title>
 360     &example;
 361   </appendix>
 362
 363   <appendix id="app-example">
 364     <title>Complex &SCons; Example</title>
 365     &example;
 366   </appendix>
 367
 368   <appendix id="app-make">
 369     <title>Converting From Make</title>
 370     &make;
 371   </appendix>
 372
 373   <appendix id="app-cons">
 374     <title>Converting From Cons</title>
 375     &cons;
 376   </appendix>
 377
 378   <appendix id="app-ant">
 379     <title>Converting From Ant</title>
 380     &ant;
 381   </appendix>
 382
 383   -->
 384
 385 </book>