diff options
| author | Daniel James <daniel@calamity.org.uk> | 2013-03-03 11:06:40 +0000 |
|---|---|---|
| committer | Daniel James <daniel@calamity.org.uk> | 2013-03-03 11:06:40 +0000 |
| commit | 4a8c16ed6a433df92f5751f1d72431f7ea144545 (patch) | |
| tree | 39bc40734548c1dc9eb6f1ec383ab49ff4014917 /more | |
| parent | 2f61fb3b3ff3edef47a3dfc01f4db71a829bf2cc (diff) | |
| download | boost-4a8c16ed6a433df92f5751f1d72431f7ea144545.tar.gz | |
Merge getting started guide.
Removes references to the boostpro installer.
[SVN r83267]
Diffstat (limited to 'more')
| -rw-r--r-- | more/getting_started/index.html | 2 | ||||
| -rw-r--r-- | more/getting_started/unix-variants.html | 24 | ||||
| -rw-r--r-- | more/getting_started/windows.html | 176 | ||||
| -rw-r--r-- | more/getting_started/windows.rst | 44 |
4 files changed, 88 insertions, 158 deletions
diff --git a/more/getting_started/index.html b/more/getting_started/index.html index f82b1e4367..14a4021572 100644 --- a/more/getting_started/index.html +++ b/more/getting_started/index.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" /> <title>Boost Getting Started</title> <link rel="stylesheet" href="../../rst.css" type="text/css" /> </head> diff --git a/more/getting_started/unix-variants.html b/more/getting_started/unix-variants.html index 4b3ee6d2bb..598af61c19 100644 --- a/more/getting_started/unix-variants.html +++ b/more/getting_started/unix-variants.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" /> <title>Boost Getting Started on Unix Variants</title> <meta content="Getting Started with Boost on Unix Variants (including Linux and MacOS)" name="description" /> <link rel="stylesheet" href="../../rst.css" type="text/css" /> @@ -61,14 +61,14 @@ <div class="section" id="get-boost"> <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://www.boost.org/users/history/version_1_53_0.html">SourceForge</a>:</p> +distribution from <a class="reference external" href="http://www.boost.org/users/history/version_1_54_0.html">SourceForge</a>:</p> <ol class="arabic"> -<li><p class="first">Download <a class="reference external" href="http://www.boost.org/users/history/version_1_53_0.html"><tt class="docutils literal">boost_1_53_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_54_0.html"><tt class="docutils literal">boost_1_54_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> <pre class="literal-block"> -tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal">boost_1_53_0</tt>.tar.bz2 +tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal">boost_1_54_0</tt>.tar.bz2 </pre> </li> </ol> @@ -81,7 +81,7 @@ 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://www.boost.org/users/history/version_1_53_0.html">SourceForge</a>.</p> +from <a class="reference external" href="http://www.boost.org/users/history/version_1_54_0.html">SourceForge</a>.</p> </div> <!-- Copyright David Abrahams 2006. Distributed under the Boost --> <!-- Software License, Version 1.0. (See accompanying --> @@ -91,7 +91,7 @@ from <a class="reference external" href="http://www.boost.org/users/history/vers <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_53_0</strong><strong>/</strong> .................<em>The “boost root directory”</em> +<strong>boost_1_54_0</strong><strong>/</strong> .................<em>The “boost root directory”</em> <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em> <strong>boost</strong><strong>/</strong> .........................<em>All Boost Header files</em> <tt class="docutils literal"> </tt> @@ -136,7 +136,7 @@ anything you can use in these directories.</p> </div> <p>It's important to note the following:</p> <ol class="arabic" id="boost-root-directory"> -<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_53_0</tt>) is +<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_54_0</tt>) is sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and mailing lists .</p> </li> @@ -237,7 +237,7 @@ int main() <p>Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the following command:</p> <pre class="literal-block"> -c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_53_0</tt> example.cpp -o example +c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_54_0</tt> example.cpp -o example </pre> <p>To test the result, type:</p> <pre class="literal-block"> @@ -268,7 +268,7 @@ you'll need to acquire library binaries.</p> <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"> -<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal">boost_1_53_0</tt> +<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal">boost_1_54_0</tt> <strong>$</strong> ./bootstrap.sh --help </pre> <p>Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again @@ -420,7 +420,7 @@ b2 <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em>b 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:</p> <pre class="literal-block"> -$ cd ~/<tt class="docutils literal">boost_1_53_0</tt> +$ cd ~/<tt class="docutils literal">boost_1_54_0</tt> $ b2 <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage </pre> <p>That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “<tt class="docutils literal"><span class="pre">--build-type=complete</span></tt>”.</p> @@ -536,14 +536,14 @@ project.</li> <ol class="upperalpha"> <li><p class="first">You can specify the full path to each library:</p> <pre class="literal-block"> -$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_53_0</tt> example.cpp -o example <strong>\</strong> +$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_54_0</tt> example.cpp -o example <strong>\</strong> <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 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_53_0</tt> example.cpp -o example <strong>\</strong> +$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_54_0</tt> example.cpp -o example <strong>\</strong> <strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong> </pre> <p>As you can see, this method is just as terse as method A for one diff --git a/more/getting_started/windows.html b/more/getting_started/windows.html index e790395cf9..1ca06e8c5d 100644 --- a/more/getting_started/windows.html +++ b/more/getting_started/windows.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" /> +<meta name="generator" content="Docutils 0.8.1: http://docutils.sourceforge.net/" /> <title>Boost Getting Started on Windows</title> <link rel="stylesheet" href="../../rst.css" type="text/css" /> </head> @@ -26,64 +26,52 @@ 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="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> +<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> </ul> </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-b2" id="id42">5.3.4 Invoke <tt class="docutils literal">b2</tt></a></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> </ul> </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> +<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> </ul> </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> +<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> </ul> </li> -<li><a class="reference internal" href="#conclusion-and-further-resources" id="id50">7 Conclusion and Further Resources</a></li> +<li><a class="reference internal" href="#conclusion-and-further-resources" id="id48">7 Conclusion and Further Resources</a></li> </ul> </div> <div class="section" id="get-boost"> -<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/more/getting_started/index.html">Boost website version of this Getting Started guide</a> will have -updated information on installers as they become available, or see -<a class="reference external" href="http://www.boost.org/users/history/version_1_53_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 -building them yourself. To complete this tutorial, you'll need to at -least install the Static Multithreaded variants of the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> -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://www.boost.org/users/history/version_1_53_0.html"><tt class="docutils literal">boost_1_53_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_53_0.html"><tt class="docutils literal">boost_1_53_0</tt><tt class="docutils literal">.zip</tt></a> and unpack it to install a complete Boost +<h1><a class="toc-backref" href="#id27">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_54_0.html"><tt class="docutils literal">boost_1_54_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://www.boost.org/users/history/version_1_54_0.html"><tt class="docutils literal">boost_1_54_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="#id29">2 The Boost Distribution</a></h1> +<h1><a class="toc-backref" href="#id28">2 The Boost Distribution</a></h1> <p>This is a sketch of the resulting directory structure:</p> <pre class="literal-block"> -<strong>boost_1_53_0</strong><strong>\</strong> .................<em>The “boost root directory”</em> +<strong>boost_1_54_0</strong><strong>\</strong> .................<em>The “boost root directory”</em> <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em> <strong>boost</strong><strong>\</strong> .........................<em>All Boost Header files</em> <strong>lib</strong><strong>\</strong> .....................<em>precompiled library binaries</em> @@ -128,7 +116,7 @@ anything you can use in these directories.</p> </div> <p>It's important to note the following:</p> <ol class="arabic" id="boost-root-directory"> -<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt>) is +<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt>) is sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and mailing lists .</p> </li> @@ -163,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="#id30">3 Header-Only Libraries</a></h1> +<h1><a class="toc-backref" href="#id29">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 +198,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="#id31">4 Build a Simple Program Using Boost</a></h1> +<h1><a class="toc-backref" href="#id30">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 @@ -259,14 +247,14 @@ cd <em>path</em>\<em>to</em>\<em>some</em>\<em>directory</em> </pre> <p>followed by Return. For example,</p> <pre class="literal-block"> -cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt> +cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt> </pre> <p class="last">Long commands can be continued across several lines by typing a caret (<tt class="docutils literal">^</tt>) at the end of all but the last line. Some examples 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="#id32">4.1 Build From the Visual Studio IDE</a></h2> +<span id="vs-header-only"></span><h2><a class="toc-backref" href="#id31">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> @@ -284,12 +272,12 @@ select <em>Properties</em> from the resulting pop-up menu</p> <li><p class="first">In <em>Configuration Properties</em> > <em>C/C++</em> > <em>General</em> > <em>Additional Include Directories</em>, enter the path to the Boost root directory, for example</p> <blockquote> -<p><tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt></p> +<p><tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt></p> </blockquote> </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>3</sup></a></p> +Headers</em>.<a class="footnote-reference" href="#pch" id="id5"><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> @@ -307,7 +295,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="#id33">4.2 Or, Build From the Command Prompt</a></h2> +<h2><a class="toc-backref" href="#id32">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> @@ -322,7 +310,7 @@ Visual Studio compiler. In that window, set the <a class="reference internal" h directory</a> to a suitable location for creating some temporary files and type the following command followed by the Return key:</p> <pre class="literal-block"> -cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_53_0</tt> <em>path</em>\<em>to</em>\example.cpp +cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_54_0</tt> <em>path</em>\<em>to</em>\example.cpp </pre> <p>To test the result, type:</p> <pre class="literal-block"> @@ -333,10 +321,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="#id34">4.3 Errors and Warnings</a></h2> +<h2><a class="toc-backref" href="#id33">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 +practical.<a class="footnote-reference" href="#warnings" id="id7"><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> @@ -346,21 +334,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="#id35">5 Prepare to Use a Boost Library Binary</a></h1> +<h1><a class="toc-backref" href="#id34">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="#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_53_0</tt><tt class="docutils literal">\lib\</tt>. If you installed -all variants of the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> binary, you're done with this -step. Otherwise, please run the installer again and install them -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="#id37">5.2 Or, Simplified Build From Source</a></h2> +<div class="section" id="simplified-build-from-source"> +<h2><a class="toc-backref" href="#id35">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 @@ -375,7 +353,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="#id38">5.3 Or, Build Binaries From Source</a></h2> +<h2><a class="toc-backref" href="#id36">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> @@ -388,7 +366,7 @@ separately. See the <a class="reference external" href="https://svn.boost.org/t <!-- 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> +<h3><a class="toc-backref" href="#id37">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> @@ -401,7 +379,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="#id40">5.3.2 Identify Your Toolset</a></h3> +<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id38">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> @@ -486,7 +464,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="id13"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id41">5.3.3 Select a Build Directory</a></h3> +<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> <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 @@ -494,18 +472,18 @@ 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="#id42">5.3.4 Invoke <tt class="docutils literal">b2</tt></a></h3> +<h3><a class="toc-backref" href="#id40">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="#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 +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 </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="id15"><sup>4</sup></a></p> +<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id14"><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_53_0</tt> -<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt>> b2 <strong>^</strong> +C:\WINDOWS> cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt> +<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt>> b2 <strong>^</strong> More? <strong>--build-dir=</strong>"C:\Documents and Settings\dave\build-boost" <strong>^</strong> More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage </pre> @@ -550,7 +528,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="#id43">5.4 Expected Build Output</a></h2> +<h2><a class="toc-backref" href="#id41">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> @@ -574,7 +552,7 @@ look something like:</p> </ul> </div> <div class="section" id="in-case-of-build-errors"> -<h2><a class="toc-backref" href="#id44">5.5 In Case of Build Errors</a></h2> +<h2><a class="toc-backref" href="#id42">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 @@ -591,7 +569,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="#id45">6 Link Your Program to a Boost Library</a></h1> +<h1><a class="toc-backref" href="#id43">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 @@ -636,7 +614,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="#id46">6.1 Link From Within the Visual Studio IDE</a></h2> +<h2><a class="toc-backref" href="#id44">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"> @@ -644,24 +622,24 @@ earlier:</p> select <em>Properties</em> from the resulting pop-up menu</li> <li>In <em>Configuration Properties</em> > <em>Linker</em> > <em>Additional Library Directories</em>, enter the path to the Boost binaries, -e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt><tt class="docutils literal">\lib\</tt>.</li> +e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt><tt class="docutils literal">\lib\</tt>.</li> <li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li> </ol> <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="#id47">6.2 Or, Link From the Command Prompt</a></h2> +<h2><a class="toc-backref" href="#id45">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 -in <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_53_0</tt><tt class="docutils literal">\lib</tt>:</p> +in <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_54_0</tt><tt class="docutils literal">\lib</tt>:</p> <pre class="literal-block"> -cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_53_0</tt> example.cpp <strong>^</strong> - <strong>/link /LIBPATH:</strong><strong>C:\Program Files\boost\</strong><strong>boost_1_53_0</strong><strong>\lib</strong> +cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_54_0</tt> example.cpp <strong>^</strong> + <strong>/link /LIBPATH:</strong><strong>C:\Program Files\boost\</strong><strong>boost_1_54_0</strong><strong>\lib</strong> </pre> </div> <div class="section" id="library-naming"> -<h2><a class="toc-backref" href="#id48">6.3 Library Naming</a></h2> +<h2><a class="toc-backref" href="#id46">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, @@ -683,7 +661,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="id23"><sup>6</sup></a></dd> +not.<a class="footnote-reference" href="#distinct" id="id22"><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> @@ -726,7 +704,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="id24"><sup>7</sup></a></td> +<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id23"><sup>6</sup></a></td> <td>variant=debug</td> </tr> <tr><td><tt class="docutils literal">p</tt></td> @@ -764,7 +742,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="#id49">6.4 Test Your Program</a></h2> +<h2><a class="toc-backref" href="#id47">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"> @@ -786,7 +764,7 @@ Spoil Rock Hunter?”</p> </div> </div> <div class="section" id="conclusion-and-further-resources"> -<h1><a class="toc-backref" href="#id50">7 Conclusion and Further Resources</a></h1> +<h1><a class="toc-backref" href="#id48">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 @@ -813,26 +791,16 @@ 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://www.boost.org/users/history/version_1_53_0.html"><tt class="docutils literal">boost_1_53_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_54_0.html"><tt class="docutils literal">boost_1_54_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> </tbody> </table> -<table class="docutils footnote" frame="void" id="installer-src" rules="none"> -<colgroup><col class="label" /><col /></colgroup> -<tbody valign="top"> -<tr><td class="label">[2]</td><td>If you used the <a class="reference external" href="http://www.boostpro.com/products/free">installer</a> from Boost -Consulting and deselected “Source and Documentation” (it's -selected by default), you won't see the <tt class="docutils literal">libs/</tt> subdirectory. -That won't affect your ability to use precompiled binaries, but -you won't be able to rebuild libraries from scratch.</td></tr> -</tbody> -</table> <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">[3]</a></td><td>There's no problem using Boost with precompiled headers; +<tr><td class="label"><a class="fn-backref" href="#id5">[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> @@ -841,7 +809,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="#id15">[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="#id14">[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 @@ -868,7 +836,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">[5]</a></td><td>Remember that warnings are specific to each compiler +<tr><td class="label"><a class="fn-backref" href="#id7">[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 @@ -879,7 +847,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="#id23">[6]</a></td><td>This convention distinguishes the static version of +<tr><td class="label"><a class="fn-backref" href="#id22">[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> @@ -888,7 +856,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="#id24">[7]</a></td><td>These libraries were compiled without optimization +<tr><td class="label"><a class="fn-backref" href="#id23">[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 @@ -898,7 +866,7 @@ compiled code, you can't count on that with Boost libraries.</td></tr> <table class="docutils footnote" frame="void" id="native" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> -<tr><td class="label">[8]</td><td>This feature of STLPort is deprecated because it's +<tr><td class="label">[7]</td><td>This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it.</td></tr> </tbody> diff --git a/more/getting_started/windows.rst b/more/getting_started/windows.rst index a8fb652bac..29d5b5ea2f 100644 --- a/more/getting_started/windows.rst +++ b/more/getting_started/windows.rst @@ -35,25 +35,7 @@ __ ../../index.htm Get Boost ========= -The easiest way to get a copy of Boost is to use an installer. The -`Boost website version of this Getting Started guide`_ will have -updated information on installers as they become available, or see -`Boost downloads`_ or the installer_ provided by `BoostPro -Computing`_. We especially recommend using an installer if you use -Microsoft Visual Studio, because the installer can download and -install precompiled library binaries, saving you the trouble of -building them yourself. To complete this tutorial, you'll need to at -least install the Static Multithreaded variants of the Boost.Regex_ -binaries when given the option. - -.. _`Boost website version of this Getting Started guide`: - http://www.boost.org/more/getting_started/index.html -.. _`Boost downloads`: `sf-download`_ -.. _installer: http://www.boostpro.com/products/free -.. _BoostPro Computing: http://www.boostpro.com - -If you're using an earlier version of Visual Studio or some other -compiler, or if you prefer to build everything yourself, you can +The most reliable way to get a copy of Boost is to download |boost.7z|_ or |boost_zip|_ and unpack it to install a complete Boost distribution. [#zip]_ @@ -185,22 +167,8 @@ To test the result, type: .. include:: detail/binary-head.rst -Install Visual Studio Binaries ------------------------------- - -The installers supplied by BoostPro Computing will download and -install pre-compiled binaries into the ``lib\`` subdirectory of the -boost root, typically |default-root|\ ``\lib\``. If you installed -all variants of the Boost.Regex_ binary, you're done with this -step. Otherwise, please run the installer again and install them -now. - -|next|__ - -__ `Link Your Program to a Boost Library`_ - -Or, Simplified Build From Source --------------------------------- +Simplified Build From Source +---------------------------- 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 @@ -340,12 +308,6 @@ Spoil Rock Hunter?” .. _7-Zip: http://www.7-zip.org -.. [#installer-src] If you used the installer_ from Boost - Consulting and deselected “Source and Documentation” (it's - selected by default), you won't see the ``libs/`` subdirectory. - That won't affect your ability to use precompiled binaries, but - you won't be able to rebuild libraries from scratch. - .. [#pch] 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 |