This appendix contains descriptions of all of the Tools modules that are available "out of the box" in this version of SCons.
Sets construction variables for the 386ASM assembler for the Phar Lap ETS embedded operating system.
Sets: $AS
, $ASCOM
, $ASFLAGS
, $ASPPCOM
, $ASPPFLAGS
.
Uses: $CC
, $CPPFLAGS
, $_CPPDEFFLAGS
, $_CPPINCFLAGS
.
Sets construction variables for the IMB xlc / Visual Age C++ compiler.
Sets: $CXX
, $CXXVERSION
, $SHCXX
, $SHOBJSUFFIX
.
Sets construction variables for the IBM xlc / Visual Age C compiler.
Sets: $CC
, $CCVERSION
, $SHCC
.
Sets construction variables for the IBM Visual Age f77 Fortran compiler.
Sets construction variables for the IBM Visual Age linker.
Sets: $LINKFLAGS
, $SHLIBSUFFIX
, $SHLINKFLAGS
.
Sets construction variables for the Apple linker (similar to the GNU linker).
Sets: $APPLELINK_COMPATIBILITY_VERSION
, $APPLELINK_CURRENT_VERSION
, $APPLELINK_NO_COMPATIBILITY_VERSION
, $APPLELINK_NO_CURRENT_VERSION
, $FRAMEWORKPATHPREFIX
, $LDMODULECOM
, $LDMODULEFLAGS
, $LDMODULEPREFIX
, $LDMODULESUFFIX
, $LINKCOM
, $SHLINKCOM
, $SHLINKFLAGS
, $_APPLELINK_COMPATIBILITY_VERSION
, $_APPLELINK_CURRENT_VERSION
, $_FRAMEWORKPATH
, $_FRAMEWORKS
.
Uses: $FRAMEWORKSFLAGS
.
Sets construction variables for the ar library archiver.
Sets: $AR
, $ARCOM
, $ARFLAGS
, $LIBPREFIX
, $LIBSUFFIX
, $RANLIB
, $RANLIBCOM
, $RANLIBFLAGS
.
Sets construction variables for the as assembler.
Sets: $AS
, $ASCOM
, $ASFLAGS
, $ASPPCOM
, $ASPPFLAGS
.
Uses: $CC
, $CPPFLAGS
, $_CPPDEFFLAGS
, $_CPPINCFLAGS
.
Sets construction variables for the bcc32 compiler.
Sets: $CC
, $CCCOM
, $CCFLAGS
, $CFILESUFFIX
, $CFLAGS
, $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $INCPREFIX
, $INCSUFFIX
, $SHCC
, $SHCCCOM
, $SHCCFLAGS
, $SHCFLAGS
, $SHOBJSUFFIX
.
Uses: $_CPPDEFFLAGS
, $_CPPINCFLAGS
.
Sets construction variables for generic POSIX C compilers.
Sets: $CC
, $CCCOM
, $CCDEPFLAGS
, $CCFLAGS
, $CFILESUFFIX
, $CFLAGS
, $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $FRAMEWORKPATH
, $FRAMEWORKS
, $INCPREFIX
, $INCSUFFIX
, $SHCC
, $SHCCCOM
, $SHCCFLAGS
, $SHCFLAGS
, $SHOBJSUFFIX
.
Uses: $CCCOMSTR
, $PLATFORM
, $SHCCCOMSTR
.
Set construction variables for the Clang C compiler.
Sets: $CC
, $CCDEPFLAGS
, $CCVERSION
, $SHCCFLAGS
.
Set construction variables for the Clang C++ compiler.
Sets: $CXX
, $CXXVERSION
, $SHCXXFLAGS
, $SHOBJSUFFIX
, $STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME
.
Sets up CompilationDatabase
builder which generates a clang tooling compatible compilation database.
Sets: $COMPILATIONDB_COMSTR
, $COMPILATIONDB_PATH_FILTER
, $COMPILATIONDB_USE_ABSPATH
.
Sets construction variables for the Compaq Visual Fortran compiler.
Sets: $FORTRAN
, $FORTRANCOM
, $FORTRANMODDIR
, $FORTRANMODDIRPREFIX
, $FORTRANMODDIRSUFFIX
, $FORTRANPPCOM
, $OBJSUFFIX
, $SHFORTRANCOM
, $SHFORTRANPPCOM
.
Uses: $CPPFLAGS
, $FORTRANFLAGS
, $SHFORTRANFLAGS
, $_CPPDEFFLAGS
, $_FORTRANINCFLAGS
, $_FORTRANMODFLAG
.
Sets construction variables for generic POSIX C++ compilers.
Sets: $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $CXX
, $CXXCOM
, $CXXFILESUFFIX
, $CXXFLAGS
, $INCPREFIX
, $INCSUFFIX
, $OBJSUFFIX
, $SHCXX
, $SHCXXCOM
, $SHCXXFLAGS
, $SHOBJSUFFIX
.
Uses: $CXXCOMSTR
, $SHCXXCOMSTR
.
Set construction variables for cygwin linker/loader.
Sets: $IMPLIBPREFIX
, $IMPLIBSUFFIX
, $LDMODULEVERSIONFLAGS
, $LINKFLAGS
, $RPATHPREFIX
, $RPATHSUFFIX
, $SHLIBPREFIX
, $SHLIBSUFFIX
, $SHLIBVERSIONFLAGS
, $SHLINKCOM
, $SHLINKFLAGS
, $_LDMODULEVERSIONFLAGS
, $_SHLIBVERSIONFLAGS
.
Sets construction variables for a default list of Tool modules.
Use default
in the tools list to retain the original defaults,
since the tools
parameter
is treated as a literal statement of the tools
to be made available in that construction environment, not an addition.
The list of tools selected by default is not static,
but is dependent both on
the platform and on the software installed on the platform.
Some tools will not initialize if an underlying command is
not found, and some tools are selected from a list of choices
on a first-found basis. The finished tool list can be
examined by inspecting the $TOOLS
construction variable
in the construction environment.
On all platforms, the tools from the following list
are selected if their respective conditions are met:
filesystem;,
wix,
lex
, yacc
,
rpcgen
, swig
,
jar
, javac
, javah
, rmic
,
dvipdf
, dvips
, gs
,
tex
, latex
, pdflatex
, pdftex
,
tar
, zip
, textfile
.
On Linux systems, the default tools list selects
(first-found): a C compiler from
gcc
, intelc
, icc
, cc
;
a C++ compiler from
g++
, intelc
, icc
, cXX
;
an assembler from
gas
, nasm
, masm
;
a linker from
gnulink
, ilink
;
a Fortran compiler from
gfortran
, g77
, ifort
, ifl
,
f95
, f90
, f77
;
and a static archiver ar
.
It also selects all found from the list
m4
rpm.
On Windows systems, the default tools list selects
(first-found): a C compiler from
msvc
, mingw
, gcc
, intelc
,
icl
, icc
, cc
, bcc32
;
a C++ compiler from
msvc
, intelc
, icc
, g++
,
cXX
, bcc32
;
an assembler from
masm
, nasm
, gas
, 386asm
;
a linker from
mslink
, gnulink
, ilink
,
linkloc
, ilink32
;
a Fortran compiler from
gfortran
, g77
, ifl
, cvf
,
f95
, f90
, fortran
;
and a static archiver from
mslib
, ar
, tlib
;
It also selects all found from the list
msvs
, midl
.
On MacOS systems, the default tools list selects
(first-found): a C compiler from
gcc
, cc
;
a C++ compiler from
g++
, cXX
;
an assembler as
;
a linker from
applelink
, gnulink
;
a Fortran compiler from
gfortran
, f95
, f90
, g77
;
and a static archiver ar
.
It also selects all found from the list
m4
,
rpm.
Default lists for other platforms can be found by
examining the scons
source code (see
SCons/Tool/__init__.py
).
Sets construction variables for D language compiler DMD.
Sets: $DC
, $DCOM
, $DDEBUG
, $DDEBUGPREFIX
, $DDEBUGSUFFIX
, $DFILESUFFIX
, $DFLAGPREFIX
, $DFLAGS
, $DFLAGSUFFIX
, $DINCPREFIX
, $DINCSUFFIX
, $DLIB
, $DLIBCOM
, $DLIBDIRPREFIX
, $DLIBDIRSUFFIX
, $DLIBFLAGPREFIX
, $DLIBFLAGSUFFIX
, $DLIBLINKPREFIX
, $DLIBLINKSUFFIX
, $DLINK
, $DLINKCOM
, $DLINKFLAGPREFIX
, $DLINKFLAGS
, $DLINKFLAGSUFFIX
, $DPATH
, $DRPATHPREFIX
, $DRPATHSUFFIX
, $DVERPREFIX
, $DVERSIONS
, $DVERSUFFIX
, $SHDC
, $SHDCOM
, $SHDLIBVERSIONFLAGS
, $SHDLINK
, $SHDLINKCOM
, $SHDLINKFLAGS
.
This tool tries to make working with Docbook in SCons a little easier. It provides several toolchains for creating different output formats, like HTML or PDF. Contained in the package is a distribution of the Docbook XSL stylesheets as of version 1.76.1. As long as you don't specify your own stylesheets for customization, these official versions are picked as default...which should reduce the inevitable setup hassles for you.
Implicit dependencies to images and XIncludes are detected automatically
if you meet the HTML requirements. The additional
stylesheet utils/xmldepend.xsl
by Paul DuBois is used for this purpose.
Note, that there is no support for XML catalog resolving offered! This tool calls the XSLT processors and PDF renderers with the stylesheets you specified, that's it. The rest lies in your hands and you still have to know what you're doing when resolving names via a catalog.
For activating the tool "docbook", you have to add its name to the Environment constructor, like this
env = Environment(tools=['docbook'])
On its startup, the docbook
tool tries to find a required xsltproc
processor, and
a PDF renderer, e.g. fop. So make sure that these are added to your system's environment
PATH
and can be called directly without specifying their full path.
For the most basic processing of Docbook to HTML, you need to have installed
the Python lxml
binding to libxml2
, or
a standalone XSLT processor, currently detected are xsltproc, saxon, saxon-xslt and xalan.
Rendering to PDF requires you to have one of the applications fop or xep installed.
Creating a HTML or PDF document is very simple and straightforward. Say
env = Environment(tools=['docbook']) env.DocbookHtml('manual.html', 'manual.xml') env.DocbookPdf('manual.pdf', 'manual.xml')
to get both outputs from your XML source manual.xml
. As a shortcut, you can
give the stem of the filenames alone, like this:
env = Environment(tools=['docbook']) env.DocbookHtml('manual') env.DocbookPdf('manual')
and get the same result. Target and source lists are also supported:
env = Environment(tools=['docbook']) env.DocbookHtml(['manual.html','reference.html'], ['manual.xml','reference.xml'])
or even
env = Environment(tools=['docbook']) env.DocbookHtml(['manual','reference'])
Whenever you leave out the list of sources, you may not specify a file extension! The Tool uses the given names as file stems, and adds the suffixes for target and source files accordingly.
The rules given above are valid for the Builders DocbookHtml
,
DocbookPdf
, DocbookEpub
, DocbookSlidesPdf
and DocbookXInclude
. For the
DocbookMan
transformation you
can specify a target name, but the actual output names are automatically
set from the refname
entries in your XML source.
The Builders DocbookHtmlChunked
, DocbookHtmlhelp
and
DocbookSlidesHtml
are special, in that:
they create a large set of files, where the exact names and their number depend on the content of the source file, and
the main target is always named index.html
, i.e. the output name for the
XSL transformation is not picked up by the stylesheets.
As a result, there is simply no use in specifying a target HTML name. So the basic syntax for these builders is always:
env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual')
If you want to use a specific XSL file, you can set the
additional xsl
parameter to your
Builder call as follows:
env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl')
Since this may get tedious if you always use the same local naming for your customized XSL files,
e.g. html.xsl
for HTML and pdf.xsl
for PDF output, a set of
variables for setting the default XSL name is provided. These are:
DOCBOOK_DEFAULT_XSL_HTML DOCBOOK_DEFAULT_XSL_HTMLCHUNKED DOCBOOK_DEFAULT_XSL_HTMLHELP DOCBOOK_DEFAULT_XSL_PDF DOCBOOK_DEFAULT_XSL_EPUB DOCBOOK_DEFAULT_XSL_MAN DOCBOOK_DEFAULT_XSL_SLIDESPDF DOCBOOK_DEFAULT_XSL_SLIDESHTML
and you can set them when constructing your environment:
env = Environment( tools=['docbook'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl', ) env.DocbookHtml('manual') # now uses html.xsl
Sets: $DOCBOOK_DEFAULT_XSL_EPUB
, $DOCBOOK_DEFAULT_XSL_HTML
, $DOCBOOK_DEFAULT_XSL_HTMLCHUNKED
, $DOCBOOK_DEFAULT_XSL_HTMLHELP
, $DOCBOOK_DEFAULT_XSL_MAN
, $DOCBOOK_DEFAULT_XSL_PDF
, $DOCBOOK_DEFAULT_XSL_SLIDESHTML
, $DOCBOOK_DEFAULT_XSL_SLIDESPDF
, $DOCBOOK_FOP
, $DOCBOOK_FOPCOM
, $DOCBOOK_FOPFLAGS
, $DOCBOOK_XMLLINT
, $DOCBOOK_XMLLINTCOM
, $DOCBOOK_XMLLINTFLAGS
, $DOCBOOK_XSLTPROC
, $DOCBOOK_XSLTPROCCOM
, $DOCBOOK_XSLTPROCFLAGS
, $DOCBOOK_XSLTPROCPARAMS
.
Uses: $DOCBOOK_FOPCOMSTR
, $DOCBOOK_XMLLINTCOMSTR
, $DOCBOOK_XSLTPROCCOMSTR
.
Attaches the DVI
builder to the
construction environment.
Sets construction variables for the dvipdf utility.
Sets: $DVIPDF
, $DVIPDFCOM
, $DVIPDFFLAGS
.
Uses: $DVIPDFCOMSTR
.
Sets construction variables for the dvips utility.
Sets: $DVIPS
, $DVIPSFLAGS
, $PSCOM
, $PSPREFIX
, $PSSUFFIX
.
Uses: $PSCOMSTR
.
Set construction variables for generic POSIX Fortran 03 compilers.
Sets: $F03
, $F03COM
, $F03FLAGS
, $F03PPCOM
, $SHF03
, $SHF03COM
, $SHF03FLAGS
, $SHF03PPCOM
, $_F03INCFLAGS
.
Uses: $F03COMSTR
, $F03PPCOMSTR
, $FORTRANCOMMONFLAGS
, $SHF03COMSTR
, $SHF03PPCOMSTR
.
Set construction variables for generic POSIX Fortran 08 compilers.
Sets: $F08
, $F08COM
, $F08FLAGS
, $F08PPCOM
, $SHF08
, $SHF08COM
, $SHF08FLAGS
, $SHF08PPCOM
, $_F08INCFLAGS
.
Uses: $F08COMSTR
, $F08PPCOMSTR
, $FORTRANCOMMONFLAGS
, $SHF08COMSTR
, $SHF08PPCOMSTR
.
Set construction variables for generic POSIX Fortran 77 compilers.
Sets: $F77
, $F77COM
, $F77FILESUFFIXES
, $F77FLAGS
, $F77PPCOM
, $F77PPFILESUFFIXES
, $FORTRAN
, $FORTRANCOM
, $FORTRANFLAGS
, $SHF77
, $SHF77COM
, $SHF77FLAGS
, $SHF77PPCOM
, $SHFORTRAN
, $SHFORTRANCOM
, $SHFORTRANFLAGS
, $SHFORTRANPPCOM
, $_F77INCFLAGS
.
Uses: $F77COMSTR
, $F77PPCOMSTR
, $FORTRANCOMMONFLAGS
, $FORTRANCOMSTR
, $FORTRANFLAGS
, $FORTRANPPCOMSTR
, $SHF77COMSTR
, $SHF77PPCOMSTR
, $SHFORTRANCOMSTR
, $SHFORTRANFLAGS
, $SHFORTRANPPCOMSTR
.
Set construction variables for generic POSIX Fortran 90 compilers.
Sets: $F90
, $F90COM
, $F90FLAGS
, $F90PPCOM
, $SHF90
, $SHF90COM
, $SHF90FLAGS
, $SHF90PPCOM
, $_F90INCFLAGS
.
Uses: $F90COMSTR
, $F90PPCOMSTR
, $FORTRANCOMMONFLAGS
, $SHF90COMSTR
, $SHF90PPCOMSTR
.
Set construction variables for generic POSIX Fortran 95 compilers.
Sets: $F95
, $F95COM
, $F95FLAGS
, $F95PPCOM
, $SHF95
, $SHF95COM
, $SHF95FLAGS
, $SHF95PPCOM
, $_F95INCFLAGS
.
Uses: $F95COMSTR
, $F95PPCOMSTR
, $FORTRANCOMMONFLAGS
, $SHF95COMSTR
, $SHF95PPCOMSTR
.
Set construction variables for generic POSIX Fortran compilers.
Sets: $FORTRAN
, $FORTRANCOM
, $FORTRANFLAGS
, $SHFORTRAN
, $SHFORTRANCOM
, $SHFORTRANFLAGS
, $SHFORTRANPPCOM
.
Uses: $CPPFLAGS
, $FORTRANCOMSTR
, $FORTRANPPCOMSTR
, $SHFORTRANCOMSTR
, $SHFORTRANPPCOMSTR
, $_CPPDEFFLAGS
.
Set construction variables for the g++ C++ compiler.
Sets: $CXX
, $CXXVERSION
, $SHCXXFLAGS
, $SHOBJSUFFIX
.
Set construction variables for the g77 Fortran compiler.
Sets: $F77
, $F77COM
, $F77FILESUFFIXES
, $F77PPCOM
, $F77PPFILESUFFIXES
, $FORTRAN
, $FORTRANCOM
, $FORTRANPPCOM
, $SHF77
, $SHF77COM
, $SHF77FLAGS
, $SHF77PPCOM
, $SHFORTRAN
, $SHFORTRANCOM
, $SHFORTRANFLAGS
, $SHFORTRANPPCOM
.
Uses: $F77FLAGS
, $FORTRANCOMMONFLAGS
, $FORTRANFLAGS
.
Sets construction variables for the gas assembler.
Calls the as
tool.
Sets: $AS
.
Set construction variables for the gcc C compiler.
Sets: $CC
, $CCDEPFLAGS
, $CCVERSION
, $SHCCFLAGS
.
Sets construction variables for the D language compiler GDC.
Sets: $DC
, $DCOM
, $DDEBUG
, $DDEBUGPREFIX
, $DDEBUGSUFFIX
, $DFILESUFFIX
, $DFLAGPREFIX
, $DFLAGS
, $DFLAGSUFFIX
, $DINCPREFIX
, $DINCSUFFIX
, $DLIB
, $DLIBCOM
, $DLIBDIRPREFIX
, $DLIBDIRSUFFIX
, $DLIBFLAGPREFIX
, $DLIBFLAGSUFFIX
, $DLIBLINKPREFIX
, $DLIBLINKSUFFIX
, $DLINK
, $DLINKCOM
, $DLINKFLAGPREFIX
, $DLINKFLAGS
, $DLINKFLAGSUFFIX
, $DPATH
, $DRPATHPREFIX
, $DRPATHSUFFIX
, $DVERPREFIX
, $DVERSIONS
, $DVERSUFFIX
, $SHDC
, $SHDCOM
, $SHDLIBVERSIONFLAGS
, $SHDLINK
, $SHDLINKCOM
, $SHDLINKFLAGS
.
This is actually a toolset, which supports internationalization and localization of software being constructed with SCons. The toolset loads following tools:
When you enable gettext
, it internally loads all abovementioned tools,
so you're encouraged to see their individual documentation.
Each of the above tools provides its own builder(s) which may be used to
perform particular activities related to software internationalization. You
may be however interested in top-level
Translate
builder.
To use gettext
tools add 'gettext'
tool to your
environment:
env = Environment( tools = ['default', 'gettext'] )
Sets construction variables for the GNU Fortran compiler.
Calls the fortran
Tool module to set variables.
Sets: $F77
, $F90
, $F95
, $FORTRAN
, $SHF77
, $SHF77FLAGS
, $SHF90
, $SHF90FLAGS
, $SHF95
, $SHF95FLAGS
, $SHFORTRAN
, $SHFORTRANFLAGS
.
Set construction variables for GNU linker/loader.
Sets: $LDMODULEVERSIONFLAGS
, $RPATHPREFIX
, $RPATHSUFFIX
, $SHLIBVERSIONFLAGS
, $SHLINKFLAGS
, $_LDMODULESONAME
, $_SHLIBSONAME
.
This Tool sets the required construction variables for working with
the Ghostscript software. It also registers an appropriate Action
with the PDF
Builder, such that the conversion from
PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain.
Finally, it adds an explicit Gs
Builder for Ghostscript
to the environment.
Uses: $GSCOMSTR
.
Set construction variables for the compilers aCC on HP/UX systems.
Set construction variables for
aCC compilers on HP/UX systems.
Calls the cXX
tool for additional variables.
Sets: $CXX
, $CXXVERSION
, $SHCXXFLAGS
.
Sets construction variables for the linker on HP/UX systems.
Sets: $LINKFLAGS
, $SHLIBSUFFIX
, $SHLINKFLAGS
.
Sets construction variables for the icc compiler on OS/2 systems.
Sets: $CC
, $CCCOM
, $CFILESUFFIX
, $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $CXXCOM
, $CXXFILESUFFIX
, $INCPREFIX
, $INCSUFFIX
.
Uses: $CCFLAGS
, $CFLAGS
, $CPPFLAGS
, $_CPPDEFFLAGS
, $_CPPINCFLAGS
.
Sets construction variables for the Intel C/C++ compiler.
Calls the intelc
Tool module to set its variables.
Sets construction variables for the Intel Fortran compiler.
Sets: $FORTRAN
, $FORTRANCOM
, $FORTRANPPCOM
, $SHFORTRANCOM
, $SHFORTRANPPCOM
.
Uses: $CPPFLAGS
, $FORTRANFLAGS
, $_CPPDEFFLAGS
, $_FORTRANINCFLAGS
.
Sets construction variables for newer versions of the Intel Fortran compiler for Linux.
Sets: $F77
, $F90
, $F95
, $FORTRAN
, $SHF77
, $SHF77FLAGS
, $SHF90
, $SHF90FLAGS
, $SHF95
, $SHF95FLAGS
, $SHFORTRAN
, $SHFORTRANFLAGS
.
Sets construction variables for the ilink linker on OS/2 systems.
Sets: $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $LINKFLAGS
.
Sets construction variables for the Borland ilink32 linker.
Sets: $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $LINKFLAGS
.
Sets construction variables for file and directory installation.
Sets: $INSTALL
, $INSTALLSTR
.
Sets construction variables for the Intel C/C++ compiler
(Linux and Windows, version 7 and later).
Calls the gcc
or msvc
(on Linux and Windows, respectively)
tool to set underlying variables.
Sets: $AR
, $CC
, $CXX
, $INTEL_C_COMPILER_VERSION
, $LINK
.
Sets construction variables for the jar utility.
Sets: $JAR
, $JARCOM
, $JARFLAGS
, $JARSUFFIX
.
Uses: $JARCOMSTR
.
Sets construction variables for the javac compiler.
Sets: $JAVABOOTCLASSPATH
, $JAVAC
, $JAVACCOM
, $JAVACFLAGS
, $JAVACLASSPATH
, $JAVACLASSSUFFIX
, $JAVAINCLUDES
, $JAVASOURCEPATH
, $JAVASUFFIX
.
Uses: $JAVACCOMSTR
.
Sets construction variables for the javah tool.
Sets: $JAVACLASSSUFFIX
, $JAVAH
, $JAVAHCOM
, $JAVAHFLAGS
.
Uses: $JAVACLASSPATH
, $JAVAHCOMSTR
.
Sets construction variables for the latex utility.
Sets: $LATEX
, $LATEXCOM
, $LATEXFLAGS
.
Uses: $LATEXCOMSTR
.
Sets construction variables for the D language compiler LDC2.
Sets: $DC
, $DCOM
, $DDEBUG
, $DDEBUGPREFIX
, $DDEBUGSUFFIX
, $DFILESUFFIX
, $DFLAGPREFIX
, $DFLAGS
, $DFLAGSUFFIX
, $DINCPREFIX
, $DINCSUFFIX
, $DLIB
, $DLIBCOM
, $DLIBDIRPREFIX
, $DLIBDIRSUFFIX
, $DLIBFLAGPREFIX
, $DLIBFLAGSUFFIX
, $DLIBLINKPREFIX
, $DLIBLINKSUFFIX
, $DLINK
, $DLINKCOM
, $DLINKFLAGPREFIX
, $DLINKFLAGS
, $DLINKFLAGSUFFIX
, $DPATH
, $DRPATHPREFIX
, $DRPATHSUFFIX
, $DVERPREFIX
, $DVERSIONS
, $DVERSUFFIX
, $SHDC
, $SHDCOM
, $SHDLIBVERSIONFLAGS
, $SHDLINK
, $SHDLINKCOM
, $SHDLINKFLAGS
.
Sets construction variables for the lex lexical analyser.
Sets: $LEX
, $LEXCOM
, $LEXFLAGS
, $LEXUNISTD
.
Uses: $LEXCOMSTR
, $LEXFLAGS
, $LEX_HEADER_FILE
, $LEX_TABLES_FILE
.
Sets construction variables for generic POSIX linkers. This is a "smart" linker tool which selects a compiler to complete the linking based on the types of source files.
Sets: $LDMODULE
, $LDMODULECOM
, $LDMODULEFLAGS
, $LDMODULENOVERSIONSYMLINKS
, $LDMODULEPREFIX
, $LDMODULESUFFIX
, $LDMODULEVERSION
, $LDMODULEVERSIONFLAGS
, $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $LINKFLAGS
, $SHLIBSUFFIX
, $SHLINK
, $SHLINKCOM
, $SHLINKFLAGS
, $__LDMODULEVERSIONFLAGS
, $__SHLIBVERSIONFLAGS
.
Uses: $LDMODULECOMSTR
, $LINKCOMSTR
, $SHLINKCOMSTR
.
Sets construction variables for the LinkLoc linker for the Phar Lap ETS embedded operating system.
Sets: $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $LINKFLAGS
, $SHLINK
, $SHLINKCOM
, $SHLINKFLAGS
.
Uses: $LINKCOMSTR
, $SHLINKCOMSTR
.
Sets construction variables for the m4 macro processor.
Uses: $M4COMSTR
.
Sets construction variables for the Microsoft assembler.
Sets: $AS
, $ASCOM
, $ASFLAGS
, $ASPPCOM
, $ASPPFLAGS
.
Uses: $ASCOMSTR
, $ASPPCOMSTR
, $CPPFLAGS
, $_CPPDEFFLAGS
, $_CPPINCFLAGS
.
Sets construction variables for the Microsoft IDL compiler.
Sets: $MIDL
, $MIDLCOM
, $MIDLFLAGS
.
Uses: $MIDLCOMSTR
.
Sets construction variables for MinGW (Minimal Gnu on Windows).
Sets: $AS
, $CC
, $CXX
, $LDMODULECOM
, $LIBPREFIX
, $LIBSUFFIX
, $OBJSUFFIX
, $RC
, $RCCOM
, $RCFLAGS
, $RCINCFLAGS
, $RCINCPREFIX
, $RCINCSUFFIX
, $SHCCFLAGS
, $SHCXXFLAGS
, $SHLINKCOM
, $SHLINKFLAGS
, $SHOBJSUFFIX
, $WINDOWSDEFPREFIX
, $WINDOWSDEFSUFFIX
.
Uses: $RCCOMSTR
, $SHLINKCOMSTR
.
This scons tool is a part of scons gettext
toolset. It provides scons
interface to msgfmt(1) command, which generates binary
message catalog (MO
) from a textual translation description
(PO
).
Sets: $MOSUFFIX
, $MSGFMT
, $MSGFMTCOM
, $MSGFMTCOMSTR
, $MSGFMTFLAGS
, $POSUFFIX
.
Uses: $LINGUAS_FILE
.
This scons tool is a part of scons gettext
toolset. It provides
scons interface to msginit(1) program, which creates new
PO
file, initializing the meta information with values from
user's environment (or options).
Sets: $MSGINIT
, $MSGINITCOM
, $MSGINITCOMSTR
, $MSGINITFLAGS
, $POAUTOINIT
, $POCREATE_ALIAS
, $POSUFFIX
, $POTSUFFIX
, $_MSGINITLOCALE
.
Uses: $LINGUAS_FILE
, $POAUTOINIT
, $POTDOMAIN
.
This scons tool is a part of scons gettext
toolset. It provides
scons interface to msgmerge(1) command, which merges two
Uniform style .po
files together.
Sets: $MSGMERGE
, $MSGMERGECOM
, $MSGMERGECOMSTR
, $MSGMERGEFLAGS
, $POSUFFIX
, $POTSUFFIX
, $POUPDATE_ALIAS
.
Uses: $LINGUAS_FILE
, $POAUTOINIT
, $POTDOMAIN
.
Sets construction variables for the Microsoft mslib library archiver.
Sets: $AR
, $ARCOM
, $ARFLAGS
, $LIBPREFIX
, $LIBSUFFIX
.
Uses: $ARCOMSTR
.
Sets construction variables for the Microsoft linker.
Sets: $LDMODULE
, $LDMODULECOM
, $LDMODULEFLAGS
, $LDMODULEPREFIX
, $LDMODULESUFFIX
, $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $LINKFLAGS
, $REGSVR
, $REGSVRCOM
, $REGSVRFLAGS
, $SHLINK
, $SHLINKCOM
, $SHLINKFLAGS
, $WINDOWSDEFPREFIX
, $WINDOWSDEFSUFFIX
, $WINDOWSEXPPREFIX
, $WINDOWSEXPSUFFIX
, $WINDOWSPROGMANIFESTPREFIX
, $WINDOWSPROGMANIFESTSUFFIX
, $WINDOWSSHLIBMANIFESTPREFIX
, $WINDOWSSHLIBMANIFESTSUFFIX
, $WINDOWS_INSERT_DEF
.
Uses: $LDMODULECOMSTR
, $LINKCOMSTR
, $REGSVRCOMSTR
, $SHLINKCOMSTR
.
Sets variables for Microsoft Platform SDK and/or Windows SDK.
Note that unlike most other Tool modules,
mssdk does not set construction variables,
but sets the environment variables
in the environment SCons uses to execute
the Microsoft toolchain:
%INCLUDE%
,
%LIB%
,
%LIBPATH%
and
%PATH%
.
Uses: $MSSDK_DIR
, $MSSDK_VERSION
, $MSVS_VERSION
.
Sets construction variables for the Microsoft Visual C++ compiler.
Sets: $BUILDERS
, $CC
, $CCCOM
, $CCDEPFLAGS
, $CCFLAGS
, $CCPCHFLAGS
, $CCPDBFLAGS
, $CFILESUFFIX
, $CFLAGS
, $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $CXX
, $CXXCOM
, $CXXFILESUFFIX
, $CXXFLAGS
, $INCPREFIX
, $INCSUFFIX
, $OBJPREFIX
, $OBJSUFFIX
, $PCHCOM
, $PCHPDBFLAGS
, $RC
, $RCCOM
, $RCFLAGS
, $SHCC
, $SHCCCOM
, $SHCCFLAGS
, $SHCFLAGS
, $SHCXX
, $SHCXXCOM
, $SHCXXFLAGS
, $SHOBJPREFIX
, $SHOBJSUFFIX
.
Uses: $CCCOMSTR
, $CXXCOMSTR
, $MSVC_NOTFOUND_POLICY
, $MSVC_SCRIPTERROR_POLICY
, $MSVC_SCRIPT_ARGS
, $MSVC_SDK_VERSION
, $MSVC_SPECTRE_LIBS
, $MSVC_TOOLSET_VERSION
, $MSVC_USE_SCRIPT
, $MSVC_USE_SCRIPT_ARGS
, $MSVC_USE_SETTINGS
, $MSVC_VERSION
, $PCH
, $PCHSTOP
, $PDB
, $SHCCCOMSTR
, $SHCXXCOMSTR
.
Sets construction variables for Microsoft Visual Studio.
Sets: $MSVSBUILDCOM
, $MSVSCLEANCOM
, $MSVSENCODING
, $MSVSPROJECTCOM
, $MSVSREBUILDCOM
, $MSVSSCONS
, $MSVSSCONSCOM
, $MSVSSCONSCRIPT
, $MSVSSCONSFLAGS
, $MSVSSOLUTIONCOM
.
Sets construction variables for the Metrowerks CodeWarrior compiler.
Sets: $CC
, $CCCOM
, $CFILESUFFIX
, $CPPDEFPREFIX
, $CPPDEFSUFFIX
, $CXX
, $CXXCOM
, $CXXFILESUFFIX
, $INCPREFIX
, $INCSUFFIX
, $MWCW_VERSION
, $MWCW_VERSIONS
, $SHCC
, $SHCCCOM
, $SHCCFLAGS
, $SHCFLAGS
, $SHCXX
, $SHCXXCOM
, $SHCXXFLAGS
.
Uses: $CCCOMSTR
, $CXXCOMSTR
, $SHCCCOMSTR
, $SHCXXCOMSTR
.
Sets construction variables for the Metrowerks CodeWarrior linker.
Sets: $AR
, $ARCOM
, $LIBDIRPREFIX
, $LIBDIRSUFFIX
, $LIBLINKPREFIX
, $LIBLINKSUFFIX
, $LINK
, $LINKCOM
, $SHLINK
, $SHLINKCOM
, $SHLINKFLAGS
.
Sets construction variables for the nasm Netwide Assembler.
Sets: $AS
, $ASCOM
, $ASFLAGS
, $ASPPCOM
, $ASPPFLAGS
.
Uses: $ASCOMSTR
, $ASPPCOMSTR
.
Sets up the Ninja
builder, which generates a ninja build file, and then optionally runs ninja.
This is an experimental feature. This functionality is subject to change and/or removal without a deprecation cycle.
Sets: $IMPLICIT_COMMAND_DEPENDENCIES
, $NINJA_ALIAS_NAME
, $NINJA_CMD_ARGS
, $NINJA_COMPDB_EXPAND
, $NINJA_DEPFILE_PARSE_FORMAT
, $NINJA_DIR
, $NINJA_DISABLE_AUTO_RUN
, $NINJA_ENV_VAR_CACHE
, $NINJA_FILE_NAME
, $NINJA_FORCE_SCONS_BUILD
, $NINJA_GENERATED_SOURCE_ALIAS_NAME
, $NINJA_GENERATED_SOURCE_SUFFIXES
, $NINJA_MSVC_DEPS_PREFIX
, $NINJA_POOL
, $NINJA_REGENERATE_DEPS
, $NINJA_SCONS_DAEMON_KEEP_ALIVE
, $NINJA_SCONS_DAEMON_PORT
, $NINJA_SYNTAX
, $_NINJA_REGENERATE_DEPS_FUNC
.
Uses: $AR
, $ARCOM
, $ARFLAGS
, $CC
, $CCCOM
, $CCDEPFLAGS
, $CCFLAGS
, $CXX
, $CXXCOM
, $ESCAPE
, $LINK
, $LINKCOM
, $PLATFORM
, $PRINT_CMD_LINE_FUNC
, $PROGSUFFIX
, $RANLIB
, $RANLIBCOM
, $SHCCCOM
, $SHCXXCOM
, $SHLINK
, $SHLINKCOM
.
Sets construction variables for the Package
Builder.
If this tool is enabled, the --package-type
command-line option is also enabled.
Sets construction variables for the Portable Document Format builder.
Sets: $PDFPREFIX
, $PDFSUFFIX
.
Sets construction variables for the pdflatex utility.
Sets: $LATEXRETRIES
, $PDFLATEX
, $PDFLATEXCOM
, $PDFLATEXFLAGS
.
Uses: $PDFLATEXCOMSTR
.
Sets construction variables for the pdftex utility.
Sets: $LATEXRETRIES
, $PDFLATEX
, $PDFLATEXCOM
, $PDFLATEXFLAGS
, $PDFTEX
, $PDFTEXCOM
, $PDFTEXFLAGS
.
Uses: $PDFLATEXCOMSTR
, $PDFTEXCOMSTR
.
Loads the Python source scanner into the invoking environment. When loaded, the scanner will attempt to find implicit dependencies for any Python source files in the list of sources provided to an Action that uses this environment.
Available since scons 4.0..
Placeholder tool to alert anyone still using qt tools to switch to qt3 or newer tool.
Sets construction variables for building Qt3 applications.
This tool is only suitable for building targeted to Qt3, which is obsolete (the tool is deprecated since 4.3, and was renamed to qt3 in 4.5.0. ). There are contributed tools for Qt4 and Qt5, see https://github.com/SCons/scons-contrib. Qt4 has also passed end of life for standard support (in Dec 2015).
Note paths for these construction variables are assembled
using the os.path.join
method
so they will have the appropriate separator at runtime,
but are listed here in the various
entries only with the '/'
separator
for simplicity.
In addition, the construction variables
$CPPPATH
,
$LIBPATH
and
$LIBS
may be modified
and the variables
$PROGEMITTER
, $SHLIBEMITTER
and $LIBEMITTER
are modified. Because the build-performance is affected when using this tool,
you have to explicitly specify it at Environment creation:
Environment(tools=['default','qt3'])
The qt3
tool supports the following operations:
Automatic moc file generation from header files.
You do not have to specify moc files explicitly, the tool does it for you.
However, there are a few preconditions to do so: Your header file must have
the same filebase as your implementation file and must stay in the same
directory. It must have one of the suffixes
.h
,
.hpp
,
.H
,
.hxx
,
.hh
.
You can turn off automatic moc file generation by setting
$QT3_AUTOSCAN
to False
.
See also the corresponding
Moc
Builder.
Automatic moc file generation from C++ files.
As described in the Qt documentation, include the moc file at the end of
the C++ file. Note that you have to include the file, which is generated
by the transformation
${QT3_MOCCXXPREFIX}<basename>${QT3_MOCCXXSUFFIX}
, by default
<basename>.mo
. A warning is generated after building the moc file if you
do not include the correct file. If you are using VariantDir
, you may
need to specify duplicate=True
.
You can turn off automatic moc file generation by setting $QT3_AUTOSCAN
to
False
. See also the corresponding
Moc
Builder.
Automatic handling of .ui files.
The implementation files generated from .ui
files are handled much the same as yacc or lex files.
Each .ui file given as a source of Program
,
Library
or SharedLibrary
will generate three files: the declaration file, the
implementation file and a moc file. Because there are also generated headers,
you may need to specify duplicate=True
in calls to
VariantDir
.
See also the corresponding
Uic
Builder.
Sets: $QT3DIR
, $QT3_AUTOSCAN
, $QT3_BINPATH
, $QT3_CPPPATH
, $QT3_LIB
, $QT3_LIBPATH
, $QT3_MOC
, $QT3_MOCCXXPREFIX
, $QT3_MOCCXXSUFFIX
, $QT3_MOCFROMCXXCOM
, $QT3_MOCFROMCXXFLAGS
, $QT3_MOCFROMHCOM
, $QT3_MOCFROMHFLAGS
, $QT3_MOCHPREFIX
, $QT3_MOCHSUFFIX
, $QT3_UIC
, $QT3_UICCOM
, $QT3_UICDECLFLAGS
, $QT3_UICDECLPREFIX
, $QT3_UICDECLSUFFIX
, $QT3_UICIMPLFLAGS
, $QT3_UICIMPLPREFIX
, $QT3_UICIMPLSUFFIX
, $QT3_UISUFFIX
.
Uses: $QT3DIR
.
Sets construction variables for the rmic utility.
Sets: $JAVACLASSSUFFIX
, $RMIC
, $RMICCOM
, $RMICFLAGS
.
Uses: $RMICCOMSTR
.
Sets construction variables for building with RPCGEN.
Sets: $RPCGEN
, $RPCGENCLIENTFLAGS
, $RPCGENFLAGS
, $RPCGENHEADERFLAGS
, $RPCGENSERVICEFLAGS
, $RPCGENXDRFLAGS
.
Sets construction variables for the SGI library archiver.
Sets: $AR
, $ARCOMSTR
, $ARFLAGS
, $LIBPREFIX
, $LIBSUFFIX
, $SHLINK
, $SHLINKFLAGS
.
Uses: $ARCOMSTR
, $SHLINKCOMSTR
.
Sets construction variables for the SGI C++ compiler.
Sets: $CXX
, $CXXFLAGS
, $SHCXX
, $SHOBJSUFFIX
.
Sets construction variables for the SGI C compiler.
Sets: $CXX
, $SHOBJSUFFIX
.
Sets construction variables for the SGI linker.
Sets: $LINK
, $RPATHPREFIX
, $RPATHSUFFIX
, $SHLINKFLAGS
.
Sets construction variables for the Sun library archiver.
Sets: $AR
, $ARCOM
, $ARFLAGS
, $LIBPREFIX
, $LIBSUFFIX
.
Uses: $ARCOMSTR
.
Sets construction variables for the Sun C++ compiler.
Sets: $CXX
, $CXXVERSION
, $SHCXX
, $SHCXXFLAGS
, $SHOBJPREFIX
, $SHOBJSUFFIX
.
Sets construction variables for the Sun C compiler.
Sets: $CXX
, $SHCCFLAGS
, $SHOBJPREFIX
, $SHOBJSUFFIX
.
Set construction variables for the Sun f77 Fortran compiler.
Sets: $F77
, $FORTRAN
, $SHF77
, $SHF77FLAGS
, $SHFORTRAN
, $SHFORTRANFLAGS
.
Set construction variables for the Sun f90 Fortran compiler.
Sets: $F90
, $FORTRAN
, $SHF90
, $SHF90FLAGS
, $SHFORTRAN
, $SHFORTRANFLAGS
.
Set construction variables for the Sun f95 Fortran compiler.
Sets: $F95
, $FORTRAN
, $SHF95
, $SHF95FLAGS
, $SHFORTRAN
, $SHFORTRANFLAGS
.
Sets construction variables for the Sun linker.
Sets: $RPATHPREFIX
, $RPATHSUFFIX
, $SHLINKFLAGS
.
Sets construction variables for the SWIG interface compiler.
Sets: $SWIG
, $SWIGCFILESUFFIX
, $SWIGCOM
, $SWIGCXXFILESUFFIX
, $SWIGDIRECTORSUFFIX
, $SWIGFLAGS
, $SWIGINCPREFIX
, $SWIGINCSUFFIX
, $SWIGPATH
, $SWIGVERSION
, $_SWIGINCFLAGS
.
Uses: $SWIGCOMSTR
.
Sets construction variables for the tar archiver.
Sets: $TAR
, $TARCOM
, $TARFLAGS
, $TARSUFFIX
.
Uses: $TARCOMSTR
.
Sets construction variables for the TeX formatter and typesetter.
Sets: $BIBTEX
, $BIBTEXCOM
, $BIBTEXFLAGS
, $LATEX
, $LATEXCOM
, $LATEXFLAGS
, $MAKEINDEX
, $MAKEINDEXCOM
, $MAKEINDEXFLAGS
, $TEX
, $TEXCOM
, $TEXFLAGS
.
Uses: $BIBTEXCOMSTR
, $LATEXCOMSTR
, $MAKEINDEXCOMSTR
, $TEXCOMSTR
.
Set construction variables for the Textfile
and Substfile
builders.
Sets: $FILE_ENCODING
, $LINESEPARATOR
, $SUBSTFILEPREFIX
, $SUBSTFILESUFFIX
, $TEXTFILEPREFIX
, $TEXTFILESUFFIX
.
Uses: $SUBST_DICT
.
Sets construction variables for the Borlan tib library archiver.
Sets: $AR
, $ARCOM
, $ARFLAGS
, $LIBPREFIX
, $LIBSUFFIX
.
Uses: $ARCOMSTR
.
This scons tool is a part of scons gettext
toolset. It provides
scons interface to xgettext(1)
program, which extracts internationalized messages from source code. The tool
provides POTUpdate
builder to make PO
Template files.
Sets: $POTSUFFIX
, $POTUPDATE_ALIAS
, $XGETTEXTCOM
, $XGETTEXTCOMSTR
, $XGETTEXTFLAGS
, $XGETTEXTFROM
, $XGETTEXTFROMPREFIX
, $XGETTEXTFROMSUFFIX
, $XGETTEXTPATH
, $XGETTEXTPATHPREFIX
, $XGETTEXTPATHSUFFIX
, $_XGETTEXTDOMAIN
, $_XGETTEXTFROMFLAGS
, $_XGETTEXTPATHFLAGS
.
Uses: $POTDOMAIN
.
Sets construction variables for the yacc parser generator.
Sets: $YACC
, $YACCCOM
, $YACCFLAGS
, $YACCHFILESUFFIX
, $YACCHXXFILESUFFIX
, $YACCVCGFILESUFFIX
, $YACC_GRAPH_FILE_SUFFIX
.
Uses: $YACCCOMSTR
, $YACCFLAGS
, $YACC_GRAPH_FILE
, $YACC_HEADER_FILE
.
Sets construction variables for the zip archiver.
Sets: $ZIP
, $ZIPCOM
, $ZIPCOMPRESSION
, $ZIPFLAGS
, $ZIPSUFFIX
.
Uses: $ZIPCOMSTR
.