doc/user/main.in

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