|
|
@@ -0,0 +1,870 @@
|
|
|
+<?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.5: 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" 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" href="http://www.cygwin.com">Cygwin</a> and <a class="reference" 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" 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" href="unix-variants.html">getting started on Unix
|
|
|
+variants</a>. Other command shells, such as <a class="reference" href="http://mingw.org">MinGW</a>'s MSYS, are
|
|
|
+not supported—they may or may not work.</p>
|
|
|
+</div>
|
|
|
+<div class="contents topic">
|
|
|
+<p class="topic-title first"><a id="index" name="index">Index</a></p>
|
|
|
+<ul class="auto-toc simple">
|
|
|
+<li><a class="reference" href="#get-boost" id="id21" name="id21">1 Get Boost</a></li>
|
|
|
+<li><a class="reference" href="#the-boost-distribution" id="id22" name="id22">2 The Boost Distribution</a></li>
|
|
|
+<li><a class="reference" href="#header-only-libraries" id="id23" name="id23">3 Header-Only Libraries</a></li>
|
|
|
+<li><a class="reference" href="#build-a-simple-program-using-boost" id="id24" name="id24">4 Build a Simple Program Using Boost</a><ul class="auto-toc">
|
|
|
+<li><a class="reference" href="#build-from-the-visual-studio-ide" id="id25" name="id25">4.1 Build From the Visual Studio IDE</a></li>
|
|
|
+<li><a class="reference" href="#or-build-from-the-command-prompt" id="id26" name="id26">4.2 Or, Build From the Command Prompt</a></li>
|
|
|
+<li><a class="reference" href="#errors-and-warnings" id="id27" name="id27">4.3 Errors and Warnings</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li><a class="reference" href="#prepare-to-use-a-boost-library-binary" id="id28" name="id28">5 Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
|
|
|
+<li><a class="reference" href="#install-visual-studio-2005-or-net-2003-binaries" id="id29" name="id29">5.1 Install Visual Studio (2005 or .NET 2003) Binaries</a></li>
|
|
|
+<li><a class="reference" href="#or-build-and-install-binaries-from-source" id="id30" name="id30">5.2 Or, Build and Install Binaries From Source</a><ul class="auto-toc">
|
|
|
+<li><a class="reference" href="#get-bjam" id="id31" name="id31">5.2.1 Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
|
|
|
+<li><a class="reference" href="#identify-your-toolset" id="id32" name="id32">5.2.2 Identify Your Toolset</a></li>
|
|
|
+<li><a class="reference" href="#select-a-build-directory" id="id33" name="id33">5.2.3 Select a Build Directory</a></li>
|
|
|
+<li><a class="reference" href="#invoke-bjam" id="id34" name="id34">5.2.4 Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li><a class="reference" href="#expected-build-output" id="id35" name="id35">5.3 Expected Build Output</a></li>
|
|
|
+<li><a class="reference" href="#in-case-of-build-errors" id="id36" name="id36">5.4 In Case of Build Errors</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li><a class="reference" href="#link-your-program-to-a-boost-library" id="id37" name="id37">6 Link Your Program to a Boost Library</a><ul class="auto-toc">
|
|
|
+<li><a class="reference" href="#link-from-within-the-visual-studio-ide" id="id38" name="id38">6.1 Link From Within the Visual Studio IDE</a></li>
|
|
|
+<li><a class="reference" href="#or-link-from-the-command-prompt" id="id39" name="id39">6.2 Or, Link From the Command Prompt</a></li>
|
|
|
+<li><a class="reference" href="#library-naming" id="id40" name="id40">6.3 Library Naming</a></li>
|
|
|
+<li><a class="reference" href="#test-your-program" id="id41" name="id41">6.4 Test Your Program</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li><a class="reference" href="#conclusion-and-further-resources" id="id42" name="id42">7 Conclusion and Further Resources</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h1><a class="toc-backref" href="#id21" id="get-boost" name="get-boost">1 Get Boost</a></h1>
|
|
|
+<p>The easiest way to get a copy of Boost is to use the <a class="reference" href="http://www.boost-consulting.com/download/windows">installer</a>
|
|
|
+provided by <a class="reference" href="http://www.boost-consulting.com">Boost Consulting</a>. We especially recommend this
|
|
|
+method if you use Microsoft Visual Studio .NET 2003 or Microsoft
|
|
|
+Visual Studio 2005, 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 <a class="reference" 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" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=376197"><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt><tt class="docutils literal"><span class="pre">.exe</span></tt></a> and run it to install a complete Boost
|
|
|
+distribution.<a class="footnote-reference" href="#zip" id="id2" name="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">
|
|
|
+<h1><a class="toc-backref" href="#id22" id="the-boost-distribution" name="the-boost-distribution">2 The Boost Distribution</a></h1>
|
|
|
+<p>This is a sketch of the resulting directory structure:</p>
|
|
|
+<pre class="literal-block">
|
|
|
+<strong>boost_1_34_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" 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_34_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">
|
|
|
+<h1><a class="toc-backref" href="#id23" id="header-only-libraries" name="header-only-libraries">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>
|
|
|
+<p id="separate">The only Boost libraries that <em>must</em> be built separately are:</p>
|
|
|
+<ul class="simple">
|
|
|
+<li><a class="reference" href="../../libs/filesystem/index.html">Boost.Filesystem</a></li>
|
|
|
+<li><a class="reference" href="../../libs/iostreams/index.html">Boost.IOStreams</a></li>
|
|
|
+<li><a class="reference" href="../../libs/program_options/index.html">Boost.ProgramOptions</a></li>
|
|
|
+<li><a class="reference" href="../../libs/python/doc/building.html">Boost.Python</a></li>
|
|
|
+<li><a class="reference" href="../../libs/regex/index.html">Boost.Regex</a></li>
|
|
|
+<li><a class="reference" href="../../libs/serialization/index.html">Boost.Serialization</a></li>
|
|
|
+<li><a class="reference" href="../../libs/signals/index.html">Boost.Signals</a></li>
|
|
|
+<li><a class="reference" href="../../libs/thread/index.html">Boost.Thread</a></li>
|
|
|
+<li><a class="reference" 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" 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" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
|
|
|
+you intend to <a class="reference" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
|
|
|
+<li><a class="reference" 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">
|
|
|
+<h1><a class="toc-backref" href="#id24" id="build-a-simple-program-using-boost" name="build-a-simple-program-using-boost">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">
|
|
|
+<p class="first admonition-title"><a id="command-line-tool" name="command-line-tool"><span id="command-prompt"></span>Note</a></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" 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_34_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">
|
|
|
+<h2><a class="toc-backref" href="#id25" id="build-from-the-visual-studio-ide" name="build-from-the-visual-studio-ide"><span id="vs-header-only"></span>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_34_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="id4" name="id4"><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" href="#errors-and-warnings"><em>skip to the next step</em></a></p>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id26" id="or-build-from-the-command-prompt" name="or-build-from-the-command-prompt">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" href="#command-prompt">command prompt</a> window set up for the
|
|
|
+Visual Studio compiler. In that window, set the <a class="reference" 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_34_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">
|
|
|
+<h2><a class="toc-backref" href="#id27" id="errors-and-warnings" name="errors-and-warnings">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="id6" name="id6"><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" href="#build-a-simple-program-using-boost">example program</a> correctly and that you've
|
|
|
+correctly identified the <a class="reference" 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">
|
|
|
+<h1><a class="toc-backref" href="#id28" id="prepare-to-use-a-boost-library-binary" name="prepare-to-use-a-boost-library-binary">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">
|
|
|
+<h2><a class="toc-backref" href="#id29" id="install-visual-studio-2005-or-net-2003-binaries" name="install-visual-studio-2005-or-net-2003-binaries">5.1 Install Visual Studio (2005 or .NET 2003) Binaries</a></h2>
|
|
|
+<p>The <a class="reference" href="http://www.boost-consulting.com/download/windows">installer</a> supplied by Boost Consulting 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_34_0</span></tt><tt class="docutils literal"><span class="pre">\lib\</span></tt>. If you installed
|
|
|
+all variants of the <a class="reference" 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" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id30" id="or-build-and-install-binaries-from-source" name="or-build-and-install-binaries-from-source">5.2 Or, Build and Install 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" 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" 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>
|
|
|
+<div class="section">
|
|
|
+<h3><a class="toc-backref" href="#id31" id="get-bjam" name="get-bjam">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" 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>Boost provides <a class="reference" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941">pre-compiled <tt class="docutils literal"><span class="pre">bjam</span></tt> executables</a> for a variety of platforms.
|
|
|
+Alternatively, you can build <tt class="docutils literal"><span class="pre">bjam</span></tt> yourself using <a class="reference" href="../../doc/html/jam/building.html">these
|
|
|
+instructions</a>.</p>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h3><a class="toc-backref" href="#id32" id="identify-your-toolset" name="identify-your-toolset"><span id="toolset-name"></span><span id="toolset"></span>5.2.2 Identify Your Toolset</a></h3>
|
|
|
+<p>First, find the toolset corresponding to your compiler in the
|
|
|
+following table.</p>
|
|
|
+<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" 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">msvc-7.1</span></tt> or <tt class="docutils literal"><span class="pre">gcc-3.4</span></tt>.</p>
|
|
|
+<div class="note">
|
|
|
+<p class="first admonition-title">Note</p>
|
|
|
+<p class="last">if you built <tt class="docutils literal"><span class="pre">bjam</span></tt> yourself, you may
|
|
|
+have selected a toolset name for that purpose, but that does not
|
|
|
+affect this step in any way; you still need to select a Boost.Build
|
|
|
+toolset from the table.</p>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h3><a class="toc-backref" href="#id33" id="select-a-build-directory" name="select-a-build-directory"><span id="id11"></span><span id="build-directory"></span>5.2.3 Select a Build Directory</a></h3>
|
|
|
+<p><a class="reference" 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">
|
|
|
+<h3><a class="toc-backref" href="#id34" id="invoke-bjam" name="invoke-bjam">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" href="#id11"><em>build-directory</em></a> <strong>--toolset=</strong><a class="reference" href="#toolset-name"><em>toolset-name</em></a> stage
|
|
|
+</pre>
|
|
|
+<p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id12" name="id12"><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_34_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_34_0</span></tt>> bjam <strong>^</strong>
|
|
|
+More? <strong>--build-dir=</strong>%TEMP%\build-boost <strong>^</strong>
|
|
|
+More? <strong>--toolset=</strong>msvc stage
|
|
|
+</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) -->
|
|
|
+<p>Boost.Build will place the Boost 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" 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>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id35" id="expected-build-output" name="expected-build-output">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">
|
|
|
+<h2><a class="toc-backref" href="#id36" id="in-case-of-build-errors" name="in-case-of-build-errors">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" 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" 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" href="../../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) -->
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h1><a class="toc-backref" href="#id37" id="link-your-program-to-a-boost-library" name="link-your-program-to-a-boost-library">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" 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 class="last">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>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id38" id="link-from-within-the-visual-studio-ide" name="link-from-within-the-visual-studio-ide">6.1 Link From Within the Visual Studio IDE</a></h2>
|
|
|
+<p>Starting with the <a class="reference" 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_34_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" href="#test-your-program"><em>skip to the next step</em></a></p>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id39" id="or-link-from-the-command-prompt" name="or-link-from-the-command-prompt">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_34_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_34_0</span></tt> example.cpp <strong>^</strong>
|
|
|
+ <strong>/link /LIBPATH:</strong> <strong>C:\Program Files\boost\</strong><strong>boost_1_34_0</strong><strong>\lib</strong>
|
|
|
+</pre>
|
|
|
+</div>
|
|
|
+<div class="section">
|
|
|
+<h2><a class="toc-backref" href="#id40" id="library-naming" name="library-naming">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" 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="id17" name="id17"><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 toolset 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" 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="id18" name="id18"><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="id19" name="id19"><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 (except for static libraries built by the <tt class="docutils literal"><span class="pre">gcc</span></tt>
|
|
|
+toolset, whose names always end in <tt class="docutils literal"><span class="pre">.a</span></tt>) <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>
|
|
|
+<!-- 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">
|
|
|
+<h2><a class="toc-backref" href="#id41" id="test-your-program" name="test-your-program">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" 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">
|
|
|
+<h1><a class="toc-backref" href="#id42" id="conclusion-and-further-resources" name="conclusion-and-further-resources">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" href="../../more/mailing_lists.htm#users">Boost Users'
|
|
|
+mailing list</a>.</p>
|
|
|
+<ul class="simple">
|
|
|
+<li><a class="reference" href="../../tools/build/v2">Boost.Build reference manual</a></li>
|
|
|
+<li><a class="reference" href="../../tools/jam/index.html">Boost.Jam reference manual</a></li>
|
|
|
+<li><a class="reference" href="../../more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
|
|
|
+<li><a class="reference" href="../../more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
|
|
|
+<li><a class="reference" href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2">Boost.Build Wiki</a></li>
|
|
|
+<li><a class="reference" 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" name="zip">[1]</a></td><td>If you prefer not to download executable programs,
|
|
|
+download <a class="reference" href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=376197"><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt><tt class="docutils literal"><span class="pre">.zip</span></tt></a> and use an external tool to decompress
|
|
|
+it. 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"><a name="installer-src">[2]</a></td><td>If you used the <a class="reference" href="http://www.boost-consulting.com/download/windows">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="#id4" name="pch">[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="#id12" name="continuation">[4]</a></td><td>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. 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.</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="#id6" name="warnings">[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="#id17" name="distinct">[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="#id18" name="debug-abi">[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="#id19" name="native">[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>
|
nobody