Boost C++ Libraries

The following instructions explain how to install Docbook XML, Docbook XSL and Doxygen in a Mac OS X system, how to configure Boost.Build v2 to recognize them and how to build and install Quickbook. They were taken from a 10.4 (Tiger) machine so it is likely that they also apply to future versions; they may not work with older ones, though.

The text below assumes you want to install all the necessary utilities in a system-wide location, allowing any user in the machine to have access to them. Therefore, all files will be put in the /usr/local hierarchy. If you do not want this, you can choose any other prefix such as ~/Applications for a single-user installation.

Mac OS X comes with xsltproc and all related libraries preinstalled, so you do not need to take any extra steps to set them up. It is probable that future versions will include them too, but these instructions may not apply to older versions.

To get started:

using xsltproc ;

using boostbook
    : "/usr/local/share/xsl/docbook"
    : "/usr/local/share/xml/docbook/4.2"
    ;

The above steps are enough to get a functional BoostBook setup. Quickbook will be automatically built when needed. If you want to avoid these rebuilds and install a system-wide Quickbook instead:

using quickbook
    : "/usr/local/bin/quickbook" ;
    ;

Additionally, if you need to build documentation that uses Doxygen, you will need to install it too:

using doxygen
    : /Applications/Doxygen.app/Contents/Resources/doxygen
    ;

Alternatively, you may want to install all the prerequistes through a package system to avoid manual management of the installations. In that case, check out pkgsrc.

The following instructions apply to any Windows system based on Windows 2000, including Windows XP, Windows 2003 Server and Windows Vista. The paths shown below are taken from a Windows Vista machine; you will need to adjust them to match your system in case you are running an older version.

using xsltproc
    : "C:/Users/example/Documents/boost/xml/bin/xsltproc.exe"
    ;

using boostbook
    : "C:/Users/example/Documents/boost/xml/docbook-xsl"
    : "C:/Users/example/Documents/boost/xml/docbook-xml"
    ;

The above steps are enough to get a functional BoostBook setup. Quickbook will be automatically built when needed. If you want to avoid these rebuilds:

using quickbook
    : "C:/Users/example/Documents/boost/xml/bin/quickbook.exe"
    ;

The following instructions apply to Debian and its derivatives. They are based on a Ubuntu Edgy install but should work on other Debian based systems.

First install the bjam, xsltproc, docbook-xsl and docbook-xml packages. For example, using apt-get:

sudo apt-get install xsltproc docbook-xsl docbook-xml

If you're planning on building boost's documentation, you'll also need to install the doxygen package as well.

Next, we need to configure Boost Build to compile BoostBook files. Add the following to your user-config.jam file, which should be in your home directory. If you don't have one, create a file containing this text. For more information on setting up user-config.jam, see the Boost Build documentation.

using xsltproc ;

using boostbook
    : /usr/share/xml/docbook/stylesheet/nwalsh
    : /usr/share/xml/docbook/schema/dtd/4.2
    ;

# Remove this line if you're not using doxygen
using doxygen ;

The above steps are enough to get a functional BoostBook setup. Quickbook will be automatically built when needed. If you want to avoid these rebuilds:

using quickbook
    : /usr/local/bin/quickbook
    ;