| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
- <title>Boost Getting Started on Windows</title>
- <link rel="stylesheet" href="../../rst.css" type="text/css" />
- </head>
- <body>
- <div class="document" id="logo-getting-started-on-windows">
- <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>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <div class="admonition-a-note-to-cygwin-and-mingw-users admonition">
- <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>
- <p class="last">If you plan to use your tools from the Windows command prompt,
- you're in the right place. If you plan to build from the <a class="reference external" href="http://www.cygwin.com">Cygwin</a>
- bash shell, you're actually running on a POSIX platform and
- should follow the instructions for <a class="reference external" href="unix-variants.html">getting started on Unix
- variants</a>. Other command shells, such as <a class="reference external" href="http://mingw.org">MinGW</a>'s MSYS, are
- not supported—they may or may not work.</p>
- </div>
- <div class="contents topic" id="index">
- <p class="topic-title first">Index</p>
- <ul class="auto-toc simple">
- <li><a class="reference internal" href="#get-boost" id="id26">1 Get Boost</a></li>
- <li><a class="reference internal" href="#the-boost-distribution" id="id27">2 The Boost Distribution</a></li>
- <li><a class="reference internal" href="#header-only-libraries" id="id28">3 Header-Only Libraries</a></li>
- <li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id29">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
- <li><a class="reference internal" href="#build-from-the-visual-studio-ide" id="id30">4.1 Build From the Visual Studio IDE</a></li>
- <li><a class="reference internal" href="#or-build-from-the-command-prompt" id="id31">4.2 Or, Build From the Command Prompt</a></li>
- <li><a class="reference internal" href="#errors-and-warnings" id="id32">4.3 Errors and Warnings</a></li>
- </ul>
- </li>
- <li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id33">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
- <li><a class="reference internal" href="#install-visual-studio-binaries" id="id34">5.1 Install Visual Studio Binaries</a></li>
- <li><a class="reference internal" href="#or-build-binaries-from-source" id="id35">5.2 Or, Build Binaries From Source</a><ul class="auto-toc">
- <li><a class="reference internal" href="#get-bjam" id="id36">5.2.1 Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
- <li><a class="reference internal" href="#identify-your-toolset" id="id37">5.2.2 Identify Your Toolset</a></li>
- <li><a class="reference internal" href="#select-a-build-directory" id="id38">5.2.3 Select a Build Directory</a></li>
- <li><a class="reference internal" href="#invoke-bjam" id="id39">5.2.4 Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
- </ul>
- </li>
- <li><a class="reference internal" href="#expected-build-output" id="id40">5.3 Expected Build Output</a></li>
- <li><a class="reference internal" href="#in-case-of-build-errors" id="id41">5.4 In Case of Build Errors</a></li>
- </ul>
- </li>
- <li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id42">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
- <li><a class="reference internal" href="#link-from-within-the-visual-studio-ide" id="id43">6.1 Link From Within the Visual Studio IDE</a></li>
- <li><a class="reference internal" href="#or-link-from-the-command-prompt" id="id44">6.2 Or, Link From the Command Prompt</a></li>
- <li><a class="reference internal" href="#library-naming" id="id45">6.3 Library Naming</a></li>
- <li><a class="reference internal" href="#test-your-program" id="id46">6.4 Test Your Program</a></li>
- </ul>
- </li>
- <li><a class="reference internal" href="#conclusion-and-further-resources" id="id47">7 Conclusion and Further Resources</a></li>
- </ul>
- </div>
- <div class="section" id="get-boost">
- <h1><a class="toc-backref" href="#id26">1 Get Boost</a></h1>
- <p>The easiest way to get a copy of Boost is to use an installer. The
- <a class="reference external" href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html">Boost website version of this Getting Started guide</a> will have
- undated information on installers as they become available, or see
- <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041">Boost downloads</a> or the <a class="reference external" href="http://www.boostpro.com/products/free">installer</a> provided by <a class="reference external" href="http://www.boostpro.com">BoostPro
- Computing</a>. We especially recommend using an installer if you use
- Microsoft Visual Studio, because the installer can download and
- install precompiled library binaries, saving you the trouble of
- building them yourself. To complete this tutorial, you'll need to at
- least install the Static Multithreaded variants of the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a>
- binaries when given the option.</p>
- <p>If you're using an earlier version of Visual Studio or some other
- compiler, or if you prefer to build everything yourself, you can
- download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">.7z</span></tt></a> or <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">.zip</span></tt></a> and unpack it to install a complete Boost
- distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a></p>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- <div class="section" id="the-boost-distribution">
- <h1><a class="toc-backref" href="#id27">2 The Boost Distribution</a></h1>
- <p>This is a sketch of the resulting directory structure:</p>
- <pre class="literal-block">
- <strong>boost_1_39_0</strong><strong>\</strong> .................<em>The “boost root directory”</em>
- <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
- <strong>boost</strong><strong>\</strong> .........................<em>All Boost Header files</em>
- <strong>lib</strong><strong>\</strong> .....................<em>precompiled library binaries</em>
- <strong>libs</strong><strong>\</strong> ............<em>Tests, .cpp</em>s<em>, docs, etc., by library</em>
- <strong>index.html</strong> ........<em>Library documentation starts here</em>
- <strong>algorithm</strong><strong>\</strong>
- <strong>any</strong><strong>\</strong>
- <strong>array</strong><strong>\</strong>
- <em>…more libraries…</em>
- <strong>status</strong><strong>\</strong> .........................<em>Boost-wide test suite</em>
- <strong>tools</strong><strong>\</strong> ...........<em>Utilities, e.g. bjam, quickbook, bcp</em>
- <strong>more</strong><strong>\</strong> ..........................<em>Policy documents, etc.</em>
- <strong>doc</strong><strong>\</strong> ...............<em>A subset of all Boost library docs</em>
- </pre>
- <div class="sidebar">
- <p class="first sidebar-title">Header Organization</p>
- <p class="pre-wrap">The organization of Boost library headers isn't entirely uniform,
- but most libraries follow a few patterns:</p>
- <ul class="pre-wrap last">
- <li><p class="first">Some older libraries and most very small libraries place all
- public headers directly into <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt>.</p>
- </li>
- <li><p class="first">Most libraries' public headers live in a subdirectory of
- <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt>, named after the library. For example, you'll find
- the Python library's <tt class="docutils literal"><span class="pre">def.hpp</span></tt> header in</p>
- <pre class="literal-block">
- <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">python</span></tt><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">def.hpp</span></tt>.
- </pre>
- </li>
- <li><p class="first">Some libraries have an “aggregate header” in <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> that
- <tt class="docutils literal"><span class="pre">#include</span></tt>s all of the library's other headers. For
- example, <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a>'s aggregate header is</p>
- <pre class="literal-block">
- <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">python.hpp</span></tt>.
- </pre>
- </li>
- <li><p class="first">Most libraries place private headers in a subdirectory called
- <tt class="docutils literal"><span class="pre">detail</span></tt><tt class="docutils literal"><span class="pre">\</span></tt>, or <tt class="docutils literal"><span class="pre">aux_</span></tt><tt class="docutils literal"><span class="pre">\</span></tt>. Don't expect to find
- anything you can use in these directories.</p>
- </li>
- </ul>
- </div>
- <p>It's important to note the following:</p>
- <ol class="arabic" id="boost-root-directory">
- <li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt>) is
- sometimes referred to as <tt class="docutils literal"><span class="pre">$BOOST_ROOT</span></tt> in documentation and
- mailing lists .</p>
- </li>
- <li><p class="first">To compile anything in Boost, you need a directory containing
- the <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> subdirectory in your <tt class="docutils literal"><span class="pre">#include</span></tt> path. Specific steps for setting up <tt class="docutils literal"><span class="pre">#include</span></tt>
- paths in Microsoft Visual Studio follow later in this document;
- if you use another IDE, please consult your product's
- documentation for instructions.</p>
- </li>
- <li><p class="first">Since all of Boost's header files have the <tt class="docutils literal"><span class="pre">.hpp</span></tt> extension,
- and live in the <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> subdirectory of the boost root, your
- Boost <tt class="docutils literal"><span class="pre">#include</span></tt> directives will look like:</p>
- <pre class="literal-block">
- #include <boost/<em>whatever</em>.hpp>
- </pre>
- <p>or</p>
- <pre class="literal-block">
- #include "boost/<em>whatever</em>.hpp"
- </pre>
- <p>depending on your preference regarding the use of angle bracket
- includes. Even Windows users can (and, for
- portability reasons, probably should) use forward slashes in
- <tt class="docutils literal"><span class="pre">#include</span></tt> directives; your compiler doesn't care.</p>
- </li>
- <li><p class="first">Don't be distracted by the <tt class="docutils literal"><span class="pre">doc</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> subdirectory; it only
- contains a subset of the Boost documentation. Start with
- <tt class="docutils literal"><span class="pre">libs</span></tt><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">index.html</span></tt> if you're looking for the whole enchilada.</p>
- </li>
- </ol>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- <div class="section" id="header-only-libraries">
- <h1><a class="toc-backref" href="#id28">3 Header-Only Libraries</a></h1>
- <p>The first thing many people want to know is, “how do I build
- Boost?” The good news is that often, there's nothing to build.</p>
- <div class="admonition-nothing-to-build admonition">
- <p class="first admonition-title">Nothing to Build?</p>
- <p class="last">Most Boost libraries are <strong>header-only</strong>: they consist <em>entirely
- of header files</em> containing templates and inline functions, and
- require no separately-compiled library binaries or special
- treatment when linking.</p>
- </div>
- <!-- .. _separate: -->
- <p>The only Boost libraries that <em>must</em> be built separately are:</p>
- <ul class="simple">
- <li><a class="reference external" href="../../libs/filesystem/index.html">Boost.Filesystem</a></li>
- <li><a class="reference external" href="../../libs/iostreams/index.html">Boost.IOStreams</a></li>
- <li><a class="reference external" href="../../libs/program_options/index.html">Boost.ProgramOptions</a></li>
- <li><a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a> (see the <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python build documentation</a>
- before building and installing it)</li>
- <li><a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a></li>
- <li><a class="reference external" href="../../libs/serialization/index.html">Boost.Serialization</a></li>
- <li><a class="reference external" href="../../libs/signals/index.html">Boost.Signals</a></li>
- <li><a class="reference external" href="../../doc/html/thread.html">Boost.Thread</a></li>
- <li><a class="reference external" href="../../libs/wave/index.html">Boost.Wave</a></li>
- </ul>
- <p>A few libraries have optional separately-compiled binaries:</p>
- <ul class="simple">
- <li><a class="reference external" href="../../libs/date_time/index.html">Boost.DateTime</a> has a binary component that is only needed if
- you're using its <tt class="docutils literal"><span class="pre">to_string</span></tt>/<tt class="docutils literal"><span class="pre">from_string</span></tt> or serialization
- features, or if you're targeting Visual C++ 6.x or Borland.</li>
- <li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
- you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
- <li><a class="reference external" href="../../libs/test/index.html">Boost.Test</a> can be used in “header-only” or “separately compiled”
- mode, although <strong>separate compilation is recommended for serious
- use</strong>.</li>
- </ul>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- <div class="section" id="build-a-simple-program-using-boost">
- <h1><a class="toc-backref" href="#id29">4 Build a Simple Program Using Boost</a></h1>
- <p>To keep things simple, let's start by using a header-only library.
- The following program reads a sequence of integers from standard
- input, uses Boost.Lambda to multiply each number by three, and
- writes them to standard output:</p>
- <pre class="literal-block">
- #include <boost/lambda/lambda.hpp>
- #include <iostream>
- #include <iterator>
- #include <algorithm>
- int main()
- {
- using namespace boost::lambda;
- typedef std::istream_iterator<int> in;
- std::for_each(
- in(std::cin), in(), std::cout << (_1 * 3) << " " );
- }
- </pre>
- <p>Copy the text of this program into a file called <tt class="docutils literal"><span class="pre">example.cpp</span></tt>.</p>
- <div class="note" id="command-line-tool">
- <span id="command-prompt"></span><p class="first admonition-title">Note</p>
- <p class="last">To build the examples in this guide, you can use an
- Integrated Development Environment (IDE) like Visual Studio, or
- you can issue commands from the <a class="reference internal" href="#command-prompt">command prompt</a>. Since every
- IDE and compiler has different options and Microsoft's are by
- far the dominant compilers on Windows, we only give specific
- directions here for Visual Studio 2005 and .NET 2003 IDEs and
- their respective command prompt compilers (using the command
- prompt is a bit simpler). If you are using another compiler or
- IDE, it should be relatively easy to adapt these instructions to
- your environment.</p>
- </div>
- <div class="small sidebar">
- <p class="first sidebar-title">Command Prompt Basics</p>
- <p>In Windows, a command-line tool is invoked by typing its name,
- optionally followed by arguments, into a <em>Command Prompt</em> window
- and pressing the Return (or Enter) key.</p>
- <p>To open a generic <em>Command Prompt</em>, click the <em>Start</em> menu
- button, click <em>Run</em>, type “cmd”, and then click <em>OK</em>.</p>
- <p id="current-directory">All commands are executed within the context of a <strong>current
- directory</strong> in the filesystem. To set the current directory,
- type:</p>
- <pre class="literal-block">
- cd <em>path</em>\<em>to</em>\<em>some</em>\<em>directory</em>
- </pre>
- <p>followed by Return. For example,</p>
- <pre class="literal-block">
- cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt>
- </pre>
- <p class="last">Long commands can be continued across several lines by typing a
- caret (<tt class="docutils literal"><span class="pre">^</span></tt>) at the end of all but the last line. Some examples
- on this page use that technique to save horizontal space.</p>
- </div>
- <div class="section" id="build-from-the-visual-studio-ide">
- <span id="vs-header-only"></span><h2><a class="toc-backref" href="#id30">4.1 Build From the Visual Studio IDE</a></h2>
- <ul>
- <li><p class="first">From Visual Studio's <em>File</em> menu, select <em>New</em> > <em>Project…</em></p>
- </li>
- <li><p class="first">In the left-hand pane of the resulting <em>New Project</em> dialog,
- select <em>Visual C++</em> > <em>Win32</em>.</p>
- </li>
- <li><p class="first">In the right-hand pane, select <em>Win32 Console Application</em>
- (VS8.0) or <em>Win32 Console Project</em> (VS7.1).</p>
- </li>
- <li><p class="first">In the <em>name</em> field, enter “example”</p>
- </li>
- <li><p class="first">Right-click <strong>example</strong> in the <em>Solution Explorer</em> pane and
- select <em>Properties</em> from the resulting pop-up menu</p>
- </li>
- <li><p class="first">In <em>Configuration Properties</em> > <em>C/C++</em> > <em>General</em> > <em>Additional Include
- Directories</em>, enter the path to the Boost root directory, for example</p>
- <blockquote>
- <p><tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt></p>
- </blockquote>
- </li>
- <li><p class="first">In <em>Configuration Properties</em> > <em>C/C++</em> > <em>Precompiled Headers</em>, change
- <em>Use Precompiled Header (/Yu)</em> to <em>Not Using Precompiled
- Headers</em>.<a class="footnote-reference" href="#pch" id="id5"><sup>3</sup></a></p>
- </li>
- <li><p class="first">Replace the contents of the <tt class="docutils literal"><span class="pre">example.cpp</span></tt> generated by the IDE
- with the example code above.</p>
- </li>
- <li><p class="first">From the <em>Build</em> menu, select <em>Build Solution</em>.</p>
- </li>
- </ul>
- <p>To test your application, hit the F5 key and type the following
- into the resulting window, followed by the Return key:</p>
- <pre class="literal-block">
- 1 2 3
- </pre>
- <p>Then hold down the control key and press "Z", followed by the
- Return key.</p>
- <p><a class="reference internal" href="#errors-and-warnings"><em>skip to the next step</em></a></p>
- </div>
- <div class="section" id="or-build-from-the-command-prompt">
- <h2><a class="toc-backref" href="#id31">4.2 Or, Build From the Command Prompt</a></h2>
- <p>From your computer's <em>Start</em> menu, if you are a Visual
- Studio 2005 user, select</p>
- <blockquote>
- <em>All Programs</em> > <em>Microsoft Visual Studio 2005</em>
- > <em>Visual Studio Tools</em> > <em>Visual Studio 2005 Command Prompt</em></blockquote>
- <p>or, if you're a Visual Studio .NET 2003 user, select</p>
- <blockquote>
- <em>All Programs</em> > <em>Microsoft Visual Studio .NET 2003</em>
- > <em>Visual Studio .NET Tools</em> > <em>Visual Studio .NET 2003 Command Prompt</em></blockquote>
- <p>to bring up a special <a class="reference internal" href="#command-prompt">command prompt</a> window set up for the
- Visual Studio compiler. In that window, set the <a class="reference internal" href="#current-directory">current
- directory</a> to a suitable location for creating some temporary
- files and type the following command followed by the Return key:</p>
- <pre class="literal-block">
- cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt> <em>path</em>\<em>to</em>\example.cpp
- </pre>
- <p>To test the result, type:</p>
- <pre class="literal-block">
- echo 1 2 3 | example
- </pre>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- <div class="section" id="errors-and-warnings">
- <h2><a class="toc-backref" href="#id32">4.3 Errors and Warnings</a></h2>
- <p>Don't be alarmed if you see compiler warnings originating in Boost
- headers. We try to eliminate them, but doing so isn't always
- practical.<a class="footnote-reference" href="#warnings" id="id7"><sup>5</sup></a> <strong>Errors are another matter</strong>. If you're
- seeing compilation errors at this point in the tutorial, check to
- 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
- correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- </div>
- <div class="section" id="prepare-to-use-a-boost-library-binary">
- <h1><a class="toc-backref" href="#id33">5 Prepare to Use a Boost Library Binary</a></h1>
- <p>If you want to use any of the separately-compiled Boost libraries,
- you'll need to acquire library binaries.</p>
- <div class="section" id="install-visual-studio-binaries">
- <h2><a class="toc-backref" href="#id34">5.1 Install Visual Studio Binaries</a></h2>
- <p>The installers supplied by BoostPro Computing will download and
- install pre-compiled binaries into the <tt class="docutils literal"><span class="pre">lib\</span></tt> subdirectory of the
- boost root, typically <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></tt>. If you installed
- all variants of the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> binary, you're done with this
- step. Otherwise, please run the installer again and install them
- now.</p>
- <p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
- </div>
- <div class="section" id="or-build-binaries-from-source">
- <h2><a class="toc-backref" href="#id35">5.2 Or, Build Binaries From Source</a></h2>
- <p>If you're using an earlier version of Visual C++, or a compiler
- from another vendor, you'll need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create your
- own binaries.</p>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
- installing software. To use it, you'll need an executable called
- <tt class="docutils literal"><span class="pre">bjam</span></tt>.</p>
- <!-- .. _Boost.Jam documentation: Boost.Jam_ -->
- <div class="section" id="get-bjam">
- <h3><a class="toc-backref" href="#id36">5.2.1 Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
- <p><tt class="docutils literal"><span class="pre">bjam</span></tt> is the <a class="reference internal" href="#command-line-tool">command-line tool</a> that drives the Boost Build
- system. To build Boost binaries, you'll invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> from the
- Boost root.</p>
- <p>We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">download a pre-built <tt class="docutils literal"><span class="pre">bjam</span></tt> executable</a> for your platform.
- Alternatively, you can build <tt class="docutils literal"><span class="pre">bjam</span></tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
- instructions</a>.</p>
- <p>Move the <tt class="docutils literal"><span class="pre">bjam</span></tt> executable into a directory in your PATH. You can
- see the list of directories in your PATH, separated by semicolons,
- by typing “<tt class="docutils literal"><span class="pre">PATH</span></tt>” at the command prompt.</p>
- </div>
- <div class="section" id="identify-your-toolset">
- <span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id37">5.2.2 Identify Your Toolset</a></h3>
- <p>First, find the toolset corresponding to your compiler in the
- following table.</p>
- <div class="note">
- <p class="first admonition-title">Note</p>
- <p class="last">If you previously chose a toolset for the purposes of
- <a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
- choose newly from the table below.</p>
- </div>
- <table border="1" class="docutils">
- <colgroup>
- <col width="18%" />
- <col width="33%" />
- <col width="48%" />
- </colgroup>
- <thead valign="bottom">
- <tr><th class="head">Toolset
- Name</th>
- <th class="head">Vendor</th>
- <th class="head">Notes</th>
- </tr>
- </thead>
- <tbody valign="top">
- <tr><td><tt class="docutils literal"><span class="pre">acc</span></tt></td>
- <td>Hewlett Packard</td>
- <td>Only very recent versions are
- known to work well with Boost</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">borland</span></tt></td>
- <td>Borland</td>
- <td> </td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">como</span></tt></td>
- <td>Comeau Computing</td>
- <td>Using this toolset may
- require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
- toolset to act as its backend</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">cw</span></tt></td>
- <td>Metrowerks/FreeScale</td>
- <td>The CodeWarrior compiler. We
- have not tested versions of
- this compiler produced since
- it was sold to FreeScale.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">dmc</span></tt></td>
- <td>Digital Mars</td>
- <td>As of this Boost release, no
- version of dmc is known to
- handle Boost well.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">darwin</span></tt></td>
- <td>Apple Computer</td>
- <td>Apple's version of the GCC
- toolchain with support for
- Darwin and MacOS X features
- such as frameworks.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">gcc</span></tt></td>
- <td>The Gnu Project</td>
- <td>Includes support for Cygwin
- and MinGW compilers.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">hp_cxx</span></tt></td>
- <td>Hewlett Packard</td>
- <td>Targeted at the Tru64
- operating system.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">intel</span></tt></td>
- <td>Intel</td>
- <td> </td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">kylix</span></tt></td>
- <td>Borland</td>
- <td> </td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">msvc</span></tt></td>
- <td>Microsoft</td>
- <td> </td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">qcc</span></tt></td>
- <td>QNX Software Systems</td>
- <td> </td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">sun</span></tt></td>
- <td>Sun</td>
- <td>Only very recent versions are
- known to work well with
- Boost.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">vacpp</span></tt></td>
- <td>IBM</td>
- <td>The VisualAge C++ compiler.</td>
- </tr>
- </tbody>
- </table>
- <p>If you have multiple versions of a particular compiler installed,
- you can append the version number to the toolset name, preceded by
- a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></tt> or
- <tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <strong>On Windows, append a version
- number even if you only have one version installed</strong> (unless you
- are using the msvc or gcc toolsets, which have special version
- detection code) or <a class="reference internal" href="#auto-linking">auto-linking</a> will fail.</p>
- </div>
- <div class="section" id="select-a-build-directory">
- <span id="id12"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id38">5.2.3 Select a Build Directory</a></h3>
- <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
- building into the <strong>build directory</strong>. If your Boost root
- directory is writable, this step isn't strictly necessary: by
- default Boost.Build will create a <tt class="docutils literal"><span class="pre">bin.v2/</span></tt> subdirectory for that
- purpose in your current working directory.</p>
- </div>
- <div class="section" id="invoke-bjam">
- <h3><a class="toc-backref" href="#id39">5.2.4 Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
- <p>Change your current directory to the Boost root directory and
- invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> as follows:</p>
- <pre class="literal-block">
- bjam <strong>--build-dir=</strong><a class="reference internal" href="#id12"><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
- </pre>
- <p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id13"><sup>4</sup></a></p>
- <pre class="literal-block">
- C:\WINDOWS> cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt>
- <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt>> bjam <strong>^</strong>
- More? <strong>--build-dir=</strong>"C:\Documents and Settings\dave\build-boost" <strong>^</strong>
- More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage
- </pre>
- <p>Be sure to read <a class="reference internal" href="#continuation">this note</a> about the appearance of <tt class="docutils literal"><span class="pre">^</span></tt>,
- <tt class="docutils literal"><span class="pre">More?</span></tt> and quotation marks (<tt class="docutils literal"><span class="pre">"</span></tt>) in that line.</p>
- <p>The option “<strong>--build-type=complete</strong>” causes <tt class="docutils literal"><span class="pre">bjam</span></tt> to build
- all supported variants of the libraries. For instructions on how to
- build only specific variants, please ask on the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing
- list</a>.</p>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <p>Building the special <tt class="docutils literal"><span class="pre">stage</span></tt> target places Boost
- library binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> subdirectory of your <a class="reference internal" href="#build-directory">build
- directory</a>.</p>
- <div class="note">
- <p class="first admonition-title">Note</p>
- <p class="last"><tt class="docutils literal"><span class="pre">bjam</span></tt> is case-sensitive; it is important that all the
- parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
- </div>
- <p>For a description of other options you can pass when invoking
- <tt class="docutils literal"><span class="pre">bjam</span></tt>, type:</p>
- <pre class="literal-block">
- bjam --help
- </pre>
- <p>In particular, to limit the amount of time spent building, you may
- be interested in:</p>
- <ul class="simple">
- <li>reviewing the list of library names with <tt class="docutils literal"><span class="pre">--show-libraries</span></tt></li>
- <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>
- <li>choosing a specific build variant by adding <tt class="docutils literal"><span class="pre">release</span></tt> or
- <tt class="docutils literal"><span class="pre">debug</span></tt> to the command line.</li>
- </ul>
- <div class="note">
- <p class="first admonition-title">Note</p>
- <p class="last">Boost.Build can produce a great deal of output, which can
- make it easy to miss problems. If you want to make sure
- everything is went well, you might redirect the output into a
- file by appending “<tt class="docutils literal"><span class="pre">>build.log</span> <span class="pre">2>&1</span></tt>” to your command line.</p>
- </div>
- </div>
- </div>
- <div class="section" id="expected-build-output">
- <h2><a class="toc-backref" href="#id40">5.3 Expected Build Output</a></h2>
- <p>During the process of building Boost libraries, you can expect to
- see some messages printed on the console. These may include</p>
- <ul>
- <li><p class="first">Notices about Boost library configuration—for example, the Regex
- library outputs a message about ICU when built without Unicode
- support, and the Python library may be skipped without error (but
- with a notice) if you don't have Python installed.</p>
- </li>
- <li><p class="first">Messages from the build tool that report the number of targets
- that were built or skipped. Don't be surprised if those numbers
- don't make any sense to you; there are many targets per library.</p>
- </li>
- <li><p class="first">Build action messages describing what the tool is doing, which
- look something like:</p>
- <pre class="literal-block">
- <em>toolset-name</em>.c++ <em>long</em>/<em>path</em>/<em>to</em>/<em>file</em>/<em>being</em>/<em>built</em>
- </pre>
- </li>
- <li><p class="first">Compiler warnings.</p>
- </li>
- </ul>
- </div>
- <div class="section" id="in-case-of-build-errors">
- <h2><a class="toc-backref" href="#id41">5.4 In Case of Build Errors</a></h2>
- <p>The only error messages you see when building Boost—if any—should
- be related to the IOStreams library's support of zip and bzip2
- formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>. Install the relevant development
- packages for libz and libbz2 if you need those features. Other
- errors when building Boost libraries are cause for concern.</p>
- <p>If it seems like the build system can't find your compiler and/or
- linker, consider setting up a <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file as described
- in the <a class="reference external" href="../../tools/build/index.html">Boost.Build documentation</a>. If that isn't your problem or
- the <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file doesn't work for you, please address
- questions about configuring Boost 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>
- <span class="target" id="auto-linking"></span><!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- </div>
- <div class="section" id="link-your-program-to-a-boost-library">
- <h1><a class="toc-backref" href="#id42">6 Link Your Program to a Boost Library</a></h1>
- <p>To demonstrate linking with a Boost binary library, we'll use the
- following simple program that extracts the subject lines from
- emails. It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
- separately-compiled binary component.</p>
- <pre class="literal-block">
- #include <boost/regex.hpp>
- #include <iostream>
- #include <string>
- int main()
- {
- std::string line;
- boost::regex pat( "^Subject: (Re: |Aw: )*(.*)" );
- while (std::cin)
- {
- std::getline(std::cin, line);
- boost::smatch matches;
- if (boost::regex_match(line, matches, pat))
- std::cout << matches[2] << std::endl;
- }
- }
- </pre>
- <p>There are two main challenges associated with linking:</p>
- <ol class="arabic simple">
- <li>Tool configuration, e.g. choosing command-line options or IDE
- build settings.</li>
- <li>Identifying the library binary, among all the build variants,
- whose compile configuration is compatible with the rest of your
- project.</li>
- </ol>
- <div class="admonition-auto-linking admonition">
- <p class="first admonition-title">Auto-Linking</p>
- <p>Most Windows compilers and linkers have so-called “auto-linking
- support,” which eliminates the second challenge. Special code in
- Boost header files detects your compiler options and uses that
- information to encode the name of the correct library into your
- object files; the linker selects the library with that name from
- the directories you've told it to search.</p>
- <p class="last">The GCC toolchains (Cygwin and MinGW) are notable exceptions;
- 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
- variant OSes</a> for the appropriate command-line options to use.</p>
- </div>
- <div class="section" id="link-from-within-the-visual-studio-ide">
- <h2><a class="toc-backref" href="#id43">6.1 Link From Within the Visual Studio IDE</a></h2>
- <p>Starting with the <a class="reference internal" href="#vs-header-only">header-only example project</a> we created
- earlier:</p>
- <ol class="arabic simple">
- <li>Right-click <strong>example</strong> in the <em>Solution Explorer</em> pane and
- select <em>Properties</em> from the resulting pop-up menu</li>
- <li>In <em>Configuration Properties</em> > <em>Linker</em> > <em>Additional Library
- Directories</em>, enter the path to the Boost binaries,
- e.g. <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></tt>.</li>
- <li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li>
- </ol>
- <p><a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a></p>
- </div>
- <div class="section" id="or-link-from-the-command-prompt">
- <h2><a class="toc-backref" href="#id44">6.2 Or, Link From the Command Prompt</a></h2>
- <p>For example, we can compile and link the above program from the
- Visual C++ command-line by simply adding the <strong>bold</strong> text below to
- the command line we used earlier, assuming your Boost binaries are
- in <tt class="docutils literal"><span class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">\lib</span></tt>:</p>
- <pre class="literal-block">
- cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt> example.cpp <strong>^</strong>
- <strong>/link /LIBPATH:</strong> <strong>C:\Program Files\boost\</strong><strong>boost_1_39_0</strong><strong>\lib</strong>
- </pre>
- </div>
- <div class="section" id="library-naming">
- <h2><a class="toc-backref" href="#id45">6.3 Library Naming</a></h2>
- <div class="note">
- <p class="first admonition-title">Note</p>
- <p>If, like Visual C++, your compiler supports auto-linking,
- you can probably <a class="reference internal" href="#test-your-program"><em>skip to the next step</em></a>.</p>
- <blockquote class="last">
- </blockquote>
- </div>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <p>In order to choose the right binary for your build configuration
- you need to know how Boost binaries are named. Each library
- filename is composed of a common sequence of elements that describe
- how it was built. For example,
- <tt class="docutils literal"><span class="pre">libboost_regex-vc71-mt-d-1_34.lib</span></tt> can be broken down into the
- following elements:</p>
- <dl class="docutils">
- <dt><tt class="docutils literal"><span class="pre">lib</span></tt></dt>
- <dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
- name begins with this string. On Windows, only ordinary static
- libraries use the <tt class="docutils literal"><span class="pre">lib</span></tt> prefix; import libraries and DLLs do
- not.<a class="footnote-reference" href="#distinct" id="id20"><sup>6</sup></a></dd>
- <dt><tt class="docutils literal"><span class="pre">boost_regex</span></tt></dt>
- <dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal"><span class="pre">boost_</span></tt>.</dd>
- <dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
- <dd><em>Toolset tag</em>: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
- the binary.</dd>
- <dt><tt class="docutils literal"><span class="pre">-mt</span></tt></dt>
- <dd><em>Threading tag</em>: indicates that the library was
- built with multithreading support enabled. Libraries built
- without multithreading support can be identified by the absence
- of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
- <dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
- <dd><p class="first"><em>ABI tag</em>: encodes details that affect the library's
- interoperability with other compiled code. For each such
- feature, a single letter is added to the tag:</p>
- <blockquote>
- <table border="1" class="docutils">
- <colgroup>
- <col width="6%" />
- <col width="94%" />
- </colgroup>
- <thead valign="bottom">
- <tr><th class="head">Key</th>
- <th class="head">Use this library when:</th>
- </tr>
- </thead>
- <tbody valign="top">
- <tr><td><tt class="docutils literal"><span class="pre">s</span></tt></td>
- <td>linking statically to the C++ standard library and compiler runtime support
- libraries.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">g</span></tt></td>
- <td>using debug versions of the standard and runtime support libraries.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">y</span></tt></td>
- <td>using a special <a class="reference external" href="../../libs/python/doc/building.html#variants">debug build of Python</a>.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">d</span></tt></td>
- <td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id21"><sup>7</sup></a></td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">p</span></tt></td>
- <td>using the STLPort standard library rather than the default one supplied with
- your compiler.</td>
- </tr>
- <tr><td><tt class="docutils literal"><span class="pre">n</span></tt></td>
- <td>using STLPort's deprecated “native iostreams” feature.<a class="footnote-reference" href="#native" id="id22"><sup>8</sup></a></td>
- </tr>
- </tbody>
- </table>
- </blockquote>
- <p class="last">For example, if you build a debug version of your code for use
- with debug versions of the static runtime library and the
- STLPort standard library in “native iostreams” mode,
- the tag would be: <tt class="docutils literal"><span class="pre">-sgdpn</span></tt>. If none of the above apply, the
- ABI tag is ommitted.</p>
- </dd>
- <dt><tt class="docutils literal"><span class="pre">-1_34</span></tt></dt>
- <dd><em>Version tag</em>: the full Boost release number, with periods
- replaced by underscores. For example, version 1.31.1 would be
- tagged as "-1_31_1".</dd>
- <dt><tt class="docutils literal"><span class="pre">.lib</span></tt></dt>
- <dd><em>Extension</em>: determined according to the operating system's usual
- convention. On most unix-style platforms the extensions are
- <tt class="docutils literal"><span class="pre">.a</span></tt> and <tt class="docutils literal"><span class="pre">.so</span></tt> for static libraries (archives) and shared
- libraries, respectively. On Windows, <tt class="docutils literal"><span class="pre">.dll</span></tt> indicates a shared
- library and <tt class="docutils literal"><span class="pre">.lib</span></tt> indicates a
- static or import library. Where supported by toolsets on unix
- variants, a full version extension is added (e.g. ".so.1.34") and
- a symbolic link to the library file, named without the trailing
- version number, will also be created.</dd>
- </dl>
- <!-- .. _Boost.Build toolset names: toolset-name_ -->
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- <div class="section" id="test-your-program">
- <h2><a class="toc-backref" href="#id46">6.4 Test Your Program</a></h2>
- <p>To test our subject extraction, we'll filter the following text
- file. Copy it out of your browser and save it as <tt class="docutils literal"><span class="pre">jayne.txt</span></tt>:</p>
- <pre class="literal-block">
- To: George Shmidlap
- From: Rita Marlowe
- Subject: Will Success Spoil Rock Hunter?
- ---
- See subject.
- </pre>
- <p>Now, in a <a class="reference internal" href="#command-prompt">command prompt</a> window, type:</p>
- <pre class="literal-block">
- <em>path</em>\<em>to</em>\<em>compiled</em>\example < <em>path</em>\<em>to</em>\jayne.txt
- </pre>
- <p>The program should respond with the email subject, “Will Success
- Spoil Rock Hunter?”</p>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- </div>
- <div class="section" id="conclusion-and-further-resources">
- <h1><a class="toc-backref" href="#id47">7 Conclusion and Further Resources</a></h1>
- <p>This concludes your introduction to Boost and to integrating it
- with your programs. As you start using Boost in earnest, there are
- surely a few additional points you'll wish we had covered. One day
- we may have a “Book 2 in the Getting Started series” that addresses
- them. Until then, we suggest you pursue the following resources.
- If you can't find what you need, or there's anything we can do to
- 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'
- mailing list</a>.</p>
- <ul class="simple">
- <li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
- <li><a class="reference external" href="../../tools/jam/index.html">Boost.Jam reference manual</a></li>
- <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
- <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
- <li><a class="reference external" href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2">Boost.Build Wiki</a></li>
- <li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
- </ul>
- <div class="admonition-onward admonition">
- <p class="first admonition-title">Onward</p>
- <blockquote class="epigraph last">
- <p>Good luck, and have fun!</p>
- <p class="attribution">—the Boost Developers</p>
- </blockquote>
- </div>
- <hr class="docutils" />
- <table class="docutils footnote" frame="void" id="zip" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We recommend
- downloading <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_39_0</span></tt><tt class="docutils literal"><span class="pre">.7z</span></tt></a> and using <a class="reference external" href="http://www.7-zip.org">7-Zip</a> to decompress
- it. We no longer recommend .zip files for Boost because they are twice
- as large as the equivalent .7z files. We don't recommend using Windows'
- built-in decompression as it can be painfully slow for large archives.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="installer-src" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label">[2]</td><td>If you used the <a class="reference external" href="http://www.boostpro.com/products/free">installer</a> from Boost
- Consulting and deselected “Source and Documentation” (it's
- selected by default), you won't see the <tt class="docutils literal"><span class="pre">libs/</span></tt> subdirectory.
- That won't affect your ability to use precompiled binaries, but
- you won't be able to rebuild libraries from scratch.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="pch" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id5">[3]</a></td><td>There's no problem using Boost with precompiled headers;
- these instructions merely avoid precompiled headers because it
- would require Visual Studio-specific changes to the source code
- used in the examples.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="continuation" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id13">[4]</a></td><td><p class="first">In this example, the caret character <tt class="docutils literal"><span class="pre">^</span></tt> is a
- way of continuing the command on multiple lines, and must be the
- <strong>final character</strong> used on the line to be continued (i.e. do
- not follow it with spaces). The command prompt responds with
- <tt class="docutils literal"><span class="pre">More?</span></tt> to prompt for more input. Feel free to omit the
- carets and subsequent newlines; we used them so the example
- would fit on a page of reasonable width.</p>
- <p>The command prompt treats each bit of whitespace in the command
- as an argument separator. That means quotation marks (<tt class="docutils literal"><span class="pre">"</span></tt>)
- are required to keep text together whenever a single
- command-line argument contains spaces, as in</p>
- <pre class="literal-block">
- --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>
- </pre>
- <p>Also, for example, you can't add spaces around the <tt class="docutils literal"><span class="pre">=</span></tt> sign as in</p>
- <pre class="last literal-block">
- --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>"C:\Documents and Settings\dave\build-boost"
- </pre>
- </td></tr>
- </tbody>
- </table>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <table class="docutils footnote" frame="void" id="warnings" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id7">[5]</a></td><td>Remember that warnings are specific to each compiler
- implementation. The developer of a given Boost library might
- not have access to your compiler. Also, some warnings are
- extremely difficult to eliminate in generic code, to the point
- where it's not worth the trouble. Finally, some compilers don't
- have any source code mechanism for suppressing warnings.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="distinct" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id20">[6]</a></td><td>This convention distinguishes the static version of
- a Boost library from the import library for an
- identically-configured Boost DLL, which would otherwise have the
- same name.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="debug-abi" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id21">[7]</a></td><td>These libraries were compiled without optimization
- or inlining, with full debug symbols enabled, and without
- <tt class="docutils literal"><span class="pre">NDEBUG</span></tt> <tt class="docutils literal"><span class="pre">#define</span></tt>d. Although it's true that sometimes
- these choices don't affect binary compatibility with other
- compiled code, you can't count on that with Boost libraries.</td></tr>
- </tbody>
- </table>
- <table class="docutils footnote" frame="void" id="native" rules="none">
- <colgroup><col class="label" /><col /></colgroup>
- <tbody valign="top">
- <tr><td class="label"><a class="fn-backref" href="#id22">[8]</a></td><td>This feature of STLPort is deprecated because it's
- impossible to make it work transparently to the user; we don't
- recommend it.</td></tr>
- </tbody>
- </table>
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <!-- This file contains all the definitions that need to be updated -->
- <!-- for each new release of Boost. -->
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
- <!-- Software License, Version 1.0. (See accompanying -->
- <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
- </div>
- </div>
- </body>
- </html>
|