bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.
-Boost provides pre-compiled bjam executables for a variety of platforms. +
We suggest you download a pre-built bjam executable for your platform. Alternatively, you can build bjam yourself using these instructions.
+Move the bjam executable into a directory in your PATH. You can +see the list of directories in your PATH, separated by colons, +by typing “echo $PATH” at the command prompt.
Change your current directory to the Boost root directory and invoke bjam as follows:
-bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stage +bjam --build-dir=build-directory --toolset=toolset-name stage
For example, your session might look like this:
$ cd ~/boost_1_37_0
$ bjam --build-dir=/tmp/build-boost --toolset=gcc stage
-That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations:
-
-$ cd ~/boost_1_37_0
-$ bjam --build-dir=/tmp/build-boost --toolset=gcc --build-type=complete stage
-
+That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “``--build-type=complete``”.
diff --git a/more/getting_started/unix-variants.rst b/more/getting_started/unix-variants.rst index f87eacbe5b..548343ee9a 100644 --- a/more/getting_started/unix-variants.rst +++ b/more/getting_started/unix-variants.rst @@ -142,12 +142,7 @@ For example, your session might look like this: $ cd ~/|boost_ver| $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc stage -That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations: - -.. parsed-literal:: - - $ cd ~/|boost_ver| - $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc **--build-type=complete** stage +That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “``--build-type=complete``”. .. include:: detail/build-from-source-tail.rst @@ -237,6 +232,8 @@ Spoil Rock Hunter?” .. [#lowercase-l] That option is a dash followed by a lowercase “L” character, which looks very much like a numeral 1 in some fonts. +.. |build-type-complete| replace:: `` `` + .. include:: detail/common-footnotes.rst .. include:: detail/release-variables.rst .. include:: detail/common-unix.rst diff --git a/more/getting_started/windows.html b/more/getting_started/windows.html index 6274efbe45..a4dea4efa8 100644 --- a/more/getting_started/windows.html +++ b/more/getting_started/windows.html @@ -3,7 +3,7 @@ - +bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.
-Boost provides pre-compiled bjam executables for a variety of platforms. +
We suggest you download a pre-built bjam executable for your platform. Alternatively, you can build bjam yourself using these instructions.
+Move the bjam executable into a directory in your PATH. You can +see the list of directories in your PATH, separated by semicolons, +by typing “PATH” at the command prompt.
Change your current directory to the Boost root directory and invoke bjam as follows:
-bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stage +bjam --build-dir=build-directory --toolset=toolset-name --build-type=complete stage
For example, your session might look like this:4
C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0 C:\Program Files\boost\boost_1_37_0> bjam ^ More? --build-dir="C:\Documents and Settings\dave\build-boost" ^ -More? --toolset=msvc stage +More? --toolset= --build-type=complete msvc stage
Be sure to read this note about the appearance of ^, More? and quotation marks (") in that line.
-The above example session will build static and shared non-debug multi-threaded -variations of the libraries. To build all variations:
--C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0 -C:\Program Files\boost\boost_1_37_0> bjam ^ -More? --build-dir="C:\Documents and Settings\dave\build-boost" ^ -More? --toolset=msvc --build-type=complete stage -+
The option “--build-type=complete” causes bjam to build +all supported variants of the libraries. For instructions on how to +build only specific variants, please ask on the Boost.Build mailing +list.
diff --git a/more/getting_started/windows.rst b/more/getting_started/windows.rst index dab2cb228d..6026dd7d74 100644 --- a/more/getting_started/windows.rst +++ b/more/getting_started/windows.rst @@ -35,14 +35,16 @@ __ ../../index.htm Get Boost ========= -The easiest way to get a copy of Boost is to use an installer. -The `Boost website version of this Getting Started guide`_ will -have undated information on installers as they become available, -or see `Boost downloads`_ or the installer_ provided by `BoostPro Computing`_. We especially recommend using -an installer if you use Microsoft Visual Studio, because the installer can download and install -precompiled library binaries, saving you the trouble of building -them yourself. To complete this tutorial, you'll need to at least -install the Boost.Regex_ binaries when given the option. +The easiest way to get a copy of Boost is to use an installer. The +`Boost website version of this Getting Started guide`_ will have +undated information on installers as they become available, or see +`Boost downloads`_ or the installer_ provided by `BoostPro +Computing`_. We especially recommend using an installer if you use +Microsoft Visual Studio, because the installer can download and +install precompiled library binaries, saving you the trouble of +building them yourself. To complete this tutorial, you'll need to at +least install the Static Multithreaded variants of the Boost.Regex_ +binaries when given the option. .. _`Boost website version of this Getting Started guide`: http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html @@ -186,7 +188,7 @@ To test the result, type: Install Visual Studio Binaries ------------------------------ -The installers will download and +The installers supplied by BoostPro Computing will download and install pre-compiled binaries into the ``lib\`` subdirectory of the boost root, typically |default-root|\ ``\lib\``. If you installed all variants of the Boost.Regex_ binary, you're done with this @@ -213,20 +215,15 @@ For example, your session might look like this: [#continuation]_ C:\\WINDOWS> cd |default-root| |default-root|> bjam **^** More? **--build-dir=**\ "C:\\Documents and Settings\\dave\\build-boost" **^** - More? **--toolset=**\ msvc stage + More? **--toolset=**\ **--build-type=complete** msvc stage Be sure to read `this note`__ about the appearance of ``^``, ``More?`` and quotation marks (``"``) in that line. -The above example session will build static and shared non-debug multi-threaded -variations of the libraries. To build all variations: - -.. parsed-literal:: - - C:\\WINDOWS> cd |default-root| - |default-root|> bjam **^** - More? **--build-dir=**\ "C:\\Documents and Settings\\dave\\build-boost" **^** - More? **--toolset=**\ msvc **--build-type=complete** stage +The option “\ **--build-type=complete**\ ” causes ``bjam`` to build +all supported variants of the libraries. For instructions on how to +build only specific variants, please ask on the `Boost.Build mailing +list`_. __ continuation_ @@ -355,6 +352,7 @@ Spoil Rock Hunter?” .. _`boost.zip`: `sf-download`_ +.. |build-type-complete| replace:: **--build-type=complete** .. include:: detail/common-footnotes.rst .. include:: detail/release-variables.rst