diff options
Diffstat (limited to 'scons.1')
| -rw-r--r-- | scons.1 | 856 |
1 files changed, 380 insertions, 476 deletions
@@ -3,11 +3,11 @@ .\" Author: Steven Knight .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> .\" Date: <pubdate>2004 - 2016</pubdate> -.\" Manual: SCons 2.5.1 -.\" Source: SCons 2.5.1 version 2.5.1 +.\" Manual: SCons 3.0.0 +.\" Source: SCons 3.0.0 version 3.0.0 .\" Language: English .\" -.TH "SCONS" "1" "<pubdate>2004 - 2016</pubdate>" "SCons 2\&.5\&.1 version 2.5.1" "SCons 2\&.5\&.1" +.TH "SCONS" "1" "<pubdate>2004 - 2016</pubdate>" "SCons 3\&.0\&.0 version 3.0.0" "SCons 3\&.0\&.0" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -1472,6 +1472,26 @@ The tool definition (i\&.e\&. my_tool()) can use the PLATFORM variable from the .PP If no tool list is specified, then SCons will auto\-detect the installed tools using the PATH variable in the ENV construction variable and the platform name when the Environment is constructed\&. Changing the PATH variable after the Environment is constructed will not cause the tools to be redetected\&. .PP +One feature now present within Scons is the ability to have nested tools\&. Tools which can be located within a subdirectory in the toolpath\&. With a nested tool name the dot represents a directory seperator +.sp +.if n \{\ +.RS 4 +.\} +.nf +# namespaced builder +env = Environment(ENV = os\&.environ, tools = [\*(AqSubDir1\&.SubDir2\&.SomeTool\*(Aq]) +env\&.SomeTool(targets, sources) + +# Search Paths +# SCons\eTool\eSubDir1\eSubDir2\eSomeTool\&.py +# SCons\eTool\eSubDir1\eSubDir2\eSomeTool\e__init__\&.py +# \&.\esite_scons\esite_tools\eSubDir1\eSubDir2\eSomeTool\&.py +# \&.\esite_scons\esite_tools\eSubDir1\eSubDir2\eSomeTool\e__init__\&.py +.fi +.if n \{\ +.RE +.\} +.PP SCons supports the following tool specifications out of the box: .PP 386asm @@ -1614,20 +1634,6 @@ Uses: \fB$_CPPINCFLAGS\fR\&. .RE .PP -BitKeeper -.RS 4 -Sets construction variables for the BitKeeper source code control system\&. -.sp -Sets: -\fB$BITKEEPER\fR, -\fB$BITKEEPERCOM\fR, -\fB$BITKEEPERGET\fR, -\fB$BITKEEPERGETFLAGS\fR\&. -.sp -Uses: -\fB$BITKEEPERCOMSTR\fR\&. -.RE -.PP cc .RS 4 Sets construction variables for generic POSIX C copmilers\&. @@ -1654,6 +1660,28 @@ Uses: \fB$PLATFORM\fR\&. .RE .PP +clang +.RS 4 +Set construction variables for the Clang C compiler\&. +.sp +Sets: +\fB$CC\fR, +\fB$CCVERSION\fR, +\fB$SHCCFLAGS\fR\&. +.RE +.PP +clangxx +.RS 4 +Set construction variables for the Clang C++ compiler\&. +.sp +Sets: +\fB$CXX\fR, +\fB$CXXVERSION\fR, +\fB$SHCXXFLAGS\fR, +\fB$SHOBJSUFFIX\fR, +\fB$STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME\fR\&. +.RE +.PP cvf .RS 4 Sets construction variables for the Compaq Visual Fortran compiler\&. @@ -1678,20 +1706,6 @@ Uses: \fB$_FORTRANMODFLAG\fR\&. .RE .PP -CVS -.RS 4 -Sets construction variables for the CVS source code management system\&. -.sp -Sets: -\fB$CVS\fR, -\fB$CVSCOFLAGS\fR, -\fB$CVSCOM\fR, -\fB$CVSFLAGS\fR\&. -.sp -Uses: -\fB$CVSCOMSTR\fR\&. -.RE -.PP cXX .RS 4 Sets construction variables for generic POSIX C++ compilers\&. @@ -1766,26 +1780,23 @@ Sets: \fB$DLIBLINKSUFFIX\fR, \fB$DLINK\fR, \fB$DLINKCOM\fR, +\fB$DLINKFLAGPREFIX\fR, \fB$DLINKFLAGS\fR, +\fB$DLINKFLAGSUFFIX\fR, \fB$DPATH\fR, +\fB$DRPATHPREFIX\fR, +\fB$DRPATHSUFFIX\fR, +\fB$DShLibSonameGenerator\fR, \fB$DVERPREFIX\fR, \fB$DVERSIONS\fR, \fB$DVERSUFFIX\fR, -\fB$RPATHPREFIX\fR, -\fB$RPATHSUFFIX\fR, \fB$SHDC\fR, \fB$SHDCOM\fR, +\fB$SHDLIBVERSION\fR, +\fB$SHDLIBVERSIONFLAGS\fR, \fB$SHDLINK\fR, \fB$SHDLINKCOM\fR, -\fB$SHDLINKFLAGS\fR, -\fB$_DDEBUGFLAGS\fR, -\fB$_DFLAGS\fR, -\fB$_DINCFLAGS\fR, -\fB$_DLIBDIRFLAGS\fR, -\fB$_DLIBFLAGS\fR, -\fB$_DLIBFLAGS\fR, -\fB$_DVERFLAGS\fR, -\fB$_RPATH\fR\&. +\fB$SHDLINKFLAGS\fR\&. .RE .PP docbook @@ -2312,30 +2323,31 @@ Sets: \fB$DINCSUFFIX\fR, \fB$DLIB\fR, \fB$DLIBCOM\fR, +\fB$DLIBDIRPREFIX\fR, +\fB$DLIBDIRSUFFIX\fR, \fB$DLIBFLAGPREFIX\fR, \fB$DLIBFLAGSUFFIX\fR, +\fB$DLIBLINKPREFIX\fR, +\fB$DLIBLINKSUFFIX\fR, \fB$DLINK\fR, \fB$DLINKCOM\fR, \fB$DLINKFLAGPREFIX\fR, \fB$DLINKFLAGS\fR, \fB$DLINKFLAGSUFFIX\fR, \fB$DPATH\fR, +\fB$DRPATHPREFIX\fR, +\fB$DRPATHSUFFIX\fR, +\fB$DShLibSonameGenerator\fR, \fB$DVERPREFIX\fR, \fB$DVERSIONS\fR, \fB$DVERSUFFIX\fR, -\fB$RPATHPREFIX\fR, -\fB$RPATHSUFFIX\fR, \fB$SHDC\fR, \fB$SHDCOM\fR, +\fB$SHDLIBVERSION\fR, +\fB$SHDLIBVERSIONFLAGS\fR, \fB$SHDLINK\fR, \fB$SHDLINKCOM\fR, -\fB$SHDLINKFLAGS\fR, -\fB$_DDEBUGFLAGS\fR, -\fB$_DFLAGS\fR, -\fB$_DINCFLAGS\fR, -\fB$_DLIBFLAGS\fR, -\fB$_DVERFLAGS\fR, -\fB$_RPATH\fR\&. +\fB$SHDLINKFLAGS\fR\&. .RE .PP gettext @@ -2731,24 +2743,19 @@ Sets: \fB$DLINKFLAGS\fR, \fB$DLINKFLAGSUFFIX\fR, \fB$DPATH\fR, +\fB$DRPATHPREFIX\fR, +\fB$DRPATHSUFFIX\fR, +\fB$DShLibSonameGenerator\fR, \fB$DVERPREFIX\fR, \fB$DVERSIONS\fR, \fB$DVERSUFFIX\fR, -\fB$RPATHPREFIX\fR, -\fB$RPATHSUFFIX\fR, \fB$SHDC\fR, \fB$SHDCOM\fR, +\fB$SHDLIBVERSION\fR, +\fB$SHDLIBVERSIONFLAGS\fR, \fB$SHDLINK\fR, \fB$SHDLINKCOM\fR, -\fB$SHDLINKFLAGS\fR, -\fB$_DDEBUGFLAGS\fR, -\fB$_DFLAGS\fR, -\fB$_DINCFLAGS\fR, -\fB$_DLIBDIRFLAGS\fR, -\fB$_DLIBFLAGS\fR, -\fB$_DLIBFLAGS\fR, -\fB$_DVERFLAGS\fR, -\fB$_RPATH\fR\&. +\fB$SHDLINKFLAGS\fR\&. .RE .PP lex @@ -3185,11 +3192,6 @@ Uses: \fB$ASPPCOMSTR\fR\&. .RE .PP -packaging -.RS 4 -A framework for building binary and source packages\&. -.RE -.PP Packaging .RS 4 Sets construction variables for the @@ -3197,6 +3199,11 @@ Sets construction variables for the Builder\&. .RE .PP +packaging +.RS 4 +A framework for building binary and source packages\&. +.RE +.PP pdf .RS 4 Sets construction variables for the Portable Document Format builder\&. @@ -3242,19 +3249,6 @@ Uses: \fB$PDFTEXCOMSTR\fR\&. .RE .PP -Perforce -.RS 4 -Sets construction variables for interacting with the Perforce source code management system\&. -.sp -Sets: -\fB$P4\fR, -\fB$P4COM\fR, -\fB$P4FLAGS\fR\&. -.sp -Uses: -\fB$P4COMSTR\fR\&. -.RE -.PP qt .RS 4 Sets construction variables for building Qt applications\&. @@ -3286,20 +3280,6 @@ Sets: \fB$QT_UISUFFIX\fR\&. .RE .PP -RCS -.RS 4 -Sets construction variables for the interaction with the Revision Control System\&. -.sp -Sets: -\fB$RCS\fR, -\fB$RCS_CO\fR, -\fB$RCS_COCOM\fR, -\fB$RCS_COFLAGS\fR\&. -.sp -Uses: -\fB$RCS_COCOMSTR\fR\&. -.RE -.PP rmic .RS 4 Sets construction variables for the @@ -3329,20 +3309,6 @@ Sets: \fB$RPCGENXDRFLAGS\fR\&. .RE .PP -SCCS -.RS 4 -Sets construction variables for interacting with the Source Code Control System\&. -.sp -Sets: -\fB$SCCS\fR, -\fB$SCCSCOM\fR, -\fB$SCCSFLAGS\fR, -\fB$SCCSGETFLAGS\fR\&. -.sp -Uses: -\fB$SCCSCOMSTR\fR\&. -.RE -.PP sgiar .RS 4 Sets construction variables for the SGI library archiver\&. @@ -3884,7 +3850,7 @@ foo = Object(\*(Aqfoo\&.c\*(Aq) bar = Object(\*(Aqbar\&.c\*(Aq) objects = [\*(Aqbegin\&.o\*(Aq] + foo + [\*(Aqmiddle\&.o\*(Aq] + bar + [\*(Aqend\&.o\*(Aq] for object in objects: - print str(object) + print(str(object)) .fi .if n \{\ .RE @@ -3901,7 +3867,7 @@ foo = Object(\*(Aqfoo\&.c\*(Aq) bar = Object(\*(Aqbar\&.c\*(Aq) objects = Flatten([\*(Aqbegin\&.o\*(Aq, foo, \*(Aqmiddle\&.o\*(Aq, bar, \*(Aqend\&.o\*(Aq]) for object in objects: - print str(object) + print(str(object)) .fi .if n \{\ .RE @@ -3944,7 +3910,7 @@ function: .\} .nf bar_obj_list = env\&.StaticObject(\*(Aqbar\&.c\*(Aq, CPPDEFINES=\*(Aq\-DBAR\*(Aq) -print "The path to bar_obj is:", str(bar_obj_list[0]) +print("The path to bar_obj is:", str(bar_obj_list[0])) .fi .if n \{\ .RE @@ -4915,22 +4881,22 @@ Example usage: .RS 4 .\} .nf -barsrcs = [\*(Aqbar\&.cpp\*(Aq], -barincs = [\*(Aqbar\&.h\*(Aq], +barsrcs = [\*(Aqbar\&.cpp\*(Aq] +barincs = [\*(Aqbar\&.h\*(Aq] barlocalincs = [\*(AqStdAfx\&.h\*(Aq] barresources = [\*(Aqbar\&.rc\*(Aq,\*(Aqresource\&.h\*(Aq] barmisc = [\*(Aqbar_readme\&.txt\*(Aq] dll = env\&.SharedLibrary(target = \*(Aqbar\&.dll\*(Aq, source = barsrcs) - +buildtarget = [s for s in dll if str(s)\&.endswith(\*(Aqdll\*(Aq)] env\&.MSVSProject(target = \*(AqBar\*(Aq + env[\*(AqMSVSPROJECTSUFFIX\*(Aq], srcs = barsrcs, incs = barincs, localincs = barlocalincs, resources = barresources, misc = barmisc, - buildtarget = dll, + buildtarget = buildtarget, variant = \*(AqRelease\*(Aq) .fi .if n \{\ @@ -5944,6 +5910,66 @@ env\&.Program(target = \*(Aqfoo\*(Aq, source = [\*(Aqfoo\&.o\*(Aq, \*(Aqbar\&.c\ .\} .RE .PP +\fBProgramAllAtOnce()\fR, \fBenv\&.ProgramAllAtOnce()\fR +.RS 4 +Builds an executable from D sources without first creating individual objects for each file\&. +.sp +D sources can be compiled file\-by\-file as C and C++ source are, and D is integrated into the +scons +Object and Program builders for this model of build\&. D codes can though do whole source meta\-programming (some of the testing frameworks do this)\&. For this it is imperative that all sources are compiled and linked in a single call of the D compiler\&. This builder serves that purpose\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + env\&.ProgramAllAtOnce(\*(Aqexecutable\*(Aq, [\*(Aqmod_a\&.d, mod_b\&.d\*(Aq, \*(Aqmod_c\&.d\*(Aq]) + +.fi +.if n \{\ +.RE +.\} +.sp +This command will compile the modules mod_a, mod_b, and mod_c in a single compilation process without first creating object files for the modules\&. Some of the D compilers will create executable\&.o others will not\&. +.sp +Builds an executable from D sources without first creating individual objects for each file\&. +.sp +D sources can be compiled file\-by\-file as C and C++ source are, and D is integrated into the +scons +Object and Program builders for this model of build\&. D codes can though do whole source meta\-programming (some of the testing frameworks do this)\&. For this it is imperative that all sources are compiled and linked in a single call of the D compiler\&. This builder serves that purpose\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + env\&.ProgramAllAtOnce(\*(Aqexecutable\*(Aq, [\*(Aqmod_a\&.d, mod_b\&.d\*(Aq, \*(Aqmod_c\&.d\*(Aq]) + +.fi +.if n \{\ +.RE +.\} +.sp +This command will compile the modules mod_a, mod_b, and mod_c in a single compilation process without first creating object files for the modules\&. Some of the D compilers will create executable\&.o others will not\&. +.sp +Builds an executable from D sources without first creating individual objects for each file\&. +.sp +D sources can be compiled file\-by\-file as C and C++ source are, and D is integrated into the +scons +Object and Program builders for this model of build\&. D codes can though do whole source meta\-programming (some of the testing frameworks do this)\&. For this it is imperative that all sources are compiled and linked in a single call of the D compiler\&. This builder serves that purpose\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + env\&.ProgramAllAtOnce(\*(Aqexecutable\*(Aq, [\*(Aqmod_a\&.d, mod_b\&.d\*(Aq, \*(Aqmod_c\&.d\*(Aq]) + +.fi +.if n \{\ +.RE +.\} +.sp +This command will compile the modules mod_a, mod_b, and mod_c in a single compilation process without first creating object files for the modules\&. Some of the D compilers will create executable\&.o others will not\&. +.RE +.PP \fBRES()\fR, \fBenv\&.RES()\fR .RS 4 Builds a Microsoft Visual C++ resource file\&. This builder method is only provided when Microsoft Visual C++ or MinGW is being used as the compiler\&. The @@ -6336,7 +6362,7 @@ Any occurrences of a key in the source are replaced by the corresponding value, env = Environment(tools = [\*(Aqdefault\*(Aq, \*(Aqtextfile\*(Aq]) env[\*(Aqprefix\*(Aq] = \*(Aq/usr/bin\*(Aq -script_dict = {\*(Aq@prefix@\*(Aq: \*(Aq/bin\*(Aq, @exec_prefix@: \*(Aq$prefix\*(Aq} +script_dict = {\*(Aq@prefix@\*(Aq: \*(Aq/bin\*(Aq, \*(Aq@exec_prefix@\*(Aq: \*(Aq$prefix\*(Aq} env\&.Substfile(\*(Aqscript\&.in\*(Aq, SUBST_DICT = script_dict) conf_dict = {\*(Aq%VERSION%\*(Aq: \*(Aq1\&.2\&.3\*(Aq, \*(Aq%BASE%\*(Aq: \*(AqMyProg\*(Aq} @@ -6925,7 +6951,7 @@ Examples: # which the method will be called; the Python # convention is to call it \*(Aqself\*(Aq\&. def my_method(self, arg): - print "my_method() got", arg + print("my_method() got", arg) # Use the global AddMethod() function to add a method # to the Environment class\&. This @@ -7210,29 +7236,6 @@ env\&.AppendUnique(CCFLAGS = \*(Aq\-g\*(Aq, FOO = [\*(Aqfoo\&.yyy\*(Aq]) .\} .RE .PP -env\&.BitKeeper() -.RS 4 -A factory function that returns a Builder object to be used to fetch source files using BitKeeper\&. The returned Builder is intended to be passed to the -\fBSourceCode\fR -function\&. -.sp -This function is deprecated\&. For details, see the entry for the -\fBSourceCode\fR -function\&. -.sp -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.BitKeeper()) -.fi -.if n \{\ -.RE -.\} -.RE -.PP BuildDir(build_dir, src_dir, [duplicate]), env\&.BuildDir(build_dir, src_dir, [duplicate]) .RS 4 Deprecated synonyms for @@ -7507,44 +7510,6 @@ A now\-deprecated synonym for \fBenv\&.Clone\fR()\&. .RE .PP -env\&.CVS(repository, module) -.RS 4 -A factory function that returns a Builder object to be used to fetch source files from the specified CVS -\fIrepository\fR\&. The returned Builder is intended to be passed to the -\fBSourceCode\fR -function\&. -.sp -This function is deprecated\&. For details, see the entry for the -\fBSourceCode\fR -function\&. -.sp -The optional specified -\fImodule\fR -will be added to the beginning of all repository path names; this can be used, in essence, to strip initial directory names from the repository path names, so that you only have to replicate part of the repository directory hierarchy in your local build directory\&. -.sp -Examples: -.sp -.if n \{\ -.RS 4 -.\} -.nf -# Will fetch foo/bar/src\&.c -# from /usr/local/CVSROOT/foo/bar/src\&.c\&. -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.CVS(\*(Aq/usr/local/CVSROOT\*(Aq)) - -# Will fetch bar/src\&.c -# from /usr/local/CVSROOT/foo/bar/src\&.c\&. -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.CVS(\*(Aq/usr/local/CVSROOT\*(Aq, \*(Aqfoo\*(Aq)) - -# Will fetch src\&.c -# from /usr/local/CVSROOT/foo/bar/src\&.c\&. -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.CVS(\*(Aq/usr/local/CVSROOT\*(Aq, \*(Aqfoo/bar\*(Aq)) -.fi -.if n \{\ -.RE -.\} -.RE -.PP Decider(function), env\&.Decider(function) .RS 4 Specifies that all up\-to\-date decisions for targets built through this construction environment will be handled by the specified @@ -7569,7 +7534,7 @@ timestamp, such as can happen when restoring files from backup archives\&. .PP MD5 .RS 4 -Specifies that a target shall be considered out of date and rebuilt if the dependency\*(Aqs content has changed sine the last time the target was built, as determined be performing an MD5 checksum on the dependency\*(Aqs contents and comparing it to the checksum recorded the last time the target was built\&. +Specifies that a target shall be considered out of date and rebuilt if the dependency\*(Aqs content has changed since the last time the target was built, as determined be performing an MD5 checksum on the dependency\*(Aqs contents and comparing it to the checksum recorded the last time the target was built\&. content can be used as a synonym for MD5\&. @@ -7577,7 +7542,7 @@ MD5\&. .PP MD5\-timestamp .RS 4 -Specifies that a target shall be considered out of date and rebuilt if the dependency\*(Aqs content has changed sine the last time the target was built, except that dependencies with a timestamp that matches the last time the target was rebuilt will be assumed to be up\-to\-date and +Specifies that a target shall be considered out of date and rebuilt if the dependency\*(Aqs content has changed since the last time the target was built, except that dependencies with a timestamp that matches the last time the target was rebuilt will be assumed to be up\-to\-date and \fInot\fR rebuilt\&. This provides behavior very similar to the MD5 @@ -8233,7 +8198,7 @@ import atexit def print_build_failures(): from SCons\&.Script import GetBuildFailures for bf in GetBuildFailures(): - print "%s failed: %s" % (bf\&.node, bf\&.errstr) + print("%s failed: %s" % (bf\&.node, bf\&.errstr)) atexit\&.register(print_build_failures) .fi @@ -8835,31 +8800,6 @@ dict = env\&.ParseFlags(\*(Aq\-O2\*(Aq, \*(Aq!echo \-Dfoo \-Dbar=1\*(Aq) .\} .RE .PP -env\&.Perforce() -.RS 4 -A factory function that returns a Builder object to be used to fetch source files from the Perforce source code management system\&. The returned Builder is intended to be passed to the -\fBSourceCode\fR -function\&. -.sp -This function is deprecated\&. For details, see the entry for the -\fBSourceCode\fR -function\&. -.sp -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.Perforce()) -.fi -.if n \{\ -.RE -.\} -.sp -Perforce uses a number of external environment variables for its operation\&. Consequently, this function adds the following variables from the user\*(Aqs external environment to the construction environment\*(Aqs ENV dictionary: P4CHARSET, P4CLIENT, P4LANGUAGE, P4PASSWD, P4PORT, P4USER, SystemRoot, USER, and USERNAME\&. -.RE -.PP Platform(string) .RS 4 The @@ -9015,7 +8955,7 @@ An example of a simple custom progress function that prints a string containing .\} .nf def my_progress_function(node, *args, **kw): - print \*(AqEvaluating node %s!\*(Aq % node + print(\*(AqEvaluating node %s!\*(Aq % node) Progress(my_progress_function, interval=10) .fi .if n \{\ @@ -9108,31 +9048,16 @@ is more appropriate\&. Multiple targets can be passed in to a single call to \fBPseudo\fR\&. .RE .PP -env\&.RCS() -.RS 4 -A factory function that returns a Builder object to be used to fetch source files from RCS\&. The returned Builder is intended to be passed to the -\fBSourceCode\fR -function: -.sp -This function is deprecated\&. For details, see the entry for the -\fBSourceCode\fR -function\&. -.sp -Examples: -.sp -.if n \{\ +PyPackageDir(modulename), env\&.PyPackageDir(modulename) .RS 4 -.\} -.nf -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.RCS()) -.fi -.if n \{\ -.RE -.\} +This returns a Directory Node similar to Dir\&. The python module / package is looked up and if located the directory is returned for the location\&. +\fImodulename\fR +Is a named python package / module to lookup the directory for it\*(Aqs location\&. .sp -Note that -scons -will fetch source files from RCS subdirectories automatically, so configuring RCS as demonstrated in the above example should only be necessary if you are fetching from RCS,v files in the same directory as the source files, or if you need to explicitly specify RCS for a specific subdirectory\&. +If +\fImodulename\fR +is a list, SCons returns a list of Dir nodes\&. Construction variables are expanded in +\fImodulename\fR\&. .RE .PP env\&.Replace(key=val, [\&.\&.\&.]) @@ -9240,31 +9165,6 @@ Creates a Scanner object for the specified \fIfunction\fR\&. See the section "Scanner Objects," below, for a complete explanation of the arguments and behavior\&. .RE .PP -env\&.SCCS() -.RS 4 -A factory function that returns a Builder object to be used to fetch source files from SCCS\&. The returned Builder is intended to be passed to the -\fBSourceCode\fR -function\&. -.sp -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -env\&.SourceCode(\*(Aq\&.\*(Aq, env\&.SCCS()) -.fi -.if n \{\ -.RE -.\} -.sp -Note that -scons -will fetch source files from SCCS subdirectories automatically, so configuring SCCS as demonstrated in the above example should only be necessary if you are fetching from -s\&.SCCS -files in the same directory as the source files, or if you need to explicitly specify SCCS for a specific subdirectory\&. -.RE -.PP SConscript(scripts, [exports, variant_dir, duplicate]), env\&.SConscript(scripts, [exports, variant_dir, duplicate]), SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate]), env\&.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate]) .RS 4 This tells @@ -9642,6 +9542,11 @@ random which corresponds to \-\-random; and .RE .PP +silent +.RS 4 +which corresponds to \-\-silent\&. +.RE +.PP stack_size .RS 4 which corresponds to \-\-stack\-size\&. @@ -10262,10 +10167,10 @@ Example: .RS 4 .\} .nf -print "first keyword, value =", ARGLIST[0][0], ARGLIST[0][1] -print "second keyword, value =", ARGLIST[1][0], ARGLIST[1][1] +print("first keyword, value =", ARGLIST[0][0], ARGLIST[0][1]) +print("second keyword, value =", ARGLIST[1][0], ARGLIST[1][1]) third_tuple = ARGLIST[2] -print "third keyword, value =", third_tuple[0], third_tuple[1] +print("third keyword, value =", third_tuple[0], third_tuple[1]) for key, value in ARGLIST: # process key and value .fi @@ -10322,7 +10227,7 @@ Example: .\} .nf if \*(Aqfoo\*(Aq in BUILD_TARGETS: - print "Don\*(Aqt forget to test the `foo\*(Aq program!" + print("Don\*(Aqt forget to test the `foo\*(Aq program!") if \*(Aqspecial/program\*(Aq in BUILD_TARGETS: SConscript(\*(Aqspecial\*(Aq) .fi @@ -10349,7 +10254,7 @@ Example: .\} .nf if \*(Aqfoo\*(Aq in COMMAND_LINE_TARGETS: - print "Don\*(Aqt forget to test the `foo\*(Aq program!" + print("Don\*(Aqt forget to test the `foo\*(Aq program!") if \*(Aqspecial/program\*(Aq in COMMAND_LINE_TARGETS: SConscript(\*(Aqspecial\*(Aq) .fi @@ -10373,9 +10278,9 @@ Example: .RS 4 .\} .nf -print str(DEFAULT_TARGETS[0]) +print(str(DEFAULT_TARGETS[0])) if \*(Aqfoo\*(Aq in map(str, DEFAULT_TARGETS): - print "Don\*(Aqt forget to test the `foo\*(Aq program!" + print("Don\*(Aqt forget to test the `foo\*(Aq program!") .fi .if n \{\ .RE @@ -10391,13 +10296,13 @@ list change on on each successive call to the .RS 4 .\} .nf -print map(str, DEFAULT_TARGETS) # originally [] +print(map(str, DEFAULT_TARGETS)) # originally [] Default(\*(Aqfoo\*(Aq) -print map(str, DEFAULT_TARGETS) # now a node [\*(Aqfoo\*(Aq] +print(map(str, DEFAULT_TARGETS)) # now a node [\*(Aqfoo\*(Aq] Default(\*(Aqbar\*(Aq) -print map(str, DEFAULT_TARGETS) # now a node [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq] +print(map(str, DEFAULT_TARGETS)) # now a node [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq] Default(None) -print map(str, DEFAULT_TARGETS) # back to [] +print(map(str, DEFAULT_TARGETS)) # back to [] .fi .if n \{\ .RE @@ -10570,35 +10475,6 @@ BIBTEXFLAGS General options passed to the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter\&. .RE .PP -BITKEEPER -.RS 4 -The BitKeeper executable\&. -.RE -.PP -BITKEEPERCOM -.RS 4 -The command line for fetching source files using BitKeeper\&. -.RE -.PP -BITKEEPERCOMSTR -.RS 4 -The string displayed when fetching a source file using BitKeeper\&. If this is not set, then -\fB$BITKEEPERCOM\fR -(the command line) is displayed\&. -.RE -.PP -BITKEEPERGET -.RS 4 -The command (\fB$BITKEEPER\fR) and subcommand for fetching source files using BitKeeper\&. -.RE -.PP -BITKEEPERGETFLAGS -.RS 4 -Options that are passed to the BitKeeper -\fBget\fR -subcommand\&. -.RE -.PP BUILDERS .RS 4 A dictionary mapping the names of the builders available through this environment to underlying Builder objects\&. Builders named Alias, CFile, CXXFile, DVI, Library, Object, PDF, PostScript, and Program are available by default\&. If you initialize this variable when an Environment is created: @@ -11021,42 +10897,6 @@ The list of suffixes of files that will be scanned for C preprocessor implicit d .\} .RE .PP -CVS -.RS 4 -The CVS executable\&. -.RE -.PP -CVSCOFLAGS -.RS 4 -Options that are passed to the CVS checkout subcommand\&. -.RE -.PP -CVSCOM -.RS 4 -The command line used to fetch source files from a CVS repository\&. -.RE -.PP -CVSCOMSTR -.RS 4 -The string displayed when fetching a source file from a CVS repository\&. If this is not set, then -\fB$CVSCOM\fR -(the command line) is displayed\&. -.RE -.PP -CVSFLAGS -.RS 4 -General options that are passed to CVS\&. By default, this is set to -\-d $CVSREPOSITORY -to specify from where the files must be fetched\&. -.RE -.PP -CVSREPOSITORY -.RS 4 -The path to the CVS repository\&. This is referenced in the default -\fB$CVSFLAGS\fR -value\&. -.RE -.PP CXX .RS 4 The C++ compiler\&. @@ -11119,32 +10959,53 @@ The version number of the C++ compiler\&. This may or may not be set, depending .PP DC .RS 4 -DC\&. +The D compiler to use\&. +.sp +The D compiler to use\&. +.sp +The D compiler to use\&. .RE .PP DCOM .RS 4 -DCOM\&. +The command line used to compile a D file to an object file\&. Any options specified in the +\fB$DFLAGS\fR +construction variable is included on this command line\&. +.sp +The command line used to compile a D file to an object file\&. Any options specified in the +\fB$DFLAGS\fR +construction variable is included on this command line\&. +.sp +The command line used to compile a D file to an object file\&. Any options specified in the +\fB$DFLAGS\fR +construction variable is included on this command line\&. .RE .PP DDEBUG .RS 4 -DDEBUG\&. -.RE -.PP -_DDEBUGFLAGS -.RS 4 -_DDEBUGFLAGS\&. +List of debug tags to enable when compiling\&. +.sp +List of debug tags to enable when compiling\&. +.sp +List of debug tags to enable when compiling\&. .RE .PP DDEBUGPREFIX .RS 4 DDEBUGPREFIX\&. +.sp +DDEBUGPREFIX\&. +.sp +DDEBUGPREFIX\&. .RE .PP DDEBUGSUFFIX .RS 4 DDEBUGSUFFIX\&. +.sp +DDEBUGSUFFIX\&. +.sp +DDEBUGSUFFIX\&. .RE .PP DESCRIPTION @@ -11165,41 +11026,55 @@ file\&. DFILESUFFIX .RS 4 DFILESUFFIX\&. +.sp +DFILESUFFIX\&. +.sp +DFILESUFFIX\&. .RE .PP DFLAGPREFIX .RS 4 DFLAGPREFIX\&. +.sp +DFLAGPREFIX\&. +.sp +DFLAGPREFIX\&. .RE .PP DFLAGS .RS 4 -DFLAGS\&. -.RE -.PP -_DFLAGS -.RS 4 -_DFLAGS\&. +General options that are passed to the D compiler\&. +.sp +General options that are passed to the D compiler\&. +.sp +General options that are passed to the D compiler\&. .RE .PP DFLAGSUFFIX .RS 4 DFLAGSUFFIX\&. -.RE -.PP -_DINCFLAGS -.RS 4 -_DINCFLAGS\&. +.sp +DFLAGSUFFIX\&. +.sp +DFLAGSUFFIX\&. .RE .PP DINCPREFIX .RS 4 DINCPREFIX\&. +.sp +DINCPREFIX\&. +.sp +DINCPREFIX\&. .RE .PP DINCSUFFIX .RS 4 -DINCSUFFIX\&. +DLIBFLAGSUFFIX\&. +.sp +DLIBFLAGSUFFIX\&. +.sp +DLIBFLAGSUFFIX\&. .RE .PP Dir @@ -11216,77 +11091,119 @@ A function that converts a list of strings into a list of Dir instances relative .PP DLIB .RS 4 -DLIB\&. +Name of the lib tool to use for D codes\&. +.sp +Name of the lib tool to use for D codes\&. +.sp +Name of the lib tool to use for D codes\&. .RE .PP DLIBCOM .RS 4 -DLIBCOM\&. -.RE -.PP -_DLIBDIRFLAGS -.RS 4 -_DLIBDIRFLAGS\&. +The command line to use when creating libraries\&. +.sp +The command line to use when creating libraries\&. +.sp +The command line to use when creating libraries\&. .RE .PP DLIBDIRPREFIX .RS 4 -DLIBDIRPREFIX\&. +DLIBLINKPREFIX\&. +.sp +DLIBLINKPREFIX\&. +.sp +DLIBLINKPREFIX\&. .RE .PP DLIBDIRSUFFIX .RS 4 -DLIBDIRSUFFIX\&. +DLIBLINKSUFFIX\&. +.sp +DLIBLINKSUFFIX\&. +.sp +DLIBLINKSUFFIX\&. .RE .PP DLIBFLAGPREFIX .RS 4 DLIBFLAGPREFIX\&. -.RE -.PP -_DLIBFLAGS -.RS 4 -_DLIBFLAGS\&. +.sp +DLIBFLAGPREFIX\&. +.sp +DLIBFLAGPREFIX\&. .RE .PP DLIBFLAGSUFFIX .RS 4 DLIBFLAGSUFFIX\&. +.sp +DLIBFLAGSUFFIX\&. +.sp +DLIBFLAGSUFFIX\&. .RE .PP DLIBLINKPREFIX .RS 4 DLIBLINKPREFIX\&. +.sp +DLIBLINKPREFIX\&. +.sp +DLIBLINKPREFIX\&. .RE .PP DLIBLINKSUFFIX .RS 4 DLIBLINKSUFFIX\&. +.sp +DLIBLINKSUFFIX\&. +.sp +DLIBLINKSUFFIX\&. .RE .PP DLINK .RS 4 -DLINK\&. +Name of the linker to use for linking systems including D sources\&. +.sp +Name of the linker to use for linking systems including D sources\&. +.sp +Name of the linker to use for linking systems including D sources\&. .RE .PP DLINKCOM .RS 4 -DLINKCOM\&. +The command line to use when linking systems including D sources\&. +.sp +The command line to use when linking systems including D sources\&. +.sp +The command line to use when linking systems including D sources\&. .RE .PP DLINKFLAGPREFIX .RS 4 DLINKFLAGPREFIX\&. +.sp +DLINKFLAGPREFIX\&. +.sp +DLINKFLAGPREFIX\&. .RE .PP DLINKFLAGS .RS 4 -DLINKFLAGS\&. +List of linker flags\&. +.sp +List of linker flags\&. +.sp +List of linker flags\&. .RE .PP DLINKFLAGSUFFIX .RS 4 DLINKFLAGSUFFIX\&. +.sp +DLINKFLAGSUFFIX\&. +.sp +DLINKFLAGSUFFIX\&. .RE .PP DOCBOOK_DEFAULT_XSL_EPUB @@ -11448,7 +11365,26 @@ saxon\-xslt, respectively\&. .PP DPATH .RS 4 -DPATH\&. +List of paths to search for import modules\&. +.sp +List of paths to search for import modules\&. +.sp +List of paths to search for import modules\&. +.RE +.PP +DRPATHPREFIX +.RS 4 +DRPATHPREFIX\&. +.RE +.PP +DRPATHSUFFIX +.RS 4 +DRPATHSUFFIX\&. +.RE +.PP +DShLibSonameGenerator +.RS 4 +DShLibSonameGenerator\&. .RE .PP DSUFFIXES @@ -11466,24 +11402,31 @@ The list of suffixes of files that will be scanned for imported D package files\ .\} .RE .PP -_DVERFLAGS -.RS 4 -_DVERFLAGS\&. -.RE -.PP DVERPREFIX .RS 4 DVERPREFIX\&. +.sp +DVERPREFIX\&. +.sp +DVERPREFIX\&. .RE .PP DVERSIONS .RS 4 -DVERSIONS\&. +List of version tags to enable when compiling\&. +.sp +List of version tags to enable when compiling\&. +.sp +List of version tags to enable when compiling\&. .RE .PP DVERSUFFIX .RS 4 DVERSUFFIX\&. +.sp +DVERSUFFIX\&. +.sp +DVERSUFFIX\&. .RE .PP DVIPDF @@ -13759,6 +13702,17 @@ and \fB$TARGET_ARCH\fR\&. If set to the name of a Visual Studio \&.bat file (e\&.g\&. vcvars\&.bat), SCons will run that bat file and extract the relevant variables from the result (typically %INCLUDE%, %LIB%, and %PATH%)\&. Setting MSVC_USE_SCRIPT to None bypasses the Visual Studio autodetection entirely; use this if you are running SCons in a Visual Studio cmd window and importing the shell\*(Aqs environment variables\&. .RE .PP +MSVC_UWP_APP +.RS 4 +Build libraries for a Universal Windows Platform (UWP) Application\&. +.sp +If +\fB$MSVC_UWP_APP\fR +is set, the Visual Studio environment will be set up to point to the Windows Store compatible libraries and Visual Studio runtimes\&. In doing so, any libraries that are built will be able to be used in a UWP App and published to the Windows Store\&. This flag will only have an effect with Visual Studio 2015+\&. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect\&. +.sp +Valid values are \*(Aq1\*(Aq or \*(Aq0\*(Aq +.RE +.PP MSVC_VERSION .RS 4 Sets the preferred version of Microsoft Visual C/C++ to use\&. @@ -13768,6 +13722,8 @@ If is not set, SCons will (by default) select the latest version of Visual C/C++ installed on your system\&. If the specified version isn\*(Aqt installed, tool initialization will fail\&. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect\&. .sp Valid values for Windows are +14\&.0, +14\&.0Exp, 12\&.0, 12\&.0Exp, 11\&.0, @@ -14072,28 +14028,6 @@ OBJSUFFIX The suffix used for (static) object file names\&. .RE .PP -P4 -.RS 4 -The Perforce executable\&. -.RE -.PP -P4COM -.RS 4 -The command line used to fetch source files from Perforce\&. -.RE -.PP -P4COMSTR -.RS 4 -The string displayed when fetching a source file from Perforce\&. If this is not set, then -\fB$P4COM\fR -(the command line) is displayed\&. -.RE -.PP -P4FLAGS -.RS 4 -General options that are passed to Perforce\&. -.RE -.PP PACKAGEROOT .RS 4 Specifies the directory where all files in resulting archive will be placed if applicable\&. The default value is "$NAME\-$VERSION"\&. @@ -14787,37 +14721,6 @@ construction variable when the variable is expanded\&. .RE .PP -RCS -.RS 4 -The RCS executable\&. Note that this variable is not actually used for the command to fetch source files from RCS; see the -\fB$RCS_CO\fR -construction variable, below\&. -.RE -.PP -RCS_CO -.RS 4 -The RCS "checkout" executable, used to fetch source files from RCS\&. -.RE -.PP -RCS_COCOM -.RS 4 -The command line used to fetch (checkout) source files from RCS\&. -.RE -.PP -RCS_COCOMSTR -.RS 4 -The string displayed when fetching a source file from RCS\&. If this is not set, then -\fB$RCS_COCOM\fR -(the command line) is displayed\&. -.RE -.PP -RCS_COFLAGS -.RS 4 -Options that are passed to the -\fB$RCS_CO\fR -command\&. -.RE -.PP RDirs .RS 4 A function that converts a string into a list of Dir instances by searching the repositories\&. @@ -14967,35 +14870,6 @@ SCANNERS A list of the available implicit dependency scanners\&. New file scanners may be added by appending to this list, although the more flexible approach is to associate scanners with a specific Builder\&. See the sections "Builder Objects" and "Scanner Objects," below, for more information\&. .RE .PP -SCCS -.RS 4 -The SCCS executable\&. -.RE -.PP -SCCSCOM -.RS 4 -The command line used to fetch source files from SCCS\&. -.RE -.PP -SCCSCOMSTR -.RS 4 -The string displayed when fetching a source file from a CVS repository\&. If this is not set, then -\fB$SCCSCOM\fR -(the command line) is displayed\&. -.RE -.PP -SCCSFLAGS -.RS 4 -General options that are passed to SCCS\&. -.RE -.PP -SCCSGETFLAGS -.RS 4 -Options that are passed specifically to the SCCS "get" subcommand\&. This can be set, for example, to -\fB\-e\fR -to check out editable files from SCCS\&. -.RE -.PP SCONS_HOME .RS 4 The (optional) path to the SCons library directory, initialized from the external environment\&. If set, this is used to construct a shorter and more efficient search path in the @@ -15083,27 +14957,57 @@ Options that are passed to the C++ compiler to generate shared\-library objects\ .PP SHDC .RS 4 -SHDC\&. +The name of the compiler to use when compiling D source destined to be in a shared objects\&. +.sp +The name of the compiler to use when compiling D source destined to be in a shared objects\&. +.sp +The name of the compiler to use when compiling D source destined to be in a shared objects\&. .RE .PP SHDCOM .RS 4 -SHDCOM\&. +The command line to use when compiling code to be part of shared objects\&. +.sp +The command line to use when compiling code to be part of shared objects\&. +.sp +The command line to use when compiling code to be part of shared objects\&. +.RE +.PP +SHDLIBVERSION +.RS 4 +SHDLIBVERSION\&. +.RE +.PP +SHDLIBVERSIONFLAGS +.RS 4 +SHDLIBVERSIONFLAGS\&. .RE .PP SHDLINK .RS 4 -SHDLINK\&. +The linker to use when creating shared objects for code bases include D sources\&. +.sp +The linker to use when creating shared objects for code bases include D sources\&. +.sp +The linker to use when creating shared objects for code bases include D sources\&. .RE .PP SHDLINKCOM .RS 4 -SHDLINKCOM\&. +The command line to use when generating shared objects\&. +.sp +The command line to use when generating shared objects\&. +.sp +The command line to use when generating shared objects\&. .RE .PP SHDLINKFLAGS .RS 4 -SHDLINKFLAGS\&. +The list of flags to use when generating a shared object\&. +.sp +The list of flags to use when generating a shared object\&. +.sp +The list of flags to use when generating a shared object\&. .RE .PP SHELL @@ -15488,6 +15392,16 @@ versions should exist as alpha\-numeric, decimal\-delimited values as defined by values include \*(Aq1\*(Aq, \*(Aq1\&.2\&.3\*(Aq, and \*(Aq1\&.2\&.gitaa412c8b\*(Aq\&. .RE .PP +SHLIBVERSIONFLAGS +.RS 4 +Extra flags added to +\fB$SHLINKCOM\fR +when building versioned +\fBSharedLibrary\fR\&. These flags are only used when +\fB$SHLIBVERSION\fR +is set\&. +.RE +.PP _SHLIBVERSIONFLAGS .RS 4 This macro automatically introduces extra flags to @@ -15504,16 +15418,6 @@ and some extra dynamically generated options (such as \-Wl,\-soname=$_SHLIBSONAME\&. It is unused by "plain" (unversioned) shared libraries\&. .RE .PP -SHLIBVERSIONFLAGS -.RS 4 -Extra flags added to -\fB$SHLINKCOM\fR -when building versioned -\fBSharedLibrary\fR\&. These flags are only used when -\fB$SHLIBVERSION\fR -is set\&. -.RE -.PP SHLINK .RS 4 The linker for programs that use shared libraries\&. @@ -16959,7 +16863,7 @@ Example of a typical Configure usage: env = Environment() conf = Configure( env ) if not conf\&.CheckCHeader( \*(Aqmath\&.h\*(Aq ): - print \*(AqWe really need math\&.h!\*(Aq + print(\*(AqWe really need math\&.h!\*(Aq) Exit(1) if conf\&.CheckLibWithHeader( \*(Aqqt\*(Aq, \*(Aqqapp\&.h\*(Aq, \*(Aqc++\*(Aq, \*(AqQApplication qapp(0,0);\*(Aq ): @@ -17204,7 +17108,7 @@ int main(int argc, char **argv) { env = Environment() conf = Configure( env, custom_tests = { \*(AqCheckQt\*(Aq : CheckQt } ) if not conf\&.CheckQt(\*(Aq/usr/lib/qt\*(Aq): - print \*(AqWe really need qt!\*(Aq + print(\*(AqWe really need qt!\*(Aq) Exit(1) env = conf\&.Finish() .fi @@ -17368,7 +17272,7 @@ Returns a dictionary containing any variables that were specified either in the .nf env = Environment(variables=vars) for key, value in vars\&.UnknownVariables(): - print "unknown variable: %s=%s" % (key, value) + print("unknown variable: %s=%s" % (key, value)) .fi .if n \{\ .RE @@ -17638,7 +17542,7 @@ File(\*(Aqfoo\&.c\*(Aq)\&.srcnode()\&.path # source path of the given source f # Builders also return File objects: foo = env\&.Program(\*(Aqfoo\&.c\*(Aq) -print "foo will be built in %s"%foo\&.path +print("foo will be built in %s"%foo\&.path) .fi .if n \{\ .RE |