]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE chapter PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" | |
3 | "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"> | |
4 | ||
5 | <chapter id="bbv2.installation"> | |
6 | <title>Installation</title> | |
7 | ||
8 | <para> | |
9 | To install Boost.Build from an official release or a nightly build, as | |
10 | available on the <ulink url="http://boost.org/boost-build2">official web site</ulink>, | |
11 | follow these steps: | |
12 | </para> | |
13 | ||
14 | <orderedlist> | |
15 | <listitem> | |
16 | <simpara> | |
17 | Unpack the release. On the command line, go to the root of the | |
18 | unpacked tree. | |
19 | </simpara> | |
20 | </listitem> | |
21 | ||
22 | <listitem> | |
23 | <simpara> | |
24 | Run either <command>.\bootstrap.bat</command> (on Windows), or | |
25 | <command>./bootstrap.sh</command> (on other operating systems). | |
26 | </simpara> | |
27 | </listitem> | |
28 | ||
29 | <listitem> | |
30 | <simpara> | |
31 | Run | |
32 | <screen>./b2 install --prefix=<replaceable>PREFIX</replaceable></screen> | |
33 | where <replaceable>PREFIX</replaceable> is a directory where you | |
34 | want Boost.Build to be installed. | |
35 | </simpara> | |
36 | </listitem> | |
37 | ||
38 | <listitem> | |
39 | <simpara> | |
40 | Optionally, add <filename><replaceable>PREFIX</replaceable>/bin</filename> | |
41 | to your <envar>PATH</envar> environment variable. | |
42 | </simpara> | |
43 | </listitem> | |
44 | </orderedlist> | |
45 | ||
46 | <para>If you are not using a Boost.Build package, but rather the version | |
47 | bundled with the Boost C++ Libraries, the above commands should be run | |
48 | in the <filename>tools/build</filename> directory.</para> | |
49 | ||
50 | <para> | |
51 | Now that Boost.Build is installed, you can try some of the examples. Copy | |
52 | <filename><replaceable>PREFIX</replaceable>/share/boost-build/examples/hello</filename> | |
53 | to a different directory, then change to that directory and run: | |
54 | <screen><filename><replaceable>PREFIX</replaceable>/bin/b2</filename></screen> | |
55 | A simple executable should be built. | |
56 | </para> | |
57 | ||
58 | <!-- | |
59 | <simpara> | |
60 | Configure Boost.Build to recognize the build resources (such | |
61 | as compilers and libraries) you have installed on your | |
62 | system. Open the | |
63 | <filename>user-config.jam</filename> file in the Boost.Build | |
64 | root directory and follow the instructions there to describe | |
65 | your toolsets and libraries, and, if necessary, where they | |
66 | are located. | |
67 | </simpara> | |
68 | </listitem> | |
69 | --> | |
70 | ||
71 | <!-- This part should not go into intoduction docs, but we need to | |
72 | place it somewhere. | |
73 | ||
74 | <para>It is slighly better way is to copy | |
75 | <filename>new/user-config.jam</filename> into one of the locations | |
76 | where it can be found (given in <link linkend= | |
77 | "bbv2.reference.init.config">this table</link>). This prevent you | |
78 | from accidentally overwriting your config when updating.</para> | |
79 | ||
80 | --> | |
81 | ||
82 | <!-- | |
83 | <bridgehead>Information for distributors</bridgehead> | |
84 | ||
85 | <para> | |
86 | If you're planning to package Boost.Build for a Linux distribution, | |
87 | please follow these guidelines: | |
88 | ||
89 | <itemizedlist> | |
90 | <listitem><para>Create a separate package for Boost.Jam.</para></listitem> | |
91 | ||
92 | <listitem> | |
93 | <para>Create another package for Boost.Build, and make | |
94 | this package install all Boost.Build files to | |
95 | <filename>/usr/share/boost-build</filename> directory. After | |
96 | install, that directory should contain everything you see in | |
97 | Boost.Build release package, except for | |
98 | <filename>jam_src</filename> directory. If you're using Boost CVS | |
99 | to obtain Boost.Build, as opposed to release package, take | |
100 | everything from the <filename>tools/build</filename> directory. | |
101 | For a check, make sure that | |
102 | <filename>/usr/share/boost-build/boost-build.jam</filename> is installed. | |
103 | </para> | |
104 | ||
105 | <para>Placing Boost.Build into <filename>/usr/share/boost-build</filename> | |
106 | will make sure that <command>b2</command> will find Boost.Build | |
107 | without any additional setup.</para> | |
108 | </listitem> | |
109 | ||
110 | <listitem><para>Provide a | |
111 | <filename>/etc/site-config.jam</filename> configuration file that will | |
112 | contain: | |
113 | <programlisting> | |
114 | using gcc ; | |
115 | </programlisting> | |
116 | You might want to add dependency from Boost.Build package to gcc, | |
117 | to make sure that users can always build Boost.Build examples. | |
118 | </para></listitem> | |
119 | </itemizedlist> | |
120 | </para> | |
121 | ||
122 | <para>If those guidelines are met, users will be able to invoke | |
123 | <command>b2/command> without any explicit configuration. | |
124 | </para> | |
125 | ||
126 | ||
127 | --> | |
128 | ||
129 | ||
130 | </chapter> | |
131 | ||
132 | <!-- | |
133 | Local Variables: | |
134 | mode: nxml | |
135 | sgml-indent-data:t | |
136 | sgml-parent-document:("userman.xml" "chapter") | |
137 | sgml-set-face: t | |
138 | sgml-omittag:nil | |
139 | sgml-shorttag:nil | |
140 | sgml-namecase-general:t | |
141 | sgml-general-insert-case:lower | |
142 | sgml-minimize-attributes:nil | |
143 | sgml-always-quote-attributes:t | |
144 | sgml-indent-step:2 | |
145 | sgml-exposed-tags:nil | |
146 | sgml-local-catalogs:nil | |
147 | sgml-local-ecat-files:nil | |
148 | End: | |
149 | --> | |
150 |