source:
downloads/boost_1_34_1/more/getting_started/detail/distro.rst
@
29
Last change on this file since 29 was 29, checked in by landauf, 16 years ago | |
---|---|
File size: 3.0 KB |
The Boost Distribution
This is a sketch of the resulting directory structure:
|boost_ver-bold||//| .................The “boost root directory” index.htm .........A copy of www.boost.org starts here boost|//| .........................All Boost Header files |precompiled-dir| libs|//| ............Tests, .cpps, docs, etc., by library index.html ........Library documentation starts here algorithm|//| any|//| array|//| …more libraries… status|//| .........................Boost-wide test suite tools|//| ...........Utilities, e.g. bjam, quickbook, bcp more|//| ..........................Policy documents, etc. doc|//| ...............A subset of all Boost library docs
It's important to note the following:
The path to the boost root directory (often |default-root|) is sometimes referred to as $BOOST_ROOT in documentation and mailing lists .
To compile anything in Boost, you need a directory containing the boost|/| subdirectory in your #include path. |include-paths|
Since all of Boost's header files have the .hpp extension, and live in the boost|/| subdirectory of the boost root, your Boost #include directives will look like:
#include <boost/whatever.hpp>
or
#include "boost/whatever.hpp"
depending on your preference regarding the use of angle bracket includes. |forward-slashes|
Don't be distracted by the doc|/| subdirectory; it only contains a subset of the Boost documentation. Start with libs|/|index.html if you're looking for the whole enchilada.