summaryrefslogtreecommitdiff
path: root/scons.1
diff options
context:
space:
mode:
authorLuca Falavigna <dktrkranz@debian.org>2010-03-10 13:49:40 +0100
committerLuca Falavigna <dktrkranz@debian.org>2010-03-10 13:49:40 +0100
commiteff7b513913aa21f41c6e304dcf5178f8bffa980 (patch)
treed991f365c5fb334ecc08f245aa008943930b83b9 /scons.1
parent5652ab4cab956f8426b1bc8d6dd0cc4ecf39f51d (diff)
parent0de5191eaec0321118254673e8f8414228668818 (diff)
Merge commit 'upstream/1.2.0.d20100306'
Diffstat (limited to 'scons.1')
-rw-r--r--scons.1111
1 files changed, 64 insertions, 47 deletions
diff --git a/scons.1 b/scons.1
index 2f19d1e..f6b7482 100644
--- a/scons.1
+++ b/scons.1
@@ -19,9 +19,9 @@
.\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
.\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.\"
-.\" doc/man/scons.1 4629 2010/01/17 22:23:21 scons
+.\" doc/man/scons.1 4691 2010/03/06 16:22:36 bdbaddog
.\"
-.TH SCONS 1 "January 2010"
+.TH SCONS 1 "March 2010"
.\" ES - Example Start - indents and turns off line fill
.rm ES
.de ES
@@ -2231,7 +2231,7 @@ env.CFile(target = 'foo.c', source = 'foo.l')
# builds bar.c
env.CFile(target = 'bar', source = 'bar.y')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP CXXFile()
.IP env.CXXFile()
@@ -2250,7 +2250,7 @@ env.CXXFile(target = 'foo.cc', source = 'foo.ll')
# builds bar.cc
env.CXXFile(target = 'bar', source = 'bar.yy')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP DVI()
.IP env.DVI()
@@ -2299,7 +2299,7 @@ env.DVI(target = 'bbb', source = 'bbb.ltx')
# builds from ccc.latex
env.DVI(target = 'ccc.dvi', source = 'ccc.latex')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Install()
.IP env.Install()
@@ -2312,7 +2312,7 @@ remain the same within the destination directory.
.ES
env.Install('/usr/local/bin', source = ['foo', 'bar'])
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP InstallAs()
.IP env.InstallAs()
@@ -2332,7 +2332,7 @@ env.InstallAs(target = '/usr/local/bin/foo',
env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'],
source = ['libFOO.a', 'libBAR.a'])
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Jar()
.IP env.Jar()
@@ -2369,7 +2369,7 @@ env.Jar(target = 'foo.jar', source = 'classes')
env.Jar(target = 'bar.jar',
source = ['bar1.java', 'bar2.java'])
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Java()
.IP env.Java()
@@ -2431,7 +2431,7 @@ with a different encoding.
env = Environment()
env['ENV']['LANG'] = 'en_GB.UTF-8'
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP JavaH()
.IP env.JavaH()
@@ -2475,7 +2475,7 @@ env.JavaH(target = 'export',
source = ['classes/foo.class', 'classes/bar.class'],
JAVACLASSDIR = 'classes')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Library()
.IP env.Library()
@@ -2506,7 +2506,7 @@ Example:
.ES
env.M4(target = 'foo.c', source = 'foo.c.m4')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Moc()
.IP env.Moc()
@@ -2519,7 +2519,7 @@ Example:
env.Moc('foo.h') # generates moc_foo.cc
env.Moc('foo.cpp') # generates foo.moc
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP MSVSProject()
.IP env.MSVSProject()
@@ -2670,7 +2670,7 @@ env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'],
buildtarget = dll,
variant = 'Release')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP MSVSSolution()
.IP env.MSVSSolution()
@@ -2724,7 +2724,7 @@ env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'],
projects = ['bar' + env['MSVSPROJECTSUFFIX']],
variant = 'Release')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Object()
.IP env.Object()
@@ -2780,7 +2780,7 @@ env.Package( NAME = 'foo',
SOURCE_URL = 'http://foo.org/foo-1.2.3.tar.gz'
)
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PCH()
.IP env.PCH()
@@ -2797,7 +2797,7 @@ the precompiled header:
.ES
env['PCH'] = env.PCH('StdAfx.cpp')[0]
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PDF()
.IP env.PDF()
@@ -2818,7 +2818,7 @@ env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
# builds bbb.pdf from bbb.dvi
env.PDF(target = 'bbb', source = 'bbb.dvi')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PostScript()
.IP env.PostScript()
@@ -2839,7 +2839,7 @@ env.PostScript(target = 'aaa.ps', source = 'aaa.tex')
# builds bbb.ps from bbb.dvi
env.PostScript(target = 'bbb', source = 'bbb.dvi')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Program()
.IP env.Program()
@@ -2865,7 +2865,7 @@ Example:
.ES
env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f'])
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RES()
.IP env.RES()
@@ -2883,7 +2883,7 @@ Example:
.ES
env.RES('resource.rc')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RMIC()
.IP env.RMIC()
@@ -2920,7 +2920,7 @@ env.RMIC(target = 'outdir3',
source = ['classes/foo.class', 'classes/bar.class'],
JAVACLASSDIR = 'classes')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenClient()
.IP env.RPCGenClient()
@@ -2935,7 +2935,7 @@ in the source file's directory by default.
# Builds src/rpcif_clnt.c
env.RPCGenClient('src/rpcif.x')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenHeader()
.IP env.RPCGenHeader()
@@ -2950,7 +2950,7 @@ in the source file's directory by default.
# Builds src/rpcif.h
env.RPCGenHeader('src/rpcif.x')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenService()
.IP env.RPCGenService()
@@ -2965,7 +2965,7 @@ in the source file's directory by default.
# Builds src/rpcif_svc.c
env.RPCGenClient('src/rpcif.x')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenXDR()
.IP env.RPCGenXDR()
@@ -2980,7 +2980,7 @@ in the source file's directory by default.
# Builds src/rpcif_xdr.c
env.RPCGenClient('src/rpcif.x')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP SharedLibrary()
.IP env.SharedLibrary()
@@ -3266,7 +3266,7 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'),
])
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Tar()
.IP env.Tar()
@@ -3304,7 +3304,7 @@ env = Environment(TARFLAGS = '-c -z',
TARSUFFIX = '.tgz')
env.Tar('foo')
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Textfile()
.IP env.Textfile()
@@ -3363,7 +3363,7 @@ blob.txt
tanteratei
....8<---- (no linefeed at the end)
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP TypeLibrary()
.IP env.TypeLibrary()
@@ -3394,7 +3394,7 @@ and returns the corresponding nodes in the above order.
This builder is only available after using the tool 'qt'. Note: you can
specify \fB.ui\fP files directly as source
files to the \fBProgram\fP(),
-.BR Library\fP() and \fBSharedLibrary () builders
+\fBLibrary\fP() and \fBSharedLibrary\fP() builders
without using this builder. Using this builder lets you override the standard
naming conventions (be careful: prefixes are always prepended to names of
built files; if you don't want prefixes, you may set them to ``).
@@ -3406,7 +3406,7 @@ env.Uic('foo.ui') # -> ['foo.h', 'uic_foo.cc', 'moc_foo.cc']
env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'),
source = 'foo.ui') # -> ['include/foo.h', 'gen/uicfoo.cc', 'gen/mocfoo.cc']
.EE
-.IP
+
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Zip()
.IP env.Zip()
@@ -8309,7 +8309,7 @@ If this is not set, then $CVSCOM
.IP CVSFLAGS
General options that are passed to CVS.
By default, this is set to
-.B \-d $CVSREPOSITORY
+.B "-d $CVSREPOSITORY"
to specify from where the files must be fetched.
.IP CVSREPOSITORY
@@ -8378,7 +8378,7 @@ of the file that controls the packaging build.
A language-specific long description for
the specified \fIlang\fP.
This is used to populate a
-.B %description -l
+.B "%description -l"
section of an RPM
\fB.spec\fP file.
@@ -9001,7 +9001,7 @@ construction variables are included on this command line.
.IP FORTRANPPCOMSTR
The string displayed when a Fortran source file
is compiled to an object file
-after first running the file throught the C preprocessor.
+after first running the file through the C preprocessor.
If this is not set, then $FORTRANPPCOM
(the command line) is displayed.
@@ -9081,7 +9081,7 @@ 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 superceded by
+(This has been largely superseded by
the $FRAMEWORKPATH, $FRAMEWORKPATHPREFIX,
$FRAMEWORKPREFIX and $FRAMEWORKS variables
described above.)
@@ -9751,6 +9751,17 @@ Any compilations where the object (target) file base name
does not match the source file base name
will be compiled separately.
+.IP MSVC_USE_SCRIPT
+Use a batch script to set up Microsoft Visual Studio compiler
+
+$MSVC_USE_SCRIPT overrides $MSVC_VERSION and $TARGET_ARCH.
+If set to the name of a Visual Studio .bat file (e.g. vcvars.bat),
+SCons will run that bat file and extract the relevant variables from
+the result (typically %INCLUDE%, %LIB%, and %PATH%). Setting
+MSVC_USE_SCRIPT to None bypasses the Visual Studio autodetection
+entirely; use this if you are running SCons in a Visual Studio cmd
+window and importing the shell's environment variables.
+
.IP MSVC_VERSION
Sets the preferred version of Microsoft Visual C/C++ to use.
@@ -10255,7 +10266,7 @@ The prefix used for PostScript file names.
The prefix used for PostScript file names.
.IP QT_AUTOSCAN
-Turn off scanning for mocable files. Use the Moc Builder to explicitely
+Turn off scanning for mocable files. Use the Moc Builder to explicitly
specify files to run moc on.
.IP QT_BINPATH
@@ -10379,7 +10390,7 @@ Environment(tools=['default','qt'])
.IP
The qt tool supports the following operations:
-.I Automatic moc file generation from header files.
+.I "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
@@ -10388,7 +10399,7 @@ can turn off automatic moc file generation by setting QT_AUTOSCAN to 0.
See also the corresponding builder method
.B Moc()
-.I Automatic moc file generation from cxx files.
+.I "Automatic moc file generation from cxx files."
As stated in the qt documentation, include the moc file at the end of
the cxx file. Note that you have to include the file, which is generated
by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by default
@@ -10399,7 +10410,7 @@ by setting QT_AUTOSCAN to 0. See also the corresponding
.BR Moc ()
builder method.
-.I Automatic handling of .ui files.
+.I "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
@@ -10896,7 +10907,7 @@ are included on this command line.
.IP SHFORTRANPPCOMSTR
The string displayed when a Fortran source file
is compiled to a shared-library object file
-after first running the file throught the C preprocessor.
+after first running the file through the C preprocessor.
If this is not set, then $SHFORTRANPPCOM
(the command line) is displayed.
@@ -10910,7 +10921,7 @@ The suffix used for shared library file names.
The linker for programs that use shared libraries.
.IP SHLINKCOM
-The command line used to link programs using shared libaries.
+The command line used to link programs using shared libraries.
.IP SHLINKCOMSTR
The string displayed when programs using shared libraries are linked.
@@ -11189,11 +11200,17 @@ constructor; setting it later has no effect.
This is currently only used on Windows, but in the future it will be
used on other OSes as well.
-Valid values for Windows are 'x86', 'i386' (for 32 bits);
-'amd64', 'emt64', 'x86_64' (64 bits);
-and 'ia64' (Itanium).
+Valid values for Windows are
+.BR x86 ,
+.B i386
+(for 32 bits);
+.BR amd64 ,
+.BR emt64 ,
+.B x86_64
+(for 64 bits);
+and \fBia64\fP (Itanium).
For example, if you want to compile 64-bit binaries, you would set
-TARGET_ARCH='x86_64' in your SCons environment.
+\fBTARGET_ARCH='x86_64'\fP in your SCons environment.
.IP TARGET_OS
The name of the target operating system for the compiled objects
@@ -11236,7 +11253,7 @@ env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
General options passed to the TeX formatter and typesetter.
.IP TEXINPUTS
-List of directories that the LaTeX programm will search
+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.
@@ -11581,7 +11598,7 @@ to the name of the generated C++ file.
The suffix of the file
containing the VCG grammar automaton definition
when the
-.B \--graph=
+.B \-\-graph=
option is used.
Note that setting this variable does not cause
the parser generator to generate a VCG
@@ -13315,7 +13332,7 @@ multi-stage builder.
.IP single_source
Specifies that this builder expects exactly one source file per call. Giving
-more than one source files without target files results in implicitely calling
+more than one source file without target files results in implicitely calling
the builder multiple times (once for each source given). Giving multiple
source files together with target files results in a UserError exception.