boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-03-12 11:30:08 +08:00
Code Issues Packages Projects Releases Wiki Activity
8d3aebdf61
more/getting_started.html

957 lines
56 KiB
HTML
Raw Normal View History

First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<?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">
Merged from Version_1_33_1 [SVN r31949]
2005-12-08 11:23:02 +08:00
<head>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<title>Boost Getting Started</title>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<link rel="stylesheet" href="../rst.css" type="text/css" />
Merged from Version_1_33_1 [SVN r31949]
2005-12-08 11:23:02 +08:00
</head>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<body>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<div class="document" id="logo-getting-started">
<h1 class="title"><a class="reference" href="../index.htm"><img alt="Boost" class="boost-logo" src="../boost.png" /></a> Getting Started</h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<div class="contents sidebar small topic">
<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<ul class="auto-toc simple">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="#introduction" id="id27" name="id27">1&nbsp;&nbsp;&nbsp;Introduction</a><ul class="auto-toc">
<li><a class="reference" href="#what-s-here" id="id28" name="id28">1.1&nbsp;&nbsp;&nbsp;What's Here</a></li>
<li><a class="reference" href="#preliminaries" id="id29" name="id29">1.2&nbsp;&nbsp;&nbsp;Preliminaries</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ul>
</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="#get-boost" id="id30" name="id30">2&nbsp;&nbsp;&nbsp;Get Boost</a></li>
<li><a class="reference" href="#the-structure-of-a-boost-distribution" id="id31" name="id31">3&nbsp;&nbsp;&nbsp;The Structure of a Boost Distribution</a></li>
<li><a class="reference" href="#header-only-libraries" id="id32" name="id32">4&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></li>
<li><a class="reference" href="#build-a-simple-program-using-boost" id="id33" name="id33">5&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a><ul class="auto-toc">
<li><a class="reference" href="#build-on-nix" id="id34" name="id34">5.1&nbsp;&nbsp;&nbsp;Build on *nix</a></li>
<li><a class="reference" href="#build-from-the-visual-studio-command-prompt" id="id35" name="id35">5.2&nbsp;&nbsp;&nbsp;Build from the Visual Studio Command Prompt</a></li>
<li><a class="reference" href="#build-in-the-visual-studio-ide" id="id36" name="id36">5.3&nbsp;&nbsp;&nbsp;Build in the Visual Studio IDE</a></li>
<li><a class="reference" href="#errors-and-warnings" id="id37" name="id37">5.4&nbsp;&nbsp;&nbsp;Errors and Warnings</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ul>
</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="#get-boost-library-binaries" id="id38" name="id38">6&nbsp;&nbsp;&nbsp;Get Boost Library Binaries</a><ul class="auto-toc">
<li><a class="reference" href="#install-visual-studio-binaries" id="id39" name="id39">6.1&nbsp;&nbsp;&nbsp;Install Visual Studio Binaries</a></li>
<li><a class="reference" href="#build-and-install-nix-binaries" id="id40" name="id40">6.2&nbsp;&nbsp;&nbsp;Build and Install *nix Binaries</a></li>
<li><a class="reference" href="#build-and-install-other-binaries" id="id41" name="id41">6.3&nbsp;&nbsp;&nbsp;Build and Install Other Binaries</a></li>
<li><a class="reference" href="#expected-build-output" id="id42" name="id42">6.4&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
<li><a class="reference" href="#in-case-of-build-errors" id="id43" name="id43">6.5&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ul>
</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="#link-your-program-to-a-boost-library" id="id44" name="id44">7&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a><ul class="auto-toc">
<li><a class="reference" href="#link-to-a-boost-library-on-windows" id="id45" name="id45">7.1&nbsp;&nbsp;&nbsp;Link to a Boost Library on Windows</a></li>
<li><a class="reference" href="#link-to-a-boost-library-on-nix" id="id46" name="id46">7.2&nbsp;&nbsp;&nbsp;Link to a Boost Library On *nix</a></li>
<li><a class="reference" href="#library-naming" id="id47" name="id47">7.3&nbsp;&nbsp;&nbsp;Library Naming</a></li>
<li><a class="reference" href="#test-your-program" id="id48" name="id48">7.4&nbsp;&nbsp;&nbsp;Test Your Program</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ul>
</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="#further-resources" id="id49" name="id49">8&nbsp;&nbsp;&nbsp;Further Resources</a></li>
<li><a class="reference" href="#appendix-using-command-line-tools-in-windows" id="id50" name="id50">9&nbsp;&nbsp;&nbsp;Appendix: Using command-line tools in Windows</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ul>
</div>
<!-- ## Update this substitution for each release -->
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h1><a class="toc-backref" href="#id27" id="introduction" name="introduction">1&nbsp;&nbsp;&nbsp;Introduction</a></h1>
<p>Welcome to the Boost libraries! By the time you've completed this
tutorial, you'll be at least somewhat comfortable with the contents
of a Boost distribution and how to go about using it.</p>
<div class="section">
<h2><a class="toc-backref" href="#id28" id="what-s-here" name="what-s-here">1.1&nbsp;&nbsp;&nbsp;What's Here</a></h2>
<p>This document is designed to be an <em>extremely</em> gentle introduction,
so we included a fair amount of material that may already be very
familiar to you. To keep things simple, we also left out some
information intermediate and advanced users will probably want. At
the end of this document, we'll refer you on to resources that can
help you pursue these topics further.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id29" id="preliminaries" name="preliminaries">1.2&nbsp;&nbsp;&nbsp;Preliminaries</a></h2>
<p>We use one typographic convention that might not be immediately
obvious: <em>italic</em> text in examples is meant as a descriptive
placeholder for something else, usually information that you'll
provide. For example:</p>
<pre class="literal-block">
<strong>$</strong> echo &quot;My name is <em>your name</em>&quot;
</pre>
<p>Here you're expected to imagine replacing the text “your name” with
your actual name.</p>
<p>We identify Unix and its variants such as Linux, FreeBSD, and MacOS
collectively as *nix. If you're not targeting Microsoft Windows,
the instructions for *nix users will probably work for you.
Cygwin users working from the Cygwin <tt class="docutils literal"><span class="pre">bash</span></tt> prompt should also
follow the *nix instructions. To use your Cygwin compiler from
the Windows command prompt, follow the instructions for Windows
users.</p>
<p>Although Boost supports a wide variety of Windows compilers
(including older Microsoft compilers), most instructions for
Windows users cover only the Visual Studio .NET 2003 and Visual
Studio 2005. We hope that gives you enough information to adapt
them for your own compiler or IDE.</p>
<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">&mdash;the Boost Developers</p>
</blockquote>
</div>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id30" id="get-boost" name="get-boost">2&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>There are basically three ways to get Boost on your system:</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<ol class="arabic">
<li><p class="first"><strong>Windows Installer</strong>: Boost Consulting provides an <a class="reference" href="http://www.boost-consulting.com/download.html">installer</a>
for Windows platforms that installs a complete Boost
distribution, plus optional precompiled library binaries for
Visual Studio, and (optionally) a prebuilt version of the
<tt class="docutils literal"><span class="pre">bjam</span></tt> build tool.</p>
</li>
<li><p class="first"><strong>Download</strong>: users of other platforms—and Windows
users who prefer to build everything from scratch—can <a class="reference" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041&amp;release_id=376197">download
a complete Boost distribution</a> from SourceForge.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<!-- ## Update this link for each release -->
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<ul>
<li><p class="first"><strong>Windows</strong>: Download and run <tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt><tt class="docutils literal"><span class="pre">.exe</span></tt>
to unpack the distribution.<a class="footnote-reference" href="#zip" id="id3" name="id3"><sup>1</sup></a></p>
</li>
<li><p class="first"><strong>*nix</strong>: Download <tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt><tt class="docutils literal"><span class="pre">.tar.bz2</span></tt>. Then, in the
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
directory where you want to put the Boost installation,
execute</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<pre class="literal-block">
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt>.tar.bz2
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
</li>
</ul>
</li>
<li><p class="first"><strong>Boost packages</strong> from RedHat, Debian, or some other
distribution packager: these instructions may not work for you
if you use 3rd party packages, because other packagers sometimes
choose to break Boost up into several packages or to reorganize
the directory structure of the Boost distribution.<a class="footnote-reference" href="#packagers" id="id4" name="id4"><sup>2</sup></a></p>
</li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</ol>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h1><a class="toc-backref" href="#id31" id="the-structure-of-a-boost-distribution" name="the-structure-of-a-boost-distribution">3&nbsp;&nbsp;&nbsp;The Structure of a Boost Distribution</a></h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>This is is a sketch of the directory structure you'll get when you
unpack your Boost installation (windows users replace forward
slashes with backslashes):</p>
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<strong>boost/</strong> .........................<em>All Boost Header files</em>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<strong>libs/</strong> ............<em>Tests, .cpp</em>s<em>, docs, etc., by library</em><a class="footnote-reference" href="#installer-src" id="id5" name="id5"><sup>3</sup></a>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<strong>index.html</strong> ........<em>Library documentation starts here</em>
<strong>algorithm/</strong>
<strong>any/</strong>
<strong>array/</strong>
<em>…more libraries…</em>
<strong>status/</strong> .........................<em>Boost-wide test suite</em>
<strong>tools/</strong> ...........<em>Utilities, e.g. bjam, quickbook, bcp</em>
<strong>more/</strong> ..........................<em>Policy documents, etc.</em>
<strong>doc/</strong> ...............<em>A subset of all Boost library docs</em>
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<div class="small sidebar">
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p class="first sidebar-title">Header Organization</p>
<p>The organization of Boost library headers isn't entirely uniform,
but most libraries follow a few patterns:</p>
<ul class="last simple">
<li>Some older libraries and most very small libraries place all
public headers directly into <tt class="docutils literal"><span class="pre">boost/</span></tt>.</li>
<li>Most libraries' public headers live in a subdirectory of
<tt class="docutils literal"><span class="pre">boost/</span></tt> named after the library. For example, you'll find
the Type Traits Library's <tt class="docutils literal"><span class="pre">is_void.hpp</span></tt> header in
<tt class="docutils literal"><span class="pre">boost/type_traits/is_void.hpp</span></tt>.</li>
<li>Some libraries have an “aggregate header” in <tt class="docutils literal"><span class="pre">boost/</span></tt> that
<tt class="docutils literal"><span class="pre">#include</span></tt>s all of the library's other headers. For
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
example, <a class="reference" href="../libs/python/index.html">Boost.Python</a>'s aggregate header is
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<tt class="docutils literal"><span class="pre">boost/python.hpp</span></tt>.</li>
<li>Most libraries place private headers in a subdirectory called
<tt class="docutils literal"><span class="pre">detail/</span></tt> or <tt class="docutils literal"><span class="pre">aux_/</span></tt>. Don't look in these directories and
expect to find anything you can use.</li>
</ul>
</div>
<p>A few things are worth noting right off the bat:</p>
<ol class="arabic">
<li><p class="first">The path to the “boost root directory” is sometimes referred to
as <tt class="docutils literal"><span class="pre">$BOOST_ROOT</span></tt> in documentation and mailing lists. If you
used the Windows installer, that will usually be <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>
</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> subdirectory in your <tt class="docutils literal"><span class="pre">#include</span></tt> path. For most
compilers, that means adding</p>
<pre class="literal-block">
-I<tt class="docutils literal"><span class="pre">/</span></tt><em>path</em><tt class="docutils literal"><span class="pre">/</span></tt><em>to</em><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt>
</pre>
<p>to the command line. 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> 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 &lt;boost/<em>whatever</em>.hpp&gt;
</pre>
<p>or</p>
<pre class="literal-block">
#include &quot;boost/<em>whatever</em>.hpp&quot;
</pre>
</li>
</ol>
<blockquote>
depending on your religion as regards the use of angle bracket
includes. Even Windows users can use forward slashes in
<tt class="docutils literal"><span class="pre">#include</span></tt> directives; your compiler doesn't care.</blockquote>
<ol class="arabic simple" start="4">
<li>Don't be distracted by the <tt class="docutils literal"><span class="pre">doc/</span></tt> subdirectory; it only
contains a subset of the Boost documentation. Start with
<tt class="docutils literal"><span class="pre">libs/index.html</span></tt> if you're looking for the whole enchilada.</li>
</ol>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h1><a class="toc-backref" href="#id32" id="header-only-libraries" name="header-only-libraries">4&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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 can't be used without separate
compilation are:</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<ul class="simple">
<li>Boost.Filesystem</li>
<li>Boost.IOStreams</li>
<li>Boost.ProgramOptions</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><a class="reference" href="../libs/python/index.html">Boost.Python</a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<li>Boost.Regex</li>
<li>Boost.Serialization</li>
<li>Boost.Signals</li>
<li>Boost.Test</li>
<li>Boost.Thread</li>
<li>Boost.Wave</li>
</ul>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>The DateTime library has a separately-compiled component that
is only needed if you're using its to/from_string and/or
serialization features or if you're targeting Visual C++ 6.x or
Borland. The Graph library also has a separately-compiled part,
but you won't need it unless you intend to <a class="reference" href="../libs/graph/doc/read_graphviz.html">parse GraphViz
files</a>.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<!-- ## Keep the list of non-header-only libraries up-to-date -->
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
</div>
<div class="section">
<h1><a class="toc-backref" href="#id33" id="build-a-simple-program-using-boost" name="build-a-simple-program-using-boost">5&nbsp;&nbsp;&nbsp;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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
#include &lt;boost/lambda/lambda.hpp&gt;
#include &lt;iostream&gt;
#include &lt;iterator&gt;
#include &lt;algorithm&gt;
int main()
{
using namespace boost::lambda;
typedef std::istream_iterator&lt;int&gt; in;
std::for_each(
in(std::cin), in(), std::cout &lt;&lt; (_1 * 3) &lt;&lt; &quot; &quot; );
}
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>Copy the text of this program into a file called <tt class="docutils literal"><span class="pre">example.cpp</span></tt>.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id34" id="build-on-nix" name="build-on-nix"><span id="unix-header-only"></span>5.1&nbsp;&nbsp;&nbsp;Build on *nix</a></h2>
<p>In the directory where you saved <tt class="docutils literal"><span class="pre">example.cpp</span></tt>, issue the
following command:</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
c++ -I <tt class="docutils literal"><span class="pre">/</span></tt><em>path</em><tt class="docutils literal"><span class="pre">/</span></tt><em>to</em><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt> example.cpp -o example
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
<p>To test the result, type:</p>
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
echo 1 2 3 | ./example
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#errors-and-warnings"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id35" id="build-from-the-visual-studio-command-prompt" name="build-from-the-visual-studio-command-prompt">5.2&nbsp;&nbsp;&nbsp;Build from the Visual Studio Command Prompt</a></h2>
<p>From your computer's <em>Start</em> menu, if you are a Visual
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
Studio 2005 user, select</p>
<blockquote>
<em>All Programs</em> &gt; <em>Microsoft Visual Studio 2005</em>
&gt; <em>Visual Studio Tools</em> &gt; <em>Visual Studio 2005 Command Prompt</em></blockquote>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>or, if you're a Visual Studio .NET 2003 user, select</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<blockquote>
<em>All Programs</em> &gt; <em>Microsoft Visual Studio .NET 2003</em>
&gt; <em>Visual Studio .NET Tools</em> &gt; <em>Visual Studio .NET 2003 Command Prompt</em></blockquote>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>to bring up a special <a class="reference" href="#command-prompt">command prompt</a> window set up for the Visual
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
Studio compiler. In that window, type the following command and
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
hit the return key:</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
cl /EHsc /I<em>path</em><tt class="docutils literal"><span class="pre">\</span></tt><em>to</em><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt> <em>path</em>\<em>to</em>\example.cpp
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
<p>To test the result, type:</p>
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
echo 1 2 3 | example
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#errors-and-warnings"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id36" id="build-in-the-visual-studio-ide" name="build-in-the-visual-studio-ide"><span id="vs-header-only"></span>5.3&nbsp;&nbsp;&nbsp;Build in the Visual Studio IDE</a></h2>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<ul class="simple">
<li>From Visual Studio's <em>File</em> menu, select <em>New</em> &gt; <em>Project…</em></li>
<li>In the left-hand pane of the resulting <em>New Project</em> dialog,
select <em>Visual C++</em> &gt; <em>Win32</em>.</li>
<li>In the right-hand pane, select <em>Win32 Console Application</em>
(VS8.0) or <em>Win32 Console Project</em> (VS7.1).</li>
<li>In the <em>name</em> field, enter “example”</li>
<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> &gt; <em>C/C++</em> &gt; <em>General</em> &gt; <em>Additional Include
Directories</em>, enter the path to the Boost root directory, 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>.</li>
<li>In <em>Configuration Properties</em> &gt; <em>C/C++</em> &gt; <em>Precompiled Headers</em>, change
<em>Use Precompiled Header (/Yu)</em> to <em>Not Using Precompiled
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
Headers</em>.<a class="footnote-reference" href="#pch" id="id9" name="id9"><sup>5</sup></a></li>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<li>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.</li>
<li>From the <em>Build</em> menu, select <em>Build Solution</em>.</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 &quot;Z&quot;, followed by the
return key.</p>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id37" id="errors-and-warnings" name="errors-and-warnings">5.4&nbsp;&nbsp;&nbsp;Errors and Warnings</a></h2>
<p>Don't be alarmed if you see compiler warnings from Boost headers.
We try to eliminate them, but doing so isn't always practical.<a class="footnote-reference" href="#warnings" id="id10" name="id10"><sup>4</sup></a></p>
<p>Errors are another matter. If you're seeing compilation errors at
this point in the tutorial, check to be sure you've copied the
example program correctly and that you've correctly identified the
Boost root directory.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h1><a class="toc-backref" href="#id38" id="get-boost-library-binaries" name="get-boost-library-binaries">6&nbsp;&nbsp;&nbsp;Get Boost Library Binaries</a></h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>If you want to use any of the separately-compiled Boost libraries,
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
you'll need library binaries.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id39" id="install-visual-studio-binaries" name="install-visual-studio-binaries">6.1&nbsp;&nbsp;&nbsp;Install Visual Studio Binaries</a></h2>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>The <a class="reference" href="http://www.boost-consulting.com/download.html">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>.</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#link-your-program-to-a-boost-library"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id40" id="build-and-install-nix-binaries" name="build-and-install-nix-binaries">6.2&nbsp;&nbsp;&nbsp;Build and Install *nix Binaries</a></h2>
<p>Issue the following commands in the shell (don't type <tt class="docutils literal"><span class="pre">$</span></tt>; it
represents the shell's prompt):</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
<strong>$</strong> cd <tt class="docutils literal"><span class="pre">/</span></tt><em>path</em><tt class="docutils literal"><span class="pre">/</span></tt><em>to</em><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt>
<strong>$</strong> ./configure --help
</pre>
<p>Select your configuration options and invoke <tt class="docutils literal"><span class="pre">./configure</span></tt> again.
Unless you have write permission in your system's <tt class="docutils literal"><span class="pre">/usr/local/</span></tt>
directory, you'll probably want to at least use</p>
<pre class="literal-block">
<strong>$</strong> ./configure <strong>--prefix=</strong><em>path</em>/<em>to</em>/<em>installation</em>/<em>prefix</em>
</pre>
<p>to install somewhere else. Finally,</p>
<pre class="literal-block">
<strong>$</strong> make install
</pre>
<p>which will leave Boost binaries in the <tt class="docutils literal"><span class="pre">lib/</span></tt> subdirectory of
your installation prefix. You will also find a copy of the Boost
headers in the <tt class="docutils literal"><span class="pre">include/</span></tt> subdirectory of the installation
prefix, so you can henceforth use that directory as an <tt class="docutils literal"><span class="pre">#include</span></tt>
path in place of the Boost root directory.</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#expected-build-output"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id41" id="build-and-install-other-binaries" name="build-and-install-other-binaries">6.3&nbsp;&nbsp;&nbsp;Build and Install Other Binaries</a></h2>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>If you're not using Visual C++ 7.1 or 8.0, or you're a *nix user
who wants want to build with a toolset other than your system's
default, or if you want a nonstandard variant build of Boost
(e.g. optimized, but with debug symbols), you'll need to use
<a class="reference" href="../tools/build/index.html">Boost.Build</a> to create your own binaries.</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="get-bjam" name="get-bjam">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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>Boost provides <a class="reference" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=72941">pre-compiled <tt class="docutils literal"><span class="pre">bjam</span></tt> executables</a> for a variety of platforms.
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
Alternatively, you can build <tt class="docutils literal"><span class="pre">bjam</span></tt> yourself using <a class="reference" href="http://www.boost.org/doc/html/jam/building.html">these
instructions</a>.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="identify-your-toolset" name="identify-your-toolset"><span id="toolset-name"></span><span id="toolset"></span>Identify Your Toolset</a></h3>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>First, find the toolset corresponding to your compiler in the
following table.</p>
<table border="1" class="docutils">
<colgroup>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<col width="18%" />
<col width="33%" />
<col width="48%" />
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</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">
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">acc</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Hewlett Packard</td>
<td>Only very recent versions are
known to work well with Boost</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">borland</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Borland</td>
<td>&nbsp;</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">como</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">cw</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">dmc</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Digital Mars</td>
<td>As of this Boost release, no
version of dmc is known to
handle Boost well.</td>
</tr>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">gcc</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>The Gnu Project</td>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<td>Includes support for Cygwin
and MinGW compilers.</td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">hp_cxx</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Hewlett Packard</td>
<td>Targeted at the Tru64
operating system.</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">intel</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Intel</td>
<td>&nbsp;</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">kylix</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Borland</td>
<td>&nbsp;</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">msvc</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Microsoft</td>
<td>&nbsp;</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">qcc</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>QNX Software Systems</td>
<td>&nbsp;</td>
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">sun</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<td>Sun</td>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<td>Only very recent versions are
known to work well with
Boost.</td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</tr>
formatting tweak [SVN r36100]
2006-11-20 11:57:49 +08:00
<tr><td><tt class="docutils literal"><span class="pre">vacpp</span></tt></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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 apend 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">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="select-a-build-directory" name="select-a-build-directory"><span id="id15"></span><span id="build-directory"></span>Select a Build Directory</a></h3>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="invoke-bjam" name="invoke-bjam">Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
bjam <strong>--build-dir=</strong><a class="reference" href="#id15"><em>build-directory</em></a> <strong>\</strong>
<strong>--toolset=</strong><a class="reference" href="#toolset-name"><em>toolset-name</em></a> stage
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
<p>For example, on Windows, your session might look like:</p>
<pre class="literal-block">
C:WINDOWS&gt; 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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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>&gt; bjam <strong>\</strong>
<strong>--build-dir=</strong>%TEMP%\build-boost <strong>\</strong>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<strong>--toolset=msvc stage</strong>
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>And on Unix:</p>
<pre class="literal-block">
$ cd ~/<tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt>
$ bjam <strong>--build-dir=</strong>~/build-boost <strong>--prefix=</strong>~/boost
</pre>
<p>In either case, Boost.Build will place the Boost binaries in the
<tt class="docutils literal"><span class="pre">stage/</span></tt> subdirectory of your <a class="reference" href="#build-directory">build directory</a>.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>For a description of other options you can pass when invoking
<tt class="docutils literal"><span class="pre">bjam</span></tt>, type:</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
bjam --help
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
</div>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id42" id="expected-build-output" name="expected-build-output">6.4&nbsp;&nbsp;&nbsp;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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<em>toolset-name</em>.c++ <em>long</em>/<em>path</em>/<em>to</em>/<em>file</em>/<em>being</em>/<em>built</em>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
</li>
<li><p class="first">Compiler warnings.</p>
</li>
</ul>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<div class="section">
<h2><a class="toc-backref" href="#id43" id="in-case-of-build-errors" name="in-case-of-build-errors">6.5&nbsp;&nbsp;&nbsp;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="file:///home/dave/src/boost/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="http://boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a>.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h1><a class="toc-backref" href="#id44" id="link-your-program-to-a-boost-library" name="link-your-program-to-a-boost-library">7&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a></h1>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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">Boost.Regex</a> library, which has a
separately-compiled binary component.</p>
<pre class="literal-block">
#include &lt;boost/regex.hpp&gt;
#include &lt;iostream&gt;
#include &lt;string&gt;
int main()
{
std::string line;
boost::regex pat( &quot;^Subject: (Re: |Aw: )*(.*)&quot; );
while (std::cin)
{
std::getline(std::cin, line);
boost::smatch matches;
if (boost::regex_match(line, matches, pat))
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
std::cout &lt;&lt; matches[2] &lt;&lt; std::endl;
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
}
}
</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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last"><a class="reference" href="../libs/python/index.html">Boost.Python</a> users should read that library's own <a class="reference" href="../libs/python/doc/building.html">build
documentation</a> as there are several library-specific issues to
consider.</p>
</div>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id45" id="link-to-a-boost-library-on-windows" name="link-to-a-boost-library-on-windows">7.1&nbsp;&nbsp;&nbsp;Link to a Boost Library on Windows</a></h2>
<p id="auto-linking">Most Windows compilers and linkers have so called “auto-linking
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
support,” which is used by many Boost libraries to eliminate 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 class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="link-to-a-boost-library-from-the-visual-studio-command-prompt" name="link-to-a-boost-library-from-the-visual-studio-command-prompt">Link to a Boost Library from the Visual Studio Command Prompt</a></h3>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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
some cleanups, add the Jamfile [SVN r36108]
2006-11-20 21:14:36 +08:00
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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<pre class="literal-block">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
cl /EHsc /I <em>path</em><tt class="docutils literal"><span class="pre">\</span></tt><em>to</em><tt class="docutils literal"><span class="pre">\</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt> example.cpp <strong>\</strong>
some cleanups, add the Jamfile [SVN r36108]
2006-11-20 21:14:36 +08:00
<strong>/link /LIBPATH:</strong> <strong>C:\Program Files\boost\</strong><strong>boost_1_34_0</strong><strong>\lib</strong>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#test-your-program"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h3><a id="link-to-a-boost-library-in-the-visual-studio-ide" name="link-to-a-boost-library-in-the-visual-studio-ide">Link to a Boost Library in the Visual Studio IDE</a></h3>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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> &gt; <em>Linker</em> &gt; <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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p><a class="reference" href="#test-your-program"><em>next...</em></a></p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</div>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id46" id="link-to-a-boost-library-on-nix" name="link-to-a-boost-library-on-nix">7.2&nbsp;&nbsp;&nbsp;Link to a Boost Library On *nix</a></h2>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<p>There are two main ways to link to libraries:</p>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<ol class="upperalpha">
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<li><p class="first">You can specify the full path to each library:</p>
<pre class="literal-block">
$ c++ -I <tt class="docutils literal"><span class="pre">/</span></tt><em>path</em><tt class="docutils literal"><span class="pre">/</span></tt><em>to</em><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt> example.cpp -o example <strong>\</strong>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<strong>~/boost/lib/libboost_regex-gcc-3.4-mt-d-1_34.a</strong>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
</li>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id21" name="id21"><sup>6</sup></a> dropping the filename's leading <tt class="docutils literal"><span class="pre">lib</span></tt> and trailing
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
suffix (<tt class="docutils literal"><span class="pre">.a</span></tt> in this case):</p>
<pre class="literal-block">
$ c++ -I <tt class="docutils literal"><span class="pre">/</span></tt><em>path</em><tt class="docutils literal"><span class="pre">/</span></tt><em>to</em><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt> example.cpp -o example <strong>\</strong>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<strong>-L~/boost/lib/ -lboost_regex-gcc-3.4-mt-d-1_34</strong>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</pre>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<p>As you can see, this method is just as terse as method A for one
library; it <em>really</em> pays off when you're using multiple
libraries from the same directory. Note, however, that if you
use this method with a library that has both static (<tt class="docutils literal"><span class="pre">.a</span></tt>) and
dynamic (<tt class="docutils literal"><span class="pre">.so</span></tt>) builds, the system may choose one
automatically for you unless you pass a special option such as
<tt class="docutils literal"><span class="pre">-static</span></tt> on the command line.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</li>
</ol>
link fix [SVN r36101]
2006-11-20 12:01:31 +08:00
<p>In both cases above, the bold text is what you'd add to <a class="reference" href="#unix-header-only">the
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
command lines we explored earlier</a>.</p>
</div>
<div class="section">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<h2><a class="toc-backref" href="#id47" id="library-naming" name="library-naming">7.3&nbsp;&nbsp;&nbsp;Library Naming</a></h2>
<p>When auto-linking is not available, you need to know how Boost
binaries are named so you can choose the right one for your build
configuration. 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
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
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
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
not.<a class="footnote-reference" href="#distinct" id="id23" name="id23"><sup>7</sup></a></dd>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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>
<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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id24" name="id24"><sup>8</sup></a></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<td>using STLPort's deprecated “native iostreams” feature.<a class="footnote-reference" href="#native" id="id25" name="id25"><sup>9</sup></a></td>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
</tr>
</tbody>
</table>
<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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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 &quot;-1_31_1&quot;.</dd>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<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 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. On most *nix 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. Where supported by *nix toolsets, a
full version extension is added (e.g. &quot;.so.1.34&quot;); a symbolic
link to the library file, named without the trailing version
number, will also be created.</dd>
</dl>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
</div>
<div class="section">
<h2><a class="toc-backref" href="#id48" id="test-your-program" name="test-your-program">7.4&nbsp;&nbsp;&nbsp;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>
<div class="section">
<h3><a id="test-your-program-on-microsoft-windows" name="test-your-program-on-microsoft-windows">Test Your Program on Microsoft Windows</a></h3>
<p>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 &lt; <em>path</em>\<em>to</em>\jayne.txt
</pre>
<p>The program should respond with the email subject, “Will Success
Spoil Rock Hunter?”</p>
</div>
<div class="section">
<h3><a id="test-your-program-on-nix" name="test-your-program-on-nix">Test Your Program on *nix</a></h3>
<p>If you linked to a shared library, you may need to prepare some
platform-specific settings so that the system will be able to find
and load it when your program is run. Most platforms have an
environment variable to which you can add the directory containing
the library. On many platforms (Linux, FreeBSD) that variable is
<tt class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></tt>, but on MacOS it's <tt class="docutils literal"><span class="pre">DYLD_LIBRARY_PATH</span></tt>, and
on Cygwin it's simply <tt class="docutils literal"><span class="pre">PATH</span></tt>. In most shells other than <tt class="docutils literal"><span class="pre">csh</span></tt>
and <tt class="docutils literal"><span class="pre">tcsh</span></tt>, you can adjust the variable as follows (again, don't
type the <tt class="docutils literal"><span class="pre">$</span></tt>—that represents the shell prompt):</p>
<pre class="literal-block">
<strong>$</strong> <em>VARIABLE_NAME</em>=<em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
<strong>$</strong> export <em>VARIABLE_NAME</em>
</pre>
<p>On <tt class="docutils literal"><span class="pre">csh</span></tt> and <tt class="docutils literal"><span class="pre">tcsh</span></tt>, it's</p>
<pre class="literal-block">
<strong>$</strong> setenv <em>VARIABLE_NAME</em> <em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
</pre>
<p>Once the necessary variable (if any) is set, you can run your
program as follows:</p>
<pre class="literal-block">
<strong>$</strong> <em>path</em>/<em>to</em>/<em>compiled</em>/example &lt; <em>path</em>/<em>to</em>/jayne.txt
</pre>
<p>The program should respond with the email subject, “Will Success
Spoil Rock Hunter?”</p>
</div>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id49" id="further-resources" name="further-resources">8&nbsp;&nbsp;&nbsp;Further Resources</a></h1>
<p>This concludes your introduction to Boost and using it with your
programs. Remember that this page is only supposed to get you
started and not describe every detail you might want to know about.
There are lots of resources you can pursue from this point onward.
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="http://boost.org/more/mailing_lists.htm#users">Boost Users'
mailing list</a>.</p>
<ul class="simple">
<li><a class="reference" href="http://boost.org/tools/build/v2">Boost.Build reference manual</a></li>
<li><a class="reference" href="http://boost.org/tools/jam">Boost.Jam reference manual</a></li>
<li><a class="reference" href="http://boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
<li><a class="reference" href="http://boost.org/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>
</ul>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">We're also very interested in what sort of material might
be appropriate for a “Book 2” in a Getting Started series.</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id50" id="appendix-using-command-line-tools-in-windows" name="appendix-using-command-line-tools-in-windows"><span id="command-line-tool"></span><span id="command-prompt"></span><span id="using-command-line-tools-in-windows"></span>9&nbsp;&nbsp;&nbsp;Appendix: Using command-line tools in Windows</a></h1>
<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 <em>Command Prompt</em>, click the <em>Start</em> menu button, click
<em>Run</em>, type “cmd”, and then click OK.</p>
<p>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>One way to name a directory you know about is to write</p>
<pre class="literal-block">
%HOMEDRIVE%%HOMEPATH%\<em>directory-name</em>
</pre>
<p>which indicates a sibling folder of your “My Documents” folder.</p>
<p>Long commands can be continued across several lines by typing
backslashes at the ends of all but the last line. Many of the
examples on this page use that technique to save horizontal
space.</p>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<hr class="docutils" />
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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="#id3" name="zip">[1]</a></td><td>If you prefer not to download executable programs, download
<tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt><tt class="docutils literal"><span class="pre">.zip</span></tt> 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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<table class="docutils footnote" frame="void" id="packagers" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id4" name="packagers">[2]</a></td><td>If developers of Boost packages would like to work
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
with us to make sure these instructions can be used with their
packages, we'd be glad to help. Please make your interest known
to the <a class="reference" href="mailing_lists.htm#main">Boost developers' list</a>.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="installer-src" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id5" name="installer-src">[3]</a></td><td>If you used the <a class="reference" href="http://www.boost-consulting.com/download.html">Windows installer</a> from Boost
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
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>
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<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="#id10" name="warnings">[4]</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>
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
<table class="docutils footnote" frame="void" id="pch" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id9" name="pch">[5]</a></td><td>There's no problem using Boost with precompiled headers;
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
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="lowercase-l" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id21" name="lowercase-l">[6]</a></td><td>That option is a dash followed by a lowercase “L”
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
character, which looks very much like a numeral 1 in some fonts.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="distinct" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id23" name="distinct">[7]</a></td><td>This convention distinguishes the static version of
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
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">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id24" name="debug-abi">[8]</a></td><td>These libraries were compiled without optimization
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
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. All though 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">
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
<tr><td class="label"><a class="fn-backref" href="#id25" name="native">[9]</a></td><td>This feature of STLPort is deprecated because it's
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
impossible to make it work transparently to the user; we don't
recommend it.</td></tr>
</tbody>
</table>
</div>
</div>
<div class="footer">
<hr class="footer" />
some cleanups, add the Jamfile [SVN r36108]
2006-11-20 21:14:36 +08:00
<a class="reference" href="./getting_started.rst">View document source</a>.
Massive overhaul of Getting Started guide. [SVN r36333]
2006-12-12 04:38:41 +08:00
Generated on: 2006-12-11 20:27 UTC.
First step in guide rewrite. [SVN r36098]
2006-11-20 11:05:14 +08:00
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
Merged from Version_1_33_1 [SVN r31949]
2005-12-08 11:23:02 +08:00
</body>
</html>
Reference in New Issue Copy Permalink