Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r57637 - branches/release/more/getting_started
From: bdawes_at_[hidden]
Date: 2009-11-13 09:50:27

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r57638 - branches/release"
Previous message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r57636 - branches/release/tools/release"

Author: bemandawes
Date: 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
New Revision: 57637
URL: http://svn.boost.org/trac/boost/changeset/57637

Log:
GSG: merge trunk
Text files modified:
   branches/release/more/getting_started/index.html | 7 -
   branches/release/more/getting_started/index.rst | 9 -
   branches/release/more/getting_started/unix-variants.html | 195 ++++++++++++++++++++-------------------
   branches/release/more/getting_started/unix-variants.rst | 20 ++-
   branches/release/more/getting_started/windows.html | 194 +++++++++++++++++++-------------------
   branches/release/more/getting_started/windows.rst | 16 +-
   6 files changed, 215 insertions(+), 226 deletions(-)

Modified: branches/release/more/getting_started/index.html
==============================================================================
--- branches/release/more/getting_started/index.html (original)
+++ branches/release/more/getting_started/index.html 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -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.6: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>Boost Getting Started</title>
<link rel="stylesheet" href="../../rst.css" type="text/css" />
</head>
@@ -48,11 +48,6 @@
Here you're expected to imagine replacing the text â€œyour nameâ€ with
your actual name.
</div>
-<div class="section" id="alternate-method-boost-cmake">
-<h1>Alternate method: Boost.CMake</h1>
-There is a cmake build for boost, supported and distributed
-separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.
-</div>
<div class="section" id="ready">
<h1>Ready?</h1>
Let's go!

Modified: branches/release/more/getting_started/index.rst
==============================================================================
--- branches/release/more/getting_started/index.rst (original)
+++ branches/release/more/getting_started/index.rst 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -54,15 +54,6 @@
Here you're expected to imagine replacing the text â€œyour nameâ€ with
your actual name.

-Alternate method: Boost.CMake
-------------------------------
-
-There is a cmake build for boost, supported and distributed
-separately. See the `Boost.CMake`_ wiki page for more information.
-
-.. _`Boost.CMake`:
- https://svn.boost.org/trac/boost/wiki/CMake
-
Ready?
------

Modified: branches/release/more/getting_started/unix-variants.html
==============================================================================
--- branches/release/more/getting_started/unix-variants.html (original)
+++ branches/release/more/getting_started/unix-variants.html 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -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.6: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.7: 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" />
@@ -40,10 +40,10 @@
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id26">5   Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
<li><a class="reference internal" href="#easy-build-and-install" id="id27">5.1   Easy Build and Install</a></li>
<li><a class="reference internal" href="#or-build-custom-binaries" id="id28">5.2   Or, Build Custom Binaries</a><ul class="auto-toc">
-<li><a class="reference internal" href="#get-bjam" id="id29">5.2.1   Get <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#get-bjam" id="id29">5.2.1   Get <tt class="docutils literal">bjam</tt></a></li>
<li><a class="reference internal" href="#identify-your-toolset" id="id30">5.2.2   Identify Your Toolset</a></li>
<li><a class="reference internal" href="#select-a-build-directory" id="id31">5.2.3   Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam" id="id32">5.2.4   Invoke <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#invoke-bjam" id="id32">5.2.4   Invoke <tt class="docutils literal">bjam</tt></a></li>
</ul>
</li>
<li><a class="reference internal" href="#expected-build-output" id="id33">5.3   Expected Build Output</a></li>
@@ -63,12 +63,12 @@
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>:
<ol class="arabic">
-<li>Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.
+<li>Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.
</li>
<li>In the directory where you want to put the Boost installation,
execute
<pre class="literal-block">
-tar --bzip2 -xf /path/to/<tt class="docutils literal">boost_1_41_0</tt>.tar.bz2
+tar --bzip2 -xf /path/to/<tt class="docutils literal">boost_1_41_0</tt>.tar.bz2
</pre>
</li>
</ol>
@@ -112,40 +112,40 @@
but most libraries follow a few patterns:
<ul class="pre-wrap last">
<li>Some older libraries and most very small libraries place all
-public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>.
+public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>.
</li>
<li>Most libraries' public headers live in a subdirectory of
-<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>, named after the library. For example, you'll find
-the Python library's <tt class="docutils literal">def.hpp</tt> header in
+<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>, named after the library. For example, you'll find
+the Python library's <tt class="docutils literal">def.hpp</tt> header in
<pre class="literal-block">
-<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt><tt class="docutils literal">python</tt><tt class="docutils literal">/</tt><tt class="docutils literal">def.hpp</tt>.
+<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt><tt class="docutils literal">python</tt><tt class="docutils literal">/</tt><tt class="docutils literal">def.hpp</tt>.
</pre>
</li>
-<li>Some libraries have an â€œaggregate headerâ€ in <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> that
-<tt class="docutils literal">#include</tt>s all of the library's other headers. For
+<li>Some libraries have an â€œaggregate headerâ€ in <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> that
+<tt class="docutils literal">#include</tt>s all of the library's other headers. For
example, <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a>'s aggregate header is
<pre class="literal-block">
-<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt><tt class="docutils literal">python.hpp</tt>.
+<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt><tt class="docutils literal">python.hpp</tt>.
</pre>
</li>
<li>Most libraries place private headers in a subdirectory called
-<tt class="docutils literal">detail</tt><tt class="docutils literal">/</tt>, or <tt class="docutils literal">aux_</tt><tt class="docutils literal">/</tt>. Don't expect to find
+<tt class="docutils literal">detail</tt><tt class="docutils literal">/</tt>, or <tt class="docutils literal">aux_</tt><tt class="docutils literal">/</tt>. Don't expect to find
anything you can use in these directories.
</li>
</ul>
</div>
It's important to note the following:
<ol class="arabic" id="boost-root-directory">
-<li>The path to the boost root directory (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_41_0</tt>) is
-sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
+<li>The path to the boost root directory (often <tt class="docutils literal">/usr/local/</tt><tt class="docutils literal">boost_1_41_0</tt>) is
+sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
mailing lists .
</li>
<li>To compile anything in Boost, you need a directory containing
-the <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> subdirectory in your <tt class="docutils literal">#include</tt> path. <tt class="docutils literal"> </tt>
+the <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> subdirectory in your <tt class="docutils literal">#include</tt> path. <tt class="docutils literal"> </tt>
</li>
-<li>Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
-and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> subdirectory of the boost root, your
-Boost <tt class="docutils literal">#include</tt> directives will look like:
+<li>Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
+and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> subdirectory of the boost root, your
+Boost <tt class="docutils literal">#include</tt> directives will look like:
<pre class="literal-block">
#include <boost/whatever.hpp>
</pre>
@@ -156,9 +156,9 @@
depending on your preference regarding the use of angle bracket
includes. <tt class="docutils literal"> </tt>
</li>
-<li>Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">/</tt> subdirectory; it only
+<li>Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">/</tt> subdirectory; it only
contains a subset of the Boost documentation. Start with
-<tt class="docutils literal">libs</tt><tt class="docutils literal">/</tt><tt class="docutils literal">index.html</tt> if you're looking for the whole enchilada.
+<tt class="docutils literal">libs</tt><tt class="docutils literal">/</tt><tt class="docutils literal">index.html</tt> if you're looking for the whole enchilada.
</li>
</ol>

@@ -194,7 +194,7 @@
A few libraries have optional separately-compiled binaries:
<ul class="simple">
<li><a class="reference external" href="../../libs/date_time/index.html">Boost.DateTime</a> has a binary component that is only needed if
-you're using its <tt class="docutils literal">to_string</tt>/<tt class="docutils literal">from_string</tt> or serialization
+you're using its <tt class="docutils literal">to_string</tt>/<tt class="docutils literal">from_string</tt> or serialization
features, or if you're targeting Visual C++ 6.x or Borland.</li>
<li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
@@ -227,11 +227,11 @@
 in(std::cin), in(), std::cout << (_1 * 3) << " " );
}
</pre>
-Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.
-Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the
+Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.
+Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the
following command:
<pre class="literal-block">
-c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example
+c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example
</pre>
To test the result, type:
<pre class="literal-block">
@@ -259,15 +259,15 @@
you'll need to acquire library binaries.
<div class="section" id="easy-build-and-install">
<h2><a class="toc-backref" href="#id27">5.1   Easy Build and Install</a></h2>
-Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that
+Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that
represents the shell's prompt):
<pre class="literal-block">
-$ cd path/to/<tt class="docutils literal">boost_1_41_0</tt>
+$ cd path/to/<tt class="docutils literal">boost_1_41_0</tt>
$ ./bootstrap.sh --help
</pre>
-Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again
+Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again
without the <tt class="docutils literal">--help</tt> option. Unless you have write permission in
-your system's <tt class="docutils literal">/usr/local/</tt> directory, you'll probably want to at
+your system's <tt class="docutils literal">/usr/local/</tt> directory, you'll probably want to at
least use
<pre class="literal-block">
$ ./bootstrap.sh --prefix=path/to/installation/prefix
@@ -278,42 +278,43 @@
<pre class="literal-block">
$ ./bjam install
</pre>
-will leave Boost binaries in the <tt class="docutils literal">lib/</tt> subdirectory of your
+will leave Boost binaries in the <tt class="docutils literal">lib/</tt> subdirectory of your
installation prefix. You will also find a copy of the Boost
-headers in the <tt class="docutils literal">include/</tt> subdirectory of the installation
-prefix, so you can henceforth use that directory as an <tt class="docutils literal">#include</tt>
+headers in the <tt class="docutils literal">include/</tt> subdirectory of the installation
+prefix, so you can henceforth use that directory as an <tt class="docutils literal">#include</tt>
path in place of the Boost root directory.
-<div class="admonition-boost-cmake admonition">
-Boost.CMake
-There is a cmake build for boost, supported and distributed
-separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.
-</div>
<a class="reference internal" href="#link-your-program-to-a-boost-library">skip to the next step</a>
</div>
<div class="section" id="or-build-custom-binaries">
<h2><a class="toc-backref" href="#id28">5.2   Or, Build Custom Binaries</a></h2>
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. You'll also
+need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create binaries.
+You'll also
use this method if you need a nonstandard build variant (see the
<a class="reference external" href="../../tools/build/index.html">Boost.Build documentation</a> for more details).
+<div class="admonition-boost-cmake admonition">
+Boost.CMake
+There is also an experimental CMake build for boost, supported and distributed
+separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.
+</div>



<a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
installing software. To use it, you'll need an executable called
-<tt class="docutils literal">bjam</tt>.
+<tt class="docutils literal">bjam</tt>.

<div class="section" id="get-bjam">
-<h3><a class="toc-backref" href="#id29">5.2.1   Get <tt class="docutils literal">bjam</tt></a></h3>
-<tt class="docutils literal">bjam</tt> is the command-line tool that drives the Boost Build
-system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
+<h3><a class="toc-backref" href="#id29">5.2.1   Get <tt class="docutils literal">bjam</tt></a></h3>
+<tt class="docutils literal">bjam</tt> is the command-line tool that drives the Boost Build
+system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
Boost root.
-We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
-Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
+We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
+Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
instructions</a>.
-Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
+Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
see the list of directories in your PATH, separated by colons,
-by typing â€œ<tt class="docutils literal">echo $PATH</tt>â€ at the command prompt.
+by typing â€œ<tt class="docutils literal">echo $PATH</tt>â€ at the command prompt.
</div>
<div class="section" id="identify-your-toolset">
<h3><a class="toc-backref" href="#id30">5.2.2   Identify Your Toolset</a></h3>
@@ -340,70 +341,70 @@
</tr>
</thead>
<tbody valign="top">
-<tr><td><tt class="docutils literal">acc</tt></td>
+<tr><td><tt class="docutils literal">acc</tt></td>
<td>Hewlett Packard</td>
<td>Only very recent versions are
known to work well with Boost</td>
</tr>
-<tr><td><tt class="docutils literal">borland</tt></td>
+<tr><td><tt class="docutils literal">borland</tt></td>
<td>Borland</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">como</tt></td>
+<tr><td><tt class="docutils literal">como</tt></td>
<td>Comeau Computing</td>
<td>Using this toolset may
require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
toolset to act as its backend</td>
</tr>
-<tr><td><tt class="docutils literal">cw</tt></td>
+<tr><td><tt class="docutils literal">cw</tt></td>
<td>Metrowerks/Freescale</td>
<td>The CodeWarrior compiler. We
have not tested versions of
this compiler produced since
it was sold to Freescale.</td>
</tr>
-<tr><td><tt class="docutils literal">dmc</tt></td>
+<tr><td><tt class="docutils literal">dmc</tt></td>
<td>Digital Mars</td>
<td>As of this Boost release, no
version of dmc is known to
handle Boost well.</td>
</tr>
-<tr><td><tt class="docutils literal">darwin</tt></td>
+<tr><td><tt class="docutils literal">darwin</tt></td>
<td>Apple Computer</td>
<td>Apple's version of the GCC
toolchain with support for
Darwin and MacOS X features
such as frameworks.</td>
</tr>
-<tr><td><tt class="docutils literal">gcc</tt></td>
+<tr><td><tt class="docutils literal">gcc</tt></td>
<td>The Gnu Project</td>
<td>Includes support for Cygwin
and MinGW compilers.</td>
</tr>
-<tr><td><tt class="docutils literal">hp_cxx</tt></td>
+<tr><td><tt class="docutils literal">hp_cxx</tt></td>
<td>Hewlett Packard</td>
<td>Targeted at the Tru64
operating system.</td>
</tr>
-<tr><td><tt class="docutils literal">intel</tt></td>
+<tr><td><tt class="docutils literal">intel</tt></td>
<td>Intel</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">msvc</tt></td>
+<tr><td><tt class="docutils literal">msvc</tt></td>
<td>Microsoft</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">qcc</tt></td>
+<tr><td><tt class="docutils literal">qcc</tt></td>
<td>QNX Software Systems</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">sun</tt></td>
+<tr><td><tt class="docutils literal">sun</tt></td>
<td>Sun</td>
<td>Only very recent versions are
known to work well with
Boost.</td>
</tr>
-<tr><td><tt class="docutils literal">vacpp</tt></td>
+<tr><td><tt class="docutils literal">vacpp</tt></td>
<td>IBM</td>
<td>The VisualAge C++ compiler.</td>
</tr>
@@ -419,13 +420,13 @@
<a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
building into the build directory. If your Boost root
directory is writable, this step isn't strictly necessary: by
-default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
+default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
purpose in your current working directory.
</div>
<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id32">5.2.4   Invoke <tt class="docutils literal">bjam</tt></a></h3>
+<h3><a class="toc-backref" href="#id32">5.2.4   Invoke <tt class="docutils literal">bjam</tt></a></h3>
Change your current directory to the Boost root directory and
-invoke <tt class="docutils literal">bjam</tt> as follows:
+invoke <tt class="docutils literal">bjam</tt> as follows:
<pre class="literal-block">
bjam --build-dir=<a class="reference internal" href="#id11">build-directory</a> toolset=<a class="reference internal" href="#toolset-name">toolset-name</a> <tt class="docutils literal"> </tt> stage
</pre>
@@ -433,23 +434,23 @@
please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.
For example, your session might look like this:
<pre class="literal-block">
-$ cd ~/<tt class="docutils literal">boost_1_41_0</tt>
+$ cd ~/<tt class="docutils literal">boost_1_41_0</tt>
$ bjam --build-dir=/tmp/build-boost toolset=gcc stage
</pre>
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">--build-type=complete</tt>â€.



-Building the special <tt class="docutils literal">stage</tt> target places Boost
-library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">/</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">/</tt> subdirectory of your <a class="reference internal" href="#build-directory">build
+Building the special <tt class="docutils literal">stage</tt> target places Boost
+library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">/</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">/</tt> subdirectory of your <a class="reference internal" href="#build-directory">build
directory</a>.
<div class="note">
Note
-<tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
+<tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
parts shown in bold type above be entirely lower-case.
</div>
For a description of other options you can pass when invoking
-<tt class="docutils literal">bjam</tt>, type:
+<tt class="docutils literal">bjam</tt>, type:
<pre class="literal-block">
bjam --help
</pre>
@@ -458,15 +459,15 @@
<ul class="simple">
<li>reviewing the list of library names with <tt class="docutils literal">--show-libraries</tt></li>
<li>limiting which libraries get built with the <tt class="docutils literal">--with-</tt>library-name or <tt class="docutils literal">--without-</tt>library-name options</li>
-<li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
-<tt class="docutils literal">debug</tt> to the command line.</li>
+<li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
+<tt class="docutils literal">debug</tt> to the command line.</li>
</ul>
<div class="note">
Note
Boost.Build can produce a great deal of output, which can
make it easy to miss problems. If you want to make sure
everything is went well, you might redirect the output into a
-file by appending â€œ<tt class="docutils literal">>build.log 2>&1</tt>â€ to your command line.
+file by appending â€œ<tt class="docutils literal">>build.log 2>&1</tt>â€ to your command line.
</div>
</div>
</div>
@@ -548,21 +549,21 @@
<ol class="upperalpha">
<li>You can specify the full path to each library:
<pre class="literal-block">
-$ c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example \
+$ c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example \
 ~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a
</pre>
</li>
-<li>You can separately specify a directory to search (with <tt class="docutils literal">-L</tt>directory) and a library name to search for (with <tt class="docutils literal">-l</tt>library,<a class="footnote-reference" href="#lowercase-l" id="id15">2</a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
-suffix (<tt class="docutils literal">.a</tt> in this case):
+<li>You can separately specify a directory to search (with <tt class="docutils literal">-L</tt>directory) and a library name to search for (with <tt class="docutils literal">-l</tt>library,<a class="footnote-reference" href="#lowercase-l" id="id15">2</a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
+suffix (<tt class="docutils literal">.a</tt> in this case):
<pre class="literal-block">
-$ c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example \
+$ c++ -I path/to/<tt class="docutils literal">boost_1_41_0</tt> example.cpp -o example \
 -L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36
</pre>
As you can see, this method is just as terse as method A for one
library; it really pays off when you're using multiple
libraries from the same directory. Note, however, that if you
-use this method with a library that has both static (<tt class="docutils literal">.a</tt>) and
-dynamic (<tt class="docutils literal">.so</tt>) builds, the system may choose one
+use this method with a library that has both static (<tt class="docutils literal">.a</tt>) and
+dynamic (<tt class="docutils literal">.so</tt>) builds, the system may choose one
automatically for you unless you pass a special option such as
<tt class="docutils literal">-static</tt> on the command line.
</li>
@@ -581,13 +582,13 @@
<tt class="docutils literal">libboost_regex-vc71-mt-d-1_34.lib</tt> can be broken down into the
following elements:
<dl class="docutils">
-<dt><tt class="docutils literal">lib</tt></dt>
+<dt><tt class="docutils literal">lib</tt></dt>
<dd>Prefix: 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
+libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
not.<a class="footnote-reference" href="#distinct" id="id17">4</a></dd>
-<dt><tt class="docutils literal">boost_regex</tt></dt>
-<dd>Library name: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
+<dt><tt class="docutils literal">boost_regex</tt></dt>
+<dd>Library name: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
<dt><tt class="docutils literal">-vc71</tt></dt>
<dd>Toolset tag: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
the binary.</dd>
@@ -612,24 +613,24 @@
</tr>
</thead>
<tbody valign="top">
-<tr><td><tt class="docutils literal">s</tt></td>
+<tr><td><tt class="docutils literal">s</tt></td>
<td>linking statically to the C++ standard library and compiler runtime support
libraries.</td>
</tr>
-<tr><td><tt class="docutils literal">g</tt></td>
+<tr><td><tt class="docutils literal">g</tt></td>
<td>using debug versions of the standard and runtime support libraries.</td>
</tr>
-<tr><td><tt class="docutils literal">y</tt></td>
+<tr><td><tt class="docutils literal">y</tt></td>
<td>using a special <a class="reference external" href="../../libs/python/doc/building.html#variants">debug build of Python</a>.</td>
</tr>
-<tr><td><tt class="docutils literal">d</tt></td>
+<tr><td><tt class="docutils literal">d</tt></td>
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id18">5</a></td>
</tr>
-<tr><td><tt class="docutils literal">p</tt></td>
+<tr><td><tt class="docutils literal">p</tt></td>
<td>using the STLPort standard library rather than the default one supplied with
your compiler.</td>
</tr>
-<tr><td><tt class="docutils literal">n</tt></td>
+<tr><td><tt class="docutils literal">n</tt></td>
<td>using STLPort's deprecated â€œnative iostreamsâ€ feature.<a class="footnote-reference" href="#native" id="id19">6</a></td>
</tr>
</tbody>
@@ -645,12 +646,12 @@
<dd>Version tag: the full Boost release number, with periods
replaced by underscores. For example, version 1.31.1 would be
tagged as "-1_31_1".</dd>
-<dt><tt class="docutils literal">.lib</tt></dt>
+<dt><tt class="docutils literal">.lib</tt></dt>
<dd>Extension: determined according to the operating system's usual
convention. On most unix-style platforms the extensions are
-<tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
-libraries, respectively. On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
-library and <tt class="docutils literal">.lib</tt> indicates a
+<tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
+libraries, respectively. On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
+library and <tt class="docutils literal">.lib</tt> indicates a
static or import library. Where supported by toolsets on unix
variants, a full version extension is added (e.g. ".so.1.34") and
a symbolic link to the library file, named without the trailing
@@ -664,7 +665,7 @@
<div class="section" id="test-your-program">
<h2><a class="toc-backref" href="#id37">6.2   Test Your Program</a></h2>
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>:
+file. Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:
<pre class="literal-block">
To: George Shmidlap
From: Rita Marlowe
@@ -677,15 +678,15 @@
and load it when your program is run. Most platforms have an
environment variable to which you can add the directory containing
the library. On many platforms (Linux, FreeBSD) that variable is
-<tt class="docutils literal">LD_LIBRARY_PATH</tt>, but on MacOS it's <tt class="docutils literal">DYLD_LIBRARY_PATH</tt>, and
-on Cygwin it's simply <tt class="docutils literal">PATH</tt>. In most shells other than <tt class="docutils literal">csh</tt>
-and <tt class="docutils literal">tcsh</tt>, you can adjust the variable as follows (again, don't
-type the <tt class="docutils literal">$</tt>â€”that represents the shell prompt):
+<tt class="docutils literal">LD_LIBRARY_PATH</tt>, but on MacOS it's <tt class="docutils literal">DYLD_LIBRARY_PATH</tt>, and
+on Cygwin it's simply <tt class="docutils literal">PATH</tt>. In most shells other than <tt class="docutils literal">csh</tt>
+and <tt class="docutils literal">tcsh</tt>, you can adjust the variable as follows (again, don't
+type the <tt class="docutils literal">$</tt>â€”that represents the shell prompt):
<pre class="literal-block">
$ VARIABLE_NAME=path/to/lib/directory:${VARIABLE_NAME}
$ export VARIABLE_NAME
</pre>
-On <tt class="docutils literal">csh</tt> and <tt class="docutils literal">tcsh</tt>, it's
+On <tt class="docutils literal">csh</tt> and <tt class="docutils literal">tcsh</tt>, it's
<pre class="literal-block">
$ setenv VARIABLE_NAME path/to/lib/directory:${VARIABLE_NAME}
</pre>
@@ -771,7 +772,7 @@
<tbody valign="top">
<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
+<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
compiled code, you can't count on that with Boost libraries.</td></tr>
</tbody>

Modified: branches/release/more/getting_started/unix-variants.rst
==============================================================================
--- branches/release/more/getting_started/unix-variants.rst (original)
+++ branches/release/more/getting_started/unix-variants.rst 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -121,14 +121,6 @@
prefix, so you can henceforth use that directory as an ``#include``
path in place of the Boost root directory.

-.. Admonition:: Boost.CMake
-
- There is a cmake build for boost, supported and distributed
- separately. See the `Boost.CMake`_ wiki page for more information.
-
- .. _`Boost.CMake`:
- https://svn.boost.org/trac/boost/wiki/CMake
-
|next|__

__ `Link Your Program to a Boost Library`_
@@ -137,10 +129,20 @@
-------------------------

If you're using a compiler other than your system's default, you'll
-need to use Boost.Build_ to create binaries. You'll also
+need to use Boost.Build_ to create binaries.
+
+You'll also
use this method if you need a nonstandard build variant (see the
`Boost.Build documentation`_ for more details).

+.. Admonition:: Boost.CMake
+
+ There is also an experimental CMake build for boost, supported and distributed
+ separately. See the `Boost.CMake`_ wiki page for more information.
+
+ .. _`Boost.CMake`:
+ https://svn.boost.org/trac/boost/wiki/CMake
+
.. include:: detail/build-from-source-head.rst

For example, your session might look like this:

Modified: branches/release/more/getting_started/windows.html
==============================================================================
--- branches/release/more/getting_started/windows.html (original)
+++ branches/release/more/getting_started/windows.html 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -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.6: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>Boost Getting Started on Windows</title>
<link rel="stylesheet" href="../../rst.css" type="text/css" />
</head>
@@ -39,10 +39,10 @@
<li><a class="reference internal" href="#install-visual-studio-binaries" id="id38">5.1   Install Visual Studio Binaries</a></li>
<li><a class="reference internal" href="#or-simplified-build-from-source" id="id39">5.2   Or, Simplified Build From Source</a></li>
<li><a class="reference internal" href="#or-build-binaries-from-source" id="id40">5.3   Or, Build Binaries From Source</a><ul class="auto-toc">
-<li><a class="reference internal" href="#get-bjam" id="id41">5.3.1   Get <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#get-bjam" id="id41">5.3.1   Get <tt class="docutils literal">bjam</tt></a></li>
<li><a class="reference internal" href="#identify-your-toolset" id="id42">5.3.2   Identify Your Toolset</a></li>
<li><a class="reference internal" href="#select-a-build-directory" id="id43">5.3.3   Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam" id="id44">5.3.4   Invoke <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#invoke-bjam" id="id44">5.3.4   Invoke <tt class="docutils literal">bjam</tt></a></li>
</ul>
</li>
<li><a class="reference internal" href="#expected-build-output" id="id45">5.4   Expected Build Output</a></li>
@@ -73,7 +73,7 @@
binaries when given the option.
If you're using an earlier version of Visual Studio or some other
compiler, or if you prefer to build everything yourself, you can
-download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">.zip</tt></a> and unpack 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">boost_1_41_0</tt><tt class="docutils literal">.7z</tt></a> or <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_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">1</a>


@@ -104,43 +104,43 @@
but most libraries follow a few patterns:
<ul class="pre-wrap last">
<li>Some older libraries and most very small libraries place all
-public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>.
+public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>.
</li>
<li>Most libraries' public headers live in a subdirectory of
-<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>, named after the library. For example, you'll find
-the Python library's <tt class="docutils literal">def.hpp</tt> header in
+<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>, named after the library. For example, you'll find
+the Python library's <tt class="docutils literal">def.hpp</tt> header in
<pre class="literal-block">
-<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt><tt class="docutils literal">python</tt><tt class="docutils literal">\</tt><tt class="docutils literal">def.hpp</tt>.
+<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt><tt class="docutils literal">python</tt><tt class="docutils literal">\</tt><tt class="docutils literal">def.hpp</tt>.
</pre>
</li>
-<li>Some libraries have an â€œaggregate headerâ€ in <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> that
-<tt class="docutils literal">#include</tt>s all of the library's other headers. For
+<li>Some libraries have an â€œaggregate headerâ€ in <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> that
+<tt class="docutils literal">#include</tt>s all of the library's other headers. For
example, <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a>'s aggregate header is
<pre class="literal-block">
-<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt><tt class="docutils literal">python.hpp</tt>.
+<tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt><tt class="docutils literal">python.hpp</tt>.
</pre>
</li>
<li>Most libraries place private headers in a subdirectory called
-<tt class="docutils literal">detail</tt><tt class="docutils literal">\</tt>, or <tt class="docutils literal">aux_</tt><tt class="docutils literal">\</tt>. Don't expect to find
+<tt class="docutils literal">detail</tt><tt class="docutils literal">\</tt>, or <tt class="docutils literal">aux_</tt><tt class="docutils literal">\</tt>. Don't expect to find
anything you can use in these directories.
</li>
</ul>
</div>
It's important to note the following:
<ol class="arabic" id="boost-root-directory">
-<li>The path to the boost root directory (often <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>) is
-sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
+<li>The path to the boost root directory (often <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>) is
+sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
mailing lists .
</li>
<li>To compile anything in Boost, you need a directory containing
-the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory in your <tt class="docutils literal">#include</tt> path. Specific steps for setting up <tt class="docutils literal">#include</tt>
+the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory in your <tt class="docutils literal">#include</tt> path. Specific steps for setting up <tt class="docutils literal">#include</tt>
paths in Microsoft Visual Studio follow later in this document;
if you use another IDE, please consult your product's
documentation for instructions.
</li>
-<li>Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
-and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory of the boost root, your
-Boost <tt class="docutils literal">#include</tt> directives will look like:
+<li>Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
+and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory of the boost root, your
+Boost <tt class="docutils literal">#include</tt> directives will look like:
<pre class="literal-block">
#include <boost/whatever.hpp>
</pre>
@@ -151,11 +151,11 @@
depending on your preference regarding the use of angle bracket
includes. Even Windows users can (and, for
portability reasons, probably should) use forward slashes in
-<tt class="docutils literal">#include</tt> directives; your compiler doesn't care.
+<tt class="docutils literal">#include</tt> directives; your compiler doesn't care.
</li>
-<li>Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">\</tt> subdirectory; it only
+<li>Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">\</tt> subdirectory; it only
contains a subset of the Boost documentation. Start with
-<tt class="docutils literal">libs</tt><tt class="docutils literal">\</tt><tt class="docutils literal">index.html</tt> if you're looking for the whole enchilada.
+<tt class="docutils literal">libs</tt><tt class="docutils literal">\</tt><tt class="docutils literal">index.html</tt> if you're looking for the whole enchilada.
</li>
</ol>

@@ -191,7 +191,7 @@
A few libraries have optional separately-compiled binaries:
<ul class="simple">
<li><a class="reference external" href="../../libs/date_time/index.html">Boost.DateTime</a> has a binary component that is only needed if
-you're using its <tt class="docutils literal">to_string</tt>/<tt class="docutils literal">from_string</tt> or serialization
+you're using its <tt class="docutils literal">to_string</tt>/<tt class="docutils literal">from_string</tt> or serialization
features, or if you're targeting Visual C++ 6.x or Borland.</li>
<li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
@@ -224,7 +224,7 @@
in(std::cin), in(), std::cout << (_1 * 3) << " " );
}
</pre>
-Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.
+Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.
<div class="note" id="command-line-tool">
Note
To build the examples in this guide, you can use an
@@ -253,10 +253,10 @@
</pre>
followed by Return. For example,
<pre class="literal-block">
-cd <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
+cd <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
</pre>
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
+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.
</div>
<div class="section" id="build-from-the-visual-studio-ide">
@@ -278,14 +278,14 @@
<li>In Configuration Properties > C/C++ > General > Additional Include
Directories, enter the path to the Boost root directory, for example
<blockquote>
-<tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
+<tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
</blockquote>
</li>
<li>In Configuration Properties > C/C++ > Precompiled Headers, change
Use Precompiled Header (/Yu) to Not Using Precompiled
Headers.<a class="footnote-reference" href="#pch" id="id5">3</a>
</li>
-<li>Replace the contents of the <tt class="docutils literal">example.cpp</tt> generated by the IDE
+<li>Replace the contents of the <tt class="docutils literal">example.cpp</tt> generated by the IDE
with the example code above.
</li>
<li>From the Build menu, select Build Solution.
@@ -316,7 +316,7 @@
directory</a> to a suitable location for creating some temporary
files and type the following command followed by the Return key:
<pre class="literal-block">
-cl /EHsc /I path\to\<tt class="docutils literal">boost_1_41_0</tt> path\to\example.cpp
+cl /EHsc /I path\to\<tt class="docutils literal">boost_1_41_0</tt> path\to\example.cpp
</pre>
To test the result, type:
<pre class="literal-block">
@@ -346,8 +346,8 @@
<div class="section" id="install-visual-studio-binaries">
<h2><a class="toc-backref" href="#id38">5.1   Install Visual Studio Binaries</a></h2>
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">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">\lib\</tt>. If you installed
+install pre-compiled binaries into the <tt class="docutils literal">lib\</tt> subdirectory of the
+boost root, typically <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_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.
@@ -366,36 +366,36 @@
The first command prepares the Boost.Build system for use. The second
command invokes Boost.Build to build the separately-compiled Boost
libraries. Please consult the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a> for a list
-of options that can be passed to <tt class="docutils literal">bjam</tt>.
-<div class="admonition-boost-cmake admonition">
-Boost.CMake
-There is a also a cmake build for boost, supported and distributed
-separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.
-</div>
+of options that can be passed to <tt class="docutils literal">bjam</tt>.
</div>
<div class="section" id="or-build-binaries-from-source">
<h2><a class="toc-backref" href="#id40">5.3   Or, Build Binaries From Source</a></h2>
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.
+<div class="admonition-boost-cmake admonition">
+Boost.CMake
+There is also an experimental CMake build for boost, supported and distributed
+separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.
+</div>



<a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
installing software. To use it, you'll need an executable called
-<tt class="docutils literal">bjam</tt>.
+<tt class="docutils literal">bjam</tt>.

<div class="section" id="get-bjam">
-<h3><a class="toc-backref" href="#id41">5.3.1   Get <tt class="docutils literal">bjam</tt></a></h3>
-<tt class="docutils literal">bjam</tt> is the <a class="reference internal" href="#command-line-tool">command-line tool</a> that drives the Boost Build
-system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
+<h3><a class="toc-backref" href="#id41">5.3.1   Get <tt class="docutils literal">bjam</tt></a></h3>
+<tt class="docutils literal">bjam</tt> is the <a class="reference internal" href="#command-line-tool">command-line tool</a> that drives the Boost Build
+system. To build Boost binaries, you'll invoke <tt class="docutils literal">bjam</tt> from the
Boost root.
-We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
-Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
+We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal">bjam</tt> executable</a> for your platform.
+Alternatively, you can build <tt class="docutils literal">bjam</tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
instructions</a>.
-Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
+Move the <tt class="docutils literal">bjam</tt> executable into a directory in your PATH. You can
see the list of directories in your PATH, separated by semicolons,
-by typing â€œ<tt class="docutils literal">PATH</tt>â€ at the command prompt.
+by typing â€œ<tt class="docutils literal">PATH</tt>â€ at the command prompt.
</div>
<div class="section" id="identify-your-toolset">
<h3><a class="toc-backref" href="#id42">5.3.2   Identify Your Toolset</a></h3>
@@ -422,70 +422,70 @@
</tr>
</thead>
<tbody valign="top">
-<tr><td><tt class="docutils literal">acc</tt></td>
+<tr><td><tt class="docutils literal">acc</tt></td>
<td>Hewlett Packard</td>
<td>Only very recent versions are
known to work well with Boost</td>
</tr>
-<tr><td><tt class="docutils literal">borland</tt></td>
+<tr><td><tt class="docutils literal">borland</tt></td>
<td>Borland</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">como</tt></td>
+<tr><td><tt class="docutils literal">como</tt></td>
<td>Comeau Computing</td>
<td>Using this toolset may
require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
toolset to act as its backend</td>
</tr>
-<tr><td><tt class="docutils literal">cw</tt></td>
+<tr><td><tt class="docutils literal">cw</tt></td>
<td>Metrowerks/Freescale</td>
<td>The CodeWarrior compiler. We
have not tested versions of
this compiler produced since
it was sold to Freescale.</td>
</tr>
-<tr><td><tt class="docutils literal">dmc</tt></td>
+<tr><td><tt class="docutils literal">dmc</tt></td>
<td>Digital Mars</td>
<td>As of this Boost release, no
version of dmc is known to
handle Boost well.</td>
</tr>
-<tr><td><tt class="docutils literal">darwin</tt></td>
+<tr><td><tt class="docutils literal">darwin</tt></td>
<td>Apple Computer</td>
<td>Apple's version of the GCC
toolchain with support for
Darwin and MacOS X features
such as frameworks.</td>
</tr>
-<tr><td><tt class="docutils literal">gcc</tt></td>
+<tr><td><tt class="docutils literal">gcc</tt></td>
<td>The Gnu Project</td>
<td>Includes support for Cygwin
and MinGW compilers.</td>
</tr>
-<tr><td><tt class="docutils literal">hp_cxx</tt></td>
+<tr><td><tt class="docutils literal">hp_cxx</tt></td>
<td>Hewlett Packard</td>
<td>Targeted at the Tru64
operating system.</td>
</tr>
-<tr><td><tt class="docutils literal">intel</tt></td>
+<tr><td><tt class="docutils literal">intel</tt></td>
<td>Intel</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">msvc</tt></td>
+<tr><td><tt class="docutils literal">msvc</tt></td>
<td>Microsoft</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">qcc</tt></td>
+<tr><td><tt class="docutils literal">qcc</tt></td>
<td>QNX Software Systems</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal">sun</tt></td>
+<tr><td><tt class="docutils literal">sun</tt></td>
<td>Sun</td>
<td>Only very recent versions are
known to work well with
Boost.</td>
</tr>
-<tr><td><tt class="docutils literal">vacpp</tt></td>
+<tr><td><tt class="docutils literal">vacpp</tt></td>
<td>IBM</td>
<td>The VisualAge C++ compiler.</td>
</tr>
@@ -504,13 +504,13 @@
<a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
building into the build directory. If your Boost root
directory is writable, this step isn't strictly necessary: by
-default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
+default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
purpose in your current working directory.
</div>
<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id44">5.3.4   Invoke <tt class="docutils literal">bjam</tt></a></h3>
+<h3><a class="toc-backref" href="#id44">5.3.4   Invoke <tt class="docutils literal">bjam</tt></a></h3>
Change your current directory to the Boost root directory and
-invoke <tt class="docutils literal">bjam</tt> as follows:
+invoke <tt class="docutils literal">bjam</tt> as follows:
<pre class="literal-block">
bjam --build-dir=<a class="reference internal" href="#id14">build-directory</a> toolset=<a class="reference internal" href="#toolset-name">toolset-name</a> --build-type=complete stage
</pre>
@@ -518,30 +518,30 @@
please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.
For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id16">4</a>
<pre class="literal-block">
-C:\WINDOWS> cd <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
-<tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>> bjam ^
+C:\WINDOWS> cd <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>
+<tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt>> bjam ^
More? --build-dir="C:\Documents and Settings\dave\build-boost" ^
More? --build-type=complete msvc stage
</pre>
-Be sure to read <a class="reference internal" href="#continuation">this note</a> about the appearance of <tt class="docutils literal">^</tt>,
-<tt class="docutils literal">More?</tt> and quotation marks (<tt class="docutils literal">"</tt>) in that line.
-The option â€œ--build-type=completeâ€ causes <tt class="docutils literal">bjam</tt> to build
+Be sure to read <a class="reference internal" href="#continuation">this note</a> about the appearance of <tt class="docutils literal">^</tt>,
+<tt class="docutils literal">More?</tt> and quotation marks (<tt class="docutils literal">"</tt>) in that line.
+The option â€œ--build-type=completeâ€ causes <tt class="docutils literal">bjam</tt> to build
all supported variants of the libraries. For instructions on how to
build only specific variants, please ask on the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing
list</a>.



-Building the special <tt class="docutils literal">stage</tt> target places Boost
-library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">\</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">\</tt> subdirectory of your <a class="reference internal" href="#build-directory">build
+Building the special <tt class="docutils literal">stage</tt> target places Boost
+library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">\</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">\</tt> subdirectory of your <a class="reference internal" href="#build-directory">build
directory</a>.
<div class="note">
Note
-<tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
+<tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
parts shown in bold type above be entirely lower-case.
</div>
For a description of other options you can pass when invoking
-<tt class="docutils literal">bjam</tt>, type:
+<tt class="docutils literal">bjam</tt>, type:
<pre class="literal-block">
bjam --help
</pre>
@@ -550,15 +550,15 @@
<ul class="simple">
<li>reviewing the list of library names with <tt class="docutils literal">--show-libraries</tt></li>
<li>limiting which libraries get built with the <tt class="docutils literal">--with-</tt>library-name or <tt class="docutils literal">--without-</tt>library-name options</li>
-<li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
-<tt class="docutils literal">debug</tt> to the command line.</li>
+<li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
+<tt class="docutils literal">debug</tt> to the command line.</li>
</ul>
<div class="note">
Note
Boost.Build can produce a great deal of output, which can
make it easy to miss problems. If you want to make sure
everything is went well, you might redirect the output into a
-file by appending â€œ<tt class="docutils literal">>build.log 2>&1</tt>â€ to your command line.
+file by appending â€œ<tt class="docutils literal">>build.log 2>&1</tt>â€ to your command line.
</div>
</div>
</div>
@@ -657,7 +657,7 @@
select Properties from the resulting pop-up menu</li>
<li>In Configuration Properties > Linker > Additional Library
Directories, enter the path to the Boost binaries,
-e.g. <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">\lib\</tt>.</li>
+e.g. <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">\lib\</tt>.</li>
<li>From the Build menu, select Build Solution.</li>
</ol>
<a class="reference internal" href="#test-your-program">skip to the next step</a>
@@ -667,9 +667,9 @@
For example, we can compile and link the above program from the
Visual C++ command-line by simply adding the bold text below to
the command line we used earlier, assuming your Boost binaries are
-in <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">\lib</tt>:
+in <tt class="docutils literal">C:\Program Files\boost\</tt><tt class="docutils literal">boost_1_41_0</tt><tt class="docutils literal">\lib</tt>:
<pre class="literal-block">
-cl /EHsc /I path\to\<tt class="docutils literal">boost_1_41_0</tt> example.cpp ^
+cl /EHsc /I path\to\<tt class="docutils literal">boost_1_41_0</tt> example.cpp ^
/link /LIBPATH: C:\Program Files\boost\boost_1_41_0\lib
</pre>
</div>
@@ -692,13 +692,13 @@
<tt class="docutils literal">libboost_regex-vc71-mt-d-1_34.lib</tt> can be broken down into the
following elements:
<dl class="docutils">
-<dt><tt class="docutils literal">lib</tt></dt>
+<dt><tt class="docutils literal">lib</tt></dt>
<dd>Prefix: 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
+libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
not.<a class="footnote-reference" href="#distinct" id="id24">6</a></dd>
-<dt><tt class="docutils literal">boost_regex</tt></dt>
-<dd>Library name: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
+<dt><tt class="docutils literal">boost_regex</tt></dt>
+<dd>Library name: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
<dt><tt class="docutils literal">-vc71</tt></dt>
<dd>Toolset tag: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
the binary.</dd>
@@ -723,24 +723,24 @@
</tr>
</thead>
<tbody valign="top">
-<tr><td><tt class="docutils literal">s</tt></td>
+<tr><td><tt class="docutils literal">s</tt></td>
<td>linking statically to the C++ standard library and compiler runtime support
libraries.</td>
</tr>
-<tr><td><tt class="docutils literal">g</tt></td>
+<tr><td><tt class="docutils literal">g</tt></td>
<td>using debug versions of the standard and runtime support libraries.</td>
</tr>
-<tr><td><tt class="docutils literal">y</tt></td>
+<tr><td><tt class="docutils literal">y</tt></td>
<td>using a special <a class="reference external" href="../../libs/python/doc/building.html#variants">debug build of Python</a>.</td>
</tr>
-<tr><td><tt class="docutils literal">d</tt></td>
+<tr><td><tt class="docutils literal">d</tt></td>
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id25">7</a></td>
</tr>
-<tr><td><tt class="docutils literal">p</tt></td>
+<tr><td><tt class="docutils literal">p</tt></td>
<td>using the STLPort standard library rather than the default one supplied with
your compiler.</td>
</tr>
-<tr><td><tt class="docutils literal">n</tt></td>
+<tr><td><tt class="docutils literal">n</tt></td>
<td>using STLPort's deprecated â€œnative iostreamsâ€ feature.<a class="footnote-reference" href="#native" id="id26">8</a></td>
</tr>
</tbody>
@@ -756,12 +756,12 @@
<dd>Version tag: the full Boost release number, with periods
replaced by underscores. For example, version 1.31.1 would be
tagged as "-1_31_1".</dd>
-<dt><tt class="docutils literal">.lib</tt></dt>
+<dt><tt class="docutils literal">.lib</tt></dt>
<dd>Extension: determined according to the operating system's usual
convention. On most unix-style platforms the extensions are
-<tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
-libraries, respectively. On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
-library and <tt class="docutils literal">.lib</tt> indicates a
+<tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
+libraries, respectively. On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
+library and <tt class="docutils literal">.lib</tt> indicates a
static or import library. Where supported by toolsets on unix
variants, a full version extension is added (e.g. ".so.1.34") and
a symbolic link to the library file, named without the trailing
@@ -775,7 +775,7 @@
<div class="section" id="test-your-program">
<h2><a class="toc-backref" href="#id51">6.4   Test Your Program</a></h2>
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>:
+file. Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:
<pre class="literal-block">
To: George Shmidlap
From: Rita Marlowe
@@ -824,7 +824,7 @@
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend
-downloading <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_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://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal">boost_1_41_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>
@@ -835,7 +835,7 @@
<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.
+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>
@@ -852,21 +852,21 @@
<table class="docutils footnote" frame="void" id="continuation" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref" href="#id16">[4]</a></td><td>In this example, the caret character <tt class="docutils literal">^</tt> is a
+<tr><td class="label"><a class="fn-backref" href="#id16">[4]</a></td><td>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
final character used on the line to be continued (i.e. do
not follow it with spaces). The command prompt responds with
-<tt class="docutils literal">More?</tt> to prompt for more input. Feel free to omit the
+<tt class="docutils literal">More?</tt> to prompt for more input. Feel free to omit the
carets and subsequent newlines; we used them so the example
would fit on a page of reasonable width.
The command prompt treats each bit of whitespace in the command
-as an argument separator. That means quotation marks (<tt class="docutils literal">"</tt>)
+as an argument separator. That means quotation marks (<tt class="docutils literal">"</tt>)
are required to keep text together whenever a single
command-line argument contains spaces, as in
<pre class="literal-block">
--build-dir="C:\Documents_and_Settings\dave\build-boost"
</pre>
-Also, for example, you can't add spaces around the <tt class="docutils literal">=</tt> sign as in
+Also, for example, you can't add spaces around the <tt class="docutils literal">=</tt> sign as in
<pre class="last literal-block">
--build-dir_=_"C:\Documents and Settings\dave\build-boost"
</pre>
@@ -901,7 +901,7 @@
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id25">[7]</a></td><td>These libraries were compiled without optimization
or inlining, with full debug symbols enabled, and without
-<tt class="docutils literal">NDEBUG</tt> <tt class="docutils literal">#define</tt>d. Although it's true that sometimes
+<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
compiled code, you can't count on that with Boost libraries.</td></tr>
</tbody>

Modified: branches/release/more/getting_started/windows.rst
==============================================================================
--- branches/release/more/getting_started/windows.rst (original)
+++ branches/release/more/getting_started/windows.rst 2009-11-13 09:50:25 EST (Fri, 13 Nov 2009)
@@ -217,14 +217,6 @@

__ http://www.boost.org/boost-build2/doc/html/bbv2/overview/invocation.html

-.. Admonition:: Boost.CMake
-
- There is a also a cmake build for boost, supported and distributed
- separately. See the `Boost.CMake`_ wiki page for more information.
-
- .. _`Boost.CMake`:
- https://svn.boost.org/trac/boost/wiki/CMake
-
Or, Build Binaries From Source
------------------------------

@@ -232,6 +224,14 @@
from another vendor, you'll need to use Boost.Build_ to create your
own binaries.

+.. Admonition:: Boost.CMake
+
+ There is also an experimental CMake build for boost, supported and distributed
+ separately. See the `Boost.CMake`_ wiki page for more information.
+
+ .. _`Boost.CMake`:
+ https://svn.boost.org/trac/boost/wiki/CMake
+
.. include:: detail/build-from-source-head.rst

For example, your session might look like this: [#continuation]_

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r57638 - branches/release"
Previous message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r57636 - branches/release/tools/release"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk