Denis Arnaud 3957a0
diff --git a/tools/build/v2/doc/bjam.1 b/tools/build/v2/doc/bjam.1
Denis Arnaud 3957a0
new file mode 100644
Denis Arnaud 3957a0
index 0000000..8a44af6
Denis Arnaud 3957a0
--- /dev/null
Denis Arnaud 3957a0
+++ b/tools/build/v2/doc/bjam.1
Denis Arnaud 3957a0
@@ -0,0 +1,144 @@
Denis Arnaud 3957a0
+.TH "bjam" 1 "Sat Nov 19 2011" "Doxygen" \" -*- nroff -*-
Denis Arnaud 3957a0
+.ad l
Denis Arnaud 3957a0
+.nh
Denis Arnaud 3957a0
+.SH NAME
Denis Arnaud 3957a0
+bjam \- Command-line utility to build Boost-related C++ projects with Boost\&.Build
Denis Arnaud 3957a0
+.SH "SYNOPSIS"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fBbjam\fP \fC[-a] [-dx] [-fx] [-jx] [-lx] [-n] [-ox] [-px] [-q] [-sx=y] [-tx] [-v] [--x]\fP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fIbjam\fP accepts the following options:
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-a\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Build all targets, even if they are current
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-dx\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Set the debug level to x (0-9)
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-fx\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Read x instead of Jambase
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-jx\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Run up to x shell commands concurrently
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-lx\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Limit actions to x number of seconds after which they are stopped
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-n\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Don't actually execute the updating actions
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-ox\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Write the updating actions to file x
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-px\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ x=0, pipes action stdout and stderr merged into action output
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-q\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Quit quickly as soon as a target fails
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-sx=y\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Set variable x=y, overriding environment
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-tx\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Rebuild x, even if it is up-to-date
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB-v\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Print the version of jam and exit
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fB--x\fP 
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ Option is ignored
Denis Arnaud 3957a0
+.SH "DESCRIPTION"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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)
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\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 bjam on the command line is as follows:
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+\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”
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+The top-level module loads user-defined configuration files, \fIuser-config\&.jam\fP and \fIsite-config\&.jam\fP, which define available toolsets
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+So, to be able to successfully use \fIBoost\&.Build\fP, you need to know only four things:
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+How to configure \fIBoost\&.Build\fP (http://www.boost.org/boost-build2/doc/html/bbv2/overview/configuration.html)
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+How to declare targets in Jamfiles (http://www.boost.org/boost-build2/doc/html/bbv2/overview/targets.html)
Denis Arnaud 3957a0
+.IP "\(bu" 2
Denis Arnaud 3957a0
+How the build process works (http://www.boost.org/boost-build2/doc/html/bbv2/overview/build_process.html)
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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)
Denis Arnaud 3957a0
+.SH "CONCEPTS"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+a\&.o: a\&.c
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ g++ -o a\&.o -g a\&.c
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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\&.
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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:
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+add_program ('a', 'a\&.c')
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+Consider an example:
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+exe a : a\&.cpp ;
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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:
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fIbjam\fP toolset=gcc toolset=msvc
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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\&.
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+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)\&.
Denis Arnaud 3957a0
+.SH "SEE ALSO"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+\fBboost-libraries\fP(3)
Denis Arnaud 3957a0
+.SH "SUPPORT"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+Please report any bugs to https://svn.boost.org/trac/boost/
Denis Arnaud 3957a0
+.SH "COPYRIGHT"
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+Boost Software License - Version 1\&.0 - August 17th, 2003
Denis Arnaud 3957a0
+.PP
Denis Arnaud 3957a0
+See the LICENSE_1_0\&.txt file for more information on that license, or directly on Internet:
Denis Arnaud 3957a0
+.br
Denis Arnaud 3957a0
+ http://www.boost.org/LICENSE_1_0.txt