Blame SOURCES/boost-1.48.0-add-bjam-man-page.patch

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