diff --git a/more/getting_started/detail/build-from-source-head.rst b/more/getting_started/detail/build-from-source-head.rst index 7e55da83b1..b2dfd5cad1 100644 --- a/more/getting_started/detail/build-from-source-head.rst +++ b/more/getting_started/detail/build-from-source-head.rst @@ -10,7 +10,7 @@ installing software. To use it, you'll need an executable called .. _precompiled-bjam: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941 -.. _Boost.Jam documentation: Boost.Jam_ +.. .. _Boost.Jam documentation: Boost.Jam_ .. _Boost.Build: ../../tools/build/index.html .. _Boost.Jam: ../../tools/jam/index.html .. _Boost.Build documentation: Boost.Build_ diff --git a/more/getting_started/detail/header-only.rst b/more/getting_started/detail/header-only.rst index 13d7e3fd7d..c1f1dd3b3e 100644 --- a/more/getting_started/detail/header-only.rst +++ b/more/getting_started/detail/header-only.rst @@ -15,20 +15,23 @@ Boost?” The good news is that often, there's nothing to build. require no separately-compiled library binaries or special treatment when linking. -.. _separate: +.. .. _separate: The only Boost libraries that *must* be built separately are: * Boost.Filesystem_ * Boost.IOStreams_ * Boost.ProgramOptions_ -* Boost.Python_ +* Boost.Python_ (see the `Boost.Python build documentation`__ + before building and installing it) * Boost.Regex_ * Boost.Serialization_ * Boost.Signals_ * Boost.Thread_ * Boost.Wave_ +__ ../../libs/python/doc/building.html + A few libraries have optional separately-compiled binaries: * Boost.DateTime_ has a binary component that is only needed if diff --git a/more/getting_started/detail/library-naming.rst b/more/getting_started/detail/library-naming.rst index ad1d512232..76d99ed5c2 100644 --- a/more/getting_started/detail/library-naming.rst +++ b/more/getting_started/detail/library-naming.rst @@ -19,7 +19,7 @@ following elements: *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`` @@ -68,13 +68,13 @@ following elements: ``.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 version number, will also be created. -.. _Boost.Build toolset names: toolset-name_ +.. .. _Boost.Build toolset names: toolset-name_ __ ../../libs/python/doc/building.html#variants diff --git a/more/getting_started/detail/release-variables.rst b/more/getting_started/detail/release-variables.rst index c8dc919531..1adbd3fb67 100644 --- a/more/getting_started/detail/release-variables.rst +++ b/more/getting_started/detail/release-variables.rst @@ -9,4 +9,4 @@ .. |boost_ver| replace:: ``boost_1_34_0`` .. |boost_ver-bold| replace:: **boost_1_34_0** -.. _sf-download: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041&release_id=376197 \ No newline at end of file +.. _sf-download: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041 \ No newline at end of file diff --git a/more/getting_started/index.html b/more/getting_started/index.html index c72e124216..2f60d00baa 100644 --- a/more/getting_started/index.html +++ b/more/getting_started/index.html @@ -9,19 +9,19 @@
-

Getting Started

+

Getting Started

-
-

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 @@ -29,8 +29,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 @@ -41,16 +41,16 @@ provide. For example:

Here you're expected to imagine replacing the text “your name” with your actual name.

-
-

Ready?

+
+

Ready?

Let's go!

-
Next: Getting Started on Microsoft Windows
-
or: Getting Started on Unix variants (e.g. Linux, MacOS)
+
Next: Getting Started on Microsoft Windows
+
or: Getting Started on Unix variants (e.g. Linux, MacOS)
diff --git a/more/getting_started/unix-variants.html b/more/getting_started/unix-variants.html index 68c2ef0402..3e8f61bc69 100644 --- a/more/getting_started/unix-variants.html +++ b/more/getting_started/unix-variants.html @@ -10,7 +10,7 @@
-

Getting Started on Unix Variants

+

Getting Started on Unix Variants

@@ -27,43 +27,43 @@ .. _`Getting Started on Windows`: windows.html .. _Cygwin: http://www.cygwin.com .. _MinGW: http://mingw.org --> -
-

Index

+ -
-

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:

    -

  1. Download boost_1_34_0.tar.bz2.

    +

  2. Download boost_1_34_0.tar.bz2.

  3. In the directory where you want to put the Boost installation, execute

    @@ -79,16 +79,16 @@ library packages, however you may need to adapt these instructions if you use third-party packages, because their creators usually choose to break Boost up into several packages, reorganize the directory structure of the Boost distribution, -and/or rename the library binaries.1 If you have +and/or rename the library binaries.1 If you have any trouble, we suggest using an official Boost distribution -from SourceForge.

    +from SourceForge.

-
-

2   The Boost Distribution

+
+

2   The Boost Distribution

This is a sketch of the resulting directory structure:

 boost_1_34_0/ .................The “boost root directory”
@@ -123,7 +123,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.
 
    
@@ -165,8 +165,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.

    @@ -176,26 +176,28 @@ of header files containing templates and inline functions, and require no separately-compiled library binaries or special treatment when linking.

    -

    The only Boost libraries that must be built separately are:

    + +

    The only Boost libraries that must be built separately are:

    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.
    @@ -203,8 +205,8 @@ 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 @@ -237,25 +239,25 @@ 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):

    @@ -280,34 +282,35 @@ 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.
    
-
    skip to the next step
    
+
    skip to the next step
    -
    -

    5.2   Or, Custom Build and Install

    +
    +

    5.2   Or, Custom Build and Install

    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.

    - +
    @@ -333,7 +336,7 @@ known to work well with Boost @@ -405,20 +408,20 @@ affect this step in any way; you still need to select a Boost.Build toolset from the table.

    -
    -

    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 stage
+bjam --build-dir=build-directory --toolset=toolset-name stage

    For example, your session might look like this:

    @@ -429,7 +432,7 @@ $ bjam --build-dir=/tmp/build-boost --toolset=
 
 
 
    Boost.Build will place the Boost binaries in the stage/
-subdirectory of your build directory.
    
+subdirectory of your build directory.
    
 
    
 
    Note
    
 
    bjam is case-sensitive; it is important that all the
@@ -450,8 +453,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

      @@ -474,29 +477,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

    +
    como Comeau Computing Using this toolset may -require configuring another +require configuring another toolset to act as its backend
    cw
    +
    @@ -601,17 +604,17 @@ libraries. - + - + - +
    using debug versions of the standard and runtime support libraries.
    yusing a special debug build of Python.using a special debug build of Python.
    dbuilding a debug version of your code.5building a debug version of your code.5
    p using the STLPort standard library rather than the default one supplied with your compiler.
    nusing STLPort's deprecated “native iostreams” feature.6using STLPort's deprecated “native iostreams” feature.6
    @@ -632,18 +635,19 @@ 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 version number, will also be created. +
    -
    -

    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:

    @@ -682,23 +686,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.

    Onward

    @@ -711,17 +715,17 @@ mailing list.

    -
    [1]

    If developers of Boost packages would like to work +

    [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.

    +to the Boost developers' list.
    -
    [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.
    @@ -731,7 +735,7 @@ 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 @@ -742,7 +746,7 @@ have any source code mechanism for suppressing warnings.
    - @@ -751,7 +755,7 @@ same name.
    [4]This convention distinguishes the static version of +
    [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 @@ -761,7 +765,7 @@ compiled code, you can't count on that with Boost libraries.
    - diff --git a/more/getting_started/unix-variants.rst b/more/getting_started/unix-variants.rst index 6924468c96..fe39dba943 100644 --- a/more/getting_started/unix-variants.rst +++ b/more/getting_started/unix-variants.rst @@ -40,7 +40,7 @@ distribution from SourceForge_: .. _SourceForge: `sf-download`_ -1. Download |boost.tar.bz2|. +1. Download |boost.tar.bz2|_. 2. In the directory where you want to put the Boost installation, execute diff --git a/more/getting_started/windows.html b/more/getting_started/windows.html index dbf529ee30..9d2a8d56fc 100644 --- a/more/getting_started/windows.html +++ b/more/getting_started/windows.html @@ -9,74 +9,74 @@
    -

    Getting Started on Windows

    +

    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

    +
    +

    Index

    -
    -

    1   Get Boost

    -

    The easiest way to get a copy of Boost is to use the installer -provided by Boost Consulting. We especially recommend this +

    +

    1   Get Boost

    +

    The easiest way to get a copy of Boost is to use the installer +provided by Boost Consulting. We especially recommend this method if you use Microsoft Visual Studio .NET 2003 or Microsoft Visual Studio 2005, because the installer can download and install precompiled library binaries, saving you the trouble of building them yourself. To complete this tutorial, you'll need to at least -install the 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_34_0.exe and run it to install a complete Boost -distribution.1

    +download boost_1_34_0.exe and run 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_34_0\ .................The “boost root directory”
@@ -111,7 +111,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.
 
    
@@ -158,8 +158,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.

    @@ -169,26 +169,28 @@ of header files containing templates and inline functions, and require no separately-compiled library binaries or special treatment when linking.

    -

    The only Boost libraries that must be built separately are:

    + +

    The only Boost libraries that must be built separately are:

    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.
    @@ -196,8 +198,8 @@ 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 @@ -218,11 +220,11 @@ int main() }

    Copy the text of this program into a file called example.cpp.

    -
    -

    Note

    +
    +

    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 @@ -252,8 +254,8 @@ cd C:\Program ^) 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

    • From Visual Studio's File menu, select New > Project…

      • @@ -276,7 +278,7 @@ Directories, enter the path to the Boost root directory, for example

    • In Configuration Properties > C/C++ > Precompiled Headers, change Use Precompiled Header (/Yu) to Not Using Precompiled -Headers.3

      +Headers.3

    • Replace the contents of the example.cpp generated by the IDE with the example code above.

      @@ -291,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.

      -

      skip to the next step

      +

      skip to the next step

    -
    -

    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

    @@ -304,8 +306,8 @@ Studio 2005 user, select

    All 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:

    @@ -319,58 +321,59 @@ 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 (2005 or .NET 2003) Binaries

    -

    The installer supplied by Boost Consulting will download and +

    +

    5.1   Install Visual Studio (2005 or .NET 2003) Binaries

    +

    The installer supplied by Boost Consulting will download and install pre-compiled binaries into the lib\ subdirectory of the boost root, typically C:\Program Files\boost\boost_1_34_0\lib\. If you installed -all variants of the Boost.Regex binary, you're done with this +all variants of the Boost.Regex binary, you're done with this step. Otherwise, please run the installer again and install them now.

    -

    skip to the next step

    +

    skip to the next step

    -
    -

    5.2   Or, Build and Install Binaries From Source

    +
    +

    5.2   Or, Build and Install 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.

    -
    [6]This feature of STLPort is deprecated because it's +
    [6]This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it.
    +
    @@ -396,7 +399,7 @@ known to work well with Boost @@ -468,22 +471,22 @@ affect this step in any way; you still need to select a Boost.Build toolset from the table.

    -
    -

    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 stage
+bjam --build-dir=build-directory --toolset=toolset-name 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_34_0
 C:\Program Files\boost\boost_1_34_0> bjam ^
@@ -494,7 +497,7 @@ More? --toolset=msvc stage
 
 
 
    Boost.Build will place the Boost binaries in the stage\
-subdirectory of your build directory.
    
+subdirectory of your build directory.
    
 
    
 
    Note
    
 
    bjam is case-sensitive; it is important that all the
@@ -515,8 +518,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

      @@ -539,29 +542,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.1   Link From Within the Visual Studio IDE

    -

    Starting with the header-only example project we created +

    -
    -

    6.2   Or, Link From the Command Prompt

    + -
    -

    6.3   Library Naming

    +
    +

    6.3   Library Naming

    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.

    @@ -647,11 +650,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.6
    +not.6
    boost_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 @@ -663,7 +666,7 @@ of -mt.
    interoperability with other compiled code. For each such feature, a single letter is added to the tag:

    -
    como Comeau Computing Using this toolset may -require configuring another +require configuring another toolset to act as its backend
    cw
    +
    @@ -682,17 +685,17 @@ libraries. - + - + - +
    using debug versions of the standard and runtime support libraries.
    yusing a special debug build of Python.using a special debug build of Python.
    dbuilding a debug version of your code.7building a debug version of your code.7
    p using the STLPort standard library rather than the default one supplied with your compiler.
    nusing STLPort's deprecated “native iostreams” feature.8using STLPort's deprecated “native iostreams” feature.8
    @@ -713,18 +716,19 @@ 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 version number, will also be created. +
    -
    -

    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:

    @@ -734,7 +738,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
    @@ -745,23 +749,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.

    Onward

    @@ -774,8 +778,8 @@ mailing list.

    - @@ -783,7 +787,7 @@ it can be painfully slow for large archives.
    [1]If you prefer not to download executable programs, -download boost_1_34_0.zip and use an external tool to decompress +
    [1]If you prefer not to download executable programs, +download boost_1_34_0.zip 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.
    -
    [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 @@ -793,7 +797,7 @@ you won't be able to rebuild libraries from scratch.
    - @@ -802,7 +806,7 @@ used in the examples.
    [3]There's no problem using Boost with precompiled headers; +
    [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. The command prompt responds with More? to prompt for more input. Feel free to omit the carets and subsequent newlines; we used them so @@ -815,7 +819,7 @@ the example would fit on a page of reasonable width.
    -
    [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 @@ -826,7 +830,7 @@ have any source code mechanism for suppressing warnings.
    - @@ -835,7 +839,7 @@ same name.
    [6]This convention distinguishes the static version of +
    [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 @@ -845,7 +849,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.