path: root/doc/user/main.in

<!--

  __COPYRIGHT__

  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 book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
[

    <!ENTITY % version SYSTEM "../version.sgml">
    %version;

    <!ENTITY % scons SYSTEM "../scons.mod">
    %scons;

    <!ENTITY % builders-mod SYSTEM "builders.mod">
    %builders-mod;

    <!ENTITY % tools-mod SYSTEM "tools.mod">
    %tools-mod;

    <!ENTITY % variables-mod SYSTEM "variables.mod">
    %variables-mod;

    <!ENTITY actions SYSTEM "actions.sgml">
    <!ENTITY alias SYSTEM "alias.sgml">
    <!ENTITY ant SYSTEM "ant.sgml">
    <!ENTITY build-install SYSTEM "build-install.sgml">
    <!ENTITY builders SYSTEM "builders.sgml">
    <!ENTITY builders-built-in SYSTEM "builders-built-in.sgml">
    <!ENTITY builders-commands SYSTEM "builders-commands.sgml">
    <!ENTITY builders-writing SYSTEM "builders-writing.sgml">
    <!ENTITY caching SYSTEM "caching.sgml">
    <!ENTITY command-line SYSTEM "command-line.sgml">
    <!ENTITY copyright SYSTEM "copyright.sgml">
    <!ENTITY depends SYSTEM "depends.sgml">
    <!ENTITY ENV_file SYSTEM "ENV.sgml">
    <!ENTITY environments SYSTEM "environments.sgml">
    <!ENTITY errors SYSTEM "errors.sgml">
    <!ENTITY example SYSTEM "example.sgml">
    <!ENTITY factories SYSTEM "factories.sgml">
    <!ENTITY file-removal SYSTEM "file-removal.sgml">
    <!ENTITY help SYSTEM "help.sgml">
    <!ENTITY hierarchy SYSTEM "hierarchy.sgml">
    <!ENTITY java SYSTEM "java.sgml">
    <!ENTITY install SYSTEM "install.sgml">
    <!ENTITY less-simple SYSTEM "less-simple.sgml">
    <!ENTITY libraries SYSTEM "libraries.sgml">
    <!ENTITY make SYSTEM "make.sgml">
    <!ENTITY nodes SYSTEM "nodes.sgml">
    <!ENTITY parseconfig SYSTEM "parseconfig.sgml">
    <!ENTITY preface SYSTEM "preface.sgml">
    <!ENTITY python SYSTEM "python.sgml">
    <!ENTITY repositories SYSTEM "repositories.sgml">
    <!ENTITY run SYSTEM "run.sgml">
    <!ENTITY scanners SYSTEM "scanners.sgml">
    <!ENTITY sconf SYSTEM "sconf.sgml">
    <!ENTITY separate SYSTEM "separate.sgml">
    <!ENTITY simple SYSTEM "simple.sgml">
    <!ENTITY sourcecode SYSTEM "sourcecode.sgml">
    <!ENTITY tasks SYSTEM "tasks.sgml">
    <!ENTITY tools SYSTEM "tools.sgml">
    <!ENTITY troubleshoot SYSTEM "troubleshoot.sgml">
    <!ENTITY variables SYSTEM "variables.sgml">
    <!ENTITY variants SYSTEM "variants.sgml">

    <!ENTITY builders-gen SYSTEM "builders.gen">
    <!ENTITY tools-gen SYSTEM "tools.gen">
    <!ENTITY variables-gen SYSTEM "variables.gen">

]>

  <!--

  XXX AllowSubstExceptions()
  XXX EnsurePythonVersion()
  XXX EnsureSConsVersion()
  XXX Exit()
  XXX FindFile()
  XXX FindPathDirs()
  XXX Flatten()
  XXX GetBuildPath()
  XXX GetLaunchDir()

  XXX MergeFlags()
  XXX ParseFlags()

  XXX ParseDepends()
  XXX Platform()
  XXX SConsignFile()
  XXX SideEffect()
  XXX Tools()

  XXX GetOption('clean')
  XXX SetOption('clean')

  XXX GetOption('duplicate')
  XXX SetOption('duplicate')
  XXX - - duplicate=

  XXX GetOption('num_jobs')
  XXX SetOption('num_jobs')

  XXX - - diskcheck=

  XXX site_scons
  XXX - - site-dir
  XXX - - no-site-dir

  XXX - - warn=

  XXX ARGLIST
  XXX ARGUMENTS
  XXX BUILD_TARGETS
  XXX COMMAND_LINE_TARGETS
  XXX DEFAULT_TARGETS

  -->

<book>
  <bookinfo>
    <title>SCons User Guide &buildversion;</title>

    <author>
      <firstname>Steven</firstname>
      <surname>Knight</surname>
    </author>

    <edition>Revision &buildrevision; (&builddate;)</edition>

    <pubdate>2004, 2005, 2006, 2007</pubdate>

    <copyright>
      <year>2004, 2005, 2006, 2007</year>
      <holder>Steven Knight</holder>
    </copyright>

    <legalnotice>
      &copyright;
    </legalnotice>

    <releaseinfo>version &buildversion;</releaseinfo>

  </bookinfo>

  <preface id="chap-preface">
    <title>Preface</title>
    &preface;
  </preface>

  <chapter id="chap-build-install">
    <title>Building and Installing &SCons;</title>
    &build-install;
  </chapter>

  <chapter id="chap-simple">
    <title>Simple Builds</title>
    &simple;
  </chapter>

  <chapter id="chap-less-simple">
    <title>Less Simple Things to Do With Builds</title>
    &less-simple;
  </chapter>

  <chapter id="chap-libraries">
    <title>Building and Linking with Libraries</title>
    &libraries;
  </chapter>

  <chapter id="chap-nodes">
    <title>Node Objects</title>
    &nodes;
  </chapter>

  <chapter id="chap-depends">
    <title>Dependencies</title>
    &depends;
  </chapter>

  <chapter id="chap-environments">
    <title>Construction Environments</title>
    &environments;
  </chapter>

  <!--

  <chapter id="chap-parseconfig">
    <title>Finding Installed Library Information:  the &ParseConfig; Function</title>
    &parseconfig;
  </chapter>

  -->

  <chapter id="chap-ENV">
    <title>Controlling the External Environment Used to Execute Build Commands</title>
    &ENV_file;
  </chapter>

  <chapter id="chap-command-line">
    <title>Controlling a Build From the Command Line</title>
    &command-line;
  </chapter>

  <chapter id="chap-help">
    <title>Providing Build Help:  the &Help; Function</title>
    &help;
  </chapter>

  <chapter id="chap-install">
    <title>Installing Files in Other Directories:  the &Install; Builder</title>
    &install;
  </chapter>

  <chapter id="chap-factories">
    <title>Platform-Independent File System Manipulation</title>
    &factories;
  </chapter>

  <chapter id="chap-file-removal">
    <title>Preventing Removal of Targets</title>
    &file-removal;
  </chapter>

  <chapter id="chap-hierarchical">
    <title>Hierarchical Builds</title>
    &hierarchy;
  </chapter>

  <chapter id="chap-separate">
    <title>Separating Source and Build Directories</title>
    &separate;
  </chapter>

  <chapter id="chap-variants">
    <title>Variant Builds</title>
    &variants;
  </chapter>

  <!--

  <chapter id="chap-builders-built-in">
    <title>Built-In Builders</title>
    &builders-built-in;
  </chapter>

  -->

  <chapter id="chap-builders-writing">
    <title>Writing Your Own Builders</title>
    &builders-writing;
  </chapter>

  <chapter id="chap-builders-commands">
    <title>Not Writing a Builder:  the &Command; Builder</title>
    &builders-commands;
  </chapter>

  <!--

  XXX Action()
  XXX AddPostAction()
  XXX AddPreAction()

  <chapter id="chap-actions">
    <title>&SCons; Actions</title>
    &actions;
  </chapter>

  -->

  <chapter id="chap-scanners">
    <title>Writing Scanners</title>
    &scanners;
  </chapter>

  <chapter id="chap-repositories">
    <title>Building From Code Repositories</title>
    &repositories;
  </chapter>

  <chapter id="chap-sconf">
    <title>Multi-Platform Configuration (&Autoconf; Functionality)</title>
    &sconf;
  </chapter>

  <!--

  <chapter id="chap-sourcecode">
    <title>Fetching Files From Source Code Management Systems</title>
    &sourcecode;
  </chapter>

  -->

  <chapter id="chap-caching">
    <title>Caching Built Files</title>
    &caching;
  </chapter>

  <chapter id="chap-alias">
    <title>Alias Targets</title>
    &alias;
  </chapter>

  <chapter id="chap-java">
    <title>Java Builds</title>
    &java;
  </chapter>

  <!--

  <chapter id="chap-run">
    <title>How to Run &SCons;</title>
    &run;
  </chapter>

  -->

  <chapter id="chap-troubleshooting">
    <title>Troubleshooting</title>
    &troubleshoot;
  </chapter>

  <appendix id="app-variables">
    <title>Construction Variables</title>
    &variables;
  </appendix>

  <appendix id="app-builders">
    <title>Builders</title>
    &builders;
  </appendix>

  <appendix id="app-tools">
    <title>Tools</title>
    &tools;
  </appendix>

  <appendix id="app-tasks">
    <title>Handling Common Tasks</title>
    &tasks;
  </appendix>

  <!--

  <appendix id="app-python">
    <title>Python Overview</title>
    &example;
  </appendix>

  <appendix id="app-example">
    <title>Complex &SCons; Example</title>
    &example;
  </appendix>

  <appendix id="app-make">
    <title>Converting From Make</title>
    &make;
  </appendix>

  <appendix id="app-cons">
    <title>Converting From Cons</title>
    &cons;
  </appendix>

  <appendix id="app-ant">
    <title>Converting From Ant</title>
    &ant;
  </appendix>

  -->

</book>