diff --git a/getting_started/index.html b/getting_started/index.html index 2f60d00..07428bd 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -14,6 +14,13 @@ <!-- Copyright David Abrahams 2006. Distributed under the Boost --> <!-- Software License, Version 1.0. (See accompanying --> <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) --> +<div class="admonition-use-the-latest-version-of-this-getting-started-guide admonition"> +<p class="first admonition-title">Use the latest version of this Getting Started guide</p> +<p class="last">The <a class="reference external" href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html">Boost website version of this Getting Started guide</a> may +have undated information, such as the location of additional installers +or improved installation procedures, so you might want use that version +if you've got an Internet connection available.</p> +</div> <div class="section" id="welcome"> <h1>Welcome</h1> <p>Welcome to the Boost libraries! By the time you've completed this diff --git a/getting_started/index.rst b/getting_started/index.rst index 23bfa7b..d12b400 100644 --- a/getting_started/index.rst +++ b/getting_started/index.rst @@ -12,6 +12,16 @@ __ ../../index.htm +.. Admonition:: Use the latest version of this Getting Started guide + + The `Boost website version of this Getting Started guide`_ may + have undated information, such as the location of additional installers + or improved installation procedures, so you might want use that version + if you've got an Internet connection available. + + .. _`Boost website version of this Getting Started guide`: + http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html + Welcome ------- diff --git a/getting_started/unix-variants.html b/getting_started/unix-variants.html index 91a29ff..0830ef1 100644 --- a/getting_started/unix-variants.html +++ b/getting_started/unix-variants.html @@ -63,12 +63,12 @@ <p>The most reliable way to get a copy of Boost is to download a distribution from <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041">SourceForge</a>:</p> <ol class="arabic"> -<li><p class="first">Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">.tar.bz2</span></tt></a>.</p> +<li><p class="first">Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">.tar.bz2</span></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"><span class="pre">boost_1_35_0</span></tt>.tar.bz2 +tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt>.tar.bz2 </pre> </li> </ol> @@ -91,7 +91,7 @@ from <a class="reference external" href="http://sourceforge.net/project/showfile <h1><a class="toc-backref" href="#id19">2 The Boost Distribution</a></h1> <p>This is a sketch of the resulting directory structure:</p> <pre class="literal-block"> -<strong>boost_1_35_0</strong><strong>/</strong> .................<em>The “boost root directory”</em> +<strong>boost_1_36_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"><span class="pre">/usr/local/</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt>) is +<li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">/usr/local/</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt>) is sometimes referred to as <tt class="docutils literal"><span class="pre">$BOOST_ROOT</span></tt> in documentation and mailing lists .</p> </li> @@ -230,7 +230,7 @@ int main() <p>Now, in the directory where you saved <tt class="docutils literal"><span class="pre">example.cpp</span></tt>, issue the following command:</p> <pre class="literal-block"> -c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> example.cpp -o example +c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> example.cpp -o example </pre> <p>To test the result, type:</p> <pre class="literal-block"> @@ -261,7 +261,7 @@ you'll need to acquire library binaries.</p> <p>Issue the following commands in the shell (don't type <tt class="docutils literal"><span class="pre">$</span></tt>; that represents the shell's prompt):</p> <pre class="literal-block"> -<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> +<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> <strong>$</strong> ./configure --help </pre> <p>Select your configuration options and invoke <tt class="docutils literal"><span class="pre">./configure</span></tt> again @@ -425,9 +425,14 @@ bjam <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em </pre> <p>For example, your session might look like this:</p> <pre class="literal-block"> -$ cd ~/<tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> +$ cd ~/<tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> $ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>--toolset=</strong>gcc stage </pre> +<p>That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations:</p> +<pre class="literal-block"> +$ cd ~/<tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> +$ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>--toolset=</strong>gcc <strong>--build-type=</strong>complete stage +</pre> <!-- 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) --> @@ -533,15 +538,15 @@ 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"><span class="pre">boost_1_35_0</span></tt> example.cpp -o example <strong>\</strong> - <strong>~/boost/lib/libboost_regex-gcc34-mt-d-1_35.a</strong> +$ c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> example.cpp -o example <strong>\</strong> + <strong>~/boost/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="id12"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal"><span class="pre">lib</span></tt> and trailing suffix (<tt class="docutils literal"><span class="pre">.a</span></tt> in this case):</p> <pre class="literal-block"> -$ c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> example.cpp -o example <strong>\</strong> - <strong>-L~/boost/lib/ -lboost_regex-gcc34-mt-d-1_35</strong> +$ c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> example.cpp -o example <strong>\</strong> + <strong>-L~/boost/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 library; it <em>really</em> pays off when you're using multiple diff --git a/getting_started/unix-variants.rst b/getting_started/unix-variants.rst index c8b1db1..0a734e0 100644 --- a/getting_started/unix-variants.rst +++ b/getting_started/unix-variants.rst @@ -142,6 +142,13 @@ For example, your session might look like this: $ cd ~/|boost_ver| $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc stage +That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations: + +.. parsed-literal:: + + $ cd ~/|boost_ver| + $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc **--build-type=**\ complete stage + .. include:: detail/build-from-source-tail.rst .. include:: detail/link-head.rst diff --git a/getting_started/windows.html b/getting_started/windows.html index 32d61f7..beb71e6 100644 --- a/getting_started/windows.html +++ b/getting_started/windows.html @@ -69,7 +69,7 @@ them yourself. To complete this tutorial, you'll need to at least install 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://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">.exe</span></tt></a> and run it to install a complete Boost +download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">.exe</span></tt></a> and run 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 --> @@ -79,7 +79,7 @@ distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a> <h1><a class="toc-backref" href="#id25">2 The Boost Distribution</a></h1> <p>This is a sketch of the resulting directory structure:</p> <pre class="literal-block"> -<strong>boost_1_35_0</strong><strong>\</strong> .................<em>The “boost root directory”</em> +<strong>boost_1_36_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> @@ -124,7 +124,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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt>) is sometimes referred to as <tt class="docutils literal"><span class="pre">$BOOST_ROOT</span></tt> in documentation and mailing lists .</p> </li> @@ -248,7 +248,7 @@ 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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> +cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> </pre> <p class="last">Long commands can be continued across several lines by typing a caret (<tt class="docutils literal"><span class="pre">^</span></tt>) at the end of all but the last line. Some examples @@ -273,7 +273,7 @@ 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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt></p> +<p><tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt></p> </blockquote> </li> <li><p class="first">In <em>Configuration Properties</em> > <em>C/C++</em> > <em>Precompiled Headers</em>, change @@ -311,7 +311,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"><span class="pre">boost_1_35_0</span></tt> <em>path</em>\<em>to</em>\example.cpp +cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> <em>path</em>\<em>to</em>\example.cpp </pre> <p>To test the result, type:</p> <pre class="literal-block"> @@ -342,7 +342,7 @@ you'll need to acquire library binaries.</p> <h2><a class="toc-backref" href="#id32">5.1 Install Visual Studio (2005 or .NET 2003) Binaries</a></h2> <p>The <a class="reference external" href="http://www.boost-consulting.com/download/windows">installer</a> supplied by Boost Consulting will download and install pre-compiled binaries into the <tt class="docutils literal"><span class="pre">lib\</span></tt> subdirectory of the -boost root, typically <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></tt>. If you installed +boost root, typically <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></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> @@ -491,8 +491,8 @@ bjam <strong>--build-dir=</strong><a class="reference internal" href="#id12"><em </pre> <p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id13"><sup>4</sup></a></p> <pre class="literal-block"> -C:\WINDOWS> cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> -<tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt>> bjam <strong>^</strong> +C:\WINDOWS> cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> +<tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt>> bjam <strong>^</strong> More? <strong>--build-dir=</strong>"C:\Documents and Settings\dave\build-boost" <strong>^</strong> More? <strong>--toolset=</strong>msvc stage </pre> @@ -620,7 +620,7 @@ 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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></tt>.</li> +e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></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> @@ -630,10 +630,10 @@ e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> <span clas <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> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">\lib</span></tt>:</p> +in <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">\lib</span></tt>:</p> <pre class="literal-block"> -cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt> example.cpp <strong>^</strong> - <strong>/link /LIBPATH:</strong> <strong>C:\Program Files\boost\</strong><strong>boost_1_35_0</strong><strong>\lib</strong> +cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt> example.cpp <strong>^</strong> + <strong>/link /LIBPATH:</strong> <strong>C:\Program Files\boost\</strong><strong>boost_1_36_0</strong><strong>\lib</strong> </pre> </div> <div class="section" id="library-naming"> @@ -788,7 +788,7 @@ mailing list</a>.</p> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>If you prefer not to download executable programs, -download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_35_0</span></tt><tt class="docutils literal"><span class="pre">.zip</span></tt></a> and use an external tool to decompress +download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span class="pre">.zip</span></tt></a> and use an external tool to decompress it. We don't recommend using Windows' built-in decompression as it can be painfully slow for large archives.</td></tr> </tbody>