diff options
| author | Daniel James <daniel@calamity.org.uk> | 2016-10-02 23:02:55 +0100 |
|---|---|---|
| committer | Daniel James <daniel@calamity.org.uk> | 2016-10-02 23:02:55 +0100 |
| commit | 29e356ada071a9ada70d71fec6c1fbe7ee9bb7c4 (patch) | |
| tree | 15648f079a4cc7cbf497ba8eedaa78e0946ee779 /more | |
| parent | ef6650821e5ddc641fefe5f36a890761dc61b828 (diff) | |
| download | boost-29e356ada071a9ada70d71fec6c1fbe7ee9bb7c4.tar.gz | |
Rebuild getting started docs after adding Boost.Log
Diffstat (limited to 'more')
| -rw-r--r-- | more/getting_started/unix-variants.html | 90 | ||||
| -rw-r--r-- | more/getting_started/windows.html | 110 |
2 files changed, 100 insertions, 100 deletions
diff --git a/more/getting_started/unix-variants.html b/more/getting_started/unix-variants.html index a5947172a5..fedb53fd2d 100644 --- a/more/getting_started/unix-variants.html +++ b/more/getting_started/unix-variants.html @@ -30,36 +30,36 @@ <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="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> +<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> </ul> </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-b2" id="id30">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></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="#install-boost-build" id="id28">5.2.1 Install Boost.Build</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-b2" id="id31">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></li> </ul> </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> +<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> </ul> </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> +<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> </ul> </li> -<li><a class="reference internal" href="#conclusion-and-further-resources" id="id36">7 Conclusion and Further Resources</a></li> +<li><a class="reference internal" href="#conclusion-and-further-resources" id="id37">7 Conclusion and Further Resources</a></li> </ul> </div> <div class="section" id="get-boost"> -<h1><a class="toc-backref" href="#id19">1 Get Boost</a></h1> +<h1><a class="toc-backref" href="#id20">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://www.boost.org/users/history/version_1_63_0.html">SourceForge</a>:</p> <ol class="arabic"> @@ -88,7 +88,7 @@ from <a class="reference external" href="http://www.boost.org/users/history/vers <!-- 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="#id20">2 The Boost Distribution</a></h1> +<h1><a class="toc-backref" href="#id21">2 The Boost Distribution</a></h1> <p>This is a sketch of the resulting directory structure:</p> <pre class="literal-block"> <strong>boost_1_63_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="#id21">3 Header-Only Libraries</a></h1> +<h1><a class="toc-backref" href="#id22">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"> @@ -222,7 +222,7 @@ which requires a separately-compiled binary. This is enabled by <!-- 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="#id22">4 Build a Simple Program Using Boost</a></h1> +<h1><a class="toc-backref" href="#id23">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 @@ -256,10 +256,10 @@ 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="#id23">4.1 Errors and Warnings</a></h2> +<h2><a class="toc-backref" href="#id24">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 +practical.<a class="footnote-reference" href="#warnings" id="id6"><sup>3</sup></a> <strong>Errors are another matter</strong>. If you're seeing compilation errors at this point in the tutorial, check to be sure you've copied the <a class="reference internal" href="#build-a-simple-program-using-boost">example program</a> correctly and that you've correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p> @@ -269,11 +269,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="#id24">5 Prepare to Use a Boost Library Binary</a></h1> +<h1><a class="toc-backref" href="#id25">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="#id25">5.1 Easy Build and Install</a></h2> +<h2><a class="toc-backref" href="#id26">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"> @@ -301,7 +301,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="#id26">5.2 Or, Build Custom Binaries</a></h2> +<h2><a class="toc-backref" href="#id27">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 @@ -311,7 +311,7 @@ use this method if you need a nonstandard build variant (see the <!-- 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> +<h3><a class="toc-backref" href="#id28">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. First, you'll need to build and install it. To do this:</p> @@ -324,7 +324,7 @@ the directory where you want Boost.Build to be installed</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="#id28">5.2.2 Identify Your Toolset</a></h3> +<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id29">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/build/doc/html/bbv2/reference/tools.html">in the Boost.Build documentation</a>).</p> @@ -408,7 +408,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="id10"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id29">5.2.3 Select a Build Directory</a></h3> +<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> <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 @@ -416,11 +416,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-b2"> -<h3><a class="toc-backref" href="#id30">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></h3> +<h3><a class="toc-backref" href="#id31">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></h3> <p>Change your current directory to the Boost root directory and invoke <tt class="docutils literal">b2</tt> as follows:</p> <pre class="literal-block"> -b2 <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 +b2 <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 </pre> <p>For a complete description of these and other invocation options, please see the <a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a>.</p> @@ -465,7 +465,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="#id31">5.3 Expected Build Output</a></h2> +<h2><a class="toc-backref" href="#id32">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> @@ -489,7 +489,7 @@ look something like:</p> </ul> </div> <div class="section" id="in-case-of-build-errors"> -<h2><a class="toc-backref" href="#id32">5.4 In Case of Build Errors</a></h2> +<h2><a class="toc-backref" href="#id33">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 @@ -506,7 +506,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="#id33">6 Link Your Program to a Boost Library</a></h1> +<h1><a class="toc-backref" href="#id34">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 @@ -546,7 +546,7 @@ $ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_63_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="id14"><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="id15"><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_63_0</tt> example.cpp -o example <strong>\</strong> @@ -564,7 +564,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="#id34">6.1 Library Naming</a></h2> +<h2><a class="toc-backref" href="#id35">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) --> @@ -579,7 +579,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="id16"><sup>4</sup></a></dd> +not.<a class="footnote-reference" href="#distinct" id="id17"><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> @@ -622,7 +622,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="id17"><sup>5</sup></a></td> +<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id18"><sup>5</sup></a></td> <td>variant=debug</td> </tr> <tr><td><tt class="docutils literal">p</tt></td> @@ -660,7 +660,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="#id35">6.2 Test Your Program</a></h2> +<h2><a class="toc-backref" href="#id36">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"> @@ -700,7 +700,7 @@ Spoil Rock Hunter?”</p> </div> </div> <div class="section" id="conclusion-and-further-resources"> -<h1><a class="toc-backref" href="#id36">7 Conclusion and Further Resources</a></h1> +<h1><a class="toc-backref" href="#id37">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 @@ -735,7 +735,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="#id14">[2]</a></td><td>That option is a dash followed by a lowercase “L” +<tr><td class="label"><a class="fn-backref" href="#id15">[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> @@ -745,7 +745,7 @@ character, which looks very much like a numeral 1 in some fonts.</td></tr> <table class="docutils footnote" frame="void" id="warnings" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> -<tr><td class="label"><a class="fn-backref" href="#id5">[3]</a></td><td>Remember that warnings are specific to each compiler +<tr><td class="label"><a class="fn-backref" href="#id6">[3]</a></td><td>Remember that warnings are specific to each compiler implementation. The developer of a given Boost library might not have access to your compiler. Also, some warnings are extremely difficult to eliminate in generic code, to the point @@ -756,7 +756,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="#id16">[4]</a></td><td>This convention distinguishes the static version of +<tr><td class="label"><a class="fn-backref" href="#id17">[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> @@ -765,7 +765,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="#id17">[5]</a></td><td>These libraries were compiled without optimization +<tr><td class="label"><a class="fn-backref" href="#id18">[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 diff --git a/more/getting_started/windows.html b/more/getting_started/windows.html index be81b5de1f..5c1f5b8ecb 100644 --- a/more/getting_started/windows.html +++ b/more/getting_started/windows.html @@ -26,40 +26,40 @@ 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="id27">1 Get Boost</a></li> -<li><a class="reference internal" href="#the-boost-distribution" id="id28">2 The Boost Distribution</a></li> -<li><a class="reference internal" href="#header-only-libraries" id="id29">3 Header-Only Libraries</a></li> -<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id30">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="id31">4.1 Build From the Visual Studio IDE</a></li> -<li><a class="reference internal" href="#or-build-from-the-command-prompt" id="id32">4.2 Or, Build From the Command Prompt</a></li> -<li><a class="reference internal" href="#errors-and-warnings" id="id33">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="id34">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc"> -<li><a class="reference internal" href="#simplified-build-from-source" id="id35">5.1 Simplified Build From Source</a></li> -<li><a class="reference internal" href="#or-build-binaries-from-source" id="id36">5.2 Or, Build Binaries From Source</a><ul class="auto-toc"> -<li><a class="reference internal" href="#install-boost-build" id="id37">5.2.1 Install Boost.Build</a></li> -<li><a class="reference internal" href="#identify-your-toolset" id="id38">5.2.2 Identify Your Toolset</a></li> -<li><a class="reference internal" href="#select-a-build-directory" id="id39">5.2.3 Select a Build Directory</a></li> -<li><a class="reference internal" href="#invoke-b2" id="id40">5.2.4 Invoke <tt class="docutils literal">b2</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="#simplified-build-from-source" id="id36">5.1 Simplified Build From Source</a></li> +<li><a class="reference internal" href="#or-build-binaries-from-source" id="id37">5.2 Or, Build Binaries From Source</a><ul class="auto-toc"> +<li><a class="reference internal" href="#install-boost-build" id="id38">5.2.1 Install Boost.Build</a></li> +<li><a class="reference internal" href="#identify-your-toolset" id="id39">5.2.2 Identify Your Toolset</a></li> +<li><a class="reference internal" href="#select-a-build-directory" id="id40">5.2.3 Select a Build Directory</a></li> +<li><a class="reference internal" href="#invoke-b2" id="id41">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></li> </ul> </li> -<li><a class="reference internal" href="#expected-build-output" id="id41">5.3 Expected Build Output</a></li> -<li><a class="reference internal" href="#in-case-of-build-errors" id="id42">5.4 In Case of Build Errors</a></li> +<li><a class="reference internal" href="#expected-build-output" id="id42">5.3 Expected Build Output</a></li> +<li><a class="reference internal" href="#in-case-of-build-errors" id="id43">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="id43">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="id44">6.1 Link From Within the Visual Studio IDE</a></li> -<li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id45">6.2 Or, Link From the Command Prompt</a></li> -<li><a class="reference internal" href="#library-naming" id="id46">6.3 Library Naming</a></li> -<li><a class="reference internal" href="#test-your-program" id="id47">6.4 Test Your Program</a></li> +<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id44">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="id45">6.1 Link From Within the Visual Studio IDE</a></li> +<li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id46">6.2 Or, Link From the Command Prompt</a></li> +<li><a class="reference internal" href="#library-naming" id="id47">6.3 Library Naming</a></li> +<li><a class="reference internal" href="#test-your-program" id="id48">6.4 Test Your Program</a></li> </ul> </li> -<li><a class="reference internal" href="#conclusion-and-further-resources" id="id48">7 Conclusion and Further Resources</a></li> +<li><a class="reference internal" href="#conclusion-and-further-resources" id="id49">7 Conclusion and Further Resources</a></li> </ul> </div> <div class="section" id="get-boost"> -<h1><a class="toc-backref" href="#id27">1 Get Boost</a></h1> +<h1><a class="toc-backref" href="#id28">1 Get Boost</a></h1> <p>The most reliable way to get a copy of Boost is to download <a class="reference external" href="http://www.boost.org/users/history/version_1_63_0.html"><tt class="docutils literal">boost_1_63_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_63_0.html"><tt class="docutils literal">boost_1_63_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> @@ -68,7 +68,7 @@ distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a> <!-- 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="#id28">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_63_0</strong><strong>\</strong> .................<em>The “boost root directory”</em> @@ -151,7 +151,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="#id29">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"> @@ -207,7 +207,7 @@ which requires a separately-compiled binary. This is enabled by <!-- 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="#id30">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 @@ -263,7 +263,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="#id31">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> @@ -286,7 +286,7 @@ Directories</em>, enter the path to the Boost root directory, for example</p> </li> <li><p class="first">In <em>Configuration Properties</em> > <em>C/C++</em> > <em>Precompiled Headers</em>, change <em>Use Precompiled Header (/Yu)</em> to <em>Not Using Precompiled -Headers</em>.<a class="footnote-reference" href="#pch" id="id5"><sup>2</sup></a></p> +Headers</em>.<a class="footnote-reference" href="#pch" id="id6"><sup>2</sup></a></p> </li> <li><p class="first">Replace the contents of the <tt class="docutils literal">example.cpp</tt> generated by the IDE with the example code above.</p> @@ -304,7 +304,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="#id32">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> @@ -330,10 +330,10 @@ 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="#id33">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>4</sup></a> <strong>Errors are another matter</strong>. If you're +practical.<a class="footnote-reference" href="#warnings" id="id8"><sup>4</sup></a> <strong>Errors are another matter</strong>. If you're seeing compilation errors at this point in the tutorial, check to be sure you've copied the <a class="reference internal" href="#build-a-simple-program-using-boost">example program</a> correctly and that you've correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p> @@ -343,11 +343,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="#id34">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="simplified-build-from-source"> -<h2><a class="toc-backref" href="#id35">5.1 Simplified Build From Source</a></h2> +<h2><a class="toc-backref" href="#id36">5.1 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 @@ -362,7 +362,7 @@ libraries. Please consult the <a class="reference external" href="http://www.boo of allowed options.</p> </div> <div class="section" id="or-build-binaries-from-source"> -<h2><a class="toc-backref" href="#id36">5.2 Or, Build Binaries From Source</a></h2> +<h2><a class="toc-backref" href="#id37">5.2 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> @@ -370,7 +370,7 @@ own binaries.</p> <!-- 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="#id37">5.2.1 Install Boost.Build</a></h3> +<h3><a class="toc-backref" href="#id38">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. First, you'll need to build and install it. To do this:</p> @@ -383,7 +383,7 @@ the directory where you want Boost.Build to be installed</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="#id38">5.2.2 Identify Your Toolset</a></h3> +<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id39">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/build/doc/html/bbv2/reference/tools.html">in the Boost.Build documentation</a>).</p> @@ -470,7 +470,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="id12"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id39">5.2.3 Select a Build Directory</a></h3> +<span id="id13"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id40">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 @@ -478,15 +478,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-b2"> -<h3><a class="toc-backref" href="#id40">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></h3> +<h3><a class="toc-backref" href="#id41">5.2.4 Invoke <tt class="docutils literal">b2</tt></a></h3> <p>Change your current directory to the Boost root directory and invoke <tt class="docutils literal">b2</tt> as follows:</p> <pre class="literal-block"> -b2 <strong>--build-dir=</strong><a class="reference internal" href="#id12"><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 +b2 <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/build/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a>.</p> -<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id14"><sup>3</sup></a></p> +<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>3</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_63_0</tt> <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_63_0</tt>> b2 <strong>^</strong> @@ -534,7 +534,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="#id41">5.3 Expected Build Output</a></h2> +<h2><a class="toc-backref" href="#id42">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> @@ -558,7 +558,7 @@ look something like:</p> </ul> </div> <div class="section" id="in-case-of-build-errors"> -<h2><a class="toc-backref" href="#id42">5.4 In Case of Build Errors</a></h2> +<h2><a class="toc-backref" href="#id43">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 @@ -575,7 +575,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="#id43">6 Link Your Program to a Boost Library</a></h1> +<h1><a class="toc-backref" href="#id44">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 @@ -620,7 +620,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="#id44">6.1 Link From Within the Visual Studio IDE</a></h2> +<h2><a class="toc-backref" href="#id45">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"> @@ -634,7 +634,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="#id45">6.2 Or, Link From the Command Prompt</a></h2> +<h2><a class="toc-backref" href="#id46">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 @@ -645,7 +645,7 @@ cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_63_0</tt> exam </pre> </div> <div class="section" id="library-naming"> -<h2><a class="toc-backref" href="#id46">6.3 Library Naming</a></h2> +<h2><a class="toc-backref" href="#id47">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, @@ -667,7 +667,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="id22"><sup>5</sup></a></dd> +not.<a class="footnote-reference" href="#distinct" id="id23"><sup>5</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> @@ -710,7 +710,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="id23"><sup>6</sup></a></td> +<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id24"><sup>6</sup></a></td> <td>variant=debug</td> </tr> <tr><td><tt class="docutils literal">p</tt></td> @@ -748,7 +748,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="#id47">6.4 Test Your Program</a></h2> +<h2><a class="toc-backref" href="#id48">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"> @@ -770,7 +770,7 @@ Spoil Rock Hunter?”</p> </div> </div> <div class="section" id="conclusion-and-further-resources"> -<h1><a class="toc-backref" href="#id48">7 Conclusion and Further Resources</a></h1> +<h1><a class="toc-backref" href="#id49">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 @@ -806,7 +806,7 @@ built-in decompression as it can be painfully slow for large archives.</td></tr> <table class="docutils footnote" frame="void" id="pch" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> -<tr><td class="label"><a class="fn-backref" href="#id5">[2]</a></td><td>There's no problem using Boost with precompiled headers; +<tr><td class="label"><a class="fn-backref" href="#id6">[2]</a></td><td>There's no problem using Boost with precompiled headers; these instructions merely avoid precompiled headers because it would require Visual Studio-specific changes to the source code used in the examples.</td></tr> @@ -815,7 +815,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="#id14">[3]</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">[3]</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 @@ -842,7 +842,7 @@ command-line argument contains spaces, as in</p> <table class="docutils footnote" frame="void" id="warnings" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> -<tr><td class="label"><a class="fn-backref" href="#id7">[4]</a></td><td>Remember that warnings are specific to each compiler +<tr><td class="label"><a class="fn-backref" href="#id8">[4]</a></td><td>Remember that warnings are specific to each compiler implementation. The developer of a given Boost library might not have access to your compiler. Also, some warnings are extremely difficult to eliminate in generic code, to the point @@ -853,7 +853,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="#id22">[5]</a></td><td>This convention distinguishes the static version of +<tr><td class="label"><a class="fn-backref" href="#id23">[5]</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> @@ -862,7 +862,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="#id23">[6]</a></td><td>These libraries were compiled without optimization +<tr><td class="label"><a class="fn-backref" href="#id24">[6]</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 |