.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH B2 "1" "February 2021" "B2 4.3-git" "User Commands"
.SH NAME
B2 \- software build tool
.SH DESCRIPTION
B2 4.3\-git
.PP
Project\-specific help:
.IP
Project has jamfile at Jamroot
.PP
Usage:
.IP
b2 [options] [properties] [install|stage]
.IP
Builds and installs Boost.
.PP
Targets and Related Options:
.TP
install
Install headers and compiled library files to the
.TP
=======
configured locations (below).
.TP
\fB\-\-prefix=\fR<PREFIX>
Install architecture independent files here.
Default: C:\eBoost on Windows
Default: \fI\,/usr/local\/\fP on Unix, Linux, etc.
.TP
\fB\-\-exec\-prefix=\fR<EPREFIX> Install architecture dependent files here.
Default: <PREFIX>
.TP
\fB\-\-libdir=\fR<LIBDIR>
Install library files here.
Default: <EPREFIX>/lib
.TP
\fB\-\-includedir=\fR<HDRDIR>
Install header files here.
Default: <PREFIX>/include
.TP
\fB\-\-cmakedir=\fR<CMAKEDIR>
Install CMake configuration files here.
Default: <LIBDIR>/cmake
.TP
\fB\-\-no\-cmake\-config\fR
Do not install CMake configuration files.
.TP
stage
Build and install only compiled library files to the
.TP
=====
stage directory.
.TP
\fB\-\-stagedir=\fR<STAGEDIR>
Install library files here
Default: ./stage
.PP
Other Options:
.TP
\fB\-\-build\-type=\fR<type>
Build the specified pre\-defined set of variations of
the libraries. Note, that which variants get built
depends on what each library supports.
.TP
\fB\-\-\fR minimal \fB\-\-\fR (default) Builds a minimal set of
variants. On Windows, these are static
multithreaded libraries in debug and release
modes, using shared runtime. On Linux, these are
static and shared multithreaded libraries in
release mode.
.IP
\fB\-\-\fR complete \fB\-\-\fR Build all possible variations.
.TP
\fB\-\-build\-dir\fR=\fI\,DIR\/\fR
Build in this location instead of building within
the distribution tree. Recommended!
.TP
\fB\-\-show\-libraries\fR
Display the list of Boost libraries that require
build and installation steps, and then exit.
.TP
\fB\-\-layout=\fR<layout>
Determine whether to choose library names and header
locations such that multiple versions of Boost or
multiple compilers can be used on the same system.
.TP
\fB\-\-\fR versioned \fB\-\-\fR Names of boost binaries include
the Boost version number, name and version of
the compiler and encoded build properties. Boost
headers are installed in a subdirectory of
<HDRDIR> whose name contains the Boost version
number.
.TP
\fB\-\-\fR tagged \fB\-\-\fR Names of boost binaries include the
encoded build properties such as variant and
threading, but do not including compiler name
and version, or Boost version. This option is
useful if you build several variants of Boost,
using the same compiler.
.TP
\fB\-\-\fR system \fB\-\-\fR Binaries names do not include the
Boost version number or the name and version
number of the compiler. Boost headers are
installed directly into <HDRDIR>. This option is
intended for system integrators building
distribution packages.
.TP
The default value is 'versioned' on Windows, and
\&'system' on Unix.
.TP
\fB\-\-buildid\fR=\fI\,ID\/\fR
Add the specified ID to the name of built libraries.
The default is to not add anything.
.TP
\fB\-\-python\-buildid\fR=\fI\,ID\/\fR
Add the specified ID to the name of built libraries
that depend on Python. The default is to not add
anything. This ID is added in addition to \fB\-\-buildid\fR.
.TP
\fB\-\-help\fR
This message.
.TP
\fB\-\-with\-\fR<library>
Build and install the specified <library>. If this
option is used, only libraries specified using this
option will be built.
.TP
\fB\-\-without\-\fR<library>
Do not build, stage, or install the specified
<library>. By default, all libraries are built.
.PP
Properties:
.TP
toolset=toolset
Indicate the toolset to build with.
.TP
variant=debug|release
Select the build variant
.TP
link=static|shared
Whether to build static or shared libraries
.TP
threading=single|multi
Whether to build single or multithreaded binaries
.TP
runtime\-link=static|shared
Whether to link to static or shared C and C++
runtime.
.PP
General command line usage:
.IP
b2 [options] [properties] [targets]
.IP
Options, properties and targets can be specified in any order.
.PP
Important Options:
.IP
* \fB\-\-clean\fR Remove targets instead of building
* \fB\-a\fR Rebuild everything
* \fB\-n\fR Don't execute the commands, only print them
* \fB\-d\fR+2 Show commands as they are executed
* \fB\-d0\fR Suppress all informational messages
* \fB\-q\fR Stop at first error
* \fB\-\-reconfigure\fR Rerun all configuration checks
* \fB\-\-debug\-configuration\fR Diagnose configuration
* \fB\-\-debug\-building\fR Report which targets are built with what properties
* \fB\-\-debug\-generator\fR Diagnose generator search/execution
.PP
Further Help:
.IP
The following options can be used to obtain additional documentation.
.IP
* \fB\-\-help\-options\fR Print more obscure command line options.
* \fB\-\-help\-internal\fR B2 implementation details.
* \fB\-\-help\-doc\-options\fR Implementation details doc formatting.
.PP
\&...found 1 target...