This construction variable automatically introduces $_LDMODULEVERSIONFLAGS if $LDMODULEVERSION is set. Othervise it evaluates to an empty string.

Internal flag. Used to tell SCons whether or not to try to import pypi's ninja python package. This is set to True when being called by Ninja?

This construction variable automatically introduces $_SHLIBVERSIONFLAGS if $SHLIBVERSION is set. Othervise it evaluates to an empty string.

On Mac OS X this is used to set the linker flag: -compatibility_version

The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and 255, Z can be omitted or between 1 and 255. This value will be derived from $SHLIBVERSION if not specified. The lowest digit will be dropped and replaced by a 0.

If the $APPLELINK_NO_COMPATIBILITY_VERSION is set then no -compatibility_version will be output.

See MacOS's ld manpage for more details

A macro (by default a generator function) used to create the linker flags to specify apple's linker's -compatibility_version flag. The default generator uses $APPLELINK_COMPATIBILITY_VERSION and $APPLELINK_NO_COMPATIBILITY_VERSION and $SHLIBVERSION to determine the correct flag.

On Mac OS X this is used to set the linker flag: -current_version

The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and 255, Z can be omitted or between 1 and 255. This value will be set to $SHLIBVERSION if not specified.

If the $APPLELINK_NO_CURRENT_VERSION is set then no -current_version will be output.

See MacOS's ld manpage for more details

A macro (by default a generator function) used to create the linker flags to specify apple's linker's -current_version flag. The default generator uses $APPLELINK_CURRENT_VERSION and $APPLELINK_NO_CURRENT_VERSION and $SHLIBVERSION to determine the correct flag.

Set this to any True (1|True|non-empty string) value to disable adding -compatibility_version flag when generating versioned shared libraries.

This overrides $APPLELINK_COMPATIBILITY_VERSION.

Set this to any True (1|True|non-empty string) value to disable adding -current_version flag when generating versioned shared libraries.

This overrides $APPLELINK_CURRENT_VERSION.

The static library archiver.

Specifies the system architecture for which the package is being built. The default is the system architecture of the machine on which SCons is running. This is used to fill in the Architecture: field in an Ipkg control file, and the BuildArch: field in the RPM .spec file, as well as forming part of the name of a generated RPM package file.

See the Package builder.

The command line used to generate a static library from object files.

The string displayed when a static library is generated from object files. If this is not set, then $ARCOM (the command line) is displayed.

env = Environment(ARCOMSTR = "Archiving $TARGET")

General options passed to the static library archiver.

The assembler.

The command line used to generate an object file from an assembly-language source file.

The string displayed when an object file is generated from an assembly-language source file. If this is not set, then $ASCOM (the command line) is displayed.

env = Environment(ASCOMSTR = "Assembling $TARGET")

General options passed to the assembler.

The command line used to assemble an assembly-language source file into an object file after first running the file through the C preprocessor. Any options specified in the $ASFLAGS and $CPPFLAGS construction variables are included on this command line.

The string displayed when an object file is generated from an assembly-language source file after first running the file through the C preprocessor. If this is not set, then $ASPPCOM (the command line) is displayed.

env = Environment(ASPPCOMSTR = "Assembling $TARGET")

General options when an assembling an assembly-language source file into an object file after first running the file through the C preprocessor. The default is to use the value of $ASFLAGS.

The bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

The command line used to call the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

The string displayed when generating a bibliography for TeX or LaTeX. If this is not set, then $BIBTEXCOM (the command line) is displayed.

env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET")

General options passed to the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

A dictionary mapping the names of the builders available through the construction environment to underlying Builder objects. Custom builders need to be added to this to make them available.

A platform-dependent default list of builders such as Program, Library etc. is used to populate this construction variable when the construction environment is initialized via the presence/absence of the tools those builders depend on. $BUILDERS can be examined to learn which builders will actually be available at run-time.

Note that if you initialize this construction variable through assignment when the construction environment is created, that value for $BUILDERS will override any defaults:

bld = Builder(action='foobuild < $SOURCE > $TARGET')
env = Environment(BUILDERS={'NewBuilder': bld})

To instead use a new Builder object in addition to the default Builders, add your new Builder object like this:

env = Environment()
env.Append(BUILDERS={'NewBuilder': bld})

or this:

env = Environment()
env['BUILDERS']['NewBuilder'] = bld

The class type that SCons should use when instantiating a new CacheDir for the given environment. It must be a subclass of the SCons.CacheDir.CacheDir class.

The C compiler.

The command line used to compile a C source file to a (static) object file. Any options specified in the $CFLAGS, $CCFLAGS and $CPPFLAGS construction variables are included on this command line. See also $SHCCCOM for compiling to shared objects.

If set, the string displayed when a C source file is compiled to a (static) object file. If not set, then $CCCOM (the command line) is displayed. See also $SHCCCOMSTR for compiling to shared objects.

env = Environment(CCCOMSTR = "Compiling static object $TARGET")

General options that are passed to the C and C++ compilers. See also $SHCCFLAGS for compiling to shared objects.

Options added to the compiler command line to support building with precompiled headers. The default value expands expands to the appropriate Microsoft Visual C++ command-line options when the $PCH construction variable is set.

Options added to the compiler command line to support storing debugging information in a Microsoft Visual C++ PDB file. The default value expands expands to appropriate Microsoft Visual C++ command-line options when the $PDB construction variable is set.

The Visual C++ compiler option that SCons uses by default to generate PDB information is /Z7. This works correctly with parallel (-j) builds because it embeds the debug information in the intermediate object files, as opposed to sharing a single PDB file between multiple object files. This is also the only way to get debug information embedded into a static library. Using the /Zi instead may yield improved link-time performance, although parallel builds will no longer work.

You can generate PDB files with the /Zi switch by overriding the default $CCPDBFLAGS variable as follows:

env['CCPDBFLAGS'] = ['${(PDB and "/Zi /Fd%s" % File(PDB)) or ""}']

An alternative would be to use the /Zi to put the debugging information in a separate .pdb file for each object file by overriding the $CCPDBFLAGS variable as follows:

env['CCPDBFLAGS'] = '/Zi /Fd${TARGET}.pdb'

The version number of the C compiler. This may or may not be set, depending on the specific C compiler being used.

The suffix for C source files. This is used by the internal CFile builder when generating C files from Lex (.l) or YACC (.y) input files. The default suffix, of course, is .c (lower case). On case-insensitive systems (like Windows), SCons also treats .C (upper case) files as C files.

General options that are passed to the C compiler (C only; not C++). See also $SHCFLAGS for compiling to shared objects.

A hook for modifying the file that controls the packaging build (the .spec for RPM, the control for Ipkg, the .wxs for MSI). If set, the function will be called after the SCons template for the file has been written.

See the Package builder.

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

The name of a file containing the change log text to be included in the package. This is included as the %changelog section of the RPM .spec file.

See the Package builder.

The string displayed when the CompilationDatabase builder's action is run.

A string which instructs CompilationDatabase to only include entries where the output member matches the pattern in the filter string using fnmatch, which uses glob style wildcards.

The default value is an empty string '', which disables filtering.

A boolean flag to instruct CompilationDatabase whether to write the file and output members in the compilation database using absolute or relative paths.

The default value is False (use relative paths)

A function used to produce variables like $_CPPINCFLAGS. It takes four mandatory arguments, and up to 4 additional optional arguments: 1) a prefix to concatenate onto each element, 2) a list of elements, 3) a suffix to concatenate onto each element, 4) an environment for variable interpolation, 5) an optional function that will be called to transform the list before concatenation, 6) an optionally specified target (Can use TARGET), 7) an optionally specified source (Can use SOURCE), 8) optional affect_signature flag which will wrap non-empty returned value with $( and $) to indicate the contents should not affect the signature of the generated command line.

        env['_CPPINCFLAGS'] = '${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE, affect_signature=False)}'
    

The name of the directory in which Configure context test files are written. The default is .sconf_temp in the top-level directory containing the SConstruct file.

The name of the Configure context log file. The default is config.log in the top-level directory containing the SConstruct file.

An automatically-generated construction variable containing the C preprocessor command-line options to define values. The value of $_CPPDEFFLAGS is created by respectively prepending and appending $CPPDEFPREFIX and $CPPDEFSUFFIX to each definition in $CPPDEFINES.

A platform independent specification of C preprocessor macro definitions. The definitions will be added to command lines through the automatically-generated $_CPPDEFFLAGS construction variable (see above), which is constructed according to the type of value of $CPPDEFINES:

If $CPPDEFINES is a string, the values of the $CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to each definition in $CPPDEFINES.

# Will add -Dxyz to POSIX compiler command lines,
# and /Dxyz to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES='xyz')

If $CPPDEFINES is a list, the values of the $CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to each element in the list. If any element is a list or tuple, then the first item is the name being defined and the second item is its value:

# Will add -DB=2 -DA to POSIX compiler command lines,
# and /DB=2 /DA to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES=[('B', 2), 'A'])

If $CPPDEFINES is a dictionary, the values of the $CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to each item from the dictionary. The key of each dictionary item is a name being defined to the dictionary item's corresponding value; if the value is None, then the name is defined without an explicit value. Note that the resulting flags are sorted by keyword to ensure that the order of the options on the command line is consistent each time scons is run.

# Will add -DA -DB=2 to POSIX compiler command lines,
# and /DA /DB=2 to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES={'B':2, 'A':None})

The prefix used to specify preprocessor macro definitions on the C compiler command line. This will be prepended to each definition in the $CPPDEFINES construction variable when the $_CPPDEFFLAGS variable is automatically generated.

The suffix used to specify preprocessor macro definitions on the C compiler command line. This will be appended to each definition in the $CPPDEFINES construction variable when the $_CPPDEFFLAGS variable is automatically generated.

User-specified C preprocessor options. These will be included in any command that uses the C preprocessor, including not just compilation of C and C++ source files via the $CCCOM, $SHCCCOM, $CXXCOM and $SHCXXCOM command lines, but also the $FORTRANPPCOM, $SHFORTRANPPCOM, $F77PPCOM and $SHF77PPCOM command lines used to compile a Fortran source file, and the $ASPPCOM command line used to assemble an assembly language source file, after first running each file through the C preprocessor. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $CPPPATH. See $_CPPINCFLAGS, below, for the variable that expands to those options.

An automatically-generated construction variable containing the C preprocessor command-line options for specifying directories to be searched for include files. The value of $_CPPINCFLAGS is created by respectively prepending and appending $INCPREFIX and $INCSUFFIX to each directory in $CPPPATH.

The list of directories that the C preprocessor will search for include directories. The C/C++ implicit dependency scanner will search these directories for include files. In general it's not advised to put include directory directives directly into $CCFLAGS or $CXXFLAGS as the result will be non-portable and the directories will not be searched by the dependency scanner. $CPPPATH should be a list of path strings, or a single string, not a pathname list joined by Python's os.sep.

Note: directory names in $CPPPATH will be looked-up relative to the directory of the SConscript file when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use the # prefix:

env = Environment(CPPPATH='#/include')

The directory look-up can also be forced using the Dir function:

include = Dir('include')
env = Environment(CPPPATH=include)

The directory list will be added to command lines through the automatically-generated $_CPPINCFLAGS construction variable, which is constructed by respectively prepending and appending the values of the $INCPREFIX and $INCSUFFIX construction variables to each directory in $CPPPATH. Any command lines you define that need the $CPPPATH directory list should include $_CPPINCFLAGS:

env = Environment(CCCOM="my_compiler $_CPPINCFLAGS -c -o $TARGET $SOURCE")

The list of suffixes of files that will be scanned for C preprocessor implicit dependencies (#include lines). The default list is:

[".c", ".C", ".cxx", ".cpp", ".c++", ".cc",
 ".h", ".H", ".hxx", ".hpp", ".hh",
 ".F", ".fpp", ".FPP",
 ".m", ".mm",
 ".S", ".spp", ".SPP"]

The C++ compiler. See also $SHCXX for compiling to shared objects..

The command line used to compile a C++ source file to an object file. Any options specified in the $CXXFLAGS and $CPPFLAGS construction variables are included on this command line. See also $SHCXXCOM for compiling to shared objects..

If set, the string displayed when a C++ source file is compiled to a (static) object file. If not set, then $CXXCOM (the command line) is displayed. See also $SHCXXCOMSTR for compiling to shared objects..

env = Environment(CXXCOMSTR = "Compiling static object $TARGET")

The suffix for C++ source files. This is used by the internal CXXFile builder when generating C++ files from Lex (.ll) or YACC (.yy) input files. The default suffix is .cc. SCons also treats files with the suffixes .cpp, .cxx, .c++, and .C++ as C++ files, and files with .mm suffixes as Objective C++ files. On case-sensitive systems (Linux, UNIX, and other POSIX-alikes), SCons also treats .C (upper case) files as C++ files.

General options that are passed to the C++ compiler. By default, this includes the value of $CCFLAGS, so that setting $CCFLAGS affects both C and C++ compilation. If you want to add C++-specific flags, you must set or override the value of $CXXFLAGS. See also $SHCXXFLAGS for compiling to shared objects..

The version number of the C++ compiler. This may or may not be set, depending on the specific C++ compiler being used.

The D compiler to use. See also $SHDC for compiling to shared objects.

The command line used to compile a D file to an object file. Any options specified in the $DFLAGS construction variable is included on this command line. See also $SHDCOM for compiling to shared objects.

If set, the string displayed when a D source file is compiled to a (static) object file. If not set, then $DCOM (the command line) is displayed. See also $SHDCOMSTR for compiling to shared objects.

List of debug tags to enable when compiling.

DDEBUGPREFIX.

DDEBUGSUFFIX.

A long description of the project being packaged. This is included in the relevant section of the file that controls the packaging build.

See the Package builder.

A language-specific long description for the specified lang. This is used to populate a %description -l section of an RPM .spec file.

See the Package builder.

DFILESUFFIX.

DFLAGPREFIX.

General options that are passed to the D compiler.

DFLAGSUFFIX.

DINCPREFIX.

DLIBFLAGSUFFIX.

A function that converts a string into a Dir instance relative to the target being built.

A function that converts a list of strings into a list of Dir instances relative to the target being built.

Name of the lib tool to use for D codes.

The command line to use when creating libraries.

DLIBLINKPREFIX.

DLIBLINKSUFFIX.

DLIBFLAGPREFIX.

DLIBFLAGSUFFIX.

DLIBLINKPREFIX.

DLIBLINKSUFFIX.

Name of the linker to use for linking systems including D sources. See also $SHDLINK for linking shared objects.

The command line to use when linking systems including D sources. See also $SHDLINKCOM for linking shared objects.

DLINKFLAGPREFIX.

List of linker flags. See also $SHDLINKFLAGS for linking shared objects.

DLINKFLAGSUFFIX.

The default XSLT file for the DocbookEpub builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookHtml builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookHtmlChunked builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookHtmlhelp builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookMan builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookPdf builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookSlidesHtml builder within the current environment, if no other XSLT gets specified via keyword.

The default XSLT file for the DocbookSlidesPdf builder within the current environment, if no other XSLT gets specified via keyword.

The path to the PDF renderer fop or xep, if one of them is installed (fop gets checked first).

The full command-line for the PDF renderer fop or xep.

The string displayed when a renderer like fop or xep is used to create PDF output from an XML file.

Additonal command-line flags for the PDF renderer fop or xep.

The path to the external executable xmllint, if it's installed. Note, that this is only used as last fallback for resolving XIncludes, if no lxml Python binding can be imported in the current system.

The full command-line for the external executable xmllint.

The string displayed when xmllint is used to resolve XIncludes for a given XML file.

Additonal command-line flags for the external executable xmllint.

The path to the external executable xsltproc (or saxon, xalan), if one of them is installed. Note, that this is only used as last fallback for XSL transformations, if no lxml Python binding can be imported in the current system.

The full command-line for the external executable xsltproc (or saxon, xalan).

The string displayed when xsltproc is used to transform an XML file via a given XSLT stylesheet.

Additonal command-line flags for the external executable xsltproc (or saxon, xalan).

Additonal parameters that are not intended for the XSLT processor executable, but the XSL processing itself. By default, they get appended at the end of the command line for saxon and saxon-xslt, respectively.

List of paths to search for import modules.

DRPATHPREFIX.

DRPATHSUFFIX.

The list of suffixes of files that will be scanned for imported D package files. The default list is ['.d'].

DVERPREFIX.

List of version tags to enable when compiling.

DVERSUFFIX.

The TeX DVI file to PDF file converter.

The command line used to convert TeX DVI files into a PDF file.

The string displayed when a TeX DVI file is converted into a PDF file. If this is not set, then $DVIPDFCOM (the command line) is displayed.

General options passed to the TeX DVI file to PDF file converter.

The TeX DVI file to PostScript converter.

General options passed to the TeX DVI file to PostScript converter.

A dictionary of environment variables to use when invoking commands. When $ENV is used in a command all list values will be joined using the path separator and any other non-string values will simply be coerced to a string. Note that, by default, scons does not propagate the environment in effect when you execute scons to the commands used to build target files. This is so that builds will be guaranteed repeatable regardless of the environment variables set at the time scons is invoked.

If you want to propagate your environment variables to the commands executed to build target files, you must do so explicitly:

import os
env = Environment(ENV=os.environ.copy())

Note that you can choose only to propagate certain environment variables. A common example is the system PATH environment variable, so that scons uses the same utilities as the invoking shell (or other process):

import os
env = Environment(ENV={'PATH': os.environ['PATH']})

A function that will be called to escape shell special characters in command lines. The function should take one argument: the command line string to escape; and should return the escaped command line.

The Fortran 03 compiler. You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $F03 if you need to use a specific compiler or compiler version for Fortran 03 files.

The command line used to compile a Fortran 03 source file to an object file. You only need to set $F03COM if you need to use a specific command line for Fortran 03 files. You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 03 source file is compiled to an object file. If not set, then $F03COM or $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the F03 dialect will be used. By default, this is ['.f03']

General user-specified options that are passed to the Fortran 03 compiler. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $F03PATH. See $_F03INCFLAGS below, for the variable that expands to those options. You only need to set $F03FLAGS if you need to define specific user options for Fortran 03 files. You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

An automatically-generated construction variable containing the Fortran 03 compiler command-line options for specifying directories to be searched for include files. The value of $_F03INCFLAGS is created by appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $F03PATH.

The list of directories that the Fortran 03 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory arguments in $F03FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in $F03PATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #: You only need to set $F03PATH if you need to define a specific include path for Fortran 03 files. You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions.

env = Environment(F03PATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(F03PATH=include)

The directory list will be added to command lines through the automatically-generated $_F03INCFLAGS construction variable, which is constructed by appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $F03PATH. Any command lines you define that need the F03PATH directory list should include $_F03INCFLAGS:

env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran 03 source file to an object file after first running the file through the C preprocessor. Any options specified in the $F03FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $F03PPCOM if you need to use a specific C-preprocessor command line for Fortran 03 files. You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 03 source file is compiled to an object file after first running the file through the C preprocessor. If not set, then $F03PPCOM or $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for F03 dialect will be used. By default, this is empty.

The Fortran 08 compiler. You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $F08 if you need to use a specific compiler or compiler version for Fortran 08 files.

The command line used to compile a Fortran 08 source file to an object file. You only need to set $F08COM if you need to use a specific command line for Fortran 08 files. You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 08 source file is compiled to an object file. If not set, then $F08COM or $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the F08 dialect will be used. By default, this is ['.f08']

General user-specified options that are passed to the Fortran 08 compiler. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $F08PATH. See $_F08INCFLAGS below, for the variable that expands to those options. You only need to set $F08FLAGS if you need to define specific user options for Fortran 08 files. You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

An automatically-generated construction variable containing the Fortran 08 compiler command-line options for specifying directories to be searched for include files. The value of $_F08INCFLAGS is created by appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $F08PATH.

The list of directories that the Fortran 08 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory arguments in $F08FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in $F08PATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #: You only need to set $F08PATH if you need to define a specific include path for Fortran 08 files. You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions.

env = Environment(F08PATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(F08PATH=include)

The directory list will be added to command lines through the automatically-generated $_F08INCFLAGS construction variable, which is constructed by appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $F08PATH. Any command lines you define that need the F08PATH directory list should include $_F08INCFLAGS:

env = Environment(F08COM="my_compiler $_F08INCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran 08 source file to an object file after first running the file through the C preprocessor. Any options specified in the $F08FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $F08PPCOM if you need to use a specific C-preprocessor command line for Fortran 08 files. You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 08 source file is compiled to an object file after first running the file through the C preprocessor. If not set, then $F08PPCOM or $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for F08 dialect will be used. By default, this is empty.

The Fortran 77 compiler. You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $F77 if you need to use a specific compiler or compiler version for Fortran 77 files.

The command line used to compile a Fortran 77 source file to an object file. You only need to set $F77COM if you need to use a specific command line for Fortran 77 files. You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 77 source file is compiled to an object file. If not set, then $F77COM or $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the F77 dialect will be used. By default, this is ['.f77']

General user-specified options that are passed to the Fortran 77 compiler. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $F77PATH. See $_F77INCFLAGS below, for the variable that expands to those options. You only need to set $F77FLAGS if you need to define specific user options for Fortran 77 files. You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

An automatically-generated construction variable containing the Fortran 77 compiler command-line options for specifying directories to be searched for include files. The value of $_F77INCFLAGS is created by appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $F77PATH.

The list of directories that the Fortran 77 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory arguments in $F77FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in $F77PATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #: You only need to set $F77PATH if you need to define a specific include path for Fortran 77 files. You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions.

env = Environment(F77PATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(F77PATH=include)

The directory list will be added to command lines through the automatically-generated $_F77INCFLAGS construction variable, which is constructed by appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $F77PATH. Any command lines you define that need the F77PATH directory list should include $_F77INCFLAGS:

env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran 77 source file to an object file after first running the file through the C preprocessor. Any options specified in the $F77FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $F77PPCOM if you need to use a specific C-preprocessor command line for Fortran 77 files. You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 77 source file is compiled to an object file after first running the file through the C preprocessor. If not set, then $F77PPCOM or $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for F77 dialect will be used. By default, this is empty.

The Fortran 90 compiler. You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $F90 if you need to use a specific compiler or compiler version for Fortran 90 files.

The command line used to compile a Fortran 90 source file to an object file. You only need to set $F90COM if you need to use a specific command line for Fortran 90 files. You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 90 source file is compiled to an object file. If not set, then $F90COM or $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the F90 dialect will be used. By default, this is ['.f90']

General user-specified options that are passed to the Fortran 90 compiler. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $F90PATH. See $_F90INCFLAGS below, for the variable that expands to those options. You only need to set $F90FLAGS if you need to define specific user options for Fortran 90 files. You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

An automatically-generated construction variable containing the Fortran 90 compiler command-line options for specifying directories to be searched for include files. The value of $_F90INCFLAGS is created by appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $F90PATH.

The list of directories that the Fortran 90 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory arguments in $F90FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in $F90PATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #: You only need to set $F90PATH if you need to define a specific include path for Fortran 90 files. You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions.

env = Environment(F90PATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(F90PATH=include)

The directory list will be added to command lines through the automatically-generated $_F90INCFLAGS construction variable, which is constructed by appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $F90PATH. Any command lines you define that need the F90PATH directory list should include $_F90INCFLAGS:

env = Environment(F90COM="my_compiler $_F90INCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran 90 source file to an object file after first running the file through the C preprocessor. Any options specified in the $F90FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $F90PPCOM if you need to use a specific C-preprocessor command line for Fortran 90 files. You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 90 source file is compiled after first running the file through the C preprocessor. If not set, then $F90PPCOM or $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for F90 dialect will be used. By default, this is empty.

The Fortran 95 compiler. You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $F95 if you need to use a specific compiler or compiler version for Fortran 95 files.

The command line used to compile a Fortran 95 source file to an object file. You only need to set $F95COM if you need to use a specific command line for Fortran 95 files. You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 95 source file is compiled to an object file. If not set, then $F95COM or $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the F95 dialect will be used. By default, this is ['.f95']

General user-specified options that are passed to the Fortran 95 compiler. Note that this variable does not contain -I (or similar) include search path options that scons generates automatically from $F95PATH. See $_F95INCFLAGS below, for the variable that expands to those options. You only need to set $F95FLAGS if you need to define specific user options for Fortran 95 files. You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

An automatically-generated construction variable containing the Fortran 95 compiler command-line options for specifying directories to be searched for include files. The value of $_F95INCFLAGS is created by appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $F95PATH.

The list of directories that the Fortran 95 compiler will search for include directories. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory arguments in $F95FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in $F95PATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #: You only need to set $F95PATH if you need to define a specific include path for Fortran 95 files. You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions.

env = Environment(F95PATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(F95PATH=include)

The directory list will be added to command lines through the automatically-generated $_F95INCFLAGS construction variable, which is constructed by appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $F95PATH. Any command lines you define that need the F95PATH directory list should include $_F95INCFLAGS:

env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran 95 source file to an object file after first running the file through the C preprocessor. Any options specified in the $F95FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $F95PPCOM if you need to use a specific C-preprocessor command line for Fortran 95 files. You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 95 source file is compiled to an object file after first running the file through the C preprocessor. If not set, then $F95PPCOM or $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for F95 dialect will be used. By default, this is empty.

A function that converts a string into a File instance relative to the target being built.

The default Fortran compiler for all versions of Fortran.

The command line used to compile a Fortran source file to an object file. By default, any options specified in the $FORTRANFLAGS, $CPPFLAGS, $_CPPDEFFLAGS, $_FORTRANMODFLAG, and $_FORTRANINCFLAGS construction variables are included on this command line.

If set, the string displayed when a Fortran source file is compiled to an object file. If not set, then $FORTRANCOM (the command line) is displayed.

The list of file extensions for which the FORTRAN dialect will be used. By default, this is ['.f', '.for', '.ftn']

General user-specified options that are passed to the Fortran compiler. Note that this variable does not contain -I (or similar) include or module search path options that scons generates automatically from $FORTRANPATH. See $_FORTRANINCFLAGS and $_FORTRANMODFLAG, below, for the variables that expand those options.

An automatically-generated construction variable containing the Fortran compiler command-line options for specifying directories to be searched for include files and module files. The value of $_FORTRANINCFLAGS is created by respectively prepending and appending $INCPREFIX and $INCSUFFIX to the beginning and end of each directory in $FORTRANPATH.

Directory location where the Fortran compiler should place any module files it generates. This variable is empty, by default. Some Fortran compilers will internally append this directory in the search path for module files, as well.

The prefix used to specify a module directory on the Fortran compiler command line. This will be prepended to the beginning of the directory in the $FORTRANMODDIR construction variables when the $_FORTRANMODFLAG variables is automatically generated.

The suffix used to specify a module directory on the Fortran compiler command line. This will be appended to the end of the directory in the $FORTRANMODDIR construction variables when the $_FORTRANMODFLAG variables is automatically generated.

An automatically-generated construction variable containing the Fortran compiler command-line option for specifying the directory location where the Fortran compiler should place any module files that happen to get generated during compilation. The value of $_FORTRANMODFLAG is created by respectively prepending and appending $FORTRANMODDIRPREFIX and $FORTRANMODDIRSUFFIX to the beginning and end of the directory in $FORTRANMODDIR.

The module file prefix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of module_name.mod. As a result, this variable is left empty, by default. For situations in which the compiler does not necessarily follow the normal convention, the user may use this variable. Its value will be appended to every module file name as scons attempts to resolve dependencies.

The module file suffix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of module_name.mod. As a result, this variable is set to ".mod", by default. For situations in which the compiler does not necessarily follow the normal convention, the user may use this variable. Its value will be appended to every module file name as scons attempts to resolve dependencies.

The list of directories that the Fortran compiler will search for include files and (for some compilers) module files. The Fortran implicit dependency scanner will search these directories for include files (but not module files since they are autogenerated and, as such, may not actually exist at the time the scan takes place). Don't explicitly put include directory arguments in FORTRANFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in FORTRANPATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #:

env = Environment(FORTRANPATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(FORTRANPATH=include)

The directory list will be added to command lines through the automatically-generated $_FORTRANINCFLAGS construction variable, which is constructed by respectively prepending and appending the values of the $INCPREFIX and $INCSUFFIX construction variables to the beginning and end of each directory in $FORTRANPATH. Any command lines you define that need the FORTRANPATH directory list should include $_FORTRANINCFLAGS:

env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURCE")

The command line used to compile a Fortran source file to an object file after first running the file through the C preprocessor. By default, any options specified in the $FORTRANFLAGS, $CPPFLAGS, $_CPPDEFFLAGS, $_FORTRANMODFLAG, and $_FORTRANINCFLAGS construction variables are included on this command line.

If set, the string displayed when a Fortran source file is compiled to an object file after first running the file through the C preprocessor. If not set, then $FORTRANPPCOM (the command line) is displayed.

The list of file extensions for which the compilation + preprocessor pass for FORTRAN dialect will be used. By default, this is ['.fpp', '.FPP']

The list of suffixes of files that will be scanned for Fortran implicit dependencies (INCLUDE lines and USE statements). The default list is:

[".f", ".F", ".for", ".FOR", ".ftn", ".FTN", ".fpp", ".FPP",
".f77", ".F77", ".f90", ".F90", ".f95", ".F95"]

On Mac OS X with gcc, a list containing the paths to search for frameworks. Used by the compiler to find framework-style includes like #include <Fmwk/Header.h>. Used by the linker to find user-specified frameworks when linking (see $FRAMEWORKS). For example:

env.AppendUnique(FRAMEWORKPATH='#myframeworkdir')
            

will add

... -Fmyframeworkdir
            

to the compiler and linker command lines.

On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options corresponding to $FRAMEWORKPATH.

On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries. (see $FRAMEWORKPATH). The default value is -F.

On Mac OS X with gcc, the prefix to be used for linking in frameworks (see $FRAMEWORKS). The default value is -framework.

On Mac OS X with gcc, a list of the framework names to be linked into a program or shared library or bundle. The default value is the empty list. For example:

env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration'))
            

On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options for linking with FRAMEWORKS.

On Mac OS X with gcc, general user-supplied frameworks options to be added at the end of a command line building a loadable module. (This has been largely superseded by the $FRAMEWORKPATH, $FRAMEWORKPATHPREFIX, $FRAMEWORKPREFIX and $FRAMEWORKS variables described above.)

The Ghostscript program used to, for example, convert PostScript to PDF files.

The full Ghostscript command line used for the conversion process. Its default value is “$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES”.

The string displayed when Ghostscript is called for the conversion process. If this is not set (the default), then $GSCOM (the command line) is displayed.

General options passed to the Ghostscript program, when converting PostScript to PDF files for example. Its default value is “-dNOPAUSE -dBATCH -sDEVICE=pdfwrite”

The name of the host hardware architecture used to create this construction environment. The platform code sets this when initializing (see $PLATFORM and the platform argument to Environment). Note the detected name of the architecture may not be identical to that returned by the Python platform.machine method.

On the win32 platform, if the Microsoft Visual C++ compiler is available, msvc tool setup is done using $HOST_ARCH and $TARGET_ARCH. Changing the values at any later time will not cause the tool to be reinitialized. Valid host arch values are x86 and arm for 32-bit hosts and amd64 and x86_64 for 64-bit hosts.

Should be considered immutable. $HOST_ARCH is not currently used by other platforms, but the option is reserved to do so in future

The name of the host operating system for the platform used to create this construction environment. The platform code sets this when initializing (see $PLATFORM and the platform argument to Environment).

Should be considered immutable. $HOST_OS is not currently used by SCons, but the option is reserved to do so in future

The list of suffixes of files that will be scanned for IDL implicit dependencies (#include or import lines). The default list is:

[".idl", ".IDL"]

Used to override $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS when creating versioned import library for a shared library/loadable module. If not defined, then $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS is used to determine whether to disable symlink generation or not.

The prefix used for import library names. For example, cygwin uses import libraries (libfoo.dll.a) in pair with dynamic libraries (cygfoo.dll). The cyglink linker sets $IMPLIBPREFIX to 'lib' and $SHLIBPREFIX to 'cyg'.

The suffix used for import library names. For example, cygwin uses import libraries (libfoo.dll.a) in pair with dynamic libraries (cygfoo.dll). The cyglink linker sets $IMPLIBSUFFIX to '.dll.a' and $SHLIBSUFFIX to '.dll'.

Used to override $SHLIBVERSION/$LDMODULEVERSION when generating versioned import library for a shared library/loadable module. If undefined, the $SHLIBVERSION/$LDMODULEVERSION is used to determine the version of versioned import library.

Controls whether or not SCons will add implicit dependencies for the commands executed to build targets.

By default, SCons will add to each target an implicit dependency on the command represented by the first argument of any command line it executes (which is typically the command itself). By setting such a dependency, SCons can determine that a target should be rebuilt if the command changes, such as when a compiler is upgraded to a new version. The specific file for the dependency is found by searching the PATH variable in the ENV dictionary in the construction environment used to execute the command. The default is the same as setting the construction variable $IMPLICIT_COMMAND_DEPENDENCIES to a True-like value (“true”, “yes”, or “1” - but not a number greater than one, as that has a different meaning).

Action strings can be segmented by the use of an AND operator, &&. In a segemented string, each segment is a separate “command line”, these are run sequentially until one fails or the entire sequence has been executed. If an action string is segmented, then the selected behavior of $IMPLICIT_COMMAND_DEPENDENCIES is applied to each segment.

If $IMPLICIT_COMMAND_DEPENDENCIES is set to a False-like value (“none”, “false”, “no”, “0”, etc.), then the implicit dependency will not be added to the targets built with that construction environment.

If $IMPLICIT_COMMAND_DEPENDENCIES is set to “2” or higher, then that number of arguments in the command line will be scanned for relative or absolute paths. If any are present, they will be added as implicit dependencies to the targets built with that construction environment. The first argument in the command line will be searched for using the PATH variable in the ENV dictionary in the construction environment used to execute the command. The other arguments will only be found if they are absolute paths or valid paths relative to the working directory.

If $IMPLICIT_COMMAND_DEPENDENCIES is set to “all”, then all arguments in the command line will be scanned for relative or absolute paths. If any are present, they will be added as implicit dependencies to the targets built with that construction environment. The first argument in the command line will be searched for using the PATH variable in the ENV dictionary in the construction environment used to execute the command. The other arguments will only be found if they are absolute paths or valid paths relative to the working directory.

env = Environment(IMPLICIT_COMMAND_DEPENDENCIES=False)

The prefix used to specify an include directory on the C compiler command line. This will be prepended to each directory in the $CPPPATH and $FORTRANPATH construction variables when the $_CPPINCFLAGS and $_FORTRANINCFLAGS variables are automatically generated.

The suffix used to specify an include directory on the C compiler command line. This will be appended to each directory in the $CPPPATH and $FORTRANPATH construction variables when the $_CPPINCFLAGS and $_FORTRANINCFLAGS variables are automatically generated.

A function to be called to install a file into a destination file name. The default function copies the file into the destination (and sets the destination file's mode and permission bits to match the source file's). The function takes the following arguments:

def install(dest, source, env):

dest is the path name of the destination file. source is the path name of the source file. env is the construction environment (a dictionary of construction values) in force for this file installation.

The string displayed when a file is installed into a destination file name. The default is:

Install file: "$SOURCE" as "$TARGET"

Set by the intelc Tool to the major version number of the Intel C compiler selected for use.

The Java archive tool.

The directory to which the Java archive tool should change (using the -C option).

The command line used to call the Java archive tool.

The string displayed when the Java archive tool is called If this is not set, then $JARCOM (the command line) is displayed.

env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET")

General options passed to the Java archive tool. By default this is set to cf to create the necessary jar file.

The suffix for Java archives: .jar by default.

Specifies the list of directories that will be added to the javac command line via the -bootclasspath option. The individual directory names will be separated by the operating system's path separate character (: on UNIX/Linux/POSIX, ; on Windows).

The Java compiler.

The command line used to compile a directory tree containing Java source files to corresponding Java class files. Any options specified in the $JAVACFLAGS construction variable are included on this command line.

The string displayed when compiling a directory tree of Java source files to corresponding Java class files. If this is not set, then $JAVACCOM (the command line) is displayed.

env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES")
            

General options that are passed to the Java compiler.

The directory in which Java class files may be found. This is stripped from the beginning of any Java .class file names supplied to the JavaH builder.

Specifies the list of directories that will be searched for Java .class file. The directories in this list will be added to the javac and javah command lines via the -classpath option. The individual directory names will be separated by the operating system's path separate character (: on UNIX/Linux/POSIX, ; on Windows).

Note that this currently just adds the specified directory via the -classpath option. SCons does not currently search the $JAVACLASSPATH directories for dependency .class files.

The suffix for Java class files; .class by default.

The Java generator for C header and stub files.

The command line used to generate C header and stub files from Java classes. Any options specified in the $JAVAHFLAGS construction variable are included on this command line.

The string displayed when C header and stub files are generated from Java classes. If this is not set, then $JAVAHCOM (the command line) is displayed.

env = Environment(JAVAHCOMSTR="Generating header/stub file(s) $TARGETS from $SOURCES")

General options passed to the C header and stub file generator for Java classes.

Include path for Java header files (such as jni.h)

Specifies the list of directories that will be searched for input .java file. The directories in this list will be added to the javac command line via the -sourcepath option. The individual directory names will be separated by the operating system's path separate character (: on UNIX/Linux/POSIX, ; on Windows).

Note that this currently just adds the specified directory via the -sourcepath option. SCons does not currently search the $JAVASOURCEPATH directories for dependency .java files.

The suffix for Java files; .java by default.

Specifies the Java version being used by the Java builder. Set this to specify the version of Java targeted by the javac compiler. This is sometimes necessary because Java 1.5 changed the file names that are created for nested anonymous inner classes, which can cause a mismatch with the files that SCons expects will be generated by the javac compiler. Setting $JAVAVERSION to a version greater than 1.4 makes SCons realize that a build with such a compiler is actually up to date. The default is 1.4.

While this is not primarily intended for selecting one version of the Java compiler vs. another, it does have that effect on the Windows platform. A more precise approach is to set $JAVAC (and related construction variables for related utilities) to the path to the specific Java compiler you want, if that is not the default compiler. On non-Windows platforms, the alternatives system may provide a way to adjust the default Java compiler without having to specify explicit paths.

The LaTeX structured formatter and typesetter.

The command line used to call the LaTeX structured formatter and typesetter.

The string displayed when calling the LaTeX structured formatter and typesetter. If this is not set, then $LATEXCOM (the command line) is displayed.

env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES")

General options passed to the LaTeX structured formatter and typesetter.

The maximum number of times that LaTeX will be re-run if the .log generated by the $LATEXCOM command indicates that there are undefined references. The default is to try to resolve undefined references by re-running LaTeX up to three times.

The list of suffixes of files that will be scanned for LaTeX implicit dependencies (\include or \import files). The default list is:

[".tex", ".ltx", ".latex"]

The linker for building loadable modules. By default, this is the same as $SHLINK.

The command line for building loadable modules. On Mac OS X, this uses the $LDMODULE, $LDMODULEFLAGS and $FRAMEWORKSFLAGS variables. On other systems, this is the same as $SHLINK.

If set, the string displayed when building loadable modules. If not set, then $LDMODULECOM (the command line) is displayed.

Contains the emitter specification for the LoadableModule builder. The manpage section "Builder Objects" contains general information on specifying emitters.

General user options passed to the linker for building loadable modules.

Instructs the LoadableModule builder to not automatically create symlinks for versioned modules. Defaults to $SHLIBNOVERSIONSYMLINKS

The prefix used for loadable module file names. On Mac OS X, this is null; on other systems, this is the same as $SHLIBPREFIX.

A macro that automatically generates loadable module's SONAME based on $TARGET, $LDMODULEVERSION and $LDMODULESUFFIX. Used by LoadableModule builder when the linker tool supports SONAME (e.g. gnulink).

The suffix used for loadable module file names. On Mac OS X, this is null; on other systems, this is the same as $SHLIBSUFFIX.

When this construction variable is defined, a versioned loadable module is created by LoadableModule builder. This activates the $_LDMODULEVERSIONFLAGS and thus modifies the $LDMODULECOM as required, adds the version number to the library name, and creates the symlinks that are needed. $LDMODULEVERSION versions should exist in the same format as $SHLIBVERSION.

This macro automatically introduces extra flags to $LDMODULECOM when building versioned LoadableModule (that is when $LDMODULEVERSION is set). _LDMODULEVERSIONFLAGS usually adds $SHLIBVERSIONFLAGS and some extra dynamically generated options (such as -Wl,-soname=$_LDMODULESONAME). It is unused by plain (unversioned) loadable modules.

Extra flags added to $LDMODULECOM when building versioned LoadableModule. These flags are only used when $LDMODULEVERSION is set.

The lexical analyzer generator.

The command line used to call the lexical analyzer generator to generate a source file.

The string displayed when generating a source file using the lexical analyzer generator. If this is not set, then $LEXCOM (the command line) is displayed.

env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES")

General options passed to the lexical analyzer generator.

Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'.

An automatically-generated construction variable containing the linker command-line options for specifying directories to be searched for library. The value of $_LIBDIRFLAGS is created by respectively prepending and appending $LIBDIRPREFIX and $LIBDIRSUFFIX to each directory in $LIBPATH.

The prefix used to specify a library directory on the linker command line. This will be prepended to each directory in the $LIBPATH construction variable when the $_LIBDIRFLAGS variable is automatically generated.

The suffix used to specify a library directory on the linker command line. This will be appended to each directory in the $LIBPATH construction variable when the $_LIBDIRFLAGS variable is automatically generated.

Contains the emitter specification for the StaticLibrary builder. The manpage section "Builder Objects" contains general information on specifying emitters.

An automatically-generated construction variable containing the linker command-line options for specifying libraries to be linked with the resulting target. The value of $_LIBFLAGS is created by respectively prepending and appending $LIBLINKPREFIX and $LIBLINKSUFFIX to each filename in $LIBS.

The prefix used to specify a library to link on the linker command line. This will be prepended to each library in the $LIBS construction variable when the $_LIBFLAGS variable is automatically generated.

The suffix used to specify a library to link on the linker command line. This will be appended to each library in the $LIBS construction variable when the $_LIBFLAGS variable is automatically generated.

The list of directories that will be searched for libraries specified by the $LIBS construction variable. $LIBPATH should be a list of path strings, or a single string, not a pathname list joined by Python's os.sep. Do not put library search directives directly into $LINKFLAGS or $SHLINKFLAGS as the result will be non-portable.

Note: directory names in $LIBPATH will be looked-up relative to the directory of the SConscript file when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use the # prefix:

env = Environment(LIBPATH='#/libs')

The directory look-up can also be forced using the Dir function:

libs = Dir('libs')
env = Environment(LIBPATH=libs)

The directory list will be added to command lines through the automatically-generated $_LIBDIRFLAGS construction variable, which is constructed by respectively prepending and appending the values of the $LIBDIRPREFIX and $LIBDIRSUFFIX construction variables to each directory in $LIBPATH. Any command lines you define that need the $LIBPATH directory list should include $_LIBDIRFLAGS:

env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE")

The prefix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), but the value is overridden by individual tools (ar, mslib, sgiar, sunar, tlib, etc.) to reflect the names of the libraries they create.

A list of all legal prefixes for library file names. When searching for library dependencies, SCons will look for files with these prefixes, the base library name, and suffixes from the $LIBSUFFIXES list.

A list of one or more libraries that will be added to the link line for linking with any executable program, shared library, or loadable module created by the construction environment or override.

String-valued library names should include only the library base names, without prefixes such as lib or suffixes such as .so or .dll. The library list will be added to command lines through the automatically-generated $_LIBFLAGS construction variable which is constructed by respectively prepending and appending the values of the $LIBLINKPREFIX and $LIBLINKSUFFIX construction variables to each library name in $LIBS. Library name strings should not include a path component, instead the compiler will be directed to look for libraries in the paths specified by $LIBPATH.

Any command lines you define that need the $LIBS library list should include $_LIBFLAGS:

env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE")

If you add a File object to the $LIBS list, the name of that file will be added to $_LIBFLAGS, and thus to the link line, as-is, without $LIBLINKPREFIX or $LIBLINKSUFFIX. For example:

env.Append(LIBS=File('/tmp/mylib.so'))

In all cases, scons will add dependencies from the executable program to all the libraries in this list.

The suffix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), but the value is overridden by individual tools (ar, mslib, sgiar, sunar, tlib, etc.) to reflect the names of the libraries they create.

A list of all legal suffixes for library file names. When searching for library dependencies, SCons will look for files with prefixes from the $LIBPREFIXES list, the base library name, and these suffixes.

The abbreviated name, preferably the SPDX code, of the license under which this project is released (GPL-3.0, LGPL-2.1, BSD-2-Clause etc.). See http://www.opensource.org/licenses/alphabetical for a list of license names and SPDX codes.

See the Package builder.

The separator used by the Substfile and Textfile builders. This value is used between sources when constructing the target. It defaults to the current system line separator.

The $LINGUAS_FILE defines file(s) containing list of additional linguas to be processed by POInit, POUpdate or MOFiles builders. It also affects Translate builder. If the variable contains a string, it defines name of the list file. The $LINGUAS_FILE may be a list of file names as well. If $LINGUAS_FILE is set to True (or non-zero numeric value), the list will be read from default file named LINGUAS.

The linker. See also $SHLINK for linking shared objects.

On POSIX systems (those using the link tool), you should normally not change this value as it defaults to a "smart" linker tool which selects a compiler driver matching the type of source files in use. So for example, if you set $CXX to a specific compiler name, and are compiling C++ sources, the smartlink function will automatically select the same compiler for linking.

The command line used to link object files into an executable. See also $SHLINKCOM for linking shared objects.

If set, the string displayed when object files are linked into an executable. If not set, then $LINKCOM (the command line) is displayed. See also $SHLINKCOMSTR. for linking shared objects.

env = Environment(LINKCOMSTR = "Linking $TARGET")

General user options passed to the linker. Note that this variable should not contain -l (or similar) options for linking with the libraries listed in $LIBS, nor -L (or similar) library search path options that scons generates automatically from $LIBPATH. See $_LIBFLAGS above, for the variable that expands to library-link options, and $_LIBDIRFLAGS above, for the variable that expands to library search path options. See also $SHLINKFLAGS. for linking shared objects.

The M4 macro preprocessor.

The command line used to pass files through the M4 macro preprocessor.

The string displayed when a file is passed through the M4 macro preprocessor. If this is not set, then $M4COM (the command line) is displayed.

General options passed to the M4 macro preprocessor.

The makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

The command line used to call the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

The string displayed when calling the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. If this is not set, then $MAKEINDEXCOM (the command line) is displayed.

General options passed to the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter.

The maximum number of characters allowed on an external command line. On Win32 systems, link lines longer than this many characters are linked via a temporary file name.

The Microsoft IDL compiler.

The command line used to pass files to the Microsoft IDL compiler.

The string displayed when the Microsoft IDL compiler is called. If this is not set, then $MIDLCOM (the command line) is displayed.

General options passed to the Microsoft IDL compiler.

Suffix used for MO files (default: '.mo'). See msgfmt tool and MOFiles builder.

Absolute path to msgfmt(1) binary, found by Detect(). See msgfmt tool and MOFiles builder.

Complete command line to run msgfmt(1) program. See msgfmt tool and MOFiles builder.

String to display when msgfmt(1) is invoked (default: '', which means ``print $MSGFMTCOM''). See msgfmt tool and MOFiles builder.

Additional flags to msgfmt(1). See msgfmt tool and MOFiles builder.

Path to msginit(1) program (found via Detect()). See msginit tool and POInit builder.

Complete command line to run msginit(1) program. See msginit tool and POInit builder.

String to display when msginit(1) is invoked (default: '', which means ``print $MSGINITCOM''). See msginit tool and POInit builder.

List of additional flags to msginit(1) (default: []). See msginit tool and POInit builder.

Internal ``macro''. Computes locale (language) name based on target filename (default: '${TARGET.filebase}' ).

See msginit tool and POInit builder.

Absolute path to msgmerge(1) binary as found by Detect(). See msgmerge tool and POUpdate builder.

Complete command line to run msgmerge(1) command. See msgmerge tool and POUpdate builder.

String to be displayed when msgmerge(1) is invoked (default: '', which means ``print $MSGMERGECOM''). See msgmerge tool and POUpdate builder.

Additional flags to msgmerge(1) command. See msgmerge tool and POUpdate builder.

The directory containing the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation.

The version string of the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. Supported versions include 6.1, 6.0A, 6.0, 2003R2 and 2003R1.

When set to any true value, specifies that SCons should batch compilation of object files when calling the Microsoft Visual C/C++ compiler. All compilations of source files from the same source directory that generate target files in a same output directory and were configured in SCons using the same construction environment will be built in a single call to the compiler. Only source files that have changed since their object files were built will be passed to each compiler invocation (via the $CHANGED_SOURCES construction variable). Any compilations where the object (target) file base name (minus the .obj) does not match the source file base name will be compiled separately.

Use a batch script to set up the Microsoft Visual C++ compiler.

If set to the name of a Visual Studio .bat file (e.g. vcvars.bat), SCons will run that batch file instead of the auto-detected one, and extract the relevant variables from the result (typically %INCLUDE%, %LIB%, and %PATH%) for supplying to the build. This can be useful to force the use of a compiler version that SCons does not detect.

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's environment variables - that is, if you are sure everything is set correctly already and you don't want SCons to change anything.

$MSVC_USE_SCRIPT overrides $MSVC_VERSION and $TARGET_ARCH.

Build libraries for a Universal Windows Platform (UWP) Application.

If $MSVC_UWP_APP is set, the Visual C++ environment will be set up to point to the Windows Store compatible libraries and Visual C++ 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 or later. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect.

Valid values are '1' or '0'

Sets the preferred version of Microsoft Visual C/C++ to use.

If $MSVC_VERSION is not set, SCons will (by default) select the latest version of Visual C/C++ installed on your system. If the specified version isn't installed, tool initialization will fail. This variable must be passed as an argument to the Environment constructor; setting it later has no effect.

Valid values for Windows are 14.3, 14.2, 14.1, 14.1Exp, 14.0, 14.0Exp, 12.0, 12.0Exp, 11.0, 11.0Exp, 10.0, 10.0Exp, 9.0, 9.0Exp, 8.0, 8.0Exp, 7.1, 7.0, and 6.0. Versions ending in Exp refer to "Express" or "Express for Desktop" editions.

When the Microsoft Visual Studio tools are initialized, they set up this dictionary with the following keys:

If a value is not set, it was not available in the registry.

Sets the architecture for which the generated project(s) should build.

The default value is x86. amd64 is also supported by SCons for most Visual Studio versions. Since Visual Studio 2015 arm is supported, and since Visual Studio 2017 arm64 is supported. Trying to set $MSVS_ARCH to an architecture that's not supported for a given Visual Studio version will generate an error.

The string placed in a generated Microsoft Visual Studio project file as the value of the ProjectGUID attribute. There is no default value. If not defined, a new GUID is generated.

The path name placed in a generated Microsoft Visual Studio project file as the value of the SccAuxPath attribute if the MSVS_SCC_PROVIDER construction variable is also set. There is no default value.

The root path of projects in your SCC workspace, i.e the path under which all project and solution files will be generated. It is used as a reference path from which the relative paths of the generated Microsoft Visual Studio project and solution files are computed. The relative project file path is placed as the value of the SccLocalPath attribute of the project file and as the values of the SccProjectFilePathRelativizedFromConnection[i] (where [i] ranges from 0 to the number of projects in the solution) attributes of the GlobalSection(SourceCodeControl) section of the Microsoft Visual Studio solution file. Similarly the relative solution file path is placed as the values of the SccLocalPath[i] (where [i] ranges from 0 to the number of projects in the solution) attributes of the GlobalSection(SourceCodeControl) section of the Microsoft Visual Studio solution file. This is used only if the MSVS_SCC_PROVIDER construction variable is also set. The default value is the current working directory.

The project name placed in a generated Microsoft Visual Studio project file as the value of the SccProjectName attribute if the MSVS_SCC_PROVIDER construction variable is also set. In this case the string is also placed in the SccProjectName0 attribute of the GlobalSection(SourceCodeControl) section of the Microsoft Visual Studio solution file. There is no default value.

The string placed in a generated Microsoft Visual Studio project file as the value of the SccProvider attribute. The string is also placed in the SccProvider0 attribute of the GlobalSection(SourceCodeControl) section of the Microsoft Visual Studio solution file. There is no default value.

Sets the preferred version of Microsoft Visual Studio to use.

If $MSVS_VERSION is not set, SCons will (by default) select the latest version of Visual Studio installed on your system. So, if you have version 6 and version 7 (MSVS .NET) installed, it will prefer version 7. You can override this by specifying the MSVS_VERSION variable in the Environment initialization, setting it to the appropriate version ('6.0' or '7.0', for example). If the specified version isn't installed, tool initialization will fail.

This is obsolete: use $MSVC_VERSION instead. If $MSVS_VERSION is set and $MSVC_VERSION is not, $MSVC_VERSION will be set automatically to $MSVS_VERSION. If both are set to different values, scons will raise an error.

The build command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with any specified build targets.

The clean command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with the -c option to remove any specified targets.

The encoding string placed in a generated Microsoft Visual Studio project file. The default is encoding Windows-1252.

The action used to generate Microsoft Visual Studio project files.

The suffix used for Microsoft Visual Studio project (DSP) files. The default value is .vcproj when using Visual Studio version 7.x (.NET) or later version, and .dsp when using earlier versions of Visual Studio.

The rebuild command line placed in a generated Microsoft Visual Studio project file. The default is to have Visual Studio invoke SCons with any specified rebuild targets.

The SCons used in generated Microsoft Visual Studio project files. The default is the version of SCons being used to generate the project file.

The default SCons command used in generated Microsoft Visual Studio project files.

The sconscript file (that is, SConstruct or SConscript file) that will be invoked by Visual Studio project files (through the $MSVSSCONSCOM variable). The default is the same sconscript file that contains the call to MSVSProject to build the project file.

The SCons flags used in generated Microsoft Visual Studio project files.

The action used to generate Microsoft Visual Studio solution files.

The suffix used for Microsoft Visual Studio solution (DSW) files. The default value is .sln when using Visual Studio version 7.x (.NET), and .dsw when using earlier versions of Visual Studio.

The program used on Windows systems to embed manifests into DLLs and EXEs. See also $WINDOWS_EMBED_MANIFEST.

The Windows command line used to embed manifests into executables. See also $MTSHLIBCOM.

Flags passed to the $MT manifest embedding program (Windows only).

The Windows command line used to embed manifests into shared libraries (DLLs). See also $MTEXECOM.

The version number of the MetroWerks CodeWarrior C compiler to be used.

A list of installed versions of the MetroWerks CodeWarrior C compiler on this system.

Specfies the name of the project to package.

See the Package builder.

Name of the Alias() which is will cause SCons to create the ninja.build file, and then (optionally) run ninja.

Boolean value (True|False) to instruct ninja to expand the command line arguments normally put into response files. This prevents lines in the compilation database like “gcc @rsp_file” and instead yields “gcc -c -o myfile.o myfile.c -Ia -DXYZ”

Ninja's compdb tool added the “-x” flag in Ninja V1.9.0

This propagates directly into the generated ninja.build file. From Ninja's docs:

Boolean (True|False). Default: False When True, SCons will not run ninja automatically after creating the ninja.build file. If not set, this will be set to True if “--disable_execute_ninja” or SetOption('disable_execute_ninja', True)

A string that sets the environment for any environment variables that differ between the OS environment and the SCons command ENV. It will be compatible with the default shell of the operating system. If not explicitly specified, SCons will generate this dynamically from the Environment()'s 'ENV' “env['ENV']” where those values differ from the existing shell..

The filename for the generated Ninja build file defaults to ninja.build

When NINJA_FORCE_SCONS_BUILD is True, this will cause the build nodes to callback to scons instead of using ninja to build them. This is intended to be passed to the environment on the builder invocation. It is useful if you have a build node which does something which is not easily translated into ninja.

The list of source file suffixes which are generated by SCons build steps. All source files which match these suffixes will be added to the _generated_sources alias in the output ninja.build file. Then all other source files will be made to depend on this in the ninja.build file, forcing the generated sources to be built first.

This propagates directly into the generated ninja.build file. From Ninja's docs “defines the string which should be stripped from msvc’s /showIncludes output”

Set the “ninja_pool” for this or all targets in scope for this env var.

A generator function used to create a ninja depsfile which includes all the files which would require SCons to be invoked if they change. Or a list of said files.

Internal value used to specify the function to call with argument env to generate the list of files which if changed would require the ninja file to be regenerated.

Theres also NINJA_SYNTAX which is the path to a custom ninja_syntax.py file which is used in generation. The tool currently assumes you have ninja installed through pip, and grabs the syntax file from that installation if none specified.

When set to non-zero, suppresses creation of a corresponding Windows static import lib by the SharedLibrary builder when used with MinGW, Microsoft Visual Studio or Metrowerks. This also suppresses creation of an export (.exp) file when using Microsoft Visual Studio.

The prefix used for (static) object file names.

The suffix used for (static) object file names.

Specifies the directory where all files in resulting archive will be placed if applicable. The default value is “$NAME-$VERSION”.

See the Package builder.

Selects the package type to build when using the Package builder. May be a string or list of strings. See the docuentation for the builder for the currently supported types.

$PACKAGETYPE may be overridden with the --package-type command line option.

See the Package builder.

The version of the package (not the underlying project). This is currently only used by the rpm packager and should reflect changes in the packaging, not the underlying project code itself.

See the Package builder.

The Microsoft Visual C++ precompiled header that will be used when compiling object files. This variable is ignored by tools other than Microsoft Visual C++. When this variable is defined SCons will add options to the compiler command line to cause it to use the precompiled header, and will also set up the dependencies for the PCH file. Example:

env['PCH'] = File('StdAfx.pch')

The command line used by the PCH builder to generated a precompiled header.

The string displayed when generating a precompiled header. If this is not set, then $PCHCOM (the command line) is displayed.

A construction variable that, when expanded, adds the /yD flag to the command line only if the $PDB construction variable is set.

This variable specifies how much of a source file is precompiled. This variable is ignored by tools other than Microsoft Visual C++, or when the PCH variable is not being used. When this variable is define it must be a string that is the name of the header that is included at the end of the precompiled portion of the source files, or the empty string if the "#pragma hrdstop" construct is being used:

env['PCHSTOP'] = 'StdAfx.h'

The Microsoft Visual C++ PDB file that will store debugging information for object files, shared libraries, and programs. This variable is ignored by tools other than Microsoft Visual C++. When this variable is defined SCons will add options to the compiler and linker command line to cause them to generate external debugging information, and will also set up the dependencies for the PDB file. Example:

env['PDB'] = 'hello.pdb'

The Visual C++ compiler switch that SCons uses by default to generate PDB information is /Z7. This works correctly with parallel (-j) builds because it embeds the debug information in the intermediate object files, as opposed to sharing a single PDB file between multiple object files. This is also the only way to get debug information embedded into a static library. Using the /Zi instead may yield improved link-time performance, although parallel builds will no longer work. You can generate PDB files with the /Zi switch by overriding the default $CCPDBFLAGS variable; see the entry for that variable for specific examples.

The pdflatex utility.

The command line used to call the pdflatex utility.

The string displayed when calling the pdflatex utility. If this is not set, then $PDFLATEXCOM (the command line) is displayed.

env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES")

General options passed to the pdflatex utility.

The prefix used for PDF file names.

The suffix used for PDF file names.

The pdftex utility.

The command line used to call the pdftex utility.

The string displayed when calling the pdftex utility. If this is not set, then $PDFTEXCOM (the command line) is displayed.

env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES")

General options passed to the pdftex utility.

On Solaris systems, the package-checking program that will be used (along with $PKGINFO) to look for installed versions of the Sun PRO C++ compiler. The default is /usr/sbin/pgkchk.

On Solaris systems, the package information program that will be used (along with $PKGCHK) to look for installed versions of the Sun PRO C++ compiler. The default is pkginfo.

The name of the platform used to create this construction environment. SCons sets this when initializing the platform, which by default is auto-detected (see the platform argument to Environment).

env = Environment(tools=[])
if env['PLATFORM'] == 'cygwin':
    Tool('mingw')(env)
else:
    Tool('msvc')(env)
    

The $POAUTOINIT variable, if set to True (on non-zero numeric value), let the msginit tool to automatically initialize missing PO files with msginit(1). This applies to both, POInit and POUpdate builders (and others that use any of them).

Common alias for all PO files created with POInit builder (default: 'po-create'). See msginit tool and POInit builder.

Suffix used for PO files (default: '.po') See msginit tool and POInit builder.

The $POTDOMAIN defines default domain, used to generate POT filename as $POTDOMAIN.pot when no POT file name is provided by the user. This applies to POTUpdate, POInit and POUpdate builders (and builders, that use them, e.g. Translate). Normally (if $POTDOMAIN is not defined), the builders use messages.pot as default POT file name.

Suffix used for PO Template files (default: '.pot'). See xgettext tool and POTUpdate builder.

Name of the common phony target for all PO Templates created with POUpdate (default: 'pot-update'). See xgettext tool and POTUpdate builder.

Common alias for all PO files being defined with POUpdate builder (default: 'po-update'). See msgmerge tool and POUpdate builder.

A Python function used to print the command lines as they are executed (assuming command printing is not disabled by the -q or -s options or their equivalents). The function should take four arguments: s, the command being executed (a string), target, the target being built (file node, list, or string name(s)), source, the source(s) used (file node, list, or string name(s)), and env, the environment being used.

The function must do the printing itself. The default implementation, used if this variable is not set or is None, is:

def print_cmd_line(s, target, source, env):
  sys.stdout.write(s + "\n")

Here's an example of a more interesting function:

def print_cmd_line(s, target, source, env):
   sys.stdout.write("Building %s -> %s...\n" %
    (' and '.join([str(x) for x in source]),
     ' and '.join([str(x) for x in target])))
env=Environment(PRINT_CMD_LINE_FUNC=print_cmd_line)
env.Program('foo', 'foo.c')

This just prints "Building targetname from sourcename..." instead of the actual commands. Such a function could also log the actual commands to a log file, for example.

Contains the emitter specification for the Program builder. The manpage section "Builder Objects" contains general information on specifying emitters.

The prefix used for executable file names.

The suffix used for executable file names.

The command line used to convert TeX DVI files into a PostScript file.

The string displayed when a TeX DVI file is converted into a PostScript file. If this is not set, then $PSCOM (the command line) is displayed.

The prefix used for PostScript file names.

The prefix used for PostScript file names.

Turn off scanning for mocable files. Use the Moc Builder to explicitly specify files to run moc on.

The path where the Qt binaries are installed. The default value is '$QTDIR/bin'.

The path where the Qt header files are installed. The default value is '$QTDIR/include'. Note: If you set this variable to None, the tool won't change the $CPPPATH construction variable.

Prints lots of debugging information while scanning for moc files.

Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set this variable to None, the tool won't change the $LIBS variable.

The path where the Qt libraries are installed. The default value is '$QTDIR/lib'. Note: If you set this variable to None, the tool won't change the $LIBPATH construction variable.

Default value is '$QT_BINPATH/moc'.

Default value is ''. Prefix for moc output files when source is a C++ file.

Default value is '.moc'. Suffix for moc output files when source is a C++ file.

Command to generate a moc file from a C++ file.

The string displayed when generating a moc file from a C++ file. If this is not set, then $QT_MOCFROMCXXCOM (the command line) is displayed.

Default value is '-i'. These flags are passed to moc when moccing a C++ file.

Command to generate a moc file from a header.

The string displayed when generating a moc file from a C++ file. If this is not set, then $QT_MOCFROMHCOM (the command line) is displayed.

Default value is ''. These flags are passed to moc when moccing a header file.

Default value is 'moc_'. Prefix for moc output files when source is a header.

Default value is '$CXXFILESUFFIX'. Suffix for moc output files when source is a header.

Default value is '$QT_BINPATH/uic'.

Command to generate header files from .ui files.

The string displayed when generating header files from .ui files. If this is not set, then $QT_UICCOM (the command line) is displayed.

Default value is ''. These flags are passed to uic when creating a header file from a .ui file.

Default value is ''. Prefix for uic generated header files.

Default value is '.h'. Suffix for uic generated header files.

Default value is ''. These flags are passed to uic when creating a C++ file from a .ui file.

Default value is 'uic_'. Prefix for uic generated implementation files.

Default value is '$CXXFILESUFFIX'. Suffix for uic generated implementation files.

Default value is '.ui'. Suffix of designer input files.

The path to the Qt installation to build against. If not already set, qt tool tries to obtain this from os.environ; if not found there, it tries to make a guess.

The archive indexer.

The command line used to index a static library archive.

The string displayed when a static library archive is indexed. If this is not set, then $RANLIBCOM (the command line) is displayed.

env = Environment(RANLIBCOMSTR = "Indexing $TARGET")

General options passed to the archive indexer.

The resource compiler used to build a Microsoft Visual C++ resource file.

The command line used to build a Microsoft Visual C++ resource file.

The string displayed when invoking the resource compiler to build a Microsoft Visual C++ resource file. If this is not set, then $RCCOM (the command line) is displayed.

The flags passed to the resource compiler by the RES builder.

An automatically-generated construction variable containing the command-line options for specifying directories to be searched by the resource compiler. The value of $RCINCFLAGS is created by respectively prepending and appending $RCINCPREFIX and $RCINCSUFFIX to the beginning and end of each directory in $CPPPATH.

The prefix (flag) used to specify an include directory on the resource compiler command line. This will be prepended to the beginning of each directory in the $CPPPATH construction variable when the $RCINCFLAGS variable is expanded.

The suffix used to specify an include directory on the resource compiler command line. This will be appended to the end of each directory in the $CPPPATH construction variable when the $RCINCFLAGS variable is expanded.

A function that converts a string into a list of Dir instances by searching the repositories.

The program used on Windows systems to register a newly-built DLL library whenever the SharedLibrary builder is passed a keyword argument of register=True.

The command line used on Windows systems to register a newly-built DLL library whenever the SharedLibrary builder is passed a keyword argument of register=True.

The string displayed when registering a newly-built DLL file. If this is not set, then $REGSVRCOM (the command line) is displayed.

Flags passed to the DLL registration program on Windows systems when a newly-built DLL library is registered. By default, this includes the /s that prevents dialog boxes from popping up and requiring user attention.

The Java RMI stub compiler.

The command line used to compile stub and skeleton class files from Java classes that contain RMI implementations. Any options specified in the $RMICFLAGS construction variable are included on this command line.

The string displayed when compiling stub and skeleton class files from Java classes that contain RMI implementations. If this is not set, then $RMICCOM (the command line) is displayed.

env = Environment(RMICCOMSTR = "Generating stub/skeleton class files $TARGETS from $SOURCES")

General options passed to the Java RMI stub compiler.

A list of paths to search for shared libraries when running programs. Currently only used in the GNU (gnulink), IRIX (sgilink) and Sun (sunlink) linkers. Ignored on platforms and toolchains that don't support it. Note that the paths added to RPATH are not transformed by scons in any way: if you want an absolute path, you must make it absolute yourself.

An automatically-generated construction variable containing the rpath flags to be used when linking a program with shared libraries. The value of $_RPATH is created by respectively prepending $RPATHPREFIX and appending $RPATHSUFFIX to the beginning and end of each directory in $RPATH.

The prefix used to specify a directory to be searched for shared libraries when running programs. This will be prepended to the beginning of each directory in the $RPATH construction variable when the $_RPATH variable is automatically generated.

The suffix used to specify a directory to be searched for shared libraries when running programs. This will be appended to the end of each directory in the $RPATH construction variable when the $_RPATH variable is automatically generated.

The RPC protocol compiler.

Options passed to the RPC protocol compiler when generating client side stubs. These are in addition to any flags specified in the $RPCGENFLAGS construction variable.

General options passed to the RPC protocol compiler.

Options passed to the RPC protocol compiler when generating a header file. These are in addition to any flags specified in the $RPCGENFLAGS construction variable.

Options passed to the RPC protocol compiler when generating server side stubs. These are in addition to any flags specified in the $RPCGENFLAGS construction variable.

Options passed to the RPC protocol compiler when generating XDR routines. These are in addition to any flags specified in the $RPCGENFLAGS construction variable.

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 manpage sections "Builder Objects" and "Scanner Objects" for more information.

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 $MSVSSCONS command line executed from Microsoft Visual Studio project files.

The C compiler used for generating shared-library objects. See also $CC for compiling to static objects.

The command line used to compile a C source file to a shared-library object file. Any options specified in the $SHCFLAGS, $SHCCFLAGS and $CPPFLAGS construction variables are included on this command line. See also $CCCOM for compiling to static objects.

If set, the string displayed when a C source file is compiled to a shared object file. If not set, then $SHCCCOM (the command line) is displayed. See also $CCCOMSTR for compiling to static objects.

env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET")

Options that are passed to the C and C++ compilers to generate shared-library objects. See also $CCFLAGS for compiling to static objects.

Options that are passed to the C compiler (only; not C++) to generate shared-library objects. See also $CFLAGS for compiling to static objects.

The C++ compiler used for generating shared-library objects. See also $CXX for compiling to static objects.

The command line used to compile a C++ source file to a shared-library object file. Any options specified in the $SHCXXFLAGS and $CPPFLAGS construction variables are included on this command line. See also $CXXCOM for compiling to static objects.

If set, the string displayed when a C++ source file is compiled to a shared object file. If not set, then $SHCXXCOM (the command line) is displayed. See also $CXXCOMSTR for compiling to static objects.

env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET")

Options that are passed to the C++ compiler to generate shared-library objects. See also $CXXFLAGS for compiling to static objects.

The name of the compiler to use when compiling D source destined to be in a shared objects. See also $DC for compiling to static objects.

The command line to use when compiling code to be part of shared objects. See also $DCOM for compiling to static objects.

If set, the string displayed when a D source file is compiled to a (shared) object file. If not set, then $SHDCOM (the command line) is displayed. See also $DCOMSTR for compiling to static objects.

Extra flags added to $SHDLINKCOM when building versioned SharedLibrary. These flags are only used when $SHLIBVERSION is set.

The linker to use when creating shared objects for code bases include D sources. See also $DLINK for linking static objects.

The command line to use when generating shared objects. See also $DLINKCOM for linking static objects.

The list of flags to use when generating a shared object. See also $DLINKFLAGS for linking static objects.

A string naming the shell program that will be passed to the $SPAWN function. See the $SPAWN construction variable for more information.

The Fortran 03 compiler used for generating shared-library objects. You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $SHF03 if you need to use a specific compiler or compiler version for Fortran 03 files.

The command line used to compile a Fortran 03 source file to a shared-library object file. You only need to set $SHF03COM if you need to use a specific command line for Fortran 03 files. You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file. If not set, then $SHF03COM or $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran 03 compiler to generated shared-library objects. You only need to set $SHF03FLAGS if you need to define specific user options for Fortran 03 files. You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

The command line used to compile a Fortran 03 source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHF03FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $SHF03PPCOM if you need to use a specific C-preprocessor command line for Fortran 03 files. You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHF03PPCOM or $SHFORTRANPPCOM (the command line) is displayed.

The Fortran 08 compiler used for generating shared-library objects. You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $SHF08 if you need to use a specific compiler or compiler version for Fortran 08 files.

The command line used to compile a Fortran 08 source file to a shared-library object file. You only need to set $SHF08COM if you need to use a specific command line for Fortran 08 files. You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 08 source file is compiled to a shared-library object file. If not set, then $SHF08COM or $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran 08 compiler to generated shared-library objects. You only need to set $SHF08FLAGS if you need to define specific user options for Fortran 08 files. You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

The command line used to compile a Fortran 08 source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHF08FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $SHF08PPCOM if you need to use a specific C-preprocessor command line for Fortran 08 files. You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 08 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHF08PPCOM or $SHFORTRANPPCOM (the command line) is displayed.

The Fortran 77 compiler used for generating shared-library objects. You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $SHF77 if you need to use a specific compiler or compiler version for Fortran 77 files.

The command line used to compile a Fortran 77 source file to a shared-library object file. You only need to set $SHF77COM if you need to use a specific command line for Fortran 77 files. You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file. If not set, then $SHF77COM or $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran 77 compiler to generated shared-library objects. You only need to set $SHF77FLAGS if you need to define specific user options for Fortran 77 files. You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

The command line used to compile a Fortran 77 source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHF77FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $SHF77PPCOM if you need to use a specific C-preprocessor command line for Fortran 77 files. You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHF77PPCOM or $SHFORTRANPPCOM (the command line) is displayed.

The Fortran 90 compiler used for generating shared-library objects. You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $SHF90 if you need to use a specific compiler or compiler version for Fortran 90 files.

The command line used to compile a Fortran 90 source file to a shared-library object file. You only need to set $SHF90COM if you need to use a specific command line for Fortran 90 files. You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file. If not set, then $SHF90COM or $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran 90 compiler to generated shared-library objects. You only need to set $SHF90FLAGS if you need to define specific user options for Fortran 90 files. You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

The command line used to compile a Fortran 90 source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHF90FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $SHF90PPCOM if you need to use a specific C-preprocessor command line for Fortran 90 files. You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHF90PPCOM or $SHFORTRANPPCOM (the command line) is displayed.

The Fortran 95 compiler used for generating shared-library objects. You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. You only need to set $SHF95 if you need to use a specific compiler or compiler version for Fortran 95 files.

The command line used to compile a Fortran 95 source file to a shared-library object file. You only need to set $SHF95COM if you need to use a specific command line for Fortran 95 files. You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions.

If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file. If not set, then $SHF95COM or $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran 95 compiler to generated shared-library objects. You only need to set $SHF95FLAGS if you need to define specific user options for Fortran 95 files. You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions.

The command line used to compile a Fortran 95 source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHF95FLAGS and $CPPFLAGS construction variables are included on this command line. You only need to set $SHF95PPCOM if you need to use a specific C-preprocessor command line for Fortran 95 files. You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions.

If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHF95PPCOM or $SHFORTRANPPCOM (the command line) is displayed.

The default Fortran compiler used for generating shared-library objects.

The command line used to compile a Fortran source file to a shared-library object file.

If set, the string displayed when a Fortran source file is compiled to a shared-library object file. If not set, then $SHFORTRANCOM (the command line) is displayed.

Options that are passed to the Fortran compiler to generate shared-library objects.

The command line used to compile a Fortran source file to a shared-library object file after first running the file through the C preprocessor. Any options specified in the $SHFORTRANFLAGS and $CPPFLAGS construction variables are included on this command line.

If set, the string displayed when a Fortran source file is compiled to a shared-library object file after first running the file through the C preprocessor. If not set, then $SHFORTRANPPCOM (the command line) is displayed.

Contains the emitter specification for the SharedLibrary builder. The manpage section "Builder Objects" contains general information on specifying emitters.

Instructs the SharedLibrary builder to not create symlinks for versioned shared libraries.

The prefix used for shared library file names.

A macro that automatically generates shared library's SONAME based on $TARGET, $SHLIBVERSION and $SHLIBSUFFIX. Used by SharedLibrary builder when the linker tool supports SONAME (e.g. gnulink).

The suffix used for shared library file names.

When this construction variable is defined, a versioned shared library is created by the SharedLibrary builder. This activates the $_SHLIBVERSIONFLAGS and thus modifies the $SHLINKCOM as required, adds the version number to the library name, and creates the symlinks that are needed. $SHLIBVERSION versions should exist as alpha-numeric, decimal-delimited values as defined by the regular expression "\w+[\.\w+]*". Example $SHLIBVERSION values include '1', '1.2.3', and '1.2.gitaa412c8b'.

This macro automatically introduces extra flags to $SHLINKCOM when building versioned SharedLibrary (that is when $SHLIBVERSION is set). _SHLIBVERSIONFLAGS usually adds $SHLIBVERSIONFLAGS and some extra dynamically generated options (such as -Wl,-soname=$_SHLIBSONAME. It is unused by "plain" (unversioned) shared libraries.

Extra flags added to $SHLINKCOM when building versioned SharedLibrary. These flags are only used when $SHLIBVERSION is set.

The linker for programs that use shared libraries. See also $LINK for linking static objects.

On POSIX systems (those using the link tool), you should normally not change this value as it defaults to a "smart" linker tool which selects a compiler driver matching the type of source files in use. So for example, if you set $SHCXX to a specific compiler name, and are compiling C++ sources, the smartlink function will automatically select the same compiler for linking.

The command line used to link programs using shared libraries. See also $LINKCOM for linking static objects.

The string displayed when programs using shared libraries are linked. If this is not set, then $SHLINKCOM (the command line) is displayed. See also $LINKCOMSTR for linking static objects.

env = Environment(SHLINKCOMSTR = "Linking shared $TARGET")

General user options passed to the linker for programs using shared libraries. Note that this variable should not contain -l (or similar) options for linking with the libraries listed in $LIBS, nor -L (or similar) include search path options that scons generates automatically from $LIBPATH. See $_LIBFLAGS above, for the variable that expands to library-link options, and $_LIBDIRFLAGS above, for the variable that expands to library search path options. See also $LINKFLAGS for linking static objects.

The prefix used for shared object file names.

The suffix used for shared object file names.

Variable used to hard-code SONAME for versioned shared library/loadable module.

env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SONAME='libtest.so.2')

The variable is used, for example, by gnulink linker tool.

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

The URL (web address) of the location from which the project was retrieved. This is used to fill in the Source: field in the controlling information for Ipkg and RPM packages.

See the Package builder.

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

This will construct the SONAME using on the base library name (test in the example below) and use specified SOVERSION to create SONAME.

env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SOVERSION='2')

The variable is used, for example, by gnulink linker tool.

In the example above SONAME would be libtest.so.2 which would be a symlink and point to libtest.so.0.1.2

A command interpreter function that will be called to execute command line strings. The function must expect the following arguments:

def spawn(shell, escape, cmd, args, env):

sh is a string naming the shell program to use. escape is a function that can be called to escape shell special characters in the command line. cmd is the path to the command to be executed. args is the arguments to the command. env is a dictionary of the environment variables in which the command should be executed.

When this variable is true, static objects and shared objects are assumed to be the same; that is, SCons does not check for linking static objects into a shared library.

The dictionary used by the Substfile or Textfile builders for substitution values. It can be anything acceptable to the dict() constructor, so in addition to a dictionary, lists of tuples are also acceptable.

The prefix used for Substfile file names, an empty string by default.

The suffix used for Substfile file names, an empty string by default.

A short summary of what the project is about. This is used to fill in the Summary: field in the controlling information for Ipkg and RPM packages, and as the Description: field in MSI packages.

See the Package builder.

The scripting language wrapper and interface generator.

The suffix that will be used for intermediate C source files generated by the scripting language wrapper and interface generator. The default value is _wrap$CFILESUFFIX. By default, this value is used whenever the -c++ option is not specified as part of the $SWIGFLAGS construction variable.

The command line used to call the scripting language wrapper and interface generator.

The string displayed when calling the scripting language wrapper and interface generator. If this is not set, then $SWIGCOM (the command line) is displayed.

The suffix that will be used for intermediate C++ source files generated by the scripting language wrapper and interface generator. The default value is _wrap$CFILESUFFIX. By default, this value is used whenever the -c++ option is specified as part of the $SWIGFLAGS construction variable.

The suffix that will be used for intermediate C++ header files generated by the scripting language wrapper and interface generator. These are only generated for C++ code when the SWIG 'directors' feature is turned on. The default value is _wrap.h.

General options passed to the scripting language wrapper and interface generator. This is where you should set -python, -perl5, -tcl, or whatever other options you want to specify to SWIG. If you set the -c++ option in this variable, scons will, by default, generate a C++ intermediate source file with the extension that is specified as the $CXXFILESUFFIX variable.

An automatically-generated construction variable containing the SWIG command-line options for specifying directories to be searched for included files. The value of $_SWIGINCFLAGS is created by respectively prepending and appending $SWIGINCPREFIX and $SWIGINCSUFFIX to the beginning and end of each directory in $SWIGPATH.

The prefix used to specify an include directory on the SWIG command line. This will be prepended to the beginning of each directory in the $SWIGPATH construction variable when the $_SWIGINCFLAGS variable is automatically generated.

The suffix used to specify an include directory on the SWIG command line. This will be appended to the end of each directory in the $SWIGPATH construction variable when the $_SWIGINCFLAGS variable is automatically generated.

Specifies the output directory in which the scripting language wrapper and interface generator should place generated language-specific files. This will be used by SCons to identify the files that will be generated by the swig call, and translated into the swig -outdir option on the command line.

The list of directories that the scripting language wrapper and interface generate will search for included files. The SWIG implicit dependency scanner will search these directories for include files. The default value is an empty list.

Don't explicitly put include directory arguments in SWIGFLAGS; the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in SWIGPATH will be looked-up relative to the SConscript directory when they are used in a command. To force scons to look-up a directory relative to the root of the source tree use #:

env = Environment(SWIGPATH='#/include')

The directory look-up can also be forced using the Dir() function:

include = Dir('include')
env = Environment(SWIGPATH=include)

The directory list will be added to command lines through the automatically-generated $_SWIGINCFLAGS construction variable, which is constructed by respectively prepending and appending the values of the $SWIGINCPREFIX and $SWIGINCSUFFIX construction variables to the beginning and end of each directory in $SWIGPATH. Any command lines you define that need the SWIGPATH directory list should include $_SWIGINCFLAGS:

env = Environment(SWIGCOM="my_swig -o $TARGET $_SWIGINCFLAGS $SOURCES")

The version number of the SWIG tool.

The tar archiver.

The command line used to call the tar archiver.

The string displayed when archiving files using the tar archiver. If this is not set, then $TARCOM (the command line) is displayed.

env = Environment(TARCOMSTR = "Archiving $TARGET")

General options passed to the tar archiver.

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

The name of the hardware architecture that objects created using this construction environment should target. Can be set when creating a construction environment by passing as a keyword argument in the Environment call.

On the win32 platform, if the Microsoft Visual C++ compiler is available, msvc tool setup is done using $HOST_ARCH and $TARGET_ARCH. If a value is not specified, will be set to the same value as $HOST_ARCH. Changing the value after the environment is initialized will not cause the tool to be reinitialized. Compiled objects will be in the target architecture if the compilation system supports generating for that target. The latest compiler which can fulfill the requirement will be selected, unless a different version is directed by the value of the $MSVC_VERSION construction variable.

On the win32/msvc combination, valid target arch values are x86, arm, i386 for 32-bit targets and amd64, arm64, x86_64 and ia64 (Itanium) for 64-bit targets. For example, if you want to compile 64-bit binaries, you would set TARGET_ARCH='x86_64' when creating the construction environment. Note that not all target architectures are supported for all Visual Studio / MSVC versions. Check the relevant Microsoft documentation.

$TARGET_ARCH is not currently used by other compilation tools, but the option is reserved to do so in future

The name of the operating system that objects created using this construction environment should target. Can be set when creating a construction environment by passing as a keyword argument in the Environment call;.

$TARGET_OS is not currently used by SCons but the option is reserved to do so in future

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

The suffix used for tar file names.

A callable object used to handle overly long command line strings, since operations which call out to a shell will fail if the line is longer than the shell can accept. This tends to particularly impact linking. The tempfile object stores the command line in a temporary file in the appropriate format, and returns an alternate command line so the invoked tool will make use of the contents of the temporary file. If you need to replace the default tempfile object, the callable should take into account the settings of $MAXLINELENGTH, $TEMPFILEPREFIX, $TEMPFILESUFFIX, $TEMPFILEARGJOIN, $TEMPFILEDIR and $TEMPFILEARGESCFUNC.

The default argument escape function is SCons.Subst.quote_spaces. If you need to apply extra operations on a command argument (to fix Windows slashes, normalize paths, etc.) before writing to the temporary file, you can set the $TEMPFILEARGESCFUNC variable to a custom function. Such a function takes a single string argument and returns a new string with any modifications applied. Example:

import sys
import re
from SCons.Subst import quote_spaces

WINPATHSEP_RE = re.compile(r"\\([^\"'\\]|$)")

def tempfile_arg_esc_func(arg):
    arg = quote_spaces(arg)
    if sys.platform != "win32":
        return arg
    # GCC requires double Windows slashes, let's use UNIX separator
    return WINPATHSEP_RE.sub(r"/\1", arg)

env["TEMPFILEARGESCFUNC"] = tempfile_arg_esc_func

The string to use to join the arguments passed to $TEMPFILE when the command line exceeds the limit set by $MAXLINELENGTH. The default value is a space. However for MSVC, MSLINK the default is a line separator as defined by os.linesep. Note this value is used literally and not expanded by the subst logic.

The directory to create the long-lines temporary file in.

The prefix for the name of the temporary file used to store command lines exceeding $MAXLINELENGTH. The default prefix is '@', which works for the Microsoft and GNU toolchains on Windows. Set this appropriately for other toolchains, for example '-@' for the diab compiler or '-via' for ARM toolchain.

The suffix for the name of the temporary file used to store command lines exceeding $MAXLINELENGTH. The suffix should include the dot ('.') if one is wanted as it will not be added automatically. The default is .lnk.

The TeX formatter and typesetter.

The command line used to call the TeX formatter and typesetter.

The string displayed when calling the TeX formatter and typesetter. If this is not set, then $TEXCOM (the command line) is displayed.

env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES")

General options passed to the TeX formatter and typesetter.

List of directories that the LaTeX program will search for include directories. The LaTeX implicit dependency scanner will search these directories for \include and \import files.

The prefix used for Textfile file names, an empty string by default.

The suffix used for Textfile file names; .txt by default.

A list of the names of the Tool specifications that are part of this construction environment.

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" for more information).

The person or organization who supply the packaged software. This is used to fill in the Vendor: field in the controlling information for RPM packages, and the Manufacturer: field in the controlling information for MSI packages.

See the Package builder.

The version of the project, specified as a string.

See the Package builder.

Specify the location of vswhere.exe.

The vswhere.exe executable is distributed with Microsoft Visual Studio and Build Tools since the 2017 edition, but is also available standalone. It provides full information about installations of 2017 and later editions. With the -legacy argument, vswhere.exe can detect installations of the 2010 through 2015 editions with limited data returned. If VSWHERE is set, SCons will use that location.

Otherwise SCons will look in the following locations and set VSWHERE to the path of the first vswhere.exe located.

Note that VSWHERE must be set at the same time or prior to any of msvc, msvs , and/or mslink Tool being initialized. Either set it as follows

env = Environment(VSWHERE='c:/my/path/to/vswhere')

or if your construction environment is created specifying an empty tools list (or a list of tools which omits all of default, msvs, msvc, and mslink), and also before env.Tool is called to ininitialize any of those tools:

    env = Environment(tools=[])
    env['VSWHERE'] = r'c:/my/vswhere/install/location/vswhere.exe'
    env.Tool('msvc')
    env.Tool('mslink')
    env.Tool('msvs')
    

Set to True to embed the compiler-generated manifest (normally ${TARGET}.manifest) into all Windows executables and DLLs built with this environment, as a resource during their link step. This is done using $MT and $MTEXECOM and $MTSHLIBCOM. See also $WINDOWS_INSERT_MANIFEST.

If set to true, a library build of a Windows shared library (.dll file) will include a reference to the corresponding module-definition file at the same time, if a module-definition file is not already listed as a build target. The name of the module-definition file will be constructed from the base name of the library and the construction variables $WINDOWSDEFSUFFIX and $WINDOWSDEFPREFIX. The default is to not add a module-definition file. The module-definition file is not created by this directive, and must be supplied by the developer.

If set to true, scons will add the manifest file generated by Microsoft Visual C++ 8.0 and later to the target list so SCons will be aware they were generated. In the case of an executable, the manifest file name is constructed using $WINDOWSPROGMANIFESTSUFFIX and $WINDOWSPROGMANIFESTPREFIX. In the case of a shared library, the manifest file name is constructed using $WINDOWSSHLIBMANIFESTSUFFIX and $WINDOWSSHLIBMANIFESTPREFIX. See also $WINDOWS_EMBED_MANIFEST.

The prefix used for a Windows linker module-definition file name. Defaults to empty.

The suffix used for a Windows linker module-definition file name. Defaults to .def.

The prefix used for Windows linker exports file names. Defaults to empty.

The suffix used for Windows linker exports file names. Defaults to .exp.

The prefix used for executable program manifest files generated by Microsoft Visual C/C++. Defaults to empty.

The suffix used for executable program manifest files generated by Microsoft Visual C/C++. Defaults to .manifest.

The prefix used for shared library manifest files generated by Microsoft Visual C/C++. Defaults to empty.

The suffix used for shared library manifest files generated by Microsoft Visual C/C++. Defaults to .manifest.

This is used to fill in the Depends: field in the controlling information for Ipkg packages.

See the Package builder.

This is used to fill in the Description: field in the controlling information for Ipkg packages. The default value is “$SUMMARY\n$DESCRIPTION”

This is used to fill in the Maintainer: field in the controlling information for Ipkg packages.

This is used to fill in the Priority: field in the controlling information for Ipkg packages.

This is used to fill in the Section: field in the controlling information for Ipkg packages.

This is used to fill in the Language: attribute in the controlling information for MSI packages.

See the Package builder.

The text of the software license in RTF format. Carriage return characters will be replaced with the RTF equivalent \\par.

See the Package builder.

TODO

This is used to fill in the AutoReqProv: field in the RPM .spec file.

See the Package builder.

internal, but overridable

This is used to fill in the BuildRequires: field in the RPM .spec file. Note this should only be used on a host managed by rpm as the dependencies will not be resolvable at build time otherwise.

internal, but overridable

internal, but overridable

This is used to fill in the Conflicts: field in the RPM .spec file.

This value is used as the default attributes for the files in the RPM package. The default value is “(-,root,root)”.

This is used to fill in the Distribution: field in the RPM .spec file.

This is used to fill in the Epoch: field in the RPM .spec file.

This is used to fill in the ExcludeArch: field in the RPM .spec file.

This is used to fill in the ExclusiveArch: field in the RPM .spec file.

A list used to supply extra defintions or flags to be added to the RPM .spec file. Each item is added as-is with a carriage return appended. This is useful if some specific RPM feature not otherwise anticipated by SCons needs to be turned on or off. Note if this variable is omitted, SCons will by default supply the value '%global debug_package %{nil}' to disable debug package generation. To enable debug package generation, include this variable set either to None, or to a custom list that does not include the default line. Added in version 3.1.

env.Package(
    NAME="foo",
    ...
    X_RPM_EXTRADEFS=[
        "%define _unpackaged_files_terminate_build 0"
        "%define _missing_doc_files_terminate_build 0"
    ],
    ...
)

This is used to fill in the Group: field in the RPM .spec file.

This is used to fill in the Group(lang): field in the RPM .spec file. Note that lang is not literal and should be replaced by the appropriate language code.

This is used to fill in the Icon: field in the RPM .spec file.

internal, but overridable

This is used to fill in the Packager: field in the RPM .spec file.

This is used to fill in the %post: section in the RPM .spec file.

This is used to fill in the %postun: section in the RPM .spec file.

This is used to fill in the Prefix: field in the RPM .spec file.

This is used to fill in the %pre: section in the RPM .spec file.

internal, but overridable

This is used to fill in the %preun: section in the RPM .spec file.

This is used to fill in the Provides: field in the RPM .spec file.

This is used to fill in the Requires: field in the RPM .spec file.

This is used to fill in the Serial: field in the RPM .spec file.

This is used to fill in the Url: field in the RPM .spec file.

Path to xgettext(1) program (found via Detect()). See xgettext tool and POTUpdate builder.

Complete xgettext command line. See xgettext tool and POTUpdate builder.

A string that is shown when xgettext(1) command is invoked (default: '', which means "print $XGETTEXTCOM"). See xgettext tool and POTUpdate builder.

Internal "macro". Generates xgettext domain name form source and target (default: '${TARGET.filebase}').

Additional flags to xgettext(1). See xgettext tool and POTUpdate builder.

Name of file containing list of xgettext(1)'s source files. Autotools' users know this as POTFILES.in so they will in most cases set XGETTEXTFROM="POTFILES.in" here. The $XGETTEXTFROM files have same syntax and semantics as the well known GNU POTFILES.in. See xgettext tool and POTUpdate builder.

Internal "macro". Genrates list of -D<dir> flags from the $XGETTEXTPATH list.

This flag is used to add single $XGETTEXTFROM file to xgettext(1)'s commandline (default: '-f').

(default: '')

List of directories, there xgettext(1) will look for source files (default: []).

See also xgettext tool and POTUpdate builder.

Internal "macro". Generates list of -f<file> flags from $XGETTEXTFROM.

This flag is used to add single search path to xgettext(1)'s commandline (default: '-D').

(default: '')

The parser generator.

The command line used to call the parser generator to generate a source file.

The string displayed when generating a source file using the parser generator. If this is not set, then $YACCCOM (the command line) is displayed.

env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES")

General options passed to the parser generator. If $YACCFLAGS contains a -d option, SCons assumes that the call will also create a .h file (if the yacc source file ends in a .y suffix) or a .hpp file (if the yacc source file ends in a .yy suffix)

The suffix of the C header file generated by the parser generator when the -d option is used. Note that setting this variable does not cause the parser generator to generate a header file with the specified suffix, it exists to allow you to specify what suffix the parser generator will use of its own accord. The default value is .h.

The suffix of the C++ header file generated by the parser generator when the -d option is used. Note that setting this variable does not cause the parser generator to generate a header file with the specified suffix, it exists to allow you to specify what suffix the parser generator will use of its own accord. The default value is .hpp, except on Mac OS X, where the default is ${TARGET.suffix}.h. because the default bison parser generator just appends .h to the name of the generated C++ file.

The suffix of the file containing the VCG grammar automaton definition when the --graph= option is used. Note that setting this variable does not cause the parser generator to generate a VCG file with the specified suffix, it exists to allow you to specify what suffix the parser generator will use of its own accord. The default value is .vcg.

The zip compression and file packaging utility.

An optional timestamp which overrides the last modification time of the file when stored inside the Zip archive. This is a tuple of six values: Year (>= 1980) Month (one-based) Day of month (one-based) Hours (zero-based) Minutes (zero-based) Seconds (zero-based)

The command line used to call the zip utility, or the internal Python function used to create a zip archive.

The compression flag from the Python zipfile module used by the internal Python function to control whether the zip archive is compressed or not. The default value is zipfile.ZIP_DEFLATED, which creates a compressed zip archive. This value has no effect if the zipfile module is unavailable.

The string displayed when archiving files using the zip utility. If this is not set, then $ZIPCOM (the command line or internal Python function) is displayed.

env = Environment(ZIPCOMSTR = "Zipping $TARGET")

General options passed to the zip utility.

An optional zip root directory (default empty). The filenames stored in the zip file will be relative to this directory, if given. Otherwise the filenames are relative to the current directory of the command. For instance:

env = Environment()
env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1')

will produce a zip file foo.zip containing a file with the name subdir2/file1 rather than subdir1/subdir2/file1.

The suffix used for zip file names.