summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2002-06-20 00:17:18 (GMT)
committerSteven Knight <knight@baldmt.com>2002-06-20 00:17:18 (GMT)
commit01bba4cf479f99c67dcac6bc50603feccc89c457 (patch)
treea07099be95dddcfdb438e7b08b780063c8853831 /doc
parent81953156f0c5075d21b9d1573ead1f2e482482a6 (diff)
downloadSCons-01bba4cf479f99c67dcac6bc50603feccc89c457.zip
SCons-01bba4cf479f99c67dcac6bc50603feccc89c457.tar.gz
SCons-01bba4cf479f99c67dcac6bc50603feccc89c457.tar.bz2
Check in the Tool() interface. (SK and Charles Crain)
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.176
1 files changed, 75 insertions, 1 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 79ca4b7..a81bae5 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -686,6 +686,69 @@ def my_platform(env):
env = Environment(platform = my_platform)
.EE
+Additionally, a specific set of tools
+with which to initialize the environment
+may specified as an optional keyword argument:
+
+.ES
+env = Environment(tools = ['msvc', 'lex'])
+.EE
+
+The elements of the tools list may also
+be functions or callable objects,
+in which case the Environment() method
+will call the specified elements
+to update the new construction environment:
+
+.ES
+def my_tool(env):
+ env['XYZZY'] = 'xyzzy'
+
+env = Environment(tools = [my_tool])
+.EE
+
+SCons supports the following tool specifications
+out of the box on
+.B cygwin
+and
+.B posix
+platforms:
+
+.ES
+ar
+dvipdf
+dvips
+g++
+g77
+gcc
+gnulink
+latex
+lex
+pdflatex
+pdftex
+tex
+yacc
+.EE
+
+and supports the following tool specifications out of the box on
+.B win32
+platforms:
+
+.ES
+dvipdf
+dvips
+g77
+latex
+lex
+lib
+mslink
+msvc
+pdflatex
+pdftex
+tex
+yacc
+.EE
+
.SS Builder Methods
Build rules are specified by calling a construction
@@ -1767,7 +1830,7 @@ foo = SConscript('subdir/SConscript', "env")
.TP
.RI SConscriptChdir( value )
-When a non-negative
+When a non-zero
.I value
is specified,
this instructs
@@ -1842,6 +1905,17 @@ or by using a similar function such as the
string.split() function in the Python library.
.TP
+.RI Tool( string )
+Returns a callable object
+that can be used to initialize
+a construction environment using the
+tools keyword of the Environment() method.
+
+.ES
+env = Environment(tools = [ Tool('msvc') ])
+.EE
+
+.TP
.RI WhereIs( program ", [" path ", [" pathext ]])
Searches for the specified executable