Getting Started
-
+ Getting Started
Use the latest version of this Getting Started guide
-The Boost website version of this Getting Started guide may +
The Boost website version of this Getting Started guide may have undated information, such as the location of additional installers or improved installation procedures, so you might want use that version if you've got an Internet connection available.
Welcome
+Welcome
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.
What's Here
+What's Here
This document is designed to be an extremely 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 @@ -36,8 +35,8 @@ 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.
Preliminaries
+Preliminaries
We use one typographic convention that might not be immediately obvious: italic text in examples is meant as a descriptive placeholder for something else, usually information that you'll @@ -48,16 +47,16 @@ provide. For example:
Here you're expected to imagine replacing the text “your name” with your actual name.
Ready?
+Ready?
Let's go!
Getting Started on Unix Variants
-
+ Getting Started on Unix Variants
@@ -27,48 +26,48 @@
.. _`Getting Started on Windows`: windows.html
.. _Cygwin: http://www.cygwin.com
.. _MinGW: http://mingw.org -->
-Index
+-
-
- 1 Get Boost -
- 2 The Boost Distribution -
- 3 Header-Only Libraries -
- 4 Build a Simple Program Using Boost
-
-
- 4.1 Errors and Warnings +
- 1 Get Boost +
- 2 The Boost Distribution +
- 3 Header-Only Libraries +
- 4 Build a Simple Program Using Boost -
- 5 Prepare to Use a Boost Library Binary
1 Get Boost
+1 Get Boost
The most reliable way to get a copy of Boost is to download a -distribution from SourceForge:
+distribution from SourceForge:-
-
Download boost_1_36_0.tar.bz2.
+Download boost_1_37_0.tar.bz2.
In the directory where you want to put the Boost installation, execute
-tar --bzip2 -xf /path/to/boost_1_36_0.tar.bz2 +tar --bzip2 -xf /path/to/boost_1_37_0.tar.bz2
2 The Boost Distribution
+2 The Boost Distribution
This is a sketch of the resulting directory structure:
-boost_1_36_0/ .................The “boost root directory”
+boost_1_37_0/ .................The “boost root directory”
index.htm .........A copy of www.boost.org starts here
boost/ .........................All Boost Header files
@@ -123,7 +122,7 @@ the Python library's def.hpp
Some libraries have an “aggregate header” in boost/ that
#includes all of the library's other headers. For
-example, Boost.Python's aggregate header is
+example, Boost.Python's aggregate header is
boost/python.hpp.
@@ -136,7 +135,7 @@ anything you can use in these directories.
It's important to note the following:
-
-
The path to the boost root directory (often /usr/local/boost_1_36_0) is +
The path to the boost root directory (often /usr/local/boost_1_37_0) is sometimes referred to as $BOOST_ROOT in documentation and mailing lists .
@@ -165,8 +164,8 @@ contains a subset of the Boost documentation. Start with
3 Header-Only Libraries
+3 Header-Only Libraries
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.
The only Boost libraries that must be built separately are:
-
-
- Boost.Filesystem -
- Boost.IOStreams -
- Boost.ProgramOptions -
- Boost.Python (see the Boost.Python build documentation +
- Boost.Filesystem +
- Boost.IOStreams +
- Boost.ProgramOptions +
- Boost.Python (see the Boost.Python build documentation before building and installing it) -
- Boost.Regex -
- Boost.Serialization -
- Boost.Signals -
- Boost.Thread -
- Boost.Wave +
- Boost.Regex +
- Boost.Serialization +
- Boost.Signals +
- Boost.Thread +
- Boost.Wave
A few libraries have optional separately-compiled binaries:
-
-
- Boost.DateTime has a binary component that is only needed if +
- Boost.DateTime has a binary component that is only needed if you're using its to_string/from_string or serialization features, or if you're targeting Visual C++ 6.x or Borland. -
- Boost.Graph also has a binary component that is only needed if -you intend to parse GraphViz files. -
- Boost.Test can be used in “header-only” or “separately compiled” +
- Boost.Graph also has a binary component that is only needed if +you intend to parse GraphViz files. +
- Boost.Test can be used in “header-only” or “separately compiled” mode, although separate compilation is recommended for serious use.
4 Build a Simple Program Using Boost
+4 Build a Simple Program Using Boost
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 @@ -230,7 +229,7 @@ int main()
Now, in the directory where you saved example.cpp, issue the following command:
-c++ -I path/to/boost_1_36_0 example.cpp -o example +c++ -I path/to/boost_1_37_0 example.cpp -o example
To test the result, type:
@@ -239,29 +238,29 @@ echo 1 2 3 | ./example ---4.1 Errors and Warnings
++4.1 Errors and Warnings
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.3 Errors are another matter. If you're +practical.3 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.
+be sure you've copied the example program correctly and that you've +correctly identified the Boost root directory.-5 Prepare to Use a Boost Library Binary
++5 Prepare to Use a Boost Library Binary
If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.
--5.1 Easy Build and Install
++-5.1 Easy Build and Install
Issue the following commands in the shell (don't type $; that represents the shell's prompt):
-$ cd path/to/boost_1_36_0 +$ cd path/to/boost_1_37_0 $ ./configure --helpSelect your configuration options and invoke ./configure again @@ -282,38 +281,38 @@ installation prefix. You will also find a copy of the Boost headers in the include/ subdirectory of the installation prefix, so you can henceforth use that directory as an #include path in place of the Boost root directory.
- +-5.2 Or, Build Custom Binaries
++5.2 Or, Build Custom Binaries
If you're using a compiler other than your system's default, you'll -need to use Boost.Build to create binaries. You'll also +need to use Boost.Build to create binaries. You'll also use this method if you need a nonstandard build variant (see the -Boost.Build documentation for more details).
+Boost.Build documentation for more details). -Boost.Build is a text-based system for developing, testing, and +
Boost.Build is a text-based system for developing, testing, and installing software. To use it, you'll need an executable called bjam.
--5.2.1 Get bjam
++-5.2.1 Get bjam
bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.
-Boost provides pre-compiled bjam executables for a variety of platforms. -Alternatively, you can build bjam yourself using these +
Boost provides pre-compiled bjam executables for a variety of platforms. +Alternatively, you can build bjam yourself using these instructions.
-5.2.2 Identify Your Toolset
++-5.2.2 Identify Your Toolset
First, find the toolset corresponding to your compiler in the following table.
Note
If you previously chose a toolset for the purposes of -building bjam, you should assume it won't work and instead +building bjam, you should assume it won't work and instead choose newly from the table below.
@@ -342,7 +341,7 @@ known to work well with Boost
@@ -641,7 +640,7 @@ convention. On most unix-style platforms the extensions are .a and .so for static libraries (archives) and shared libraries, respectively. On Windows, .dll indicates a shared library and (except for static libraries built by the gcc -toolset, whose names always end in .a) .lib indicates a +toolset, whose names always end in .a) .lib 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 @@ -652,8 +651,8 @@ version number, will also be created.como Comeau Computing Using this toolset may -require configuring another +require configuring another toolset to act as its backend cw @@ -408,36 +407,36 @@ you can append the version number to the toolset name, preceded by a hyphen, e.g. intel-9.0 or borland-5.4.3. --5.2.3 Select a Build Directory
-Boost.Build will place all intermediate files it generates while +
+-5.2.3 Select a Build Directory
+Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by default Boost.Build will create a bin.v2/ subdirectory for that purpose in your current working directory.
-5.2.4 Invoke bjam
++-5.2.4 Invoke bjam
Change your current directory to the Boost root directory and invoke bjam as follows:
-bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stage +bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stageFor example, your session might look like this:
-$ cd ~/boost_1_36_0 +$ cd ~/boost_1_37_0 $ bjam --build-dir=/tmp/build-boost --toolset=gcc stageThat will build static and shared non-debug multi-threaded variations of the libraries. To build all variations:
-$ cd ~/boost_1_36_0 +$ cd ~/boost_1_37_0 $ bjam --build-dir=/tmp/build-boost --toolset=gcc --build-type=complete stageBuilding the special stage target places Boost -library binaries in the stage/ subdirectory of your build +library binaries in the stage/ subdirectory of your build directory.
Note
@@ -459,8 +458,8 @@ be interested in:-5.3 Expected Build Output
++-5.3 Expected Build Output
During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include
@@ -483,29 +482,29 @@ look something like:
--5.4 In Case of Build Errors
++5.4 In Case of Build Errors
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 here. Install the relevant development +formats as described here. Install the relevant development packages for libz and libbz2 if you need those features. Other errors when building Boost libraries are cause for concern.
If it seems like the build system can't find your compiler and/or linker, consider setting up a user-config.jam file as described -in the Boost.Build documentation. If that isn't your problem or +in the Boost.Build documentation. If that isn't your problem or the user-config.jam file doesn't work for you, please address questions about configuring Boost for your compiler to the -Boost.Build mailing list.
+Boost.Build mailing list.-6 Link Your Program to a Boost Library
++6 Link Your Program to a Boost Library
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 Boost.Regex library, which has a +emails. It uses the Boost.Regex library, which has a separately-compiled binary component.
#include <boost/regex.hpp> @@ -538,14 +537,14 @@ project.-
- -
You can specify the full path to each library:
-$ c++ -I path/to/boost_1_36_0 example.cpp -o example \ +$ c++ -I path/to/boost_1_37_0 example.cpp -o example \ ~/boost/lib/libboost_regex-gcc34-mt-d-1_36.aYou can separately specify a directory to search (with -Ldirectory) and a library name to search for (with -llibrary,2 dropping the filename's leading lib and trailing +
You can separately specify a directory to search (with -Ldirectory) and a library name to search for (with -llibrary,2 dropping the filename's leading lib and trailing suffix (.a in this case):
-$ c++ -I path/to/boost_1_36_0 example.cpp -o example \ +$ c++ -I path/to/boost_1_37_0 example.cpp -o example \ -L~/boost/lib/ -lboost_regex-gcc34-mt-d-1_36As you can see, this method is just as terse as method A for one @@ -557,10 +556,10 @@ automatically for you unless you pass a special option such as -static on the command line.
In both cases above, the bold text is what you'd add to the +
In both cases above, the bold text is what you'd add to the command lines we explored earlier.
--6.1 Library Naming
++6.1 Library Naming
@@ -575,11 +574,11 @@ following elements:Prefix: except on Microsoft Windows, every Boost library name begins with this string. On Windows, only ordinary static libraries use the lib prefix; import libraries and DLLs do -not.4 +not.4boost_regex Library name: all boost library filenames begin with boost_. -vc71 -Toolset tag: identifies the toolset and version used to build + Toolset tag: identifies the toolset and version used to build the binary. -mt Threading tag: indicates that the library was @@ -610,17 +609,17 @@ libraries. using debug versions of the standard and runtime support libraries. y -using a special debug build of Python. +using a special debug build of Python. d -building a debug version of your code.5 +building a debug version of your code.5 p using the STLPort standard library rather than the default one supplied with your compiler. n -using STLPort's deprecated “native iostreams” feature.6 +using STLPort's deprecated “native iostreams” feature.6 --6.2 Test Your Program
++6.2 Test Your Program
To test our subject extraction, we'll filter the following text file. Copy it out of your browser and save it as jayne.txt:
@@ -692,23 +691,23 @@ Spoil Rock Hunter?”-7 Conclusion and Further Resources
++7 Conclusion and Further Resources
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 Boost Users' +make this document clearer, please post it to the Boost Users' mailing list.
-
- Boost.Build reference manual
-- Boost.Jam reference manual
-- Boost Users' mailing list
-- Boost.Build mailing list
-- Boost.Build Wiki
-- Index of all Boost library documentation
+- Boost.Build reference manual
+- Boost.Jam reference manual
+- Boost Users' mailing list
+- Boost.Build mailing list
+- Boost.Build Wiki
+- Index of all Boost library documentation
Onward
@@ -721,16 +720,17 @@ mailing list.
- [1] If developers of Boost packages would like to work + +to the Boost developers' list. + [1] If developers of Boost packages would like to work 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 Boost developers' list.
@@ -740,7 +740,7 @@ character, which looks very much like a numeral 1 in some fonts.
- [2] That option is a dash followed by a lowercase “L” + [2] That option is a dash followed by a lowercase “L” character, which looks very much like a numeral 1 in some fonts.
- [3] Remember that warnings are specific to each compiler + [3] 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 @@ -751,7 +751,7 @@ have any source code mechanism for suppressing warnings.
- [4] This convention distinguishes the static version of + @@ -760,7 +760,7 @@ same name. [4] 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.
- [5] These libraries were compiled without optimization + [5] These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other @@ -770,7 +770,7 @@ compiled code, you can't count on that with Boost libraries.
- [6] This feature of STLPort is deprecated because it's + diff --git a/getting_started/windows.html b/getting_started/windows.html index fe3fcf5..3821856 100644 --- a/getting_started/windows.html +++ b/getting_started/windows.html @@ -3,84 +3,83 @@ - + [6] This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it. Boost Getting Started on Windows -- +
--A note to Cygwin and MinGW users
+A note to Cygwin and MinGW users
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 Cygwin +you're in the right place. If you plan to build from the Cygwin bash shell, you're actually running on a POSIX platform and -should follow the instructions for getting started on Unix -variants. Other command shells, such as MinGW's MSYS, are +should follow the instructions for getting started on Unix +variants. Other command shells, such as MinGW's MSYS, are not supported—they may or may not work.
-Index
++--
- 1 Get Boost
-- 2 The Boost Distribution
-- 3 Header-Only Libraries
-- 4 Build a Simple Program Using Boost
-
- 4.1 Build From the Visual Studio IDE
-- 4.2 Or, Build From the Command Prompt
-- 4.3 Errors and Warnings
+- 1 Get Boost
+- 2 The Boost Distribution
+- 3 Header-Only Libraries
+- 4 Build a Simple Program Using Boost
-- 5 Prepare to Use a Boost Library Binary
-
- 5.1 Install Visual Studio Binaries
-- 5.2 Or, Build Binaries From Source
-
- 5.2.1 Get bjam
-- 5.2.2 Identify Your Toolset
-- 5.2.3 Select a Build Directory
-- 5.2.4 Invoke bjam
+- 5 Prepare to Use a Boost Library Binary
-- 6 Link Your Program to a Boost Library
-1 Get Boost
++-1 Get Boost
The easiest way to get a copy of Boost is to use an installer. -The Boost website version of this Getting Started guide will +The Boost website version of this Getting Started guide will have undated information on installers as they become available, -or see Boost downloads or the installer provided by BoostPro Computing. We especially recommend using +or see Boost downloads or the installer provided by BoostPro Computing. We especially recommend using an installer if you use Microsoft Visual Studio, because the installer can download and install precompiled library binaries, saving you the trouble of building them yourself. To complete this tutorial, you'll need to at least -install the Boost.Regex binaries when given the option.
+install the Boost.Regex binaries when given the option.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 boost_1_36_0.7z or boost_1_36_0.zip and unpack it to install a complete Boost -distribution.1
+download boost_1_37_0.7z or boost_1_37_0.zip and unpack it to install a complete Boost +distribution.1--2 The Boost Distribution
++2 The Boost Distribution
This is a sketch of the resulting directory structure:
-boost_1_36_0\ .................The “boost root directory” +boost_1_37_0\ .................The “boost root directory” index.htm .........A copy of www.boost.org starts here boost\ .........................All Boost Header files lib\ .....................precompiled library binaries @@ -112,7 +111,7 @@ the Python library's def.hppSome libraries have an “aggregate header” in boost\ that #includes all of the library's other headers. For -example, Boost.Python's aggregate header is
+example, Boost.Python's aggregate header isboost\python.hpp.@@ -125,7 +124,7 @@ anything you can use in these directories.It's important to note the following:
-
The path to the boost root directory (often C:\Program Files\boost\boost_1_36_0) is +
- @@ -159,8 +158,8 @@ contains a subset of the Boost documentation. Start with
The path to the boost root directory (often C:\Program Files\boost\boost_1_37_0) is sometimes referred to as $BOOST_ROOT in documentation and mailing lists .
-3 Header-Only Libraries
++3 Header-Only Libraries
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.
@@ -173,25 +172,25 @@ treatment when linking.-The only Boost libraries that must be built separately are:
-
- Boost.Filesystem
-- Boost.IOStreams
-- Boost.ProgramOptions
-- Boost.Python (see the Boost.Python build documentation +
- Boost.Filesystem
+- Boost.IOStreams
+- Boost.ProgramOptions
+- Boost.Python (see the Boost.Python build documentation before building and installing it)
-- Boost.Regex
-- Boost.Serialization
-- Boost.Signals
-- Boost.Thread
-- Boost.Wave
+- Boost.Regex
+- Boost.Serialization
+- Boost.Signals
+- Boost.Thread
+- Boost.Wave
A few libraries have optional separately-compiled binaries:
-
@@ -199,8 +198,8 @@ use.- Boost.DateTime has a binary component that is only needed if +
- Boost.DateTime has a binary component that is only needed if you're using its to_string/from_string or serialization features, or if you're targeting Visual C++ 6.x or Borland.
-- Boost.Graph also has a binary component that is only needed if -you intend to parse GraphViz files.
-- Boost.Test can be used in “header-only” or “separately compiled” +
- Boost.Graph also has a binary component that is only needed if +you intend to parse GraphViz files.
+- Boost.Test can be used in “header-only” or “separately compiled” mode, although separate compilation is recommended for serious use.
-4 Build a Simple Program Using Boost
++4 Build a Simple Program Using Boost
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 @@ -221,11 +220,11 @@ int main() }
Copy the text of this program into a file called example.cpp.
--Note
++-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 command prompt. Since every +you can issue commands from the command prompt. 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 @@ -249,14 +248,14 @@ cd path\to\some\directory
followed by Return. For example,
-cd C:\Program Files\boost\boost_1_36_0 +cd C:\Program Files\boost\boost_1_37_0Long commands can be continued across several lines by typing a caret (^) at the end of all but the last line. Some examples on this page use that technique to save horizontal space.
-4.1 Build From the Visual Studio IDE
++-4.1 Build From the Visual Studio IDE
- @@ -274,12 +273,12 @@ select Properties from the resulting pop-up menu
From Visual Studio's File menu, select New > Project…
In Configuration Properties > C/C++ > General > Additional Include Directories, enter the path to the Boost root directory, for example
-C:\Program Files\boost\boost_1_36_0
+C:\Program Files\boost\boost_1_37_0
In Configuration Properties > C/C++ > Precompiled Headers, change Use Precompiled Header (/Yu) to Not Using Precompiled -Headers.3
+Headers.3Replace the contents of the example.cpp generated by the IDE with the example code above.
@@ -294,10 +293,10 @@ into the resulting window, followed by the Return key:Then hold down the control key and press "Z", followed by the Return key.
- +-4.2 Or, Build From the Command Prompt
++-4.2 Or, Build From the Command Prompt
From your computer's Start menu, if you are a Visual Studio 2005 user, select
@@ -307,12 +306,12 @@ Studio 2005 user, selectAll Programs > Microsoft Visual Studio .NET 2003 > Visual Studio .NET Tools > Visual Studio .NET 2003 Command Prompt-to bring up a special command prompt window set up for the -Visual Studio compiler. In that window, set the current +
to bring up a special command prompt window set up for the +Visual Studio compiler. In that window, set the current directory to a suitable location for creating some temporary files and type the following command followed by the Return key:
-cl /EHsc /I path\to\boost_1_36_0 path\to\example.cpp +cl /EHsc /I path\to\boost_1_37_0 path\to\example.cppTo test the result, type:
@@ -322,62 +321,62 @@ echo 1 2 3 | example--4.3 Errors and Warnings
++4.3 Errors and Warnings
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.5 Errors are another matter. If you're +practical.5 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.
+be sure you've copied the example program correctly and that you've +correctly identified the Boost root directory.-5 Prepare to Use a Boost Library Binary
++5 Prepare to Use a Boost Library Binary
If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.
--5.1 Install Visual Studio Binaries
++-5.1 Install Visual Studio Binaries
The installers will download and install pre-compiled binaries into the lib\ subdirectory of the -boost root, typically C:\Program Files\boost\boost_1_36_0\lib\. If you installed -all variants of the Boost.Regex binary, you're done with this +boost root, typically C:\Program Files\boost\boost_1_37_0\lib\. If you installed +all variants of the Boost.Regex binary, you're done with this step. Otherwise, please run the installer again and install them now.
- +-5.2 Or, Build Binaries From Source
++5.2 Or, Build Binaries From Source
If you're using an earlier version of Visual C++, or a compiler -from another vendor, you'll need to use Boost.Build to create your +from another vendor, you'll need to use Boost.Build to create your own binaries.
-Boost.Build is a text-based system for developing, testing, and +
Boost.Build is a text-based system for developing, testing, and installing software. To use it, you'll need an executable called bjam.
--5.2.1 Get bjam
-bjam is the command-line tool that drives the Boost Build +
+-5.2.1 Get bjam
+bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.
-Boost provides pre-compiled bjam executables for a variety of platforms. -Alternatively, you can build bjam yourself using these +
Boost provides pre-compiled bjam executables for a variety of platforms. +Alternatively, you can build bjam yourself using these instructions.
-5.2.2 Identify Your Toolset
++-5.2.2 Identify Your Toolset
First, find the toolset corresponding to your compiler in the following table.
Note
If you previously chose a toolset for the purposes of -building bjam, you should assume it won't work and instead +building bjam, you should assume it won't work and instead choose newly from the table below.
@@ -406,7 +405,7 @@ known to work well with Boost
@@ -734,7 +733,7 @@ convention. On most unix-style platforms the extensions are .a and .so for static libraries (archives) and shared libraries, respectively. On Windows, .dll indicates a shared library and (except for static libraries built by the gcc -toolset, whose names always end in .a) .lib indicates a +toolset, whose names always end in .a) .lib 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 @@ -745,8 +744,8 @@ version number, will also be created.como Comeau Computing Using this toolset may -require configuring another +require configuring another toolset to act as its backend cw @@ -473,37 +472,37 @@ a hyphen, e.g. intel-9.0borland-5.4.3. On Windows, append a version number even if you only have one version installed (unless you are using the msvc or gcc toolsets, which have special version -detection code) or auto-linking will fail. +detection code) or auto-linking will fail. --5.2.3 Select a Build Directory
-Boost.Build will place all intermediate files it generates while +
+-5.2.3 Select a Build Directory
+Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by default Boost.Build will create a bin.v2/ subdirectory for that purpose in your current working directory.
-5.2.4 Invoke bjam
++-5.2.4 Invoke bjam
Change your current directory to the Boost root directory and invoke bjam as follows:
-bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stage +bjam --build-dir=build-directory --toolset=toolset-name [--build-type=complete] stage-For example, your session might look like this:4
+For example, your session might look like this:4
-C:\WINDOWS> cd C:\Program Files\boost\boost_1_36_0 -C:\Program Files\boost\boost_1_36_0> bjam ^ +C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0 +C:\Program Files\boost\boost_1_37_0> bjam ^ More? --build-dir="C:\Documents and Settings\dave\build-boost" ^ More? --toolset=msvc stage-Be sure to read this note about the appearance of ^, +
Be sure to read this note about the appearance of ^, More? and quotation marks (") in that line.
The above example session will build static and shared non-debug multi-threaded variations of the libraries. To build all variations:
-C:\WINDOWS> cd C:\Program Files\boost\boost_1_36_0 -C:\Program Files\boost\boost_1_36_0> bjam ^ +C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0 +C:\Program Files\boost\boost_1_37_0> bjam ^ More? --build-dir="C:\Documents and Settings\dave\build-boost" ^ More? --toolset=msvc --build-type=complete stage@@ -511,7 +510,7 @@ More? --toolset=msvc --build-type=complete staBuilding the special stage target places Boost -library binaries in the stage\ subdirectory of your build +library binaries in the stage\ subdirectory of your build directory.
Note
@@ -533,8 +532,8 @@ be interested in:-5.3 Expected Build Output
++-5.3 Expected Build Output
During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include
@@ -557,29 +556,29 @@ look something like:
--5.4 In Case of Build Errors
++5.4 In Case of Build Errors
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 here. Install the relevant development +formats as described here. Install the relevant development packages for libz and libbz2 if you need those features. Other errors when building Boost libraries are cause for concern.
If it seems like the build system can't find your compiler and/or linker, consider setting up a user-config.jam file as described -in the Boost.Build documentation. If that isn't your problem or +in the Boost.Build documentation. If that isn't your problem or the user-config.jam file doesn't work for you, please address questions about configuring Boost for your compiler to the -Boost.Build mailing list.
+Boost.Build mailing list.-6 Link Your Program to a Boost Library
++-6 Link Your Program to a Boost Library
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 Boost.Regex library, which has a +emails. It uses the Boost.Regex library, which has a separately-compiled binary component.
#include <boost/regex.hpp> @@ -617,40 +616,40 @@ 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.The GCC toolchains (Cygwin and MinGW) are notable exceptions; -GCC users should refer to the linking instructions for Unix +GCC users should refer to the linking instructions for Unix variant OSes for the appropriate command-line options to use.
-6.1 Link From Within the Visual Studio IDE
-Starting with the header-only example project we created +
+-6.1 Link From Within the Visual Studio IDE
+Starting with the header-only example project we created earlier:
- +
- Right-click example in the Solution Explorer pane and select Properties from the resulting pop-up menu
- In Configuration Properties > Linker > Additional Library Directories, enter the path to the Boost binaries, -e.g. C:\Program Files\boost\boost_1_36_0\lib\.
+e.g. C:\Program Files\boost\boost_1_37_0\lib\.- From the Build menu, select Build Solution.
-6.2 Or, Link From the Command Prompt
++-6.2 Or, Link From the Command Prompt
For example, we can compile and link the above program from the Visual C++ command-line by simply adding the bold text below to the command line we used earlier, assuming your Boost binaries are -in C:\Program Files\boost\boost_1_36_0\lib:
+in C:\Program Files\boost\boost_1_37_0\lib:-cl /EHsc /I path\to\boost_1_36_0 example.cpp ^ - /link /LIBPATH: C:\Program Files\boost\boost_1_36_0\lib +cl /EHsc /I path\to\boost_1_37_0 example.cpp ^ + /link /LIBPATH: C:\Program Files\boost\boost_1_37_0\lib-6.3 Library Naming
++6.3 Library Naming
@@ -668,11 +667,11 @@ following elements:Note
If, like Visual C++, your compiler supports auto-linking, -you can probably skip to the next step.
+you can probably skip to the next step.Prefix: except on Microsoft Windows, every Boost library name begins with this string. On Windows, only ordinary static libraries use the lib prefix; import libraries and DLLs do -not.6 +not.6boost_regex Library name: all boost library filenames begin with boost_. -vc71 -Toolset tag: identifies the toolset and version used to build + Toolset tag: identifies the toolset and version used to build the binary. -mt Threading tag: indicates that the library was @@ -703,17 +702,17 @@ libraries. using debug versions of the standard and runtime support libraries. y -using a special debug build of Python. +using a special debug build of Python. d -building a debug version of your code.7 +building a debug version of your code.7 p using the STLPort standard library rather than the default one supplied with your compiler. n -using STLPort's deprecated “native iostreams” feature.8 +using STLPort's deprecated “native iostreams” feature.8 --6.4 Test Your Program
++6.4 Test Your Program
To test our subject extraction, we'll filter the following text file. Copy it out of your browser and save it as jayne.txt:
@@ -756,7 +755,7 @@ Subject: Will Success Spoil Rock Hunter? --- See subject.-Now, in a command prompt window, type:
+Now, in a command prompt window, type:
path\to\compiled\example < path\to\jayne.txt@@ -767,23 +766,23 @@ Spoil Rock Hunter?”-7 Conclusion and Further Resources
++7 Conclusion and Further Resources
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 Boost Users' +make this document clearer, please post it to the Boost Users' mailing list.
-
- Boost.Build reference manual
-- Boost.Jam reference manual
-- Boost Users' mailing list
-- Boost.Build mailing list
-- Boost.Build Wiki
-- Index of all Boost library documentation
+- Boost.Build reference manual
+- Boost.Jam reference manual
+- Boost Users' mailing list
+- Boost.Build mailing list
+- Boost.Build Wiki
+- Index of all Boost library documentation
Onward
@@ -796,8 +795,8 @@ mailing list.
- [1] We recommend -downloading boost_1_36_0.7z and using 7-Zip to decompress + @@ -806,7 +805,7 @@ built-in decompression as it can be painfully slow for large archives. [1] We recommend +downloading boost_1_37_0.7z and using 7-Zip to decompress it. We no longer recommend .zip files for Boost because they are twice as large as the equivalent .7z files. We don't recommend using Windows' built-in decompression as it can be painfully slow for large archives.
- [2] If you used the installer from Boost + [2] If you used the installer from Boost Consulting and deselected “Source and Documentation” (it's selected by default), you won't see the libs/ subdirectory. That won't affect your ability to use precompiled binaries, but @@ -816,7 +815,7 @@ you won't be able to rebuild libraries from scratch.
- [3] There's no problem using Boost with precompiled headers; + @@ -825,7 +824,7 @@ used in the examples. [3] 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.
- [4] In this example, the caret character ^ is a +
[4] In this example, the caret character ^ is a way of continuing the command on multiple lines, and must be the final character used on the line to be continued (i.e. do not follow it with spaces). The command prompt responds with @@ -852,7 +851,7 @@ command-line argument contains spaces, as in
- [5] Remember that warnings are specific to each compiler + [5] 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 @@ -863,7 +862,7 @@ have any source code mechanism for suppressing warnings.
- [6] This convention distinguishes the static version of + @@ -872,7 +871,7 @@ same name. [6] 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.
- [7] These libraries were compiled without optimization + [7] These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other @@ -882,7 +881,7 @@ compiled code, you can't count on that with Boost libraries.
- [8] This feature of STLPort is deprecated because it's + [8] This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it.