more/getting_started/windows.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 Windows</title>
   8 <link rel="stylesheet" href="../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="logo-getting-started-on-windows">
  12 <h1 class="title"><a class="reference external" href="../../index.htm"><img alt="Boost" class="boost-logo" src="../../boost.png" /></a> Getting Started on Windows</h1>
  13
  14 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  15 <!-- Software License, Version 1.0. (See accompanying -->
  16 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  17 <div class="admonition-a-note-to-cygwin-and-mingw-users admonition">
  18 <p class="first admonition-title">A note to <a class="reference external" href="http://www.cygwin.com">Cygwin</a> and <a class="reference external" href="http://mingw.org">MinGW</a> users</p>
  19 <p class="last">If you plan to use your tools from the Windows command prompt,
  20 you're in the right place.  If you plan to build from the <a class="reference external" href="http://www.cygwin.com">Cygwin</a>
  21 bash shell, you're actually running on a POSIX platform and
  22 should follow the instructions for <a class="reference external" href="unix-variants.html">getting started on Unix
  23 variants</a>.  Other command shells, such as <a class="reference external" href="http://mingw.org">MinGW</a>'s MSYS, are
  24 not supported—they may or may not work.</p>
  25 </div>
  26 <div class="contents topic" id="index">
  27 <p class="topic-title first">Index</p>
  28 <ul class="auto-toc simple">
  29 <li><a class="reference internal" href="#get-boost" id="id28">1&nbsp;&nbsp;&nbsp;Get Boost</a></li>
  30 <li><a class="reference internal" href="#the-boost-distribution" id="id29">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></li>
  31 <li><a class="reference internal" href="#header-only-libraries" id="id30">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></li>
  32 <li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id31">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a><ul class="auto-toc">
  33 <li><a class="reference internal" href="#build-from-the-visual-studio-ide" id="id32">4.1&nbsp;&nbsp;&nbsp;Build From the Visual Studio IDE</a></li>
  34 <li><a class="reference internal" href="#or-build-from-the-command-prompt" id="id33">4.2&nbsp;&nbsp;&nbsp;Or, Build From the Command Prompt</a></li>
  35 <li><a class="reference internal" href="#errors-and-warnings" id="id34">4.3&nbsp;&nbsp;&nbsp;Errors and Warnings</a></li>
  36 </ul>
  37 </li>
  38 <li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id35">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
  39 <li><a class="reference internal" href="#simplified-build-from-source" id="id36">5.1&nbsp;&nbsp;&nbsp;Simplified Build From Source</a></li>
  40 <li><a class="reference internal" href="#or-build-binaries-from-source" id="id37">5.2&nbsp;&nbsp;&nbsp;Or, Build Binaries From Source</a><ul class="auto-toc">
  41 <li><a class="reference internal" href="#install-boost-build" id="id38">5.2.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></li>
  42 <li><a class="reference internal" href="#identify-your-toolset" id="id39">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
  43 <li><a class="reference internal" href="#select-a-build-directory" id="id40">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
  44 <li><a class="reference internal" href="#invoke-b2" id="id41">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></li>
  45 </ul>
  46 </li>
  47 <li><a class="reference internal" href="#expected-build-output" id="id42">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
  48 <li><a class="reference internal" href="#in-case-of-build-errors" id="id43">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></li>
  49 </ul>
  50 </li>
  51 <li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id44">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a><ul class="auto-toc">
  52 <li><a class="reference internal" href="#link-from-within-the-visual-studio-ide" id="id45">6.1&nbsp;&nbsp;&nbsp;Link From Within the Visual Studio IDE</a></li>
  53 <li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id46">6.2&nbsp;&nbsp;&nbsp;Or, Link From the Command Prompt</a></li>
  54 <li><a class="reference internal" href="#library-naming" id="id47">6.3&nbsp;&nbsp;&nbsp;Library Naming</a></li>
  55 <li><a class="reference internal" href="#test-your-program" id="id48">6.4&nbsp;&nbsp;&nbsp;Test Your Program</a></li>
  56 </ul>
  57 </li>
  58 <li><a class="reference internal" href="#conclusion-and-further-resources" id="id49">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="#id28">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
  63 <p>The most reliable way to get a copy of Boost is to
  64 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">.7z</tt></a> or <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">.zip</tt></a> and unpack it to install a complete Boost
  65 distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a></p>
  66 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  67 <!-- Software License, Version 1.0. (See accompanying -->
  68 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  69 </div>
  70 <div class="section" id="the-boost-distribution">
  71 <h1><a class="toc-backref" href="#id29">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1>
  72 <p>This is a sketch of the resulting directory structure:</p>
  73 <pre class="literal-block">
  74 <strong>boost_1_72_0</strong><strong>\</strong> .................<em>The “boost root directory”</em>
  75    <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
  76    <strong>boost</strong><strong>\</strong> .........................<em>All Boost Header files</em>
  77    <strong>lib</strong><strong>\</strong> .....................<em>precompiled library binaries</em>
  78    <strong>libs</strong><strong>\</strong> ............<em>Tests, .cpp</em>s<em>, docs, etc., by library</em>
  79      <strong>index.html</strong> ........<em>Library documentation starts here</em>
  80      <strong>algorithm</strong><strong>\</strong>
  81      <strong>any</strong><strong>\</strong>
  82      <strong>array</strong><strong>\</strong>
  83                      <em>…more libraries…</em>
  84    <strong>status</strong><strong>\</strong> .........................<em>Boost-wide test suite</em>
  85    <strong>tools</strong><strong>\</strong> ...........<em>Utilities, e.g. Boost.Build, quickbook, bcp</em>
  86    <strong>more</strong><strong>\</strong> ..........................<em>Policy documents, etc.</em>
  87    <strong>doc</strong><strong>\</strong> ...............<em>A subset of all Boost library docs</em>
  88 </pre>
  89 <div class="sidebar">
  90 <p class="first sidebar-title">Header Organization</p>
  91 <p class="pre-wrap">The organization of Boost library headers isn't entirely uniform,
  92 but most libraries follow a few patterns:</p>
  93 <ul class="pre-wrap last">
  94 <li><p class="first">Some older libraries and most very small libraries place all
  95 public headers directly into <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>.</p>
  96 </li>
  97 <li><p class="first">Most libraries' public headers live in a subdirectory of
  98 <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt>, named after the library.  For example, you'll find
  99 the Python library's <tt class="docutils literal">def.hpp</tt> header in</p>
 100 <pre class="literal-block">
 101 <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>.
 102 </pre>
 103 </li>
 104 <li><p class="first">Some libraries have an “aggregate header” in <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> that
 105 <tt class="docutils literal">#include</tt>s all of the library's other headers.  For
 106 example, <a class="reference external" href="../../libs/python/doc/html/building.html">Boost.Python</a>'s aggregate header is</p>
 107 <pre class="literal-block">
 108 <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt><tt class="docutils literal">python.hpp</tt>.
 109 </pre>
 110 </li>
 111 <li><p class="first">Most libraries place private headers in a subdirectory called
 112 <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
 113 anything you can use in these directories.</p>
 114 </li>
 115 </ul>
 116 </div>
 117 <p>It's important to note the following:</p>
 118 <ol class="arabic" id="boost-root-directory">
 119 <li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt>) is
 120 sometimes referred to as <tt class="docutils literal">$BOOST_ROOT</tt> in documentation and
 121 mailing lists .</p>
 122 </li>
 123 <li><p class="first">To compile anything in Boost, you need a directory containing
 124 the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory in your <tt class="docutils literal">#include</tt> path.  Specific steps for setting up <tt class="docutils literal">#include</tt>
 125 paths in Microsoft Visual Studio follow later in this document;
 126 if you use another IDE, please consult your product's
 127 documentation for instructions.</p>
 128 </li>
 129 <li><p class="first">Since all of Boost's header files have the <tt class="docutils literal">.hpp</tt> extension,
 130 and live in the <tt class="docutils literal">boost</tt><tt class="docutils literal">\</tt> subdirectory of the boost root, your
 131 Boost <tt class="docutils literal">#include</tt> directives will look like:</p>
 132 <pre class="literal-block">
 133 #include &lt;boost/<em>whatever</em>.hpp&gt;
 134 </pre>
 135 <p>or</p>
 136 <pre class="literal-block">
 137 #include &quot;boost/<em>whatever</em>.hpp&quot;
 138 </pre>
 139 <p>depending on your preference regarding the use of angle bracket
 140 includes.  Even Windows users can (and, for
 141 portability reasons, probably should) use forward slashes in
 142 <tt class="docutils literal">#include</tt> directives; your compiler doesn't care.</p>
 143 </li>
 144 <li><p class="first">Don't be distracted by the <tt class="docutils literal">doc</tt><tt class="docutils literal">\</tt> subdirectory; it only
 145 contains a subset of the Boost documentation.  Start with
 146 <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>
 147 </li>
 148 </ol>
 149 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 150 <!-- Software License, Version 1.0. (See accompanying -->
 151 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 152 </div>
 153 <div class="section" id="header-only-libraries">
 154 <h1><a class="toc-backref" href="#id30">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></h1>
 155 <p>The first thing many people want to know is, “how do I build
 156 Boost?”  The good news is that often, there's nothing to build.</p>
 157 <div class="admonition-nothing-to-build admonition">
 158 <p class="first admonition-title">Nothing to Build?</p>
 159 <p class="last">Most Boost libraries are <strong>header-only</strong>: they consist <em>entirely
 160 of header files</em> containing templates and inline functions, and
 161 require no separately-compiled library binaries or special
 162 treatment when linking.</p>
 163 </div>
 164 <!-- .. _separate: -->
 165 <p>The only Boost libraries that <em>must</em> be built separately are:</p>
 166 <ul class="simple">
 167 <li><a class="reference external" href="../../libs/chrono/index.html">Boost.Chrono</a></li>
 168 <li><a class="reference external" href="../../libs/context/index.html">Boost.Context</a></li>
 169 <li><a class="reference external" href="../../libs/filesystem/index.html">Boost.Filesystem</a></li>
 170 <li><a class="reference external" href="../../libs/graph_parallel/index.html">Boost.GraphParallel</a></li>
 171 <li><a class="reference external" href="../../libs/iostreams/index.html">Boost.IOStreams</a></li>
 172 <li><a class="reference external" href="../../libs/locale/index.html">Boost.Locale</a></li>
 173 <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>
 174 <li><a class="reference external" href="../../libs/mpi/index.html">Boost.MPI</a></li>
 175 <li><a class="reference external" href="../../libs/program_options/index.html">Boost.ProgramOptions</a></li>
 176 <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>
 177 before building and installing it)</li>
 178 <li><a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a></li>
 179 <li><a class="reference external" href="../../libs/serialization/index.html">Boost.Serialization</a></li>
 180 <li><a class="reference external" href="../../libs/thread/index.html">Boost.Thread</a></li>
 181 <li><a class="reference external" href="../../libs/timer/index.html">Boost.Timer</a></li>
 182 <li><a class="reference external" href="../../libs/wave/index.html">Boost.Wave</a></li>
 183 </ul>
 184 <p>A few libraries have optional separately-compiled binaries:</p>
 185 <ul class="simple">
 186 <li><a class="reference external" href="../../libs/date_time/index.html">Boost.DateTime</a> has a binary component that is only needed if
 187 you're using its <tt class="docutils literal">to_string</tt>/<tt class="docutils literal">from_string</tt> or serialization
 188 features, or if you're targeting Visual C++ 6.x or Borland.</li>
 189 <li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
 190 you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
 191 <li><a class="reference external" href="../../libs/math/index.html">Boost.Math</a> has binary components for the TR1 and C99
 192 cmath functions.</li>
 193 <li><a class="reference external" href="../../libs/random/index.html">Boost.Random</a> has a binary component which is only needed if
 194 you're using <tt class="docutils literal">random_device</tt>.</li>
 195 <li><a class="reference external" href="../../libs/test/index.html">Boost.Test</a> can be used in “header-only” or “separately compiled”
 196 mode, although <strong>separate compilation is recommended for serious
 197 use</strong>.</li>
 198 <li><a class="reference external" href="../../libs/exception/index.html">Boost.Exception</a> provides non-intrusive implementation of
 199 exception_ptr for 32-bit _MSC_VER==1310 and _MSC_VER==1400
 200 which requires a separately-compiled binary. This is enabled by
 201 #define BOOST_ENABLE_NON_INTRUSIVE_EXCEPTION_PTR.</li>
 202 <li><a class="reference external" href="../../libs/system/index.html">Boost.System</a> is header-only since Boost 1.69. A stub library is
 203 still built for compatibility, but linking to it is no longer
 204 necessary.</li>
 205 </ul>
 206 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 207 <!-- Software License, Version 1.0. (See accompanying -->
 208 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 209 </div>
 210 <div class="section" id="build-a-simple-program-using-boost">
 211 <h1><a class="toc-backref" href="#id31">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a></h1>
 212 <p>To keep things simple, let's start by using a header-only library.
 213 The following program reads a sequence of integers from standard
 214 input, uses Boost.Lambda to multiply each number by three, and
 215 writes them to standard output:</p>
 216 <pre class="literal-block">
 217 #include &lt;boost/lambda/lambda.hpp&gt;
 218 #include &lt;iostream&gt;
 219 #include &lt;iterator&gt;
 220 #include &lt;algorithm&gt;
 221
 222 int main()
 223 {
 224     using namespace boost::lambda;
 225     typedef std::istream_iterator&lt;int&gt; in;
 226
 227     std::for_each(
 228         in(std::cin), in(), std::cout &lt;&lt; (_1 * 3) &lt;&lt; &quot; &quot; );
 229 }
 230 </pre>
 231 <p>Copy the text of this program into a file called <tt class="docutils literal">example.cpp</tt>.</p>
 232 <div class="note" id="command-line-tool">
 233 <span id="command-prompt"></span><p class="first admonition-title">Note</p>
 234 <p class="last">To build the examples in this guide, you can use an
 235 Integrated Development Environment (IDE) like Visual Studio, or
 236 you can issue commands from the <a class="reference internal" href="#command-prompt">command prompt</a>.  Since every
 237 IDE and compiler has different options and Microsoft's are by
 238 far the dominant compilers on Windows, we only give specific
 239 directions here for Visual Studio 2005 and .NET 2003 IDEs and
 240 their respective command prompt compilers (using the command
 241 prompt is a bit simpler).  If you are using another compiler or
 242 IDE, it should be relatively easy to adapt these instructions to
 243 your environment.</p>
 244 </div>
 245 <div class="small sidebar">
 246 <p class="first sidebar-title">Command Prompt Basics</p>
 247 <p>In Windows, a command-line tool is invoked by typing its name,
 248 optionally followed by arguments, into a <em>Command Prompt</em> window
 249 and pressing the Return (or Enter) key.</p>
 250 <p>To open a generic <em>Command Prompt</em>, click the <em>Start</em> menu
 251 button, click <em>Run</em>, type “cmd”, and then click <em>OK</em>.</p>
 252 <p id="current-directory">All commands are executed within the context of a <strong>current
 253 directory</strong> in the filesystem.  To set the current directory,
 254 type:</p>
 255 <pre class="literal-block">
 256 cd <em>path</em>\<em>to</em>\<em>some</em>\<em>directory</em>
 257 </pre>
 258 <p>followed by Return.  For example,</p>
 259 <pre class="literal-block">
 260 cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt>
 261 </pre>
 262 <p class="last">Long commands can be continued across several lines by typing a
 263 caret (<tt class="docutils literal">^</tt>) at the end of all but the last line.  Some examples
 264 on this page use that technique to save horizontal space.</p>
 265 </div>
 266 <div class="section" id="build-from-the-visual-studio-ide">
 267 <span id="vs-header-only"></span><h2><a class="toc-backref" href="#id32">4.1&nbsp;&nbsp;&nbsp;Build From the Visual Studio IDE</a></h2>
 268 <ul>
 269 <li><p class="first">From Visual Studio's <em>File</em> menu, select <em>New</em> &gt; <em>Project…</em></p>
 270 </li>
 271 <li><p class="first">In the left-hand pane of the resulting <em>New Project</em> dialog,
 272 select <em>Visual C++</em> &gt; <em>Win32</em>.</p>
 273 </li>
 274 <li><p class="first">In the right-hand pane, select <em>Win32 Console Application</em>
 275 (VS8.0) or <em>Win32 Console Project</em> (VS7.1).</p>
 276 </li>
 277 <li><p class="first">In the <em>name</em> field, enter “example”</p>
 278 </li>
 279 <li><p class="first">Right-click <strong>example</strong> in the <em>Solution Explorer</em> pane and
 280 select <em>Properties</em> from the resulting pop-up menu</p>
 281 </li>
 282 <li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>General</em> &gt; <em>Additional Include
 283 Directories</em>, enter the path to the Boost root directory, for example</p>
 284 <blockquote>
 285 <p><tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt></p>
 286 </blockquote>
 287 </li>
 288 <li><p class="first">In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>Precompiled Headers</em>, change
 289 <em>Use Precompiled Header (/Yu)</em> to <em>Not Using Precompiled
 290 Headers</em>.<a class="footnote-reference" href="#pch" id="id6"><sup>2</sup></a></p>
 291 </li>
 292 <li><p class="first">Replace the contents of the <tt class="docutils literal">example.cpp</tt> generated by the IDE
 293 with the example code above.</p>
 294 </li>
 295 <li><p class="first">From the <em>Build</em> menu, select <em>Build Solution</em>.</p>
 296 </li>
 297 </ul>
 298 <p>To test your application, hit the F5 key and type the following
 299 into the resulting window, followed by the Return key:</p>
 300 <pre class="literal-block">
 301 1 2 3
 302 </pre>
 303 <p>Then hold down the control key and press &quot;Z&quot;, followed by the
 304 Return key.</p>
 305 <p><a class="reference internal" href="#errors-and-warnings"><em>skip to the next step</em></a></p>
 306 </div>
 307 <div class="section" id="or-build-from-the-command-prompt">
 308 <h2><a class="toc-backref" href="#id33">4.2&nbsp;&nbsp;&nbsp;Or, Build From the Command Prompt</a></h2>
 309 <p>From your computer's <em>Start</em> menu, if you are a Visual
 310 Studio 2005 user, select</p>
 311 <blockquote>
 312 <em>All Programs</em> &gt; <em>Microsoft Visual Studio 2005</em>
 313 &gt; <em>Visual Studio Tools</em> &gt; <em>Visual Studio 2005 Command Prompt</em></blockquote>
 314 <p>or, if you're a Visual Studio .NET 2003 user, select</p>
 315 <blockquote>
 316 <em>All Programs</em> &gt; <em>Microsoft Visual Studio .NET 2003</em>
 317 &gt; <em>Visual Studio .NET Tools</em> &gt; <em>Visual Studio .NET 2003 Command Prompt</em></blockquote>
 318 <p>to bring up a special <a class="reference internal" href="#command-prompt">command prompt</a> window set up for the
 319 Visual Studio compiler.  In that window, set the <a class="reference internal" href="#current-directory">current
 320 directory</a> to a suitable location for creating some temporary
 321 files and type the following command followed by the Return key:</p>
 322 <pre class="literal-block">
 323 cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_72_0</tt> <em>path</em>\<em>to</em>\example.cpp
 324 </pre>
 325 <p>To test the result, type:</p>
 326 <pre class="literal-block">
 327 echo 1 2 3 | example
 328 </pre>
 329 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 330 <!-- Software License, Version 1.0. (See accompanying -->
 331 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 332 </div>
 333 <div class="section" id="errors-and-warnings">
 334 <h2><a class="toc-backref" href="#id34">4.3&nbsp;&nbsp;&nbsp;Errors and Warnings</a></h2>
 335 <p>Don't be alarmed if you see compiler warnings originating in Boost
 336 headers.  We try to eliminate them, but doing so isn't always
 337 practical.<a class="footnote-reference" href="#warnings" id="id8"><sup>4</sup></a> <strong>Errors are another matter</strong>.  If you're
 338 seeing compilation errors at this point in the tutorial, check to
 339 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
 340 correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p>
 341 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 342 <!-- Software License, Version 1.0. (See accompanying -->
 343 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 344 </div>
 345 </div>
 346 <div class="section" id="prepare-to-use-a-boost-library-binary">
 347 <h1><a class="toc-backref" href="#id35">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a></h1>
 348 <p>If you want to use any of the separately-compiled Boost libraries,
 349 you'll need to acquire library binaries.</p>
 350 <div class="section" id="simplified-build-from-source">
 351 <h2><a class="toc-backref" href="#id36">5.1&nbsp;&nbsp;&nbsp;Simplified Build From Source</a></h2>
 352 <p>If you wish to build from source with Visual C++, you can use a
 353 simple build procedure described in this section. Open the command prompt
 354 and change your current directory to the Boost root directory. Then, type
 355 the following commands:</p>
 356 <pre class="literal-block">
 357 bootstrap
 358 .\b2
 359 </pre>
 360 <p>The first command prepares the Boost.Build system for use. The second
 361 command invokes Boost.Build to build the separately-compiled Boost
 362 libraries. Please consult the <a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a> for a list
 363 of allowed options.</p>
 364 </div>
 365 <div class="section" id="or-build-binaries-from-source">
 366 <h2><a class="toc-backref" href="#id37">5.2&nbsp;&nbsp;&nbsp;Or, Build Binaries From Source</a></h2>
 367 <p>If you're using an earlier version of Visual C++, or a compiler
 368 from another vendor, you'll need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create your
 369 own binaries.</p>
 370 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 371 <!-- Software License, Version 1.0. (See accompanying -->
 372 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 373 <div class="section" id="install-boost-build">
 374 <h3><a class="toc-backref" href="#id38">5.2.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></h3>
 375 <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
 376 installing software. First, you'll need to build and
 377 install it. To do this:</p>
 378 <ol class="arabic simple">
 379 <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>
 380 <li>Run <tt class="docutils literal">bootstrap.bat</tt></li>
 381 <li>Run <tt class="docutils literal">b2 install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
 382 the directory where you want Boost.Build to be installed</li>
 383 <li>Add <em>PREFIX</em><tt class="docutils literal">\</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
 384 </ol>
 385 </div>
 386 <div class="section" id="identify-your-toolset">
 387 <span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id39">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></h3>
 388 <p>First, find the toolset corresponding to your compiler in the
 389 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
 390 Boost.Build documentation</a>).</p>
 391 <div class="note">
 392 <p class="first admonition-title">Note</p>
 393 <p class="last">If you previously chose a toolset for the purposes of
 394 <a class="reference external" href="../../doc/html/bbv2/installation.html">building b2</a>, you should assume it won't work and instead
 395 choose newly from the table below.</p>
 396 </div>
 397 <table border="1" class="docutils">
 398 <colgroup>
 399 <col width="12%" />
 400 <col width="22%" />
 401 <col width="66%" />
 402 </colgroup>
 403 <thead valign="bottom">
 404 <tr><th class="head">Toolset
 405 Name</th>
 406 <th class="head">Vendor</th>
 407 <th class="head">Notes</th>
 408 </tr>
 409 </thead>
 410 <tbody valign="top">
 411 <tr><td><tt class="docutils literal">acc</tt></td>
 412 <td>Hewlett Packard</td>
 413 <td>Only very recent versions are known to work well with Boost</td>
 414 </tr>
 415 <tr><td><tt class="docutils literal">borland</tt></td>
 416 <td>Borland</td>
 417 <td>&nbsp;</td>
 418 </tr>
 419 <tr><td><tt class="docutils literal">como</tt></td>
 420 <td>Comeau Computing</td>
 421 <td>Using this toolset may require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
 422 toolset to act as its backend.</td>
 423 </tr>
 424 <tr><td><tt class="docutils literal">darwin</tt></td>
 425 <td>Apple Computer</td>
 426 <td>Apple's version of the GCC toolchain with support for
 427 Darwin and MacOS X features such as frameworks.</td>
 428 </tr>
 429 <tr><td><tt class="docutils literal">gcc</tt></td>
 430 <td>The Gnu Project</td>
 431 <td>Includes support for Cygwin and MinGW compilers.</td>
 432 </tr>
 433 <tr><td><tt class="docutils literal">hp_cxx</tt></td>
 434 <td>Hewlett Packard</td>
 435 <td>Targeted at the Tru64 operating system.</td>
 436 </tr>
 437 <tr><td><tt class="docutils literal">intel</tt></td>
 438 <td>Intel</td>
 439 <td>&nbsp;</td>
 440 </tr>
 441 <tr><td><tt class="docutils literal">msvc</tt></td>
 442 <td>Microsoft</td>
 443 <td>&nbsp;</td>
 444 </tr>
 445 <tr><td><tt class="docutils literal">sun</tt></td>
 446 <td>Oracle</td>
 447 <td>Only very recent versions are known to work well with
 448 Boost.  Note that the Oracle/Sun compiler has a large number
 449 of options which effect binary compatibility: it is vital
 450 that the libraries are built with the same options that your
 451 appliction will use. In particular be aware that the default
 452 standard library may not work well with Boost, <em>unless you
 453 are building for C++11</em>. The particular compiler options you
 454 need can be injected with the b2 command line options
 455 <tt class="docutils literal"><span class="pre">cxxflags=``and</span> ``linkflags=</tt>.  For example to build with
 456 the Apache standard library in C++03 mode use
 457 <tt class="docutils literal">b2 <span class="pre">cxxflags=-library=stdcxx4</span> <span class="pre">linkflags=-library=stdcxx4</span></tt>.</td>
 458 </tr>
 459 <tr><td><tt class="docutils literal">vacpp</tt></td>
 460 <td>IBM</td>
 461 <td>The VisualAge C++ compiler.</td>
 462 </tr>
 463 </tbody>
 464 </table>
 465 <p>If you have multiple versions of a particular compiler installed,
 466 you can append the version number to the toolset name, preceded by
 467 a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></tt> or
 468 <tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <strong>On Windows, append a version
 469 number even if you only have one version installed</strong> (unless you
 470 are using the msvc or gcc toolsets, which have special version
 471 detection code) or <a class="reference internal" href="#auto-linking">auto-linking</a> will fail.</p>
 472 </div>
 473 <div class="section" id="select-a-build-directory">
 474 <span id="id13"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id40">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></h3>
 475 <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
 476 building into the <strong>build directory</strong>.  If your Boost root
 477 directory is writable, this step isn't strictly necessary: by
 478 default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
 479 purpose in your current working directory.</p>
 480 </div>
 481 <div class="section" id="invoke-b2">
 482 <h3><a class="toc-backref" href="#id41">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></h3>
 483 <p>Change your current directory to the Boost root directory and
 484 invoke <tt class="docutils literal">b2</tt> as follows:</p>
 485 <pre class="literal-block">
 486 b2 <strong>--build-dir=</strong><a class="reference internal" href="#id13"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <strong>--build-type=complete</strong> stage
 487 </pre>
 488 <p>For a complete description of these and other invocation options,
 489 please see the <a class="reference external" href="http://www.boost.org/build/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a>.</p>
 490 <p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>3</sup></a></p>
 491 <pre class="literal-block">
 492 C:\WINDOWS&gt; cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt>
 493 <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt>&gt; b2 <strong>^</strong>
 494 More? <strong>--build-dir=</strong>&quot;C:\Documents and Settings\dave\build-boost&quot; <strong>^</strong>
 495 More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage
 496 </pre>
 497 <p>Be sure to read <a class="reference internal" href="#continuation">this note</a> about the appearance of <tt class="docutils literal">^</tt>,
 498 <tt class="docutils literal">More?</tt> and quotation marks (<tt class="docutils literal">&quot;</tt>) in that line.</p>
 499 <p>The option “<strong>--build-type=complete</strong>” causes Boost.Build to build
 500 all supported variants of the libraries.  For instructions on how to
 501 build only specific variants, please ask on the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing
 502 list</a>.</p>
 503 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 504 <!-- Software License, Version 1.0. (See accompanying -->
 505 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 506 <p>Building the special <tt class="docutils literal">stage</tt> target places Boost
 507 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
 508 the Boost tree.  To use a different directory pass the
 509 <tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">b2</tt>.</p>
 510 <div class="note">
 511 <p class="first admonition-title">Note</p>
 512 <p class="last"><tt class="docutils literal">b2</tt> is case-sensitive; it is important that all the
 513 parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
 514 </div>
 515 <p>For a description of other options you can pass when invoking
 516 <tt class="docutils literal">b2</tt>, type:</p>
 517 <pre class="literal-block">
 518 b2 --help
 519 </pre>
 520 <p>In particular, to limit the amount of time spent building, you may
 521 be interested in:</p>
 522 <ul class="simple">
 523 <li>reviewing the list of library names with <tt class="docutils literal"><span class="pre">--show-libraries</span></tt></li>
 524 <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>
 525 <li>choosing a specific build variant by adding <tt class="docutils literal">release</tt> or
 526 <tt class="docutils literal">debug</tt> to the command line.</li>
 527 </ul>
 528 <div class="note">
 529 <p class="first admonition-title">Note</p>
 530 <p class="last">Boost.Build can produce a great deal of output, which can
 531 make it easy to miss problems.  If you want to make sure
 532 everything is went well, you might redirect the output into a
 533 file by appending “<tt class="docutils literal">&gt;build.log <span class="pre">2&gt;&amp;1</span></tt>” to your command line.</p>
 534 </div>
 535 </div>
 536 </div>
 537 <div class="section" id="expected-build-output">
 538 <h2><a class="toc-backref" href="#id42">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></h2>
 539 <p>During the process of building Boost libraries, you can expect to
 540 see some messages printed on the console.  These may include</p>
 541 <ul>
 542 <li><p class="first">Notices about Boost library configuration—for example, the Regex
 543 library outputs a message about ICU when built without Unicode
 544 support, and the Python library may be skipped without error (but
 545 with a notice) if you don't have Python installed.</p>
 546 </li>
 547 <li><p class="first">Messages from the build tool that report the number of targets
 548 that were built or skipped.  Don't be surprised if those numbers
 549 don't make any sense to you; there are many targets per library.</p>
 550 </li>
 551 <li><p class="first">Build action messages describing what the tool is doing, which
 552 look something like:</p>
 553 <pre class="literal-block">
 554 <em>toolset-name</em>.c++ <em>long</em>/<em>path</em>/<em>to</em>/<em>file</em>/<em>being</em>/<em>built</em>
 555 </pre>
 556 </li>
 557 <li><p class="first">Compiler warnings.</p>
 558 </li>
 559 </ul>
 560 </div>
 561 <div class="section" id="in-case-of-build-errors">
 562 <h2><a class="toc-backref" href="#id43">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></h2>
 563 <p>The only error messages you see when building Boost—if any—should
 564 be related to the IOStreams library's support of zip and bzip2
 565 formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>.  Install the relevant development
 566 packages for libz and libbz2 if you need those features.  Other
 567 errors when building Boost libraries are cause for concern.</p>
 568 <p>If it seems like the build system can't find your compiler and/or
 569 linker, consider setting up a <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file as described
 570 <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
 571 doesn't work for you, please address questions about configuring Boost
 572 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>
 573 <span class="target" id="auto-linking"></span><!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 574 <!-- Software License, Version 1.0. (See accompanying -->
 575 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 576 </div>
 577 </div>
 578 <div class="section" id="link-your-program-to-a-boost-library">
 579 <h1><a class="toc-backref" href="#id44">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a></h1>
 580 <p>To demonstrate linking with a Boost binary library, we'll use the
 581 following simple program that extracts the subject lines from
 582 emails.  It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
 583 separately-compiled binary component.</p>
 584 <pre class="literal-block">
 585 #include &lt;boost/regex.hpp&gt;
 586 #include &lt;iostream&gt;
 587 #include &lt;string&gt;
 588
 589 int main()
 590 {
 591     std::string line;
 592     boost::regex pat( &quot;^Subject: (Re: |Aw: )*(.*)&quot; );
 593
 594     while (std::cin)
 595     {
 596         std::getline(std::cin, line);
 597         boost::smatch matches;
 598         if (boost::regex_match(line, matches, pat))
 599             std::cout &lt;&lt; matches[2] &lt;&lt; std::endl;
 600     }
 601 }
 602 </pre>
 603 <p>There are two main challenges associated with linking:</p>
 604 <ol class="arabic simple">
 605 <li>Tool configuration, e.g. choosing command-line options or IDE
 606 build settings.</li>
 607 <li>Identifying the library binary, among all the build variants,
 608 whose compile configuration is compatible with the rest of your
 609 project.</li>
 610 </ol>
 611 <div class="admonition-auto-linking admonition">
 612 <p class="first admonition-title">Auto-Linking</p>
 613 <p>Most Windows compilers and linkers have so-called “auto-linking
 614 support,” which eliminates the second challenge.  Special code in
 615 Boost header files detects your compiler options and uses that
 616 information to encode the name of the correct library into your
 617 object files; the linker selects the library with that name from
 618 the directories you've told it to search.</p>
 619 <p class="last">The GCC toolchains (Cygwin and MinGW) are notable exceptions;
 620 GCC users should refer to the <a class="reference external" href="unix-variants.html#link-your-program-to-a-boost-library">linking instructions for Unix
 621 variant OSes</a> for the appropriate command-line options to use.</p>
 622 </div>
 623 <div class="section" id="link-from-within-the-visual-studio-ide">
 624 <h2><a class="toc-backref" href="#id45">6.1&nbsp;&nbsp;&nbsp;Link From Within the Visual Studio IDE</a></h2>
 625 <p>Starting with the <a class="reference internal" href="#vs-header-only">header-only example project</a> we created
 626 earlier:</p>
 627 <ol class="arabic simple">
 628 <li>Right-click <strong>example</strong> in the <em>Solution Explorer</em> pane and
 629 select <em>Properties</em> from the resulting pop-up menu</li>
 630 <li>In <em>Configuration Properties</em> &gt; <em>Linker</em> &gt; <em>Additional Library
 631 Directories</em>, enter the path to the Boost binaries,
 632 e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt><tt class="docutils literal">\lib\</tt>.</li>
 633 <li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li>
 634 </ol>
 635 <p><a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a></p>
 636 </div>
 637 <div class="section" id="or-link-from-the-command-prompt">
 638 <h2><a class="toc-backref" href="#id46">6.2&nbsp;&nbsp;&nbsp;Or, Link From the Command Prompt</a></h2>
 639 <p>For example, we can compile and link the above program from the
 640 Visual C++ command-line by simply adding the <strong>bold</strong> text below to
 641 the command line we used earlier, assuming your Boost binaries are
 642 in <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_72_0</tt><tt class="docutils literal">\lib</tt>:</p>
 643 <pre class="literal-block">
 644 cl /EHsc /I <em>path\to\</em><tt class="docutils literal">boost_1_72_0</tt> example.cpp   <strong>^</strong>
 645      <strong>/link /LIBPATH:</strong><strong>C:\Program Files\boost\</strong><strong>boost_1_72_0</strong><strong>\lib</strong>
 646 </pre>
 647 </div>
 648 <div class="section" id="library-naming">
 649 <h2><a class="toc-backref" href="#id47">6.3&nbsp;&nbsp;&nbsp;Library Naming</a></h2>
 650 <div class="note">
 651 <p class="first admonition-title">Note</p>
 652 <p>If, like Visual C++, your compiler supports auto-linking,
 653 you can probably <a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a>.</p>
 654 <blockquote class="last">
 655 </blockquote>
 656 </div>
 657 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 658 <!-- Software License, Version 1.0. (See accompanying -->
 659 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 660 <p>In order to choose the right binary for your build configuration
 661 you need to know how Boost binaries are named.  Each library
 662 filename is composed of a common sequence of elements that describe
 663 how it was built.  For example,
 664 <tt class="docutils literal"><span class="pre">libboost_regex-vc71-mt-d-x86-1_34.lib</span></tt> can be broken down into the
 665 following elements:</p>
 666 <dl class="docutils">
 667 <dt><tt class="docutils literal">lib</tt></dt>
 668 <dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
 669 name begins with this string.  On Windows, only ordinary static
 670 libraries use the <tt class="docutils literal">lib</tt> prefix; import libraries and DLLs do
 671 not.<a class="footnote-reference" href="#distinct" id="id23"><sup>5</sup></a></dd>
 672 <dt><tt class="docutils literal">boost_regex</tt></dt>
 673 <dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal">boost_</tt>.</dd>
 674 <dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
 675 <dd><em>Toolset tag</em>: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
 676 the binary.</dd>
 677 <dt><tt class="docutils literal"><span class="pre">-mt</span></tt></dt>
 678 <dd><em>Threading tag</em>: indicates that the library was
 679 built with multithreading support enabled.  Libraries built
 680 without multithreading support can be identified by the absence
 681 of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
 682 <dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
 683 <dd><p class="first"><em>ABI tag</em>: encodes details that affect the library's
 684 interoperability with other compiled code.  For each such
 685 feature, a single letter is added to the tag:</p>
 686 <blockquote>
 687 <table border="1" class="docutils">
 688 <colgroup>
 689 <col width="5%" />
 690 <col width="75%" />
 691 <col width="20%" />
 692 </colgroup>
 693 <thead valign="bottom">
 694 <tr><th class="head">Key</th>
 695 <th class="head">Use this library when:</th>
 696 <th class="head">Boost.Build option</th>
 697 </tr>
 698 </thead>
 699 <tbody valign="top">
 700 <tr><td><tt class="docutils literal">s</tt></td>
 701 <td>linking statically to the C++ standard library and compiler runtime support
 702 libraries.</td>
 703 <td>runtime-link=static</td>
 704 </tr>
 705 <tr><td><tt class="docutils literal">g</tt></td>
 706 <td>using debug versions of the standard and runtime support libraries.</td>
 707 <td>runtime-debugging=on</td>
 708 </tr>
 709 <tr><td><tt class="docutils literal">y</tt></td>
 710 <td>using a special <a class="reference external" href="../../libs/python/doc/html/building/python_debugging_builds.html">debug build of Python</a>.</td>
 711 <td>python-debugging=on</td>
 712 </tr>
 713 <tr><td><tt class="docutils literal">d</tt></td>
 714 <td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id24"><sup>6</sup></a></td>
 715 <td>variant=debug</td>
 716 </tr>
 717 <tr><td><tt class="docutils literal">p</tt></td>
 718 <td>using the STLPort standard library rather than the default one supplied with
 719 your compiler.</td>
 720 <td>stdlib=stlport</td>
 721 </tr>
 722 </tbody>
 723 </table>
 724 </blockquote>
 725 <p class="last">For example, if you build a debug version of your code for use
 726 with debug versions of the static runtime library and the
 727 STLPort standard library,
 728 the tag would be: <tt class="docutils literal"><span class="pre">-sgdp</span></tt>.  If none of the above apply, the
 729 ABI tag is ommitted.</p>
 730 </dd>
 731 <dt><tt class="docutils literal"><span class="pre">-x86</span></tt></dt>
 732 <dd><p class="first"><em>Architecture and address model tag</em>: in the first letter, encodes the architecture as follows:</p>
 733 <blockquote>
 734 <table border="1" class="docutils">
 735 <colgroup>
 736 <col width="11%" />
 737 <col width="41%" />
 738 <col width="48%" />
 739 </colgroup>
 740 <thead valign="bottom">
 741 <tr><th class="head">Key</th>
 742 <th class="head">Architecture</th>
 743 <th class="head">Boost.Build option</th>
 744 </tr>
 745 </thead>
 746 <tbody valign="top">
 747 <tr><td><tt class="docutils literal">x</tt></td>
 748 <td>x86-32, x86-64</td>
 749 <td>architecture=x86</td>
 750 </tr>
 751 <tr><td><tt class="docutils literal">a</tt></td>
 752 <td>ARM</td>
 753 <td>architecture=arm</td>
 754 </tr>
 755 <tr><td><tt class="docutils literal">i</tt></td>
 756 <td>IA-64</td>
 757 <td>architecture=ia64</td>
 758 </tr>
 759 <tr><td><tt class="docutils literal">s</tt></td>
 760 <td>Sparc</td>
 761 <td>architecture=sparc</td>
 762 </tr>
 763 <tr><td><tt class="docutils literal">m</tt></td>
 764 <td>MIPS/SGI</td>
 765 <td>architecture=mips*</td>
 766 </tr>
 767 <tr><td><tt class="docutils literal">p</tt></td>
 768 <td>RS/6000 &amp; PowerPC</td>
 769 <td>architecture=power</td>
 770 </tr>
 771 </tbody>
 772 </table>
 773 </blockquote>
 774 <p>The two digits following the letter encode the address model as follows:</p>
 775 <blockquote class="last">
 776 <table border="1" class="docutils">
 777 <colgroup>
 778 <col width="13%" />
 779 <col width="40%" />
 780 <col width="47%" />
 781 </colgroup>
 782 <thead valign="bottom">
 783 <tr><th class="head">Key</th>
 784 <th class="head">Address model</th>
 785 <th class="head">Boost.Build option</th>
 786 </tr>
 787 </thead>
 788 <tbody valign="top">
 789 <tr><td><tt class="docutils literal">32</tt></td>
 790 <td>32 bit</td>
 791 <td>address-model=32</td>
 792 </tr>
 793 <tr><td><tt class="docutils literal">64</tt></td>
 794 <td>64 bit</td>
 795 <td>address-model=64</td>
 796 </tr>
 797 </tbody>
 798 </table>
 799 </blockquote>
 800 </dd>
 801 <dt><tt class="docutils literal"><span class="pre">-1_34</span></tt></dt>
 802 <dd><em>Version tag</em>: the full Boost release number, with periods
 803 replaced by underscores. For example, version 1.31.1 would be
 804 tagged as &quot;-1_31_1&quot;.</dd>
 805 <dt><tt class="docutils literal">.lib</tt></dt>
 806 <dd><em>Extension</em>: determined according to the operating system's usual
 807 convention.  On most unix-style platforms the extensions are
 808 <tt class="docutils literal">.a</tt> and <tt class="docutils literal">.so</tt> for static libraries (archives) and shared
 809 libraries, respectively.  On Windows, <tt class="docutils literal">.dll</tt> indicates a shared
 810 library and <tt class="docutils literal">.lib</tt> indicates a
 811 static or import library.  Where supported by toolsets on unix
 812 variants, a full version extension is added (e.g. &quot;.so.1.34&quot;) and
 813 a symbolic link to the library file, named without the trailing
 814 version number, will also be created.</dd>
 815 </dl>
 816 <!-- .. _Boost.Build toolset names: toolset-name_ -->
 817 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 818 <!-- Software License, Version 1.0. (See accompanying -->
 819 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 820 </div>
 821 <div class="section" id="test-your-program">
 822 <h2><a class="toc-backref" href="#id48">6.4&nbsp;&nbsp;&nbsp;Test Your Program</a></h2>
 823 <p>To test our subject extraction, we'll filter the following text
 824 file.  Copy it out of your browser and save it as <tt class="docutils literal">jayne.txt</tt>:</p>
 825 <pre class="literal-block">
 826 To: George Shmidlap
 827 From: Rita Marlowe
 828 Subject: Will Success Spoil Rock Hunter?
 829 ---
 830 See subject.
 831 </pre>
 832 <p>Now, in a <a class="reference internal" href="#command-prompt">command prompt</a> window, type:</p>
 833 <pre class="literal-block">
 834 <em>path</em>\<em>to</em>\<em>compiled</em>\example &lt; <em>path</em>\<em>to</em>\jayne.txt
 835 </pre>
 836 <p>The program should respond with the email subject, “Will Success
 837 Spoil Rock Hunter?”</p>
 838 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 839 <!-- Software License, Version 1.0. (See accompanying -->
 840 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 841 </div>
 842 </div>
 843 <div class="section" id="conclusion-and-further-resources">
 844 <h1><a class="toc-backref" href="#id49">7&nbsp;&nbsp;&nbsp;Conclusion and Further Resources</a></h1>
 845 <p>This concludes your introduction to Boost and to integrating it
 846 with your programs.  As you start using Boost in earnest, there are
 847 surely a few additional points you'll wish we had covered.  One day
 848 we may have a “Book 2 in the Getting Started series” that addresses
 849 them.  Until then, we suggest you pursue the following resources.
 850 If you can't find what you need, or there's anything we can do to
 851 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'
 852 mailing list</a>.</p>
 853 <ul class="simple">
 854 <li><a class="reference external" href="../../tools/build/index.html">Boost.Build reference manual</a></li>
 855 <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
 856 <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
 857 <li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
 858 </ul>
 859 <div class="admonition-onward admonition">
 860 <p class="first admonition-title">Onward</p>
 861 <blockquote class="epigraph last">
 862 <p>Good luck, and have fun!</p>
 863 <p class="attribution">&mdash;the Boost Developers</p>
 864 </blockquote>
 865 </div>
 866 <hr class="docutils" />
 867 <table class="docutils footnote" frame="void" id="zip" rules="none">
 868 <colgroup><col class="label" /><col /></colgroup>
 869 <tbody valign="top">
 870 <tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend
 871 downloading <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">.7z</tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress
 872 it.  We no longer recommend .zip files for Boost because they are twice
 873 as large as the equivalent .7z files.  We don't recommend using Windows'
 874 built-in decompression as it can be painfully slow for large archives.</td></tr>
 875 </tbody>
 876 </table>
 877 <table class="docutils footnote" frame="void" id="pch" rules="none">
 878 <colgroup><col class="label" /><col /></colgroup>
 879 <tbody valign="top">
 880 <tr><td class="label"><a class="fn-backref" href="#id6">[2]</a></td><td>There's no problem using Boost with precompiled headers;
 881 these instructions merely avoid precompiled headers because it
 882 would require Visual Studio-specific changes to the source code
 883 used in the examples.</td></tr>
 884 </tbody>
 885 </table>
 886 <table class="docutils footnote" frame="void" id="continuation" rules="none">
 887 <colgroup><col class="label" /><col /></colgroup>
 888 <tbody valign="top">
 889 <tr><td class="label"><a class="fn-backref" href="#id15">[3]</a></td><td><p class="first">In this example, the caret character <tt class="docutils literal">^</tt> is a
 890 way of continuing the command on multiple lines, and must be the
 891 <strong>final character</strong> used on the line to be continued (i.e. do
 892 not follow it with spaces).  The command prompt responds with
 893 <tt class="docutils literal">More?</tt> to prompt for more input.  Feel free to omit the
 894 carets and subsequent newlines; we used them so the example
 895 would fit on a page of reasonable width.</p>
 896 <p>The command prompt treats each bit of whitespace in the command
 897 as an argument separator.  That means quotation marks (<tt class="docutils literal">&quot;</tt>)
 898 are required to keep text together whenever a single
 899 command-line argument contains spaces, as in</p>
 900 <pre class="literal-block">
 901 --build-dir=<span class="raw-html"><strong style="background-color:#B4FFB4">"</strong></span>C:\Documents<span class="raw-html"><strong style="color:#B4B4B4; background-color:#B4FFB4">_</strong></span>and<span class="raw-html"><strong style="color:#B4B4B4; background-color:#B4FFB4">_</strong></span>Settings\dave\build-boost<span class="raw-html"><strong style="background-color:#B4FFB4">"</strong></span>
 902 </pre>
 903 <p>Also, for example, you can't add spaces around the <tt class="docutils literal">=</tt> sign as in</p>
 904 <pre class="last literal-block">
 905 --build-dir<span class="raw-html"><strong style="color:#B4B4B4; background-color:#FFB4B4">_</strong></span>=<span class="raw-html"><strong style="color:#B4B4B4; background-color:#FFB4B4">_</strong></span>&quot;C:\Documents and Settings\dave\build-boost&quot;
 906 </pre>
 907 </td></tr>
 908 </tbody>
 909 </table>
 910 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 911 <!-- Software License, Version 1.0. (See accompanying -->
 912 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 913 <table class="docutils footnote" frame="void" id="warnings" rules="none">
 914 <colgroup><col class="label" /><col /></colgroup>
 915 <tbody valign="top">
 916 <tr><td class="label"><a class="fn-backref" href="#id8">[4]</a></td><td>Remember that warnings are specific to each compiler
 917 implementation.  The developer of a given Boost library might
 918 not have access to your compiler.  Also, some warnings are
 919 extremely difficult to eliminate in generic code, to the point
 920 where it's not worth the trouble.  Finally, some compilers don't
 921 have any source code mechanism for suppressing warnings.</td></tr>
 922 </tbody>
 923 </table>
 924 <table class="docutils footnote" frame="void" id="distinct" rules="none">
 925 <colgroup><col class="label" /><col /></colgroup>
 926 <tbody valign="top">
 927 <tr><td class="label"><a class="fn-backref" href="#id23">[5]</a></td><td>This convention distinguishes the static version of
 928 a Boost library from the import library for an
 929 identically-configured Boost DLL, which would otherwise have the
 930 same name.</td></tr>
 931 </tbody>
 932 </table>
 933 <table class="docutils footnote" frame="void" id="debug-abi" rules="none">
 934 <colgroup><col class="label" /><col /></colgroup>
 935 <tbody valign="top">
 936 <tr><td class="label"><a class="fn-backref" href="#id24">[6]</a></td><td>These libraries were compiled without optimization
 937 or inlining, with full debug symbols enabled, and without
 938 <tt class="docutils literal">NDEBUG</tt> <tt class="docutils literal">#define</tt>d.  Although it's true that sometimes
 939 these choices don't affect binary compatibility with other
 940 compiled code, you can't count on that with Boost libraries.</td></tr>
 941 </tbody>
 942 </table>
 943 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 944 <!-- Software License, Version 1.0. (See accompanying -->
 945 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 946 <!-- This file contains all the definitions that need to be updated -->
 947 <!-- for each new release of Boost. -->
 948 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 949 <!-- Software License, Version 1.0. (See accompanying -->
 950 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 951 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 952 <!-- Software License, Version 1.0. (See accompanying -->
 953 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 954 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
 955 <!-- Software License, Version 1.0. (See accompanying -->
 956 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
 957 </div>
 958 </div>
 959 </body>
 960 </html>