mirror of
https://github.com/boostorg/more.git
synced 2024-12-25 23:20:12 +08:00
Merge boost build updates to the getting started guide.
[SVN r69466]
This commit is contained in:
Daniel James
parent
f32be7a14e
commit
1e42e5284e
@ -2,36 +2,22 @@
|
||||
.. Software License, Version 1.0. (See accompanying
|
||||
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
Install Boost.Build
|
||||
...................
|
||||
|
||||
Boost.Build_ is a text-based system for developing, testing, and
|
||||
installing software. To use it, you'll need an executable called
|
||||
``bjam``.
|
||||
installing software. First, you'll need to build and
|
||||
install it. To do this:
|
||||
|
||||
.. |precompiled-bjam| replace:: download a pre-built ``bjam`` executable
|
||||
1. Go to the directory ``tools``\ |/|\ ``build``\ |/|\ ``v2``\ |/|.
|
||||
2. Run ``bootstrap.bat``
|
||||
3. Run ``bjam install --prefix=``\ *PREFIX* where *PREFIX* is
|
||||
the directory where you want Boost.Build to be installed
|
||||
4. Add *PREFIX*\ |/|\ ``bin`` to your PATH environment variable.
|
||||
|
||||
|
||||
.. _precompiled-bjam: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941
|
||||
.. .. _Boost.Jam documentation: Boost.Jam_
|
||||
.. _Boost.Build: ../../tools/build/index.html
|
||||
.. _Boost.Jam: ../../tools/build/v2/engine/index.html
|
||||
.. _Boost.Build documentation: Boost.Build_
|
||||
|
||||
Get ``bjam``
|
||||
............
|
||||
|
||||
``bjam`` is the |command-line tool| that drives the Boost Build
|
||||
system. To build Boost binaries, you'll invoke ``bjam`` from the
|
||||
Boost root.
|
||||
|
||||
We suggest you |precompiled-bjam|_ for your platform.
|
||||
Alternatively, you can build ``bjam`` yourself using `these
|
||||
instructions`__.
|
||||
|
||||
__ `building bjam`_
|
||||
|
||||
Move the ``bjam`` executable into a directory in your PATH. You can
|
||||
see the list of directories in your PATH, separated by |pathsep|\ s,
|
||||
by typing “\ |path|\ ” at the command prompt.
|
||||
|
||||
.. _toolset:
|
||||
.. _toolset-name:
|
||||
|
||||
@ -48,7 +34,7 @@ __ http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html
|
||||
`building bjam`_, you should assume it won't work and instead
|
||||
choose newly from the table below.
|
||||
|
||||
.. _building bjam: ../../doc/html/jam/building.html
|
||||
.. _building bjam: ../../doc/html/bbv2/installation.html
|
||||
|
||||
+-----------+--------------------+-----------------------------+
|
||||
|Toolset |Vendor |Notes |
|
||||
|
||||
@ -15,10 +15,8 @@ make this document clearer, please post it to the `Boost Users'
|
||||
mailing list`_.
|
||||
|
||||
* `Boost.Build reference manual`_
|
||||
* `Boost.Jam reference manual`_
|
||||
* `Boost Users' mailing list`_
|
||||
* `Boost.Build mailing list`_
|
||||
* `Boost.Build Wiki`_
|
||||
* `Index of all Boost library documentation`_
|
||||
|
||||
.. _Index of all Boost library documentation: ../../libs/index.html
|
||||
@ -32,8 +30,6 @@ mailing list`_.
|
||||
-- the Boost Developers
|
||||
|
||||
.. _Boost.Build reference manual: ../../tools/build/v2/index.html
|
||||
.. _Boost.Jam reference manual: `Boost.Jam`_
|
||||
.. _Boost Users' mailing list: http://www.boost.org/more/mailing_lists.htm#users
|
||||
.. _Boost.Build Wiki: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2
|
||||
.. _Boost.Build mailing list: http://www.boost.org/more/mailing_lists.htm#jamboost
|
||||
|
||||
|
||||
@ -9,4 +9,4 @@
|
||||
.. |boost_ver| replace:: ``boost_1_46_0``
|
||||
.. |boost_ver-bold| replace:: **boost_1_46_0**
|
||||
|
||||
.. _sf-download: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041
|
||||
.. _sf-download: http://www.boost.org/users/history/version_1_46_0.html
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
<div class="admonition-use-the-latest-version-of-this-getting-started-guide admonition">
|
||||
<p class="first admonition-title">Use the latest version of this Getting Started guide</p>
|
||||
<p class="last">The <a class="reference external" href="http://www.boost.org/doc/libs/release/more/getting_started/index.html">Boost website version of this Getting Started guide</a> may
|
||||
<p class="last">The <a class="reference external" href="http://www.boost.org/more/getting_started/index.html">Boost website version of this Getting Started guide</a> may
|
||||
have updated information, such as the location of additional installers
|
||||
or improved installation procedures, so you might want use that version
|
||||
if you've got an Internet connection available.</p>
|
||||
|
||||
@ -20,7 +20,7 @@ __ ../../index.htm
|
||||
if you've got an Internet connection available.
|
||||
|
||||
.. _`Boost website version of this Getting Started guide`:
|
||||
http://www.boost.org/doc/libs/release/more/getting_started/index.html
|
||||
http://www.boost.org/more/getting_started/index.html
|
||||
|
||||
Welcome
|
||||
-------
|
||||
|
||||
@ -30,40 +30,40 @@
|
||||
<div class="contents topic" id="index">
|
||||
<p class="topic-title first">Index</p>
|
||||
<ul class="auto-toc simple">
|
||||
<li><a class="reference internal" href="#get-boost" id="id20">1 Get Boost</a></li>
|
||||
<li><a class="reference internal" href="#the-boost-distribution" id="id21">2 The Boost Distribution</a></li>
|
||||
<li><a class="reference internal" href="#header-only-libraries" id="id22">3 Header-Only Libraries</a></li>
|
||||
<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id23">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#errors-and-warnings" id="id24">4.1 Errors and Warnings</a></li>
|
||||
<li><a class="reference internal" href="#get-boost" id="id19">1 Get Boost</a></li>
|
||||
<li><a class="reference internal" href="#the-boost-distribution" id="id20">2 The Boost Distribution</a></li>
|
||||
<li><a class="reference internal" href="#header-only-libraries" id="id21">3 Header-Only Libraries</a></li>
|
||||
<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id22">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#errors-and-warnings" id="id23">4.1 Errors and Warnings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id25">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#easy-build-and-install" id="id26">5.1 Easy Build and Install</a></li>
|
||||
<li><a class="reference internal" href="#or-build-custom-binaries" id="id27">5.2 Or, Build Custom Binaries</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#get-bjam" id="id28">5.2.1 Get <tt class="docutils literal">bjam</tt></a></li>
|
||||
<li><a class="reference internal" href="#identify-your-toolset" id="id29">5.2.2 Identify Your Toolset</a></li>
|
||||
<li><a class="reference internal" href="#select-a-build-directory" id="id30">5.2.3 Select a Build Directory</a></li>
|
||||
<li><a class="reference internal" href="#invoke-bjam" id="id31">5.2.4 Invoke <tt class="docutils literal">bjam</tt></a></li>
|
||||
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id24">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#easy-build-and-install" id="id25">5.1 Easy Build and Install</a></li>
|
||||
<li><a class="reference internal" href="#or-build-custom-binaries" id="id26">5.2 Or, Build Custom Binaries</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#install-boost-build" id="id27">5.2.1 Install Boost.Build</a></li>
|
||||
<li><a class="reference internal" href="#identify-your-toolset" id="id28">5.2.2 Identify Your Toolset</a></li>
|
||||
<li><a class="reference internal" href="#select-a-build-directory" id="id29">5.2.3 Select a Build Directory</a></li>
|
||||
<li><a class="reference internal" href="#invoke-bjam" id="id30">5.2.4 Invoke <tt class="docutils literal">bjam</tt></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#expected-build-output" id="id32">5.3 Expected Build Output</a></li>
|
||||
<li><a class="reference internal" href="#in-case-of-build-errors" id="id33">5.4 In Case of Build Errors</a></li>
|
||||
<li><a class="reference internal" href="#expected-build-output" id="id31">5.3 Expected Build Output</a></li>
|
||||
<li><a class="reference internal" href="#in-case-of-build-errors" id="id32">5.4 In Case of Build Errors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id34">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#library-naming" id="id35">6.1 Library Naming</a></li>
|
||||
<li><a class="reference internal" href="#test-your-program" id="id36">6.2 Test Your Program</a></li>
|
||||
<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id33">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#library-naming" id="id34">6.1 Library Naming</a></li>
|
||||
<li><a class="reference internal" href="#test-your-program" id="id35">6.2 Test Your Program</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#conclusion-and-further-resources" id="id37">7 Conclusion and Further Resources</a></li>
|
||||
<li><a class="reference internal" href="#conclusion-and-further-resources" id="id36">7 Conclusion and Further Resources</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="get-boost">
|
||||
<h1><a class="toc-backref" href="#id20">1 Get Boost</a></h1>
|
||||
<h1><a class="toc-backref" href="#id19">1 Get Boost</a></h1>
|
||||
<p>The most reliable way to get a copy of Boost is to download a
|
||||
distribution from <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041">SourceForge</a>:</p>
|
||||
distribution from <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html">SourceForge</a>:</p>
|
||||
<ol class="arabic">
|
||||
<li><p class="first">Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.</p>
|
||||
<li><p class="first">Download <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.</p>
|
||||
</li>
|
||||
<li><p class="first">In the directory where you want to put the Boost installation,
|
||||
execute</p>
|
||||
@ -81,14 +81,14 @@ creators usually choose to break Boost up into several packages,
|
||||
reorganize the directory structure of the Boost distribution,
|
||||
and/or rename the library binaries.<a class="footnote-reference" href="#packagers" id="id2"><sup>1</sup></a> If you have
|
||||
any trouble, we suggest using an official Boost distribution
|
||||
from <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041">SourceForge</a>.</p>
|
||||
from <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html">SourceForge</a>.</p>
|
||||
</div>
|
||||
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="the-boost-distribution">
|
||||
<h1><a class="toc-backref" href="#id21">2 The Boost Distribution</a></h1>
|
||||
<h1><a class="toc-backref" href="#id20">2 The Boost Distribution</a></h1>
|
||||
<p>This is a sketch of the resulting directory structure:</p>
|
||||
<pre class="literal-block">
|
||||
<strong>boost_1_46_0</strong><strong>/</strong> .................<em>The “boost root directory”</em>
|
||||
@ -166,7 +166,7 @@ contains a subset of the Boost documentation. Start with
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="header-only-libraries">
|
||||
<h1><a class="toc-backref" href="#id22">3 Header-Only Libraries</a></h1>
|
||||
<h1><a class="toc-backref" href="#id21">3 Header-Only Libraries</a></h1>
|
||||
<p>The first thing many people want to know is, “how do I build
|
||||
Boost?” The good news is that often, there's nothing to build.</p>
|
||||
<div class="admonition-nothing-to-build admonition">
|
||||
@ -213,7 +213,7 @@ use</strong>.</li>
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="build-a-simple-program-using-boost">
|
||||
<h1><a class="toc-backref" href="#id23">4 Build a Simple Program Using Boost</a></h1>
|
||||
<h1><a class="toc-backref" href="#id22">4 Build a Simple Program Using Boost</a></h1>
|
||||
<p>To keep things simple, let's start by using a header-only library.
|
||||
The following program reads a sequence of integers from standard
|
||||
input, uses Boost.Lambda to multiply each number by three, and
|
||||
@ -247,7 +247,7 @@ echo 1 2 3 | ./example
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
<div class="section" id="errors-and-warnings">
|
||||
<h2><a class="toc-backref" href="#id24">4.1 Errors and Warnings</a></h2>
|
||||
<h2><a class="toc-backref" href="#id23">4.1 Errors and Warnings</a></h2>
|
||||
<p>Don't be alarmed if you see compiler warnings originating in Boost
|
||||
headers. We try to eliminate them, but doing so isn't always
|
||||
practical.<a class="footnote-reference" href="#warnings" id="id5"><sup>3</sup></a> <strong>Errors are another matter</strong>. If you're
|
||||
@ -260,11 +260,11 @@ correctly identified the <a class="reference internal" href="#boost-root-directo
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="prepare-to-use-a-boost-library-binary">
|
||||
<h1><a class="toc-backref" href="#id25">5 Prepare to Use a Boost Library Binary</a></h1>
|
||||
<h1><a class="toc-backref" href="#id24">5 Prepare to Use a Boost Library Binary</a></h1>
|
||||
<p>If you want to use any of the separately-compiled Boost libraries,
|
||||
you'll need to acquire library binaries.</p>
|
||||
<div class="section" id="easy-build-and-install">
|
||||
<h2><a class="toc-backref" href="#id26">5.1 Easy Build and Install</a></h2>
|
||||
<h2><a class="toc-backref" href="#id25">5.1 Easy Build and Install</a></h2>
|
||||
<p>Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that
|
||||
represents the shell's prompt):</p>
|
||||
<pre class="literal-block">
|
||||
@ -292,7 +292,7 @@ path in place of the Boost root directory.</p>
|
||||
<p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
|
||||
</div>
|
||||
<div class="section" id="or-build-custom-binaries">
|
||||
<h2><a class="toc-backref" href="#id27">5.2 Or, Build Custom Binaries</a></h2>
|
||||
<h2><a class="toc-backref" href="#id26">5.2 Or, Build Custom Binaries</a></h2>
|
||||
<p>If you're using a compiler other than your system's default, you'll
|
||||
need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create binaries.</p>
|
||||
<p>You'll also
|
||||
@ -306,31 +306,28 @@ separately. See the <a class="reference external" href="https://svn.boost.org/t
|
||||
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
<div class="section" id="install-boost-build">
|
||||
<h3><a class="toc-backref" href="#id27">5.2.1 Install Boost.Build</a></h3>
|
||||
<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
|
||||
installing software. To use it, you'll need an executable called
|
||||
<tt class="docutils literal">bjam</tt>.</p>
|
||||
<!-- .. _Boost.Jam documentation: Boost.Jam_ -->
|
||||
<div class="section" id="get-bjam">
|
||||
<h3><a class="toc-backref" href="#id28">5.2.1 Get <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<p><tt class="docutils literal">bjam</tt> is the command-line tool that drives the Boost Build
|
||||
system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
|
||||
Boost root.</p>
|
||||
<p>We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
|
||||
Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
|
||||
instructions</a>.</p>
|
||||
<p>Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
|
||||
see the list of directories in your PATH, separated by colons,
|
||||
by typing “<tt class="docutils literal">echo $PATH</tt>” at the command prompt.</p>
|
||||
installing software. First, you'll need to build and
|
||||
install it. To do this:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Go to the directory <tt class="docutils literal">tools</tt><tt class="docutils literal">/</tt><tt class="docutils literal">build</tt><tt class="docutils literal">/</tt><tt class="docutils literal">v2</tt><tt class="docutils literal">/</tt>.</li>
|
||||
<li>Run <tt class="docutils literal">bootstrap.bat</tt></li>
|
||||
<li>Run <tt class="docutils literal">bjam install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
|
||||
the directory where you want Boost.Build to be installed</li>
|
||||
<li>Add <em>PREFIX</em><tt class="docutils literal">/</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="identify-your-toolset">
|
||||
<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id29">5.2.2 Identify Your Toolset</a></h3>
|
||||
<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id28">5.2.2 Identify Your Toolset</a></h3>
|
||||
<p>First, find the toolset corresponding to your compiler in the
|
||||
following table (an up-to-date list is always available <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html">in the
|
||||
Boost.Build documentation</a>).</p>
|
||||
<div class="note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">If you previously chose a toolset for the purposes of
|
||||
<a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
|
||||
<a class="reference external" href="../../doc/html/bbv2/installation.html">building bjam</a>, you should assume it won't work and instead
|
||||
choose newly from the table below.</p>
|
||||
</div>
|
||||
<table border="1" class="docutils">
|
||||
@ -422,7 +419,7 @@ a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></
|
||||
<tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <tt class="docutils literal"> </tt></p>
|
||||
</div>
|
||||
<div class="section" id="select-a-build-directory">
|
||||
<span id="id11"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id30">5.2.3 Select a Build Directory</a></h3>
|
||||
<span id="id10"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id29">5.2.3 Select a Build Directory</a></h3>
|
||||
<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
|
||||
building into the <strong>build directory</strong>. If your Boost root
|
||||
directory is writable, this step isn't strictly necessary: by
|
||||
@ -430,11 +427,11 @@ default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subd
|
||||
purpose in your current working directory.</p>
|
||||
</div>
|
||||
<div class="section" id="invoke-bjam">
|
||||
<h3><a class="toc-backref" href="#id31">5.2.4 Invoke <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<h3><a class="toc-backref" href="#id30">5.2.4 Invoke <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<p>Change your current directory to the Boost root directory and
|
||||
invoke <tt class="docutils literal">bjam</tt> as follows:</p>
|
||||
<pre class="literal-block">
|
||||
bjam <strong>--build-dir=</strong><a class="reference internal" href="#id11"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
|
||||
bjam <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
|
||||
</pre>
|
||||
<p>For a complete description of these and other invocation options,
|
||||
please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.</p>
|
||||
@ -479,7 +476,7 @@ file by appending “<tt class="docutils literal">>build.log <span class="pre
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="expected-build-output">
|
||||
<h2><a class="toc-backref" href="#id32">5.3 Expected Build Output</a></h2>
|
||||
<h2><a class="toc-backref" href="#id31">5.3 Expected Build Output</a></h2>
|
||||
<p>During the process of building Boost libraries, you can expect to
|
||||
see some messages printed on the console. These may include</p>
|
||||
<ul>
|
||||
@ -503,7 +500,7 @@ look something like:</p>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="in-case-of-build-errors">
|
||||
<h2><a class="toc-backref" href="#id33">5.4 In Case of Build Errors</a></h2>
|
||||
<h2><a class="toc-backref" href="#id32">5.4 In Case of Build Errors</a></h2>
|
||||
<p>The only error messages you see when building Boost—if any—should
|
||||
be related to the IOStreams library's support of zip and bzip2
|
||||
formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>. Install the relevant development
|
||||
@ -520,7 +517,7 @@ for your compiler to the <a class="reference external" href="http://www.boost.or
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="link-your-program-to-a-boost-library">
|
||||
<h1><a class="toc-backref" href="#id34">6 Link Your Program to a Boost Library</a></h1>
|
||||
<h1><a class="toc-backref" href="#id33">6 Link Your Program to a Boost Library</a></h1>
|
||||
<p>To demonstrate linking with a Boost binary library, we'll use the
|
||||
following simple program that extracts the subject lines from
|
||||
emails. It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
|
||||
@ -560,7 +557,7 @@ $ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_46_0</tt> example
|
||||
<strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
|
||||
</pre>
|
||||
</li>
|
||||
<li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
|
||||
<li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id14"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
|
||||
suffix (<tt class="docutils literal">.a</tt> in this case):</p>
|
||||
<pre class="literal-block">
|
||||
$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_46_0</tt> example.cpp -o example <strong>\</strong>
|
||||
@ -578,7 +575,7 @@ automatically for you unless you pass a special option such as
|
||||
<p>In both cases above, the bold text is what you'd add to <a class="reference internal" href="#build-a-simple-program-using-boost">the
|
||||
command lines we explored earlier</a>.</p>
|
||||
<div class="section" id="library-naming">
|
||||
<h2><a class="toc-backref" href="#id35">6.1 Library Naming</a></h2>
|
||||
<h2><a class="toc-backref" href="#id34">6.1 Library Naming</a></h2>
|
||||
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
@ -593,7 +590,7 @@ following elements:</p>
|
||||
<dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
|
||||
name begins with this string. On Windows, only ordinary static
|
||||
libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
|
||||
not.<a class="footnote-reference" href="#distinct" id="id17"><sup>4</sup></a></dd>
|
||||
not.<a class="footnote-reference" href="#distinct" id="id16"><sup>4</sup></a></dd>
|
||||
<dt><tt class="docutils literal">boost_regex</tt></dt>
|
||||
<dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
|
||||
@ -636,7 +633,7 @@ libraries.</td>
|
||||
<td>python-debugging=on</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal">d</tt></td>
|
||||
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id18"><sup>5</sup></a></td>
|
||||
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id17"><sup>5</sup></a></td>
|
||||
<td>variant=debug</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal">p</tt></td>
|
||||
@ -674,7 +671,7 @@ version number, will also be created.</dd>
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="test-your-program">
|
||||
<h2><a class="toc-backref" href="#id36">6.2 Test Your Program</a></h2>
|
||||
<h2><a class="toc-backref" href="#id35">6.2 Test Your Program</a></h2>
|
||||
<p>To test our subject extraction, we'll filter the following text
|
||||
file. Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:</p>
|
||||
<pre class="literal-block">
|
||||
@ -714,7 +711,7 @@ Spoil Rock Hunter?”</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="conclusion-and-further-resources">
|
||||
<h1><a class="toc-backref" href="#id37">7 Conclusion and Further Resources</a></h1>
|
||||
<h1><a class="toc-backref" href="#id36">7 Conclusion and Further Resources</a></h1>
|
||||
<p>This concludes your introduction to Boost and to integrating it
|
||||
with your programs. As you start using Boost in earnest, there are
|
||||
surely a few additional points you'll wish we had covered. One day
|
||||
@ -725,10 +722,8 @@ make this document clearer, please post it to the <a class="reference external"
|
||||
mailing list</a>.</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
|
||||
<li><a class="reference external" href="../../tools/build/v2/engine/index.html">Boost.Jam reference manual</a></li>
|
||||
<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
|
||||
<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
|
||||
<li><a class="reference external" href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2">Boost.Build Wiki</a></li>
|
||||
<li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
|
||||
</ul>
|
||||
<div class="admonition-onward admonition">
|
||||
@ -751,7 +746,7 @@ to the <a class="reference external" href="http://www.boost.org/more/mailing_lis
|
||||
<table class="docutils footnote" frame="void" id="lowercase-l" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id15">[2]</a></td><td>That option is a dash followed by a lowercase “L”
|
||||
<tr><td class="label"><a class="fn-backref" href="#id14">[2]</a></td><td>That option is a dash followed by a lowercase “L”
|
||||
character, which looks very much like a numeral 1 in some fonts.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -772,7 +767,7 @@ have any source code mechanism for suppressing warnings.</td></tr>
|
||||
<table class="docutils footnote" frame="void" id="distinct" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id17">[4]</a></td><td>This convention distinguishes the static version of
|
||||
<tr><td class="label"><a class="fn-backref" href="#id16">[4]</a></td><td>This convention distinguishes the static version of
|
||||
a Boost library from the import library for an
|
||||
identically-configured Boost DLL, which would otherwise have the
|
||||
same name.</td></tr>
|
||||
@ -781,7 +776,7 @@ same name.</td></tr>
|
||||
<table class="docutils footnote" frame="void" id="debug-abi" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id18">[5]</a></td><td>These libraries were compiled without optimization
|
||||
<tr><td class="label"><a class="fn-backref" href="#id17">[5]</a></td><td>These libraries were compiled without optimization
|
||||
or inlining, with full debug symbols enabled, and without
|
||||
<tt class="docutils literal">NDEBUG</tt> <tt class="docutils literal">#define</tt>d. Although it's true that sometimes
|
||||
these choices don't affect binary compatibility with other
|
||||
|
||||
@ -26,45 +26,45 @@ not supported—they may or may not work.</p>
|
||||
<div class="contents topic" id="index">
|
||||
<p class="topic-title first">Index</p>
|
||||
<ul class="auto-toc simple">
|
||||
<li><a class="reference internal" href="#get-boost" id="id29">1 Get Boost</a></li>
|
||||
<li><a class="reference internal" href="#the-boost-distribution" id="id30">2 The Boost Distribution</a></li>
|
||||
<li><a class="reference internal" href="#header-only-libraries" id="id31">3 Header-Only Libraries</a></li>
|
||||
<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id32">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#build-from-the-visual-studio-ide" id="id33">4.1 Build From the Visual Studio IDE</a></li>
|
||||
<li><a class="reference internal" href="#or-build-from-the-command-prompt" id="id34">4.2 Or, Build From the Command Prompt</a></li>
|
||||
<li><a class="reference internal" href="#errors-and-warnings" id="id35">4.3 Errors and Warnings</a></li>
|
||||
<li><a class="reference internal" href="#get-boost" id="id28">1 Get Boost</a></li>
|
||||
<li><a class="reference internal" href="#the-boost-distribution" id="id29">2 The Boost Distribution</a></li>
|
||||
<li><a class="reference internal" href="#header-only-libraries" id="id30">3 Header-Only Libraries</a></li>
|
||||
<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id31">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#build-from-the-visual-studio-ide" id="id32">4.1 Build From the Visual Studio IDE</a></li>
|
||||
<li><a class="reference internal" href="#or-build-from-the-command-prompt" id="id33">4.2 Or, Build From the Command Prompt</a></li>
|
||||
<li><a class="reference internal" href="#errors-and-warnings" id="id34">4.3 Errors and Warnings</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id36">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#install-visual-studio-binaries" id="id37">5.1 Install Visual Studio Binaries</a></li>
|
||||
<li><a class="reference internal" href="#or-simplified-build-from-source" id="id38">5.2 Or, Simplified Build From Source</a></li>
|
||||
<li><a class="reference internal" href="#or-build-binaries-from-source" id="id39">5.3 Or, Build Binaries From Source</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#get-bjam" id="id40">5.3.1 Get <tt class="docutils literal">bjam</tt></a></li>
|
||||
<li><a class="reference internal" href="#identify-your-toolset" id="id41">5.3.2 Identify Your Toolset</a></li>
|
||||
<li><a class="reference internal" href="#select-a-build-directory" id="id42">5.3.3 Select a Build Directory</a></li>
|
||||
<li><a class="reference internal" href="#invoke-bjam" id="id43">5.3.4 Invoke <tt class="docutils literal">bjam</tt></a></li>
|
||||
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id35">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#install-visual-studio-binaries" id="id36">5.1 Install Visual Studio Binaries</a></li>
|
||||
<li><a class="reference internal" href="#or-simplified-build-from-source" id="id37">5.2 Or, Simplified Build From Source</a></li>
|
||||
<li><a class="reference internal" href="#or-build-binaries-from-source" id="id38">5.3 Or, Build Binaries From Source</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#install-boost-build" id="id39">5.3.1 Install Boost.Build</a></li>
|
||||
<li><a class="reference internal" href="#identify-your-toolset" id="id40">5.3.2 Identify Your Toolset</a></li>
|
||||
<li><a class="reference internal" href="#select-a-build-directory" id="id41">5.3.3 Select a Build Directory</a></li>
|
||||
<li><a class="reference internal" href="#invoke-bjam" id="id42">5.3.4 Invoke <tt class="docutils literal">bjam</tt></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#expected-build-output" id="id44">5.4 Expected Build Output</a></li>
|
||||
<li><a class="reference internal" href="#in-case-of-build-errors" id="id45">5.5 In Case of Build Errors</a></li>
|
||||
<li><a class="reference internal" href="#expected-build-output" id="id43">5.4 Expected Build Output</a></li>
|
||||
<li><a class="reference internal" href="#in-case-of-build-errors" id="id44">5.5 In Case of Build Errors</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id46">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#link-from-within-the-visual-studio-ide" id="id47">6.1 Link From Within the Visual Studio IDE</a></li>
|
||||
<li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id48">6.2 Or, Link From the Command Prompt</a></li>
|
||||
<li><a class="reference internal" href="#library-naming" id="id49">6.3 Library Naming</a></li>
|
||||
<li><a class="reference internal" href="#test-your-program" id="id50">6.4 Test Your Program</a></li>
|
||||
<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id45">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
|
||||
<li><a class="reference internal" href="#link-from-within-the-visual-studio-ide" id="id46">6.1 Link From Within the Visual Studio IDE</a></li>
|
||||
<li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id47">6.2 Or, Link From the Command Prompt</a></li>
|
||||
<li><a class="reference internal" href="#library-naming" id="id48">6.3 Library Naming</a></li>
|
||||
<li><a class="reference internal" href="#test-your-program" id="id49">6.4 Test Your Program</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#conclusion-and-further-resources" id="id51">7 Conclusion and Further Resources</a></li>
|
||||
<li><a class="reference internal" href="#conclusion-and-further-resources" id="id50">7 Conclusion and Further Resources</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="get-boost">
|
||||
<h1><a class="toc-backref" href="#id29">1 Get Boost</a></h1>
|
||||
<h1><a class="toc-backref" href="#id28">1 Get Boost</a></h1>
|
||||
<p>The easiest way to get a copy of Boost is to use an installer. The
|
||||
<a class="reference external" href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html">Boost website version of this Getting Started guide</a> will have
|
||||
<a class="reference external" href="http://www.boost.org/more/getting_started/index.html">Boost website version of this Getting Started guide</a> will have
|
||||
undated information on installers as they become available, or see
|
||||
<a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041">Boost downloads</a> or the <a class="reference external" href="http://www.boostpro.com/products/free">installer</a> provided by <a class="reference external" href="http://www.boostpro.com">BoostPro
|
||||
<a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html">Boost downloads</a> or the <a class="reference external" href="http://www.boostpro.com/products/free">installer</a> provided by <a class="reference external" href="http://www.boostpro.com">BoostPro
|
||||
Computing</a>. 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
|
||||
@ -73,14 +73,14 @@ least install the Static Multithreaded variants of the <a class="reference exter
|
||||
binaries when given the option.</p>
|
||||
<p>If you're using an earlier version of Visual Studio or some other
|
||||
compiler, or if you prefer to build everything yourself, you can
|
||||
download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.zip</tt></a> and unpack it to install a complete Boost
|
||||
download <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.zip</tt></a> and unpack it to install a complete Boost
|
||||
distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a></p>
|
||||
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="the-boost-distribution">
|
||||
<h1><a class="toc-backref" href="#id30">2 The Boost Distribution</a></h1>
|
||||
<h1><a class="toc-backref" href="#id29">2 The Boost Distribution</a></h1>
|
||||
<p>This is a sketch of the resulting directory structure:</p>
|
||||
<pre class="literal-block">
|
||||
<strong>boost_1_46_0</strong><strong>\</strong> .................<em>The “boost root directory”</em>
|
||||
@ -163,7 +163,7 @@ contains a subset of the Boost documentation. Start with
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="header-only-libraries">
|
||||
<h1><a class="toc-backref" href="#id31">3 Header-Only Libraries</a></h1>
|
||||
<h1><a class="toc-backref" href="#id30">3 Header-Only Libraries</a></h1>
|
||||
<p>The first thing many people want to know is, “how do I build
|
||||
Boost?” The good news is that often, there's nothing to build.</p>
|
||||
<div class="admonition-nothing-to-build admonition">
|
||||
@ -210,7 +210,7 @@ use</strong>.</li>
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="build-a-simple-program-using-boost">
|
||||
<h1><a class="toc-backref" href="#id32">4 Build a Simple Program Using Boost</a></h1>
|
||||
<h1><a class="toc-backref" href="#id31">4 Build a Simple Program Using Boost</a></h1>
|
||||
<p>To keep things simple, let's start by using a header-only library.
|
||||
The following program reads a sequence of integers from standard
|
||||
input, uses Boost.Lambda to multiply each number by three, and
|
||||
@ -266,7 +266,7 @@ caret (<tt class="docutils literal">^</tt>) at the end of all but the last line.
|
||||
on this page use that technique to save horizontal space.</p>
|
||||
</div>
|
||||
<div class="section" id="build-from-the-visual-studio-ide">
|
||||
<span id="vs-header-only"></span><h2><a class="toc-backref" href="#id33">4.1 Build From the Visual Studio IDE</a></h2>
|
||||
<span id="vs-header-only"></span><h2><a class="toc-backref" href="#id32">4.1 Build From the Visual Studio IDE</a></h2>
|
||||
<ul>
|
||||
<li><p class="first">From Visual Studio's <em>File</em> menu, select <em>New</em> > <em>Project…</em></p>
|
||||
</li>
|
||||
@ -307,7 +307,7 @@ Return key.</p>
|
||||
<p><a class="reference internal" href="#errors-and-warnings"><em>skip to the next step</em></a></p>
|
||||
</div>
|
||||
<div class="section" id="or-build-from-the-command-prompt">
|
||||
<h2><a class="toc-backref" href="#id34">4.2 Or, Build From the Command Prompt</a></h2>
|
||||
<h2><a class="toc-backref" href="#id33">4.2 Or, Build From the Command Prompt</a></h2>
|
||||
<p>From your computer's <em>Start</em> menu, if you are a Visual
|
||||
Studio 2005 user, select</p>
|
||||
<blockquote>
|
||||
@ -333,7 +333,7 @@ echo 1 2 3 | example
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="errors-and-warnings">
|
||||
<h2><a class="toc-backref" href="#id35">4.3 Errors and Warnings</a></h2>
|
||||
<h2><a class="toc-backref" href="#id34">4.3 Errors and Warnings</a></h2>
|
||||
<p>Don't be alarmed if you see compiler warnings originating in Boost
|
||||
headers. We try to eliminate them, but doing so isn't always
|
||||
practical.<a class="footnote-reference" href="#warnings" id="id7"><sup>5</sup></a> <strong>Errors are another matter</strong>. If you're
|
||||
@ -346,11 +346,11 @@ correctly identified the <a class="reference internal" href="#boost-root-directo
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="prepare-to-use-a-boost-library-binary">
|
||||
<h1><a class="toc-backref" href="#id36">5 Prepare to Use a Boost Library Binary</a></h1>
|
||||
<h1><a class="toc-backref" href="#id35">5 Prepare to Use a Boost Library Binary</a></h1>
|
||||
<p>If you want to use any of the separately-compiled Boost libraries,
|
||||
you'll need to acquire library binaries.</p>
|
||||
<div class="section" id="install-visual-studio-binaries">
|
||||
<h2><a class="toc-backref" href="#id37">5.1 Install Visual Studio Binaries</a></h2>
|
||||
<h2><a class="toc-backref" href="#id36">5.1 Install Visual Studio Binaries</a></h2>
|
||||
<p>The installers supplied by BoostPro Computing will download and
|
||||
install pre-compiled binaries into the <tt class="docutils literal">lib\</tt> subdirectory of the
|
||||
boost root, typically <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">\lib\</tt>. If you installed
|
||||
@ -360,7 +360,7 @@ now.</p>
|
||||
<p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
|
||||
</div>
|
||||
<div class="section" id="or-simplified-build-from-source">
|
||||
<h2><a class="toc-backref" href="#id38">5.2 Or, Simplified Build From Source</a></h2>
|
||||
<h2><a class="toc-backref" href="#id37">5.2 Or, Simplified Build From Source</a></h2>
|
||||
<p>If you wish to build from source with Visual C++, you can use a
|
||||
simple build procedure described in this section. Open the command prompt
|
||||
and change your current directory to the Boost root directory. Then, type
|
||||
@ -375,7 +375,7 @@ libraries. Please consult the <a class="reference external" href="http://www.boo
|
||||
of options that can be passed to <tt class="docutils literal">bjam</tt>.</p>
|
||||
</div>
|
||||
<div class="section" id="or-build-binaries-from-source">
|
||||
<h2><a class="toc-backref" href="#id39">5.3 Or, Build Binaries From Source</a></h2>
|
||||
<h2><a class="toc-backref" href="#id38">5.3 Or, Build Binaries From Source</a></h2>
|
||||
<p>If you're using an earlier version of Visual C++, or a compiler
|
||||
from another vendor, you'll need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create your
|
||||
own binaries.</p>
|
||||
@ -387,31 +387,28 @@ separately. See the <a class="reference external" href="https://svn.boost.org/t
|
||||
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
|
||||
<!-- Software License, Version 1.0. (See accompanying -->
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
<div class="section" id="install-boost-build">
|
||||
<h3><a class="toc-backref" href="#id39">5.3.1 Install Boost.Build</a></h3>
|
||||
<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
|
||||
installing software. To use it, you'll need an executable called
|
||||
<tt class="docutils literal">bjam</tt>.</p>
|
||||
<!-- .. _Boost.Jam documentation: Boost.Jam_ -->
|
||||
<div class="section" id="get-bjam">
|
||||
<h3><a class="toc-backref" href="#id40">5.3.1 Get <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<p><tt class="docutils literal">bjam</tt> is the <a class="reference internal" href="#command-line-tool">command-line tool</a> that drives the Boost Build
|
||||
system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
|
||||
Boost root.</p>
|
||||
<p>We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
|
||||
Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
|
||||
instructions</a>.</p>
|
||||
<p>Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
|
||||
see the list of directories in your PATH, separated by semicolons,
|
||||
by typing “<tt class="docutils literal">PATH</tt>” at the command prompt.</p>
|
||||
installing software. First, you'll need to build and
|
||||
install it. To do this:</p>
|
||||
<ol class="arabic simple">
|
||||
<li>Go to the directory <tt class="docutils literal">tools</tt><tt class="docutils literal">\</tt><tt class="docutils literal">build</tt><tt class="docutils literal">\</tt><tt class="docutils literal">v2</tt><tt class="docutils literal">\</tt>.</li>
|
||||
<li>Run <tt class="docutils literal">bootstrap.bat</tt></li>
|
||||
<li>Run <tt class="docutils literal">bjam install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
|
||||
the directory where you want Boost.Build to be installed</li>
|
||||
<li>Add <em>PREFIX</em><tt class="docutils literal">\</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div class="section" id="identify-your-toolset">
|
||||
<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id41">5.3.2 Identify Your Toolset</a></h3>
|
||||
<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id40">5.3.2 Identify Your Toolset</a></h3>
|
||||
<p>First, find the toolset corresponding to your compiler in the
|
||||
following table (an up-to-date list is always available <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html">in the
|
||||
Boost.Build documentation</a>).</p>
|
||||
<div class="note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">If you previously chose a toolset for the purposes of
|
||||
<a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
|
||||
<a class="reference external" href="../../doc/html/bbv2/installation.html">building bjam</a>, you should assume it won't work and instead
|
||||
choose newly from the table below.</p>
|
||||
</div>
|
||||
<table border="1" class="docutils">
|
||||
@ -506,7 +503,7 @@ are using the msvc or gcc toolsets, which have special version
|
||||
detection code) or <a class="reference internal" href="#auto-linking">auto-linking</a> will fail.</p>
|
||||
</div>
|
||||
<div class="section" id="select-a-build-directory">
|
||||
<span id="id14"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id42">5.3.3 Select a Build Directory</a></h3>
|
||||
<span id="id13"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id41">5.3.3 Select a Build Directory</a></h3>
|
||||
<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
|
||||
building into the <strong>build directory</strong>. If your Boost root
|
||||
directory is writable, this step isn't strictly necessary: by
|
||||
@ -514,15 +511,15 @@ default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subd
|
||||
purpose in your current working directory.</p>
|
||||
</div>
|
||||
<div class="section" id="invoke-bjam">
|
||||
<h3><a class="toc-backref" href="#id43">5.3.4 Invoke <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<h3><a class="toc-backref" href="#id42">5.3.4 Invoke <tt class="docutils literal">bjam</tt></a></h3>
|
||||
<p>Change your current directory to the Boost root directory and
|
||||
invoke <tt class="docutils literal">bjam</tt> as follows:</p>
|
||||
<pre class="literal-block">
|
||||
bjam <strong>--build-dir=</strong><a class="reference internal" href="#id14"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <strong>--build-type=complete</strong> stage
|
||||
bjam <strong>--build-dir=</strong><a class="reference internal" href="#id13"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <strong>--build-type=complete</strong> stage
|
||||
</pre>
|
||||
<p>For a complete description of these and other invocation options,
|
||||
please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.</p>
|
||||
<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id16"><sup>4</sup></a></p>
|
||||
<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>4</sup></a></p>
|
||||
<pre class="literal-block">
|
||||
C:\WINDOWS> cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_46_0</tt>
|
||||
<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_46_0</tt>> bjam <strong>^</strong>
|
||||
@ -570,7 +567,7 @@ file by appending “<tt class="docutils literal">>build.log <span class="pre
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="expected-build-output">
|
||||
<h2><a class="toc-backref" href="#id44">5.4 Expected Build Output</a></h2>
|
||||
<h2><a class="toc-backref" href="#id43">5.4 Expected Build Output</a></h2>
|
||||
<p>During the process of building Boost libraries, you can expect to
|
||||
see some messages printed on the console. These may include</p>
|
||||
<ul>
|
||||
@ -594,7 +591,7 @@ look something like:</p>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="in-case-of-build-errors">
|
||||
<h2><a class="toc-backref" href="#id45">5.5 In Case of Build Errors</a></h2>
|
||||
<h2><a class="toc-backref" href="#id44">5.5 In Case of Build Errors</a></h2>
|
||||
<p>The only error messages you see when building Boost—if any—should
|
||||
be related to the IOStreams library's support of zip and bzip2
|
||||
formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>. Install the relevant development
|
||||
@ -611,7 +608,7 @@ for your compiler to the <a class="reference external" href="http://www.boost.or
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="link-your-program-to-a-boost-library">
|
||||
<h1><a class="toc-backref" href="#id46">6 Link Your Program to a Boost Library</a></h1>
|
||||
<h1><a class="toc-backref" href="#id45">6 Link Your Program to a Boost Library</a></h1>
|
||||
<p>To demonstrate linking with a Boost binary library, we'll use the
|
||||
following simple program that extracts the subject lines from
|
||||
emails. It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
|
||||
@ -656,7 +653,7 @@ GCC users should refer to the <a class="reference external" href="unix-variants.
|
||||
variant OSes</a> for the appropriate command-line options to use.</p>
|
||||
</div>
|
||||
<div class="section" id="link-from-within-the-visual-studio-ide">
|
||||
<h2><a class="toc-backref" href="#id47">6.1 Link From Within the Visual Studio IDE</a></h2>
|
||||
<h2><a class="toc-backref" href="#id46">6.1 Link From Within the Visual Studio IDE</a></h2>
|
||||
<p>Starting with the <a class="reference internal" href="#vs-header-only">header-only example project</a> we created
|
||||
earlier:</p>
|
||||
<ol class="arabic simple">
|
||||
@ -670,7 +667,7 @@ e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boos
|
||||
<p><a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a></p>
|
||||
</div>
|
||||
<div class="section" id="or-link-from-the-command-prompt">
|
||||
<h2><a class="toc-backref" href="#id48">6.2 Or, Link From the Command Prompt</a></h2>
|
||||
<h2><a class="toc-backref" href="#id47">6.2 Or, Link From the Command Prompt</a></h2>
|
||||
<p>For example, we can compile and link the above program from the
|
||||
Visual C++ command-line by simply adding the <strong>bold</strong> text below to
|
||||
the command line we used earlier, assuming your Boost binaries are
|
||||
@ -681,7 +678,7 @@ cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_46_0</tt> exam
|
||||
</pre>
|
||||
</div>
|
||||
<div class="section" id="library-naming">
|
||||
<h2><a class="toc-backref" href="#id49">6.3 Library Naming</a></h2>
|
||||
<h2><a class="toc-backref" href="#id48">6.3 Library Naming</a></h2>
|
||||
<div class="note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p>If, like Visual C++, your compiler supports auto-linking,
|
||||
@ -703,7 +700,7 @@ following elements:</p>
|
||||
<dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
|
||||
name begins with this string. On Windows, only ordinary static
|
||||
libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
|
||||
not.<a class="footnote-reference" href="#distinct" id="id24"><sup>6</sup></a></dd>
|
||||
not.<a class="footnote-reference" href="#distinct" id="id23"><sup>6</sup></a></dd>
|
||||
<dt><tt class="docutils literal">boost_regex</tt></dt>
|
||||
<dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
|
||||
<dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
|
||||
@ -746,7 +743,7 @@ libraries.</td>
|
||||
<td>python-debugging=on</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal">d</tt></td>
|
||||
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id25"><sup>7</sup></a></td>
|
||||
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id24"><sup>7</sup></a></td>
|
||||
<td>variant=debug</td>
|
||||
</tr>
|
||||
<tr><td><tt class="docutils literal">p</tt></td>
|
||||
@ -784,7 +781,7 @@ version number, will also be created.</dd>
|
||||
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
|
||||
</div>
|
||||
<div class="section" id="test-your-program">
|
||||
<h2><a class="toc-backref" href="#id50">6.4 Test Your Program</a></h2>
|
||||
<h2><a class="toc-backref" href="#id49">6.4 Test Your Program</a></h2>
|
||||
<p>To test our subject extraction, we'll filter the following text
|
||||
file. Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:</p>
|
||||
<pre class="literal-block">
|
||||
@ -806,7 +803,7 @@ Spoil Rock Hunter?”</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="conclusion-and-further-resources">
|
||||
<h1><a class="toc-backref" href="#id51">7 Conclusion and Further Resources</a></h1>
|
||||
<h1><a class="toc-backref" href="#id50">7 Conclusion and Further Resources</a></h1>
|
||||
<p>This concludes your introduction to Boost and to integrating it
|
||||
with your programs. As you start using Boost in earnest, there are
|
||||
surely a few additional points you'll wish we had covered. One day
|
||||
@ -817,10 +814,8 @@ make this document clearer, please post it to the <a class="reference external"
|
||||
mailing list</a>.</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
|
||||
<li><a class="reference external" href="../../tools/build/v2/engine/index.html">Boost.Jam reference manual</a></li>
|
||||
<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
|
||||
<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
|
||||
<li><a class="reference external" href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2">Boost.Build Wiki</a></li>
|
||||
<li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
|
||||
</ul>
|
||||
<div class="admonition-onward admonition">
|
||||
@ -835,7 +830,7 @@ mailing list</a>.</p>
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend
|
||||
downloading <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.7z</tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress
|
||||
downloading <a class="reference external" href="http://www.boost.org/users/history/version_1_46_0.html"><tt class="docutils literal">boost_1_46_0</tt><tt class="docutils literal">.7z</tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress
|
||||
it. We no longer recommend .zip files for Boost because they are twice
|
||||
as large as the equivalent .7z files. We don't recommend using Windows'
|
||||
built-in decompression as it can be painfully slow for large archives.</td></tr>
|
||||
@ -863,7 +858,7 @@ used in the examples.</td></tr>
|
||||
<table class="docutils footnote" frame="void" id="continuation" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id16">[4]</a></td><td><p class="first">In this example, the caret character <tt class="docutils literal">^</tt> is a
|
||||
<tr><td class="label"><a class="fn-backref" href="#id15">[4]</a></td><td><p class="first">In this example, the caret character <tt class="docutils literal">^</tt> is a
|
||||
way of continuing the command on multiple lines, and must be the
|
||||
<strong>final character</strong> used on the line to be continued (i.e. do
|
||||
not follow it with spaces). The command prompt responds with
|
||||
@ -901,7 +896,7 @@ have any source code mechanism for suppressing warnings.</td></tr>
|
||||
<table class="docutils footnote" frame="void" id="distinct" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id24">[6]</a></td><td>This convention distinguishes the static version of
|
||||
<tr><td class="label"><a class="fn-backref" href="#id23">[6]</a></td><td>This convention distinguishes the static version of
|
||||
a Boost library from the import library for an
|
||||
identically-configured Boost DLL, which would otherwise have the
|
||||
same name.</td></tr>
|
||||
@ -910,7 +905,7 @@ same name.</td></tr>
|
||||
<table class="docutils footnote" frame="void" id="debug-abi" rules="none">
|
||||
<colgroup><col class="label" /><col /></colgroup>
|
||||
<tbody valign="top">
|
||||
<tr><td class="label"><a class="fn-backref" href="#id25">[7]</a></td><td>These libraries were compiled without optimization
|
||||
<tr><td class="label"><a class="fn-backref" href="#id24">[7]</a></td><td>These libraries were compiled without optimization
|
||||
or inlining, with full debug symbols enabled, and without
|
||||
<tt class="docutils literal">NDEBUG</tt> <tt class="docutils literal">#define</tt>d. Although it's true that sometimes
|
||||
these choices don't affect binary compatibility with other
|
||||
|
||||
@ -47,7 +47,7 @@ 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
|
||||
http://www.boost.org/more/getting_started/index.html
|
||||
.. _`Boost downloads`: `sf-download`_
|
||||
.. _installer: http://www.boostpro.com/products/free
|
||||
.. _BoostPro Computing: http://www.boostpro.com
|
||||
|
||||
Loading…
Reference in New Issue
Block a user