|
Table of Contents
This section provides some guidelines on how to install and configure BoostBook
and Quickbook under several operating systems. Before installing you'll need
a local copy of boost, and to install the version of bjam which
comes with it (or a later version).
The simplest way to install on OS X is to use macports. If you don't want
to use macports and are using Snow Leopard or later, there are instructions
later. Earlier versions
of OS X need to use something like macports to install xsltproc
because the version they come with is very old, and doesn't have good enough
XSL support for boostbook's stylesheets.
First install the libxslt, docbook-xsl and
docbook-xml-4.2 packages:
sudo port install libxslt docbook-xsl docbook-xml-4.2
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
: /opt/local/bin/xsltproc
;
using boostbook
: /opt/local/share/xsl/docbook-xsl/
: /opt/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:
BOOST_ROOT/tools/quickbook).
bjam.
quickbook binary (located at BOOST_ROOT/dist/bin)
to a safe place. The traditional location is /usr/local/bin.
Add the following to your user-config.jam file, using
the full path of the quickbook executable:
using quickbook
: /usr/local/bin/quickbook
;
If you need to build documentation that uses Doxygen, you will need to install it as well:
sudo port install doxygen
And then add to your user-config.jam:
using doxygen ;
Alternatively, you can install from the official doxygen dmg.
This is described at the end of
the next section.
Section contributed by Julio M. Merino Vidal
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.
Snow Leopard 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:
/usr/local/share/xml/docbook/4.2.
docbook-xsl-1.nn.n.tar.bz2, with
no suffix such as -ns.tar.bz2 or -doc.tar.bz2.
Put the results in /usr/local/share/xsl/docbook, thus
effectively removing the version number from the directory name (for
simplicity).
Add the following to your user-config.jam file, which
should live in your home directory (/Users/<your_username>).
You must already have it somewhere or otherwise you could not be
building Boost (i.e. missing tools configuration).
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:
BOOST_ROOT/tools/quickbook).
bjam.
quickbook binary (located at BOOST_ROOT/dist/bin)
to a safe place. Following our previous example, you can install
it into: /usr/local/bin.
Add the following to your user-config.jam file:
using quickbook
: "/usr/local/bin/quickbook" ;
;
Additionally, if you need to build documentation that uses Doxygen, you will need to install it too:
dmg file) for
Mac OS X.
Applications
folder to install it.
Add the following to your user-config.jam file:
using doxygen
: /Applications/Doxygen.app/Contents/Resources/doxygen
;