summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2002-03-27 02:49:41 (GMT)
committerSteven Knight <knight@baldmt.com>2002-03-27 02:49:41 (GMT)
commit1ffd7687fe1aa4c9b438a17126052ef3d3234bfe (patch)
treec469582d0abfb3bad67d6dfd3c4b1279cc8e97a9 /doc
parentdf70fbb73a1b644373002ebe3c9bc206b256744b (diff)
downloadSCons-1ffd7687fe1aa4c9b438a17126052ef3d3234bfe.zip
SCons-1ffd7687fe1aa4c9b438a17126052ef3d3234bfe.tar.gz
SCons-1ffd7687fe1aa4c9b438a17126052ef3d3234bfe.tar.bz2
Add WhereIs() functionality.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.121
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index e49008f..51ee464 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -1230,6 +1230,27 @@ is that arguments to the command.
is a dictionary of the environment variables
in which the command should be executed.
+.TP
+.RI WhereIs( program ", [" path ", [" pathext ]])
+
+Searches for the specified executable
+.I program,
+returning the full path name to the program
+if it is found,
+and returning None if not.
+Searches the specified
+.I path,
+or the user's current PATH
+(os.environ['PATH'])
+by default.
+On Win32 systems, searches for executable
+programs with any of the file extensions
+listed in the specified
+.I pathext,
+or the user's current PATHEXT
+(os.environ['PATHEXT'])
+by default.
+
.SH EXTENDING SCONS
.SS Builder Objects
.B scons