b98e6f
.TH "b2" 1 "Sat Nov 19 2011" "Doxygen" \" -*- nroff -*-
b98e6f
.ad l
b98e6f
.nh
b98e6f
.SH NAME
b98e6f
b2 \- Command-line utility to build Boost-related C++ projects with Boost\&.Build
b98e6f
.SH "SYNOPSIS"
b98e6f
.PP
b98e6f
\fBb2\fP \fC[-a] [-dx] [-fx] [-jx] [-lx] [-n] [-ox] [-px] [-q] [-sx=y] [-tx] [-v] [--x]\fP
b98e6f
.PP
b98e6f
\fIb2\fP accepts the following options:
b98e6f
.PP
b98e6f
\fB-a\fP 
b98e6f
.br
b98e6f
 Build all targets, even if they are current
b98e6f
.PP
b98e6f
\fB-dx\fP 
b98e6f
.br
b98e6f
 Set the debug level to x (0-9)
b98e6f
.PP
b98e6f
\fB-fx\fP 
b98e6f
.br
b98e6f
 Read x instead of Jambase
b98e6f
.PP
b98e6f
\fB-jx\fP 
b98e6f
.br
b98e6f
 Run up to x shell commands concurrently
b98e6f
.PP
b98e6f
\fB-lx\fP 
b98e6f
.br
b98e6f
 Limit actions to x number of seconds after which they are stopped
b98e6f
.PP
b98e6f
\fB-n\fP 
b98e6f
.br
b98e6f
 Don't actually execute the updating actions
b98e6f
.PP
b98e6f
\fB-ox\fP 
b98e6f
.br
b98e6f
 Write the updating actions to file x
b98e6f
.PP
b98e6f
\fB-px\fP 
b98e6f
.br
b98e6f
 x=0, pipes action stdout and stderr merged into action output
b98e6f
.PP
b98e6f
\fB-q\fP 
b98e6f
.br
b98e6f
 Quit quickly as soon as a target fails
b98e6f
.PP
b98e6f
\fB-sx=y\fP 
b98e6f
.br
b98e6f
 Set variable x=y, overriding environment
b98e6f
.PP
b98e6f
\fB-tx\fP 
b98e6f
.br
b98e6f
 Rebuild x, even if it is up-to-date
b98e6f
.PP
b98e6f
\fB-v\fP 
b98e6f
.br
b98e6f
 Print the version of b2 and exit
b98e6f
.PP
b98e6f
\fB--x\fP 
b98e6f
.br
b98e6f
 Option is ignored
b98e6f
.SH "DESCRIPTION"
b98e6f
.PP
b98e6f
This section provides the information necessary to create your own projects using \fIBoost\&.Build\fP The information provided here is relatively high-level, and Chapter 6, Reference as well as the on-line help system must be used to obtain low-level documentation (see --help)
b98e6f
.PP
b98e6f
\fIBoost\&.Build\fP actually consists of two parts - \fIBoost\&.Jam\fP, a build engine with its own interpreted language, and \fIBoost\&.Build\fP itself, implemented in \fIBoost\&.Jam's\fP language\&. The chain of events when you type b2 on the command line is as follows:
b98e6f
.IP "\(bu" 2
b98e6f
\fIBoost\&.Jam\fP tries to find \fIBoost\&.Build\fP and loads the top-level module\&. The exact process is described in the section called “Initialization”
b98e6f
.PP
b98e6f
.PP
b98e6f
.IP "\(bu" 2
b98e6f
The top-level module loads user-defined configuration files, \fIuser-config\&.jam\fP and \fIsite-config\&.jam\fP, which define available toolsets
b98e6f
.PP
b98e6f
.PP
b98e6f
.IP "\(bu" 2
b98e6f
The \fIJamfile\fP in the current directory is read That in turn might cause reading of further Jamfiles\&. As a result, a tree of projects is created, with targets inside projects
b98e6f
.PP
b98e6f
.PP
b98e6f
.IP "\(bu" 2
b98e6f
Finally, using the build request specified on the command line, \fIBoost\&.Build\fP decides which targets should be built and how\&. That information is passed back to \fIBoost\&.Jam\fP, which takes care of actually running the scheduled build action commands
b98e6f
.PP
b98e6f
.PP
b98e6f
So, to be able to successfully use \fIBoost\&.Build\fP, you need to know only four things:
b98e6f
.IP "\(bu" 2
b98e6f
How to configure \fIBoost\&.Build\fP (http://www.boost.org/boost-build2/doc/html/bbv2/overview/configuration.html)
b98e6f
.IP "\(bu" 2
b98e6f
How to declare targets in Jamfiles (http://www.boost.org/boost-build2/doc/html/bbv2/overview/targets.html)
b98e6f
.IP "\(bu" 2
b98e6f
How the build process works (http://www.boost.org/boost-build2/doc/html/bbv2/overview/build_process.html)
b98e6f
.PP
b98e6f
.PP
b98e6f
Some Basics about the \fIBoost\&.Jam\fP language\&. See the section called “Boost\&.Jam Language” (http://www.boost.org/boost-build2/doc/html/bbv2/overview/jam_language.html)
b98e6f
.SH "CONCEPTS"
b98e6f
.PP
b98e6f
\fIBoost\&.Build\fP has a few unique concepts that are introduced in this section\&. The best way to explain the concepts is by comparison with more classical build tools
b98e6f
.PP
b98e6f
When using any flavour of make, you directly specify targets and commands that are used to create them from other target\&. The below example creates a\&.o from a\&.c using a hardcoded compiler invocation command
b98e6f
.PP
b98e6f
a\&.o: a\&.c
b98e6f
.br
b98e6f
 g++ -o a\&.o -g a\&.c
b98e6f
.PP
b98e6f
This is rather low-level description mechanism and it is hard to adjust commands, options, and sets of created targets depending on the used compiler and operating system\&.
b98e6f
.PP
b98e6f
To improve portability, most modern build system provide a set of higher-level functions that can be used in build description files\&. Consider this example:
b98e6f
.PP
b98e6f
add_program ('a', 'a\&.c')
b98e6f
.br
b98e6f
.PP
b98e6f
This is a function call that creates targets necessary to create executable file from source file a\&.c\&. Depending on configured properties, different commands line may be used\&. However, \fIadd_program\fP is higher-level, but rather thin level All targets are created immediately when build description is parsed, which makes it impossible to perform multi-variant builds\&. Often, change in any build property requires complete reconfiguration of the build tree
b98e6f
.PP
b98e6f
In order to support true multivariant builds, Boost\&.Build introduces the concept of metatarget—object that is created when build description is parsed and can be later called with specific build properties to generate actual targets
b98e6f
.PP
b98e6f
Consider an example:
b98e6f
.PP
b98e6f
exe a : a\&.cpp ;
b98e6f
.br
b98e6f
.PP
b98e6f
When this declaration is parsed, \fIBoost\&.Build\fP creates a metatarget, but does not yet decides what files must be created, or what commands must be used\&. After all build files are parsed, Boost\&.Build considers properties requested on the command line\&. Supposed you have invoked \fIBoost\&.Build\fP with:
b98e6f
.PP
b98e6f
\fIb2\fP toolset=gcc toolset=msvc
b98e6f
.br
b98e6f
.PP
b98e6f
In that case, the metatarget will be called twice, once with toolset=gcc and once with toolset=msvc\&. Both invocations will produce concrete targets, that will have different extensions and use different command lines\&. Another key concept is build property\&. Build property is a variable that affects the build process\&. It can be specified on the command line, and is passed when calling a metatarget
b98e6f
.PP
b98e6f
While all build tools have a similar mechanism, \fIBoost\&.Build\fP differs by requiring that all build properties are declared in advance, and providing a large set of properties with portable semantics
b98e6f
.PP
b98e6f
The final concept is property propagation\&. Boost\&.Build does not require that every metatarget is called with the same properties\&. Instead, the 'top-level' metatargets are called with the properties specified on the command line Each metatarget can elect to augment or override some properties (in particular, using the requirements mechanism, see the section called “Requirements”: http://www.boost.org/boost-build2/doc/html/bbv2/overview/targets.html#bbv2.overview.targets.requirements) Then, the dependency metatargets are called with modified properties and produce concrete targets that are then used in build process Of course, dependency metatargets maybe in turn modify build properties and have dependencies of their own\&.
b98e6f
.PP
b98e6f
For more in-depth treatment of the requirements and concepts, you may refer to SYRCoSE 2009 Boost\&.Build article (http://syrcose.ispras.ru/2009/files/04_paper.pdf)\&.
b98e6f
.SH "SEE ALSO"
b98e6f
.PP
b98e6f
\fBboost-libraries\fP(3)
b98e6f
.SH "SUPPORT"
b98e6f
.PP
b98e6f
Please report any bugs to https://svn.boost.org/trac/boost/
b98e6f
.SH "COPYRIGHT"
b98e6f
.PP
b98e6f
Boost Software License - Version 1\&.0 - August 17th, 2003
b98e6f
.PP
b98e6f
See the LICENSE_1_0\&.txt file for more information on that license, or directly on Internet:
b98e6f
.br
b98e6f
 http://www.boost.org/LICENSE_1_0.txt