Difference between revisions of "Scons command line flags"

From The Powder Toy
Jump to: navigation, search
m (moved SCONS command line flags to Scons command line flags: SCONS isn't an acronym)
(reformat the table a little, add -j)
Line 2: Line 2:
  
 
{| class="wikitable" style="text-align: center; width: 100%;"
 
{| class="wikitable" style="text-align: center; width: 100%;"
 +
! Name !! Description !! Example usage
 
|-
 
|-
| Name
+
| parallel compilation || Compiles in multiple threads, significally decreases compilation time if the number of threads equals the number of cores on your system. || -j4
| Description
 
| Define
 
 
|-
 
|-
| OpenGL
+
| OpenGL || Compiles using OpenGL instead of SDL || --opengl
| Compiles using OpenGL instead of SDL
 
| --opengl
 
 
|-
 
|-
| Renderer
+
| Renderer || Saves Renderer || --renderer
| Saves Renderer
 
| --renderer
 
 
|-
 
|-
| 64-bit
+
| 64-bit || Compiles a 64-bit (AMD64) version instead of 32-bit (x86) version. || --64bit  
| Compiles a 64-bit (AMD64) version instead of 32-bit (x86) version.
 
| --64bit  
 
 
|-
 
|-
| Static Linking
+
| Static Linking || Reduces external library dependencies || --static
| Reduces external library dependencies
 
| --static
 
 
|-
 
|-
| Pthreadw32
+
| Pthreadw32 || Use PTW32_STATIC_LIB for pthreadw32 headers || --pthreadw32-static
| Use PTW32_STATIC_LIB for pthreadw32 headers
 
| --pthreadw32-static
 
 
|-
 
|-
| Python Version
+
| Python Version || Determines which python version to use with generator.py || --python-ver python2.7
| Determines which python version to use with generator.py
 
| --python-ver version
 
 
|-
 
|-
| Release
+
| Release || Makes a release build (slows down compiling) || --release
| Makes a release build (slows down compiling)
 
| --release
 
 
|-
 
|-
| Lua Directory
+
| Lua Directory || Defines the directory in which the Lua headers are located. || --lua-dir /usr/include/lua5.1/
| Defines the directory in which the Lua headers are located.
 
| --lua-dir path
 
 
|-
 
|-
| SDL Directory
+
| SDL Directory || Defines the directory in which the SDL headers are located. || --sdl-dir /usr/local/include/SDL/
| Defines the directory in which the SDL headers are located.
 
| --sdl-dir path
 
 
|-
 
|-
| Tool
+
| Tool || Prefix for toolchain executables used for cross compiling. || --tool i586-ming32msvc-
| Usually used for cross compiling
 
| --tool
 
 
|-
 
|-
| SSE
+
| SSE || Compiles an SSE-enabled, and thus, non-legacy binary. || --sse
| Compiles a legacy version
 
| --sse
 
 
|-
 
|-
| SSE2
+
| SSE2 || Enables SSE2 optimisations. || --sse2
| Enable SSE2 optimisations
 
| --sse2
 
 
|-
 
|-
| SSE3
+
| SSE3 || Enables SSE3 optimisations. || --sse3
| Enable SSE3 optimisations
 
| --sse3
 
 
|-
 
|-
| X86
+
| X86 || Target Intel x86 platform (32-bit). || --x86
| Target Intel x86 platform (32-bit)
 
| --x86
 
 
|-
 
|-
| No FFT
+
| No FFT || Do not use fftw3f for gravity. || --nofft
| Do not use fftw3f for gravity.
 
| --nofft
 
 
|-
 
|-
| No Lua
+
| No Lua || Disables all Lua scripting features. || --nolua
| Disables all Lua scripting features.
 
| --nolua
 
 
|-
 
|-
| Debugging
+
| Debugging || Enables Debug Options. || --debugging
| Enables Debug Options
 
| --debugging
 
 
|-
 
|-
| Beta
+
| Beta || Makes a beta build. || --beta
| Makes a beta build
 
| --beta
 
 
|-
 
|-
| Save Version
+
| Save Version || Defines save version. || --save-version 89
| Defines save version
 
| --save-version ver
 
 
|-
 
|-
| Minor Version
+
| Minor Version || Defines the minor version. || --minor-version 1
| Defines the minor version
 
| --minor-version ver
 
 
|-
 
|-
| Build Number
+
| Build Number || Defines the build number. || --build-number 281
| Defines the build number
 
| --build-number ver
 
 
|-
 
|-
| Snapshot
+
| Snapshot || Makes a snapshot build. || --snapshot
| Makes a snapshot build
 
| --snapshot
 
 
|-
 
|-
| Snapshot ID
+
| Snapshot ID || Defines the snapshot ID. || --snapshot-id 12345
| Defines the snapshot ID
 
| --snapshot-id id
 
 
|-
 
|-
| Stable
+
| Stable || Makes a stable build. || --stable
| Makes a stable build
 
| --stable
 
 
|-
 
|-
| All at Once
+
| All at Once || Compiles everything at once, very slow. || --aao
| Compiles everything at once
 
| --aao
 
 
|-
 
|-
| Windows
+
| Windows || Targets the Windows platform. || --win
| Targets the Windows platform
 
| --win
 
 
|-
 
|-
| Linux
+
| Linux || Targets the Linux platform || --lin
| Targets the Linux platform
 
| --lin
 
 
|-  
 
|-  
| Mac OS X
+
| Mac OS X || Targets the Mac OS X platform. || --macosx
| Targets the Mac OS X platform
 
| --macosx
 
 
|-
 
|-
| Raspbian
+
| Raspbian || Targets the Raspbian (OS of Raspberry Pi) platform. || --rpi
| Targets the Raspbian (OS of Raspberry Pi) platform
 
| --rpi
 
 
|-
 
|-
| Build
+
| Build || Sets the build directory. || --build obj/
| Sets the build directory
 
| --build
 
 
|-
 
|-
| Full Clean
+
| Full Clean || For when nothing else works. Deletes all sconscript temporary files. || --fullclean
| For when nothing else works. Deletes all sconscript temporary files.
+
|}
| --fullclean
 

Revision as of 11:18, 16 October 2013

This page will explain all the SCONS command line flags.

Name Description Example usage
parallel compilation Compiles in multiple threads, significally decreases compilation time if the number of threads equals the number of cores on your system. -j4
OpenGL Compiles using OpenGL instead of SDL --opengl
Renderer Saves Renderer --renderer
64-bit Compiles a 64-bit (AMD64) version instead of 32-bit (x86) version. --64bit
Static Linking Reduces external library dependencies --static
Pthreadw32 Use PTW32_STATIC_LIB for pthreadw32 headers --pthreadw32-static
Python Version Determines which python version to use with generator.py --python-ver python2.7
Release Makes a release build (slows down compiling) --release
Lua Directory Defines the directory in which the Lua headers are located. --lua-dir /usr/include/lua5.1/
SDL Directory Defines the directory in which the SDL headers are located. --sdl-dir /usr/local/include/SDL/
Tool Prefix for toolchain executables used for cross compiling. --tool i586-ming32msvc-
SSE Compiles an SSE-enabled, and thus, non-legacy binary. --sse
SSE2 Enables SSE2 optimisations. --sse2
SSE3 Enables SSE3 optimisations. --sse3
X86 Target Intel x86 platform (32-bit). --x86
No FFT Do not use fftw3f for gravity. --nofft
No Lua Disables all Lua scripting features. --nolua
Debugging Enables Debug Options. --debugging
Beta Makes a beta build. --beta
Save Version Defines save version. --save-version 89
Minor Version Defines the minor version. --minor-version 1
Build Number Defines the build number. --build-number 281
Snapshot Makes a snapshot build. --snapshot
Snapshot ID Defines the snapshot ID. --snapshot-id 12345
Stable Makes a stable build. --stable
All at Once Compiles everything at once, very slow. --aao
Windows Targets the Windows platform. --win
Linux Targets the Linux platform --lin
Mac OS X Targets the Mac OS X platform. --macosx
Raspbian Targets the Raspbian (OS of Raspberry Pi) platform. --rpi
Build Sets the build directory. --build obj/
Full Clean For when nothing else works. Deletes all sconscript temporary files. --fullclean