more/getting_started/unix-variants.html

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