From 2be42b99c12f99b0729c03d674f3d4756cc02ede Mon Sep 17 00:00:00 2001 From: Vladimir Prus Date: Tue, 20 Jul 2010 09:22:20 +0000 Subject: [PATCH] Adjust install docs for current improvements [SVN r64194] --- doc/src/install.xml | 164 ++++++++++++-------------------------------- 1 file changed, 43 insertions(+), 121 deletions(-) diff --git a/doc/src/install.xml b/doc/src/install.xml index 3dd30bf1e..274f269a0 100644 --- a/doc/src/install.xml +++ b/doc/src/install.xml @@ -6,92 +6,57 @@ Installation - This section describes how to install Boost.Build from a - released Boost - source distribution - or CVS - image. - - Note that packages prepared for - Unix/Linux systems usually make their own choices about where to - put things and even which parts of Boost to include. When we - say “released source distribution” we mean a - distribution of Boost as released on its SourceForge - project - page. - - -All paths are given relative to - the Boost.Build v2 root directory, which is - - - - - - located in the tools/build/v2 subdirectory - of a full Boost distribution. - - The Boost.Build subset of boost is also distributed - separately, for those who are only interested in getting a - build tool. The top-level directory of a Boost.Build - distribution contains all the subdirectories of the - tools/build/v2 subdirectory from a full - Boost distribution, so it is itself a valid Boost.Build root - directory. It also contains the - tools/jam/src subdirectory of a - full Boost distribution, so you can rebuild Boost.Jam from - source. - - + To install Boost.Build from an official release or a nightly build, as + available on the official web site, + follow these steps: - Boost.Build uses Boost.Jam, an - extension of the Perforce - Jam portable make replacement. The - recommended way to get Boost.Jam is to download - a prebuilt executable from SourceForge. - If a prebuilt executable is not provided for your platform - or you are using Boost's sources in an unreleased state, it - may be necessary to - build bjam - from sources included in the Boost source tree. + Unpack the release. On the command line, go to the root of the + unpacked tree. - - - To install Boost.Jam, copy the executable, - called bjam - or bjam.exe to a location accessible in - your PATH. Go to the Boost.Build root - directory and - run bjam . You - should see: - - - Boost.Build V2 (Milestone N) - Boost.Jam xx.xx.xx - - - where N is the version of Boost.Build you're using. - + + Run either .\bootstrap.bat (on Windows), or + ./bootstrap.sh (on other operating systmes). + + Run + +./bjam install --prefix=PREFIX + + where PREFIX is a directory where you + want Boost.Build to be installed. + + + + + + Optionally, add PREFIX/bin + to your PATH environment variable. + + + + + + Now that Boost.Build is installed, you can try some of examples. Copy + PREFIX/share/boost-build/examples/hello + to a different directory, then change to that directory and run: + +PREFIX/bin/bjam + + A simple executable should be build. + + + - - - You should now be able to go to the - example/hello/ directory and run - bjam there. A simple application will be - built. You can also play with other projects in the - example/ directory. - - - - - If you are using Boost's CVS state, be sure to - rebuild bjam even if you have a previous - version. The CVS version of Boost.Build requires the CVS - version of Boost.Jam. - - - - When bjam is invoked, it always needs to be - able to find the Boost.Build root directory, where the - interpreted source code of Boost.Build is located. There are - two ways to tell bjam about the root directory: - - - - - - Set the environment variable BOOST_BUILD_PATH - to the absolute path of the Boost.Build root directory. - - - - - - At the root directory of your project or in any of its - parent directories, create a file called - boost-build.jam, with a single line: - - -boost-build /path/to/boost.build ; - - - - - - - Information for distributors + +