• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
7<title>Boost Getting Started on Unix Variants</title>
8<meta content="Getting Started with Boost on Unix Variants (including Linux and MacOS)" name="description" />
9<link rel="stylesheet" href="../../rst.css" type="text/css" />
10</head>
11<body>
12<div class="document" id="logo-getting-started-on-unix-variants">
13<h1 class="title"><a class="reference external" href="../../index.htm"><img alt="Boost" class="boost-logo" src="../../boost.png" /></a> Getting Started on Unix Variants</h1>
14
15<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
16<!-- Software License, Version 1.0. (See accompanying -->
17<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
18<!-- maybe we don't need this
19.. Admonition:: A note to Cygwin_ and MinGW_ users
20
21  If you plan to build from the Cygwin_ bash shell, you're in the
22  right place.  If you plan to use your tools from the Windows
23  command prompt, you should follow the instructions for `getting
24  started on Windows`_.  Other command shells, such as MinGW_\ 's
25  MSYS, are not supported—they may or may not work.
26
27  .. _`Getting Started on Windows`: windows.html
28  .. _Cygwin: http://www.cygwin.com
29  .. _MinGW: http://mingw.org -->
30<div class="contents topic" id="index">
31<p class="topic-title first">Index</p>
32<ul class="auto-toc simple">
33<li><a class="reference internal" href="#get-boost" id="id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></li>
34<li><a class="reference internal" href="#the-boost-distribution" id="id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></li>
35<li><a class="reference internal" href="#header-only-libraries" id="id22">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></li>
36<li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id23">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a><ul class="auto-toc">
37<li><a class="reference internal" href="#errors-and-warnings" id="id24">4.1&nbsp;&nbsp;&nbsp;Errors and Warnings</a></li>
38</ul>
39</li>
40<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id25">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
41<li><a class="reference internal" href="#easy-build-and-install" id="id26">5.1&nbsp;&nbsp;&nbsp;Easy Build and Install</a></li>
42<li><a class="reference internal" href="#or-build-custom-binaries" id="id27">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a><ul class="auto-toc">
43<li><a class="reference internal" href="#install-boost-build" id="id28">5.2.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></li>
44<li><a class="reference internal" href="#identify-your-toolset" id="id29">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
45<li><a class="reference internal" href="#select-a-build-directory" id="id30">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
46<li><a class="reference internal" href="#invoke-b2" id="id31">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></li>
47</ul>
48</li>
49<li><a class="reference internal" href="#expected-build-output" id="id32">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
50<li><a class="reference internal" href="#in-case-of-build-errors" id="id33">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></li>
51</ul>
52</li>
53<li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id34">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a><ul class="auto-toc">
54<li><a class="reference internal" href="#library-naming" id="id35">6.1&nbsp;&nbsp;&nbsp;Library Naming</a></li>
55<li><a class="reference internal" href="#test-your-program" id="id36">6.2&nbsp;&nbsp;&nbsp;Test Your Program</a></li>
56</ul>
57</li>
58<li><a class="reference internal" href="#conclusion-and-further-resources" id="id37">7&nbsp;&nbsp;&nbsp;Conclusion and Further Resources</a></li>
59</ul>
60</div>
61<div class="section" id="get-boost">
62<h1><a class="toc-backref" href="#id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
63<p>The most reliable way to get a copy of Boost is to download a
64distribution from <a class="reference external" href="http://www.boost.org/users/history/version_1_73_0.html">SourceForge</a>:</p>
65<ol class="arabic">
66<li><p class="first">Download <a class="reference external" href="http://www.boost.org/users/history/version_1_73_0.html"><tt class="docutils literal">boost_1_73_0</tt><tt class="docutils literal">.tar.bz2</tt></a>.</p>
67</li>
68<li><p class="first">In the directory where you want to put the Boost installation,
69execute</p>
70<pre class="literal-block">
71tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal">boost_1_73_0</tt>.tar.bz2
72</pre>
73</li>
74</ol>
75<div class="admonition-other-packages admonition">
76<p class="first admonition-title">Other Packages</p>
77<p class="last">RedHat, Debian, and other distribution packagers supply Boost
78library packages, however you may need to adapt these
79instructions if you use third-party packages, because their
80creators usually choose to break Boost up into several packages,
81reorganize the directory structure of the Boost distribution,
82and/or rename the library binaries.<a class="footnote-reference" href="#packagers" id="id2"><sup>1</sup></a> If you have
83any trouble, we suggest using an official Boost distribution
84from <a class="reference external" href="http://www.boost.org/users/history/version_1_73_0.html">SourceForge</a>.</p>
85</div>
86<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
87<!-- Software License, Version 1.0. (See accompanying -->
88<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
89</div>
90<div class="section" id="the-boost-distribution">
91<h1><a class="toc-backref" href="#id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1>
92<p>This is a sketch of the resulting directory structure:</p>
93<pre class="literal-block">
94<strong>boost_1_73_0</strong><strong>/</strong> .................<em>The “boost root directory”</em>
95   <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
96   <strong>boost</strong><strong>/</strong> .........................<em>All Boost Header files</em>
97   <tt class="docutils literal"> </tt>
98   <strong>libs</strong><strong>/</strong> ............<em>Tests, .cpp</em>s<em>, docs, etc., by library</em>
99     <strong>index.html</strong> ........<em>Library documentation starts here</em>
100     <strong>algorithm</strong><strong>/</strong>
101     <strong>any</strong><strong>/</strong>
102     <strong>array</strong><strong>/</strong>
103                     <em>…more libraries…</em>
104   <strong>status</strong><strong>/</strong> .........................<em>Boost-wide test suite</em>
105   <strong>tools</strong><strong>/</strong> ...........<em>Utilities, e.g. Boost.Build, quickbook, bcp</em>
106   <strong>more</strong><strong>/</strong> ..........................<em>Policy documents, etc.</em>
107   <strong>doc</strong><strong>/</strong> ...............<em>A subset of all Boost library docs</em>
108</pre>
109<div class="sidebar">
110<p class="first sidebar-title">Header Organization</p>
111<p class="pre-wrap">The organization of Boost library headers isn't entirely uniform,
112but most libraries follow a few patterns:</p>
113<ul class="pre-wrap last">
114<li><p class="first">Some older libraries and most very small libraries place all
115public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>.</p>
116</li>
117<li><p class="first">Most libraries' public headers live in a subdirectory of
118<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt>, named after the library.  For example, you'll find
119the Python library's <tt class="docutils literal">def.hpp</tt> header in</p>
120<pre class="literal-block">
121<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>.
122</pre>
123</li>
124<li><p class="first">Some libraries have an “aggregate header” in <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> that
125<tt class="docutils literal">#include</tt>s all of the library's other headers.  For
126example, <a class="reference external" href="../../libs/python/doc/html/building.html">Boost.Python</a>'s aggregate header is</p>
127<pre class="literal-block">
128<tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt><tt class="docutils literal">python.hpp</tt>.
129</pre>
130</li>
131<li><p class="first">Most libraries place private headers in a subdirectory called
132<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
133anything you can use in these directories.</p>
134</li>
135</ul>
136</div>
137<p>It's important to note the following:</p>
138<ol class="arabic" id="boost-root-directory">
139<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_73_0</tt>) is
140sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
141mailing lists .</p>
142</li>
143<li><p class="first">To compile anything in Boost, you need a directory containing
144the <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></p>
145</li>
146<li><p class="first">Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
147and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">/</tt> subdirectory of the boost root, your
148Boost <tt class="docutils literal">#include</tt> directives will look like:</p>
149<pre class="literal-block">
150#include &lt;boost/<em>whatever</em>.hpp&gt;
151</pre>
152<p>or</p>
153<pre class="literal-block">
154#include &quot;boost/<em>whatever</em>.hpp&quot;
155</pre>
156<p>depending on your preference regarding the use of angle bracket
157includes.  <tt class="docutils literal"> </tt></p>
158</li>
159<li><p class="first">Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">/</tt> subdirectory; it only
160contains a subset of the Boost documentation.  Start with
161<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.</p>
162</li>
163</ol>
164<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
165<!-- Software License, Version 1.0. (See accompanying -->
166<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
167</div>
168<div class="section" id="header-only-libraries">
169<h1><a class="toc-backref" href="#id22">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></h1>
170<p>The first thing many people want to know is, “how do I build
171Boost?”  The good news is that often, there's nothing to build.</p>
172<div class="admonition-nothing-to-build admonition">
173<p class="first admonition-title">Nothing to Build?</p>
174<p class="last">Most Boost libraries are <strong>header-only</strong>: they consist <em>entirely
175of header files</em> containing templates and inline functions, and
176require no separately-compiled library binaries or special
177treatment when linking.</p>
178</div>
179<!-- .. _separate: -->
180<p>The only Boost libraries that <em>must</em> be built separately are:</p>
181<ul class="simple">
182<li><a class="reference external" href="../../libs/chrono/index.html">Boost.Chrono</a></li>
183<li><a class="reference external" href="../../libs/context/index.html">Boost.Context</a></li>
184<li><a class="reference external" href="../../libs/filesystem/index.html">Boost.Filesystem</a></li>
185<li><a class="reference external" href="../../libs/graph_parallel/index.html">Boost.GraphParallel</a></li>
186<li><a class="reference external" href="../../libs/iostreams/index.html">Boost.IOStreams</a></li>
187<li><a class="reference external" href="../../libs/locale/index.html">Boost.Locale</a></li>
188<li><a class="reference external" href="../../libs/log/index.html">Boost.Log</a> (see <a class="reference external" href="../../libs/log/doc/html/log/installation/config.html">build documentation</a>)</li>
189<li><a class="reference external" href="../../libs/mpi/index.html">Boost.MPI</a></li>
190<li><a class="reference external" href="../../libs/program_options/index.html">Boost.ProgramOptions</a></li>
191<li><a class="reference external" href="../../libs/python/doc/html/building.html">Boost.Python</a> (see the <a class="reference external" href="../../libs/python/doc/html/building.html">Boost.Python build documentation</a>
192before building and installing it)</li>
193<li><a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a></li>
194<li><a class="reference external" href="../../libs/serialization/index.html">Boost.Serialization</a></li>
195<li><a class="reference external" href="../../libs/thread/index.html">Boost.Thread</a></li>
196<li><a class="reference external" href="../../libs/timer/index.html">Boost.Timer</a></li>
197<li><a class="reference external" href="../../libs/wave/index.html">Boost.Wave</a></li>
198</ul>
199<p>A few libraries have optional separately-compiled binaries:</p>
200<ul class="simple">
201<li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
202you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
203<li><a class="reference external" href="../../libs/math/index.html">Boost.Math</a> has binary components for the TR1 and C99
204cmath functions.</li>
205<li><a class="reference external" href="../../libs/random/index.html">Boost.Random</a> has a binary component which is only needed if
206you're using <tt class="docutils literal">random_device</tt>.</li>
207<li><a class="reference external" href="../../libs/test/index.html">Boost.Test</a> can be used in “header-only” or “separately compiled”
208mode, although <strong>separate compilation is recommended for serious
209use</strong>.</li>
210<li><a class="reference external" href="../../libs/exception/index.html">Boost.Exception</a> provides non-intrusive implementation of
211exception_ptr for 32-bit _MSC_VER==1310 and _MSC_VER==1400
212which requires a separately-compiled binary. This is enabled by
213#define BOOST_ENABLE_NON_INTRUSIVE_EXCEPTION_PTR.</li>
214<li><a class="reference external" href="../../libs/system/index.html">Boost.System</a> is header-only since Boost 1.69. A stub library is
215still built for compatibility, but linking to it is no longer
216necessary.</li>
217</ul>
218<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
219<!-- Software License, Version 1.0. (See accompanying -->
220<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
221</div>
222<div class="section" id="build-a-simple-program-using-boost">
223<h1><a class="toc-backref" href="#id23">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a></h1>
224<p>To keep things simple, let's start by using a header-only library.
225The following program reads a sequence of integers from standard
226input, uses Boost.Lambda to multiply each number by three, and
227writes them to standard output:</p>
228<pre class="literal-block">
229#include &lt;boost/lambda/lambda.hpp&gt;
230#include &lt;iostream&gt;
231#include &lt;iterator&gt;
232#include &lt;algorithm&gt;
233
234int main()
235{
236    using namespace boost::lambda;
237    typedef std::istream_iterator&lt;int&gt; in;
238
239    std::for_each(
240        in(std::cin), in(), std::cout &lt;&lt; (_1 * 3) &lt;&lt; &quot; &quot; );
241}
242</pre>
243<p>Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.</p>
244<p>Now, in the directory where you saved <tt class="docutils literal">example.cpp</tt>, issue the
245following command:</p>
246<pre class="literal-block">
247c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_73_0</tt> example.cpp -o example
248</pre>
249<p>To test the result, type:</p>
250<pre class="literal-block">
251echo 1 2 3 | ./example
252</pre>
253<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
254<!-- Software License, Version 1.0. (See accompanying -->
255<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
256<div class="section" id="errors-and-warnings">
257<h2><a class="toc-backref" href="#id24">4.1&nbsp;&nbsp;&nbsp;Errors and Warnings</a></h2>
258<p>Don't be alarmed if you see compiler warnings originating in Boost
259headers.  We try to eliminate them, but doing so isn't always
260practical.<a class="footnote-reference" href="#warnings" id="id6"><sup>3</sup></a> <strong>Errors are another matter</strong>.  If you're
261seeing compilation errors at this point in the tutorial, check to
262be sure you've copied the <a class="reference internal" href="#build-a-simple-program-using-boost">example program</a> correctly and that you've
263correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p>
264<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
265<!-- Software License, Version 1.0. (See accompanying -->
266<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
267</div>
268</div>
269<div class="section" id="prepare-to-use-a-boost-library-binary">
270<h1><a class="toc-backref" href="#id25">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a></h1>
271<p>If you want to use any of the separately-compiled Boost libraries,
272you'll need to acquire library binaries.</p>
273<div class="section" id="easy-build-and-install">
274<h2><a class="toc-backref" href="#id26">5.1&nbsp;&nbsp;&nbsp;Easy Build and Install</a></h2>
275<p>Issue the following commands in the shell (don't type <tt class="docutils literal">$</tt>; that
276represents the shell's prompt):</p>
277<pre class="literal-block">
278<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal">boost_1_73_0</tt>
279<strong>$</strong> ./bootstrap.sh --help
280</pre>
281<p>Select your configuration options and invoke <tt class="docutils literal">./bootstrap.sh</tt> again
282without the <tt class="docutils literal"><span class="pre">--help</span></tt> option.  Unless you have write permission in
283your system's <tt class="docutils literal">/usr/local/</tt> directory, you'll probably want to at
284least use</p>
285<pre class="literal-block">
286<strong>$</strong> ./bootstrap.sh <strong>--prefix=</strong><em>path</em>/<em>to</em>/<em>installation</em>/<em>prefix</em>
287</pre>
288<p>to install somewhere else.  Also, consider using the
289<tt class="docutils literal"><span class="pre">--show-libraries</span></tt> and <tt class="docutils literal"><span class="pre">--with-libraries=</span></tt><em>library-name-list</em> options to limit the
290long wait you'll experience if you build everything.  Finally,</p>
291<pre class="literal-block">
292<strong>$</strong> ./b2 install
293</pre>
294<p>will leave Boost binaries in the <tt class="docutils literal">lib/</tt> subdirectory of your
295installation prefix.  You will also find a copy of the Boost
296headers in the <tt class="docutils literal">include/</tt> subdirectory of the installation
297prefix, so you can henceforth use that directory as an <tt class="docutils literal">#include</tt>
298path in place of the Boost root directory.</p>
299<p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
300</div>
301<div class="section" id="or-build-custom-binaries">
302<h2><a class="toc-backref" href="#id27">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a></h2>
303<p>If you're using a compiler other than your system's default, you'll
304need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create binaries.</p>
305<p>You'll also
306use this method if you need a nonstandard build variant (see the
307<a class="reference external" href="../../tools/build/index.html">Boost.Build documentation</a> for more details).</p>
308<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
309<!-- Software License, Version 1.0. (See accompanying -->
310<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
311<div class="section" id="install-boost-build">
312<h3><a class="toc-backref" href="#id28">5.2.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></h3>
313<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
314installing software. First, you'll need to build and
315install it. To do this:</p>
316<ol class="arabic simple">
317<li>Go to the directory <tt class="docutils literal">tools</tt><tt class="docutils literal">/</tt><tt class="docutils literal">build</tt><tt class="docutils literal">/</tt>.</li>
318<li>Run <tt class="docutils literal">bootstrap.sh</tt></li>
319<li>Run <tt class="docutils literal">b2 install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
320the directory where you want Boost.Build to be installed</li>
321<li>Add <em>PREFIX</em><tt class="docutils literal">/</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
322</ol>
323</div>
324<div class="section" id="identify-your-toolset">
325<span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id29">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></h3>
326<p>First, find the toolset corresponding to your compiler in the
327following table (an up-to-date list is always available <a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/reference/tools.html">in the
328Boost.Build documentation</a>).</p>
329<div class="note">
330<p class="first admonition-title">Note</p>
331<p class="last">If you previously chose a toolset for the purposes of
332<a class="reference external" href="../../doc/html/bbv2/installation.html">building b2</a>, you should assume it won't work and instead
333choose newly from the table below.</p>
334</div>
335<table border="1" class="docutils">
336<colgroup>
337<col width="12%" />
338<col width="22%" />
339<col width="66%" />
340</colgroup>
341<thead valign="bottom">
342<tr><th class="head">Toolset
343Name</th>
344<th class="head">Vendor</th>
345<th class="head">Notes</th>
346</tr>
347</thead>
348<tbody valign="top">
349<tr><td><tt class="docutils literal">acc</tt></td>
350<td>Hewlett Packard</td>
351<td>Only very recent versions are known to work well with Boost</td>
352</tr>
353<tr><td><tt class="docutils literal">borland</tt></td>
354<td>Borland</td>
355<td>&nbsp;</td>
356</tr>
357<tr><td><tt class="docutils literal">como</tt></td>
358<td>Comeau Computing</td>
359<td>Using this toolset may require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
360toolset to act as its backend.</td>
361</tr>
362<tr><td><tt class="docutils literal">darwin</tt></td>
363<td>Apple Computer</td>
364<td>Apple's version of the GCC toolchain with support for
365Darwin and MacOS X features such as frameworks.</td>
366</tr>
367<tr><td><tt class="docutils literal">gcc</tt></td>
368<td>The Gnu Project</td>
369<td>Includes support for Cygwin and MinGW compilers.</td>
370</tr>
371<tr><td><tt class="docutils literal">hp_cxx</tt></td>
372<td>Hewlett Packard</td>
373<td>Targeted at the Tru64 operating system.</td>
374</tr>
375<tr><td><tt class="docutils literal">intel</tt></td>
376<td>Intel</td>
377<td>&nbsp;</td>
378</tr>
379<tr><td><tt class="docutils literal">msvc</tt></td>
380<td>Microsoft</td>
381<td>&nbsp;</td>
382</tr>
383<tr><td><tt class="docutils literal">sun</tt></td>
384<td>Oracle</td>
385<td>Only very recent versions are known to work well with
386Boost.  Note that the Oracle/Sun compiler has a large number
387of options which effect binary compatibility: it is vital
388that the libraries are built with the same options that your
389appliction will use. In particular be aware that the default
390standard library may not work well with Boost, <em>unless you
391are building for C++11</em>. The particular compiler options you
392need can be injected with the b2 command line options
393<tt class="docutils literal"><span class="pre">cxxflags=``and</span> ``linkflags=</tt>.  For example to build with
394the Apache standard library in C++03 mode use
395<tt class="docutils literal">b2 <span class="pre">cxxflags=-library=stdcxx4</span> <span class="pre">linkflags=-library=stdcxx4</span></tt>.</td>
396</tr>
397<tr><td><tt class="docutils literal">vacpp</tt></td>
398<td>IBM</td>
399<td>The VisualAge C++ compiler.</td>
400</tr>
401</tbody>
402</table>
403<p>If you have multiple versions of a particular compiler installed,
404you can append the version number to the toolset name, preceded by
405a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></tt> or
406<tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <tt class="docutils literal"> </tt></p>
407</div>
408<div class="section" id="select-a-build-directory">
409<span id="id11"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id30">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></h3>
410<p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
411building into the <strong>build directory</strong>.  If your Boost root
412directory is writable, this step isn't strictly necessary: by
413default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
414purpose in your current working directory.</p>
415</div>
416<div class="section" id="invoke-b2">
417<h3><a class="toc-backref" href="#id31">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></h3>
418<p>Change your current directory to the Boost root directory and
419invoke <tt class="docutils literal">b2</tt> as follows:</p>
420<pre class="literal-block">
421b2 <strong>--build-dir=</strong><a class="reference internal" href="#id11"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
422</pre>
423<p>For a complete description of these and other invocation options,
424please see the <a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a>.</p>
425<p>For example, your session might look like this:</p>
426<pre class="literal-block">
427$ cd ~/<tt class="docutils literal">boost_1_73_0</tt>
428$ b2 <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage
429</pre>
430<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>
431<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
432<!-- Software License, Version 1.0. (See accompanying -->
433<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
434<p>Building the special <tt class="docutils literal">stage</tt> target places Boost
435library 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
436the Boost tree.  To use a different directory pass the
437<tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">b2</tt>.</p>
438<div class="note">
439<p class="first admonition-title">Note</p>
440<p class="last"><tt class="docutils literal">b2</tt> is case-sensitive; it is important that all the
441parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
442</div>
443<p>For a description of other options you can pass when invoking
444<tt class="docutils literal">b2</tt>, type:</p>
445<pre class="literal-block">
446b2 --help
447</pre>
448<p>In particular, to limit the amount of time spent building, you may
449be interested in:</p>
450<ul class="simple">
451<li>reviewing the list of library names with <tt class="docutils literal"><span class="pre">--show-libraries</span></tt></li>
452<li>limiting which libraries get built with the <tt class="docutils literal"><span class="pre">--with-</span></tt><em>library-name</em> or <tt class="docutils literal"><span class="pre">--without-</span></tt><em>library-name</em> options</li>
453<li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
454<tt class="docutils literal">debug</tt> to the command line.</li>
455</ul>
456<div class="note">
457<p class="first admonition-title">Note</p>
458<p class="last">Boost.Build can produce a great deal of output, which can
459make it easy to miss problems.  If you want to make sure
460everything is went well, you might redirect the output into a
461file by appending “<tt class="docutils literal">&gt;build.log <span class="pre">2&gt;&amp;1</span></tt>” to your command line.</p>
462</div>
463</div>
464</div>
465<div class="section" id="expected-build-output">
466<h2><a class="toc-backref" href="#id32">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></h2>
467<p>During the process of building Boost libraries, you can expect to
468see some messages printed on the console.  These may include</p>
469<ul>
470<li><p class="first">Notices about Boost library configuration—for example, the Regex
471library outputs a message about ICU when built without Unicode
472support, and the Python library may be skipped without error (but
473with a notice) if you don't have Python installed.</p>
474</li>
475<li><p class="first">Messages from the build tool that report the number of targets
476that were built or skipped.  Don't be surprised if those numbers
477don't make any sense to you; there are many targets per library.</p>
478</li>
479<li><p class="first">Build action messages describing what the tool is doing, which
480look something like:</p>
481<pre class="literal-block">
482<em>toolset-name</em>.c++ <em>long</em>/<em>path</em>/<em>to</em>/<em>file</em>/<em>being</em>/<em>built</em>
483</pre>
484</li>
485<li><p class="first">Compiler warnings.</p>
486</li>
487</ul>
488</div>
489<div class="section" id="in-case-of-build-errors">
490<h2><a class="toc-backref" href="#id33">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></h2>
491<p>The only error messages you see when building Boost—if any—should
492be related to the IOStreams library's support of zip and bzip2
493formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>.  Install the relevant development
494packages for libz and libbz2 if you need those features.  Other
495errors when building Boost libraries are cause for concern.</p>
496<p>If it seems like the build system can't find your compiler and/or
497linker, consider setting up a <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file as described
498<a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/overview/configuration.html">here</a>.  If that isn't your problem or the <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file
499doesn't work for you, please address questions about configuring Boost
500for your compiler to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a>.</p>
501<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
502<!-- Software License, Version 1.0. (See accompanying -->
503<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
504</div>
505</div>
506<div class="section" id="link-your-program-to-a-boost-library">
507<h1><a class="toc-backref" href="#id34">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a></h1>
508<p>To demonstrate linking with a Boost binary library, we'll use the
509following simple program that extracts the subject lines from
510emails.  It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
511separately-compiled binary component.</p>
512<pre class="literal-block">
513#include &lt;boost/regex.hpp&gt;
514#include &lt;iostream&gt;
515#include &lt;string&gt;
516
517int main()
518{
519    std::string line;
520    boost::regex pat( &quot;^Subject: (Re: |Aw: )*(.*)&quot; );
521
522    while (std::cin)
523    {
524        std::getline(std::cin, line);
525        boost::smatch matches;
526        if (boost::regex_match(line, matches, pat))
527            std::cout &lt;&lt; matches[2] &lt;&lt; std::endl;
528    }
529}
530</pre>
531<p>There are two main challenges associated with linking:</p>
532<ol class="arabic simple">
533<li>Tool configuration, e.g. choosing command-line options or IDE
534build settings.</li>
535<li>Identifying the library binary, among all the build variants,
536whose compile configuration is compatible with the rest of your
537project.</li>
538</ol>
539<p>There are two main ways to link to libraries:</p>
540<ol class="upperalpha">
541<li><p class="first">You can specify the full path to each library:</p>
542<pre class="literal-block">
543$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_73_0</tt> example.cpp -o example <strong>\</strong>
544   <strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
545</pre>
546</li>
547<li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal">lib</tt> and trailing
548suffix (<tt class="docutils literal">.a</tt> in this case):</p>
549<pre class="literal-block">
550$ c++ -I <em>path/to/</em><tt class="docutils literal">boost_1_73_0</tt> example.cpp -o example <strong>\</strong>
551   <strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong>
552</pre>
553<p>As you can see, this method is just as terse as method A for one
554library; it <em>really</em> pays off when you're using multiple
555libraries from the same directory.  Note, however, that if you
556use this method with a library that has both static (<tt class="docutils literal">.a</tt>) and
557dynamic (<tt class="docutils literal">.so</tt>) builds, the system may choose one
558automatically for you unless you pass a special option such as
559<tt class="docutils literal"><span class="pre">-static</span></tt> on the command line.</p>
560</li>
561</ol>
562<p>In both cases above, the bold text is what you'd add to <a class="reference internal" href="#build-a-simple-program-using-boost">the
563command lines we explored earlier</a>.</p>
564<div class="section" id="library-naming">
565<h2><a class="toc-backref" href="#id35">6.1&nbsp;&nbsp;&nbsp;Library Naming</a></h2>
566<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
567<!-- Software License, Version 1.0. (See accompanying -->
568<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
569<p>In order to choose the right binary for your build configuration
570you need to know how Boost binaries are named.  Each library
571filename is composed of a common sequence of elements that describe
572how it was built.  For example,
573<tt class="docutils literal"><span class="pre">libboost_regex-vc71-mt-d-x86-1_34.lib</span></tt> can be broken down into the
574following elements:</p>
575<dl class="docutils">
576<dt><tt class="docutils literal">lib</tt></dt>
577<dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
578name begins with this string.  On Windows, only ordinary static
579libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
580not.<a class="footnote-reference" href="#distinct" id="id17"><sup>4</sup></a></dd>
581<dt><tt class="docutils literal">boost_regex</tt></dt>
582<dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
583<dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
584<dd><em>Toolset tag</em>: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
585the binary.</dd>
586<dt><tt class="docutils literal"><span class="pre">-mt</span></tt></dt>
587<dd><em>Threading tag</em>: indicates that the library was
588built with multithreading support enabled.  Libraries built
589without multithreading support can be identified by the absence
590of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
591<dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
592<dd><p class="first"><em>ABI tag</em>: encodes details that affect the library's
593interoperability with other compiled code.  For each such
594feature, a single letter is added to the tag:</p>
595<blockquote>
596<table border="1" class="docutils">
597<colgroup>
598<col width="5%" />
599<col width="75%" />
600<col width="20%" />
601</colgroup>
602<thead valign="bottom">
603<tr><th class="head">Key</th>
604<th class="head">Use this library when:</th>
605<th class="head">Boost.Build option</th>
606</tr>
607</thead>
608<tbody valign="top">
609<tr><td><tt class="docutils literal">s</tt></td>
610<td>linking statically to the C++ standard library and compiler runtime support
611libraries.</td>
612<td>runtime-link=static</td>
613</tr>
614<tr><td><tt class="docutils literal">g</tt></td>
615<td>using debug versions of the standard and runtime support libraries.</td>
616<td>runtime-debugging=on</td>
617</tr>
618<tr><td><tt class="docutils literal">y</tt></td>
619<td>using a special <a class="reference external" href="../../libs/python/doc/html/building/python_debugging_builds.html">debug build of Python</a>.</td>
620<td>python-debugging=on</td>
621</tr>
622<tr><td><tt class="docutils literal">d</tt></td>
623<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id18"><sup>5</sup></a></td>
624<td>variant=debug</td>
625</tr>
626<tr><td><tt class="docutils literal">p</tt></td>
627<td>using the STLPort standard library rather than the default one supplied with
628your compiler.</td>
629<td>stdlib=stlport</td>
630</tr>
631</tbody>
632</table>
633</blockquote>
634<p class="last">For example, if you build a debug version of your code for use
635with debug versions of the static runtime library and the
636STLPort standard library,
637the tag would be: <tt class="docutils literal"><span class="pre">-sgdp</span></tt>.  If none of the above apply, the
638ABI tag is ommitted.</p>
639</dd>
640<dt><tt class="docutils literal"><span class="pre">-x86</span></tt></dt>
641<dd><p class="first"><em>Architecture and address model tag</em>: in the first letter, encodes the architecture as follows:</p>
642<blockquote>
643<table border="1" class="docutils">
644<colgroup>
645<col width="11%" />
646<col width="41%" />
647<col width="48%" />
648</colgroup>
649<thead valign="bottom">
650<tr><th class="head">Key</th>
651<th class="head">Architecture</th>
652<th class="head">Boost.Build option</th>
653</tr>
654</thead>
655<tbody valign="top">
656<tr><td><tt class="docutils literal">x</tt></td>
657<td>x86-32, x86-64</td>
658<td>architecture=x86</td>
659</tr>
660<tr><td><tt class="docutils literal">a</tt></td>
661<td>ARM</td>
662<td>architecture=arm</td>
663</tr>
664<tr><td><tt class="docutils literal">i</tt></td>
665<td>IA-64</td>
666<td>architecture=ia64</td>
667</tr>
668<tr><td><tt class="docutils literal">s</tt></td>
669<td>Sparc</td>
670<td>architecture=sparc</td>
671</tr>
672<tr><td><tt class="docutils literal">m</tt></td>
673<td>MIPS/SGI</td>
674<td>architecture=mips*</td>
675</tr>
676<tr><td><tt class="docutils literal">p</tt></td>
677<td>RS/6000 &amp; PowerPC</td>
678<td>architecture=power</td>
679</tr>
680</tbody>
681</table>
682</blockquote>
683<p>The two digits following the letter encode the address model as follows:</p>
684<blockquote class="last">
685<table border="1" class="docutils">
686<colgroup>
687<col width="13%" />
688<col width="40%" />
689<col width="47%" />
690</colgroup>
691<thead valign="bottom">
692<tr><th class="head">Key</th>
693<th class="head">Address model</th>
694<th class="head">Boost.Build option</th>
695</tr>
696</thead>
697<tbody valign="top">
698<tr><td><tt class="docutils literal">32</tt></td>
699<td>32 bit</td>
700<td>address-model=32</td>
701</tr>
702<tr><td><tt class="docutils literal">64</tt></td>
703<td>64 bit</td>
704<td>address-model=64</td>
705</tr>
706</tbody>
707</table>
708</blockquote>
709</dd>
710<dt><tt class="docutils literal"><span class="pre">-1_34</span></tt></dt>
711<dd><em>Version tag</em>: the full Boost release number, with periods
712replaced by underscores. For example, version 1.31.1 would be
713tagged as &quot;-1_31_1&quot;.</dd>
714<dt><tt class="docutils literal">.lib</tt></dt>
715<dd><em>Extension</em>: determined according to the operating system's usual
716convention.  On most unix-style platforms the extensions are
717<tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
718libraries, respectively.  On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
719library and <tt class="docutils literal">.lib</tt> indicates a
720static or import library.  Where supported by toolsets on unix
721variants, a full version extension is added (e.g. &quot;.so.1.34&quot;) and
722a symbolic link to the library file, named without the trailing
723version number, will also be created.</dd>
724</dl>
725<!-- .. _Boost.Build toolset names: toolset-name_ -->
726<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
727<!-- Software License, Version 1.0. (See accompanying -->
728<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
729</div>
730<div class="section" id="test-your-program">
731<h2><a class="toc-backref" href="#id36">6.2&nbsp;&nbsp;&nbsp;Test Your Program</a></h2>
732<p>To test our subject extraction, we'll filter the following text
733file.  Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:</p>
734<pre class="literal-block">
735To: George Shmidlap
736From: Rita Marlowe
737Subject: Will Success Spoil Rock Hunter?
738---
739See subject.
740</pre>
741<p>If you linked to a shared library, you may need to prepare some
742platform-specific settings so that the system will be able to find
743and load it when your program is run.  Most platforms have an
744environment variable to which you can add the directory containing
745the library.  On many platforms (Linux, FreeBSD) that variable is
746<tt class="docutils literal">LD_LIBRARY_PATH</tt>, but on MacOS it's <tt class="docutils literal">DYLD_LIBRARY_PATH</tt>, and
747on Cygwin it's simply <tt class="docutils literal">PATH</tt>.  In most shells other than <tt class="docutils literal">csh</tt>
748and <tt class="docutils literal">tcsh</tt>, you can adjust the variable as follows (again, don't
749type the <tt class="docutils literal">$</tt>—that represents the shell prompt):</p>
750<pre class="literal-block">
751<strong>$</strong> <em>VARIABLE_NAME</em>=<em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
752<strong>$</strong> export <em>VARIABLE_NAME</em>
753</pre>
754<p>On <tt class="docutils literal">csh</tt> and <tt class="docutils literal">tcsh</tt>, it's</p>
755<pre class="literal-block">
756<strong>$</strong> setenv <em>VARIABLE_NAME</em> <em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
757</pre>
758<p>Once the necessary variable (if any) is set, you can run your
759program as follows:</p>
760<pre class="literal-block">
761<strong>$</strong> <em>path</em>/<em>to</em>/<em>compiled</em>/example &lt; <em>path</em>/<em>to</em>/jayne.txt
762</pre>
763<p>The program should respond with the email subject, “Will Success
764Spoil Rock Hunter?”</p>
765<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
766<!-- Software License, Version 1.0. (See accompanying -->
767<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
768</div>
769</div>
770<div class="section" id="conclusion-and-further-resources">
771<h1><a class="toc-backref" href="#id37">7&nbsp;&nbsp;&nbsp;Conclusion and Further Resources</a></h1>
772<p>This concludes your introduction to Boost and to integrating it
773with your programs.  As you start using Boost in earnest, there are
774surely a few additional points you'll wish we had covered.  One day
775we may have a “Book 2 in the Getting Started series” that addresses
776them.  Until then, we suggest you pursue the following resources.
777If you can't find what you need, or there's anything we can do to
778make this document clearer, please post it to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users'
779mailing list</a>.</p>
780<ul class="simple">
781<li><a class="reference external" href="../../tools/build/index.html">Boost.Build reference manual</a></li>
782<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
783<li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
784<li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
785</ul>
786<div class="admonition-onward admonition">
787<p class="first admonition-title">Onward</p>
788<blockquote class="epigraph last">
789<p>Good luck, and have fun!</p>
790<p class="attribution">&mdash;the Boost Developers</p>
791</blockquote>
792</div>
793<hr class="docutils" />
794<table class="docutils footnote" frame="void" id="packagers" rules="none">
795<colgroup><col class="label" /><col /></colgroup>
796<tbody valign="top">
797<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>If developers of Boost packages would like to work
798with us to make sure these instructions can be used with their
799packages, we'd be glad to help.  Please make your interest known
800to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#main">Boost developers' list</a>.</td></tr>
801</tbody>
802</table>
803<table class="docutils footnote" frame="void" id="lowercase-l" rules="none">
804<colgroup><col class="label" /><col /></colgroup>
805<tbody valign="top">
806<tr><td class="label"><a class="fn-backref" href="#id15">[2]</a></td><td>That option is a dash followed by a lowercase “L”
807character, which looks very much like a numeral 1 in some fonts.</td></tr>
808</tbody>
809</table>
810<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
811<!-- Software License, Version 1.0. (See accompanying -->
812<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
813<table class="docutils footnote" frame="void" id="warnings" rules="none">
814<colgroup><col class="label" /><col /></colgroup>
815<tbody valign="top">
816<tr><td class="label"><a class="fn-backref" href="#id6">[3]</a></td><td>Remember that warnings are specific to each compiler
817implementation.  The developer of a given Boost library might
818not have access to your compiler.  Also, some warnings are
819extremely difficult to eliminate in generic code, to the point
820where it's not worth the trouble.  Finally, some compilers don't
821have any source code mechanism for suppressing warnings.</td></tr>
822</tbody>
823</table>
824<table class="docutils footnote" frame="void" id="distinct" rules="none">
825<colgroup><col class="label" /><col /></colgroup>
826<tbody valign="top">
827<tr><td class="label"><a class="fn-backref" href="#id17">[4]</a></td><td>This convention distinguishes the static version of
828a Boost library from the import library for an
829identically-configured Boost DLL, which would otherwise have the
830same name.</td></tr>
831</tbody>
832</table>
833<table class="docutils footnote" frame="void" id="debug-abi" rules="none">
834<colgroup><col class="label" /><col /></colgroup>
835<tbody valign="top">
836<tr><td class="label"><a class="fn-backref" href="#id18">[5]</a></td><td>These libraries were compiled without optimization
837or inlining, with full debug symbols enabled, and without
838<tt class="docutils literal">NDEBUG</tt> <tt class="docutils literal">#define</tt>d.  Although it's true that sometimes
839these choices don't affect binary compatibility with other
840compiled code, you can't count on that with Boost libraries.</td></tr>
841</tbody>
842</table>
843<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
844<!-- Software License, Version 1.0. (See accompanying -->
845<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
846<!-- This file contains all the definitions that need to be updated -->
847<!-- for each new release of Boost. -->
848<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
849<!-- Software License, Version 1.0. (See accompanying -->
850<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
851<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
852<!-- Software License, Version 1.0. (See accompanying -->
853<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
854<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
855<!-- Software License, Version 1.0. (See accompanying -->
856<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
857</div>
858</div>
859</body>
860</html>
861