summaryrefslogtreecommitdiffstats
path: root/doc/user/main.sgml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2001-09-19 14:29:08 (GMT)
committerSteven Knight <knight@baldmt.com>2001-09-19 14:29:08 (GMT)
commit2e862e98a5109da56222d7ba7bcc52c5d718ea82 (patch)
treebf1bbe3555360ed5cf6d1333cdc4913fce06d838 /doc/user/main.sgml
parent7cd353fbcb81398e12a5a6b564eb4288449b4bc6 (diff)
downloadSCons-2e862e98a5109da56222d7ba7bcc52c5d718ea82.zip
SCons-2e862e98a5109da56222d7ba7bcc52c5d718ea82.tar.gz
SCons-2e862e98a5109da56222d7ba7bcc52c5d718ea82.tar.bz2
Add an outline for a User's Guide.
Diffstat (limited to 'doc/user/main.sgml')
-rw-r--r--doc/user/main.sgml153
1 files changed, 153 insertions, 0 deletions
diff --git a/doc/user/main.sgml b/doc/user/main.sgml
new file mode 100644
index 0000000..eb7ab39
--- /dev/null
+++ b/doc/user/main.sgml
@@ -0,0 +1,153 @@
+<!--
+
+ Copyright 2001 Steven Knight
+
+-->
+
+<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+[
+
+ <!ENTITY % version SYSTEM "../version.sgml">
+ %version;
+
+ <!ENTITY % scons SYSTEM "../scons.mod">
+ %scons;
+
+ <!ENTITY preface SYSTEM "preface.sgml">
+ <!ENTITY simple SYSTEM "simple.sgml">
+ <!ENTITY environments SYSTEM "environments.sgml">
+ <!ENTITY depends SYSTEM "depends.sgml">
+ <!ENTITY more SYSTEM "more.sgml">
+ <!ENTITY hierarchy SYSTEM "hierarchy.sgml">
+ <!ENTITY variants SYSTEM "variants.sgml">
+ <!ENTITY builders SYSTEM "builders.sgml">
+ <!ENTITY scanners SYSTEM "scanners.sgml">
+ <!ENTITY repositories SYSTEM "repositories.sgml">
+ <!ENTITY caching SYSTEM "caching.sgml">
+ <!ENTITY run SYSTEM "run.sgml">
+ <!ENTITY troubleshoot SYSTEM "troubleshoot.sgml">
+ <!ENTITY reference SYSTEM "reference.sgml">
+ <!ENTITY errors SYSTEM "errors.sgml">
+ <!ENTITY example SYSTEM "example.sgml">
+ <!ENTITY make SYSTEM "make.sgml">
+ <!ENTITY cons SYSTEM "cons.sgml">
+
+]>
+
+<book>
+ <bookinfo>
+ <title>SCons User Guide &build_version;</title>
+
+ <author>
+ <firstname>Steven</firstname>
+ <surname>Knight</surname>
+ </author>
+
+ <edition>Revision &build_revision; (&build_date;)</edition>
+
+ <pubdate>2001</pubdate>
+
+ <copyright>
+ <year>2001</year>
+ <holder>Steven Knight</holder>
+ </copyright>
+
+ <legalnotice>
+ &copyright;
+ </legalnotice>
+
+ <releaseinfo>version &build_version;</releaseinfo>
+
+ </bookinfo>
+
+ <chapter id="chap-preface">
+ <title>Preface</title>
+ &preface;
+ </chapter>
+
+ <chapter id="chap-simple">
+ <title>Simple Builds</title>
+ &simple;
+ </chapter>
+
+ <chapter id="chap-environments">
+ <title>Construction Environments</title>
+ &environments;
+ </chapter>
+
+ <chapter id="chap-depends">
+ <title>Dependencies</title>
+ &depends;
+ </chapter>
+
+ <chapter id="chap-more">
+ <title>More Things to Do With Builds</title>
+ &more;
+ </chapter>
+
+ <chapter id="chap-hierarchical">
+ <title>Hierarchial Builds</title>
+ &hierarchy;
+ </chapter>
+
+ <chapter id="chap-variant">
+ <title>Variant Builds</title>
+ &variants;
+ </chapter>
+
+ <chapter id="chap-builders">
+ <title>Writing Builders</title>
+ &builders;
+ </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-caching">
+ <title>Caching Built Files</title>
+ &caching;
+ </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-quick">
+ <title>Quick Reference</title>
+ &reference;
+ </appendix>
+
+ <appendix id="app-errors">
+ <title>Errors Generated by &SCons;</title>
+ &errors;
+ </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>
+
+</book>