Documentation

This page contains links to general SCons documentation, and to documentation (man page and User's Guide) for the current stable release of SCons: 2.3.3. Man pages and User's Guides for other releases of SCons are available at the Version-Specific SCons Documentation page.

SCons 2.3.3 man page

The man page for the current stable release of . We're meticulous about updating the man page whenever new functionality is added or something changes, so this covers everything that the current version of can do (modulo oversights).

SCons 2.3.3 User Guide

The User's Guide for the current stable release of . This is very much a work in progress. This covers the basics, but there is a lot in that hasn't been covered yet in this Guide, so check the man page before assuming that can't do something you don't find covered here. Please help improve this document by letting the maintainers know about anything you find that's incorrect, or about missing pieces in which you're especially interested (or to which you can contribute yourself).

SCons API

Documentation for the API of the latest release of SCons, generated by epydoc from the SCons source code and doc strings. NOTE: We only started generating this documentation with the 0.96.95 release, so it's likely that much of the text might reflect older, outdated versions of source code, and needs updating. If you find these sorts of things, please let us know by filing a bug report, or even submitting a patch yourself.

SCons Design

The ongoing design document, based largely on the ScCons design from the second round of the Software Carpentry contest. This is out of date at the moment, and needs to be updated for the changes made to the interface during alpha development.

SCons Design and Implementation

The paper about presented at the Python 10 conference in February 2002, a nominee for the best paper award at the conference.

Please subscribe to the low-volume announce@scons.tigris.org mailing list to receive news and announcements about new documentation.