unix-variants.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
  7. <title>Boost Getting Started on Unix Variants</title>
  8. <meta content="Getting Started with Boost on Unix Variants (including Linux and MacOS)" name="description" />
  9. <link rel="stylesheet" href="../../rst.css" type="text/css" />
  10. </head>
  11. <body>
  12. <div class="document" id="logo-getting-started-on-unix-variants">
  13. <h1 class="title"><a class="reference external" href="../../index.htm"><img alt="Boost" class="boost-logo" src="../../boost.png" /></a> Getting Started on Unix Variants</h1>
  14. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  15. <!-- Software License, Version 1.0. (See accompanying -->
  16. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  17. <!-- maybe we don't need this
  18. .. Admonition:: A note to Cygwin_ and MinGW_ users
  19. If you plan to build from the Cygwin_ bash shell, you're in the
  20. right place. If you plan to use your tools from the Windows
  21. command prompt, you should follow the instructions for `getting
  22. started on Windows`_. Other command shells, such as MinGW_\ 's
  23. MSYS, are not supported—they may or may not work.
  24. .. _`Getting Started on Windows`: windows.html
  25. .. _Cygwin: http://www.cygwin.com
  26. .. _MinGW: http://mingw.org -->
  27. <div class="contents topic" id="index">
  28. <p class="topic-title first">Index</p>
  29. <ul class="auto-toc simple">
  30. <li><a class="reference internal" href="#get-boost" id="id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></li>
  31. <li><a class="reference internal" href="#the-boost-distribution" id="id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></li>
  32. <li><a class="reference internal" href="#header-only-libraries" id="id22">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></li>
  33. <li><a class="reference internal" href="#build-a-simple-program-using-boost" id="id23">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a><ul class="auto-toc">
  34. <li><a class="reference internal" href="#errors-and-warnings" id="id24">4.1&nbsp;&nbsp;&nbsp;Errors and Warnings</a></li>
  35. </ul>
  36. </li>
  37. <li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id25">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
  38. <li><a class="reference internal" href="#easy-build-and-install" id="id26">5.1&nbsp;&nbsp;&nbsp;Easy Build and Install</a></li>
  39. <li><a class="reference internal" href="#or-build-custom-binaries" id="id27">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a><ul class="auto-toc">
  40. <li><a class="reference internal" href="#get-bjam" id="id28">5.2.1&nbsp;&nbsp;&nbsp;Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
  41. <li><a class="reference internal" href="#identify-your-toolset" id="id29">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
  42. <li><a class="reference internal" href="#select-a-build-directory" id="id30">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
  43. <li><a class="reference internal" href="#invoke-bjam" id="id31">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
  44. </ul>
  45. </li>
  46. <li><a class="reference internal" href="#expected-build-output" id="id32">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
  47. <li><a class="reference internal" href="#in-case-of-build-errors" id="id33">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></li>
  48. </ul>
  49. </li>
  50. <li><a class="reference internal" href="#link-your-program-to-a-boost-library" id="id34">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a><ul class="auto-toc">
  51. <li><a class="reference internal" href="#library-naming" id="id35">6.1&nbsp;&nbsp;&nbsp;Library Naming</a></li>
  52. <li><a class="reference internal" href="#test-your-program" id="id36">6.2&nbsp;&nbsp;&nbsp;Test Your Program</a></li>
  53. </ul>
  54. </li>
  55. <li><a class="reference internal" href="#conclusion-and-further-resources" id="id37">7&nbsp;&nbsp;&nbsp;Conclusion and Further Resources</a></li>
  56. </ul>
  57. </div>
  58. <div class="section" id="get-boost">
  59. <h1><a class="toc-backref" href="#id20">1&nbsp;&nbsp;&nbsp;Get Boost</a></h1>
  60. <p>The most reliable way to get a copy of Boost is to download a
  61. distribution from <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041">SourceForge</a>:</p>
  62. <ol class="arabic">
  63. <li><p class="first">Download <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041"><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt><tt class="docutils literal"><span class="pre">.tar.bz2</span></tt></a>.</p>
  64. </li>
  65. <li><p class="first">In the directory where you want to put the Boost installation,
  66. execute</p>
  67. <pre class="literal-block">
  68. tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt>.tar.bz2
  69. </pre>
  70. </li>
  71. </ol>
  72. <div class="admonition-other-packages admonition">
  73. <p class="first admonition-title">Other Packages</p>
  74. <p class="last">RedHat, Debian, and other distribution packagers supply Boost
  75. library packages, however you may need to adapt these
  76. instructions if you use third-party packages, because their
  77. creators usually choose to break Boost up into several packages,
  78. reorganize the directory structure of the Boost distribution,
  79. and/or rename the library binaries.<a class="footnote-reference" href="#packagers" id="id2"><sup>1</sup></a> If you have
  80. any trouble, we suggest using an official Boost distribution
  81. from <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=8041">SourceForge</a>.</p>
  82. </div>
  83. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  84. <!-- Software License, Version 1.0. (See accompanying -->
  85. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  86. </div>
  87. <div class="section" id="the-boost-distribution">
  88. <h1><a class="toc-backref" href="#id21">2&nbsp;&nbsp;&nbsp;The Boost Distribution</a></h1>
  89. <p>This is a sketch of the resulting directory structure:</p>
  90. <pre class="literal-block">
  91. <strong>boost_1_43_0</strong><strong>/</strong> .................<em>The “boost root directory”</em>
  92. <strong>index.htm</strong> .........<em>A copy of www.boost.org starts here</em>
  93. <strong>boost</strong><strong>/</strong> .........................<em>All Boost Header files</em>
  94. <tt class="docutils literal"> </tt>
  95. <strong>libs</strong><strong>/</strong> ............<em>Tests, .cpp</em>s<em>, docs, etc., by library</em>
  96. <strong>index.html</strong> ........<em>Library documentation starts here</em>
  97. <strong>algorithm</strong><strong>/</strong>
  98. <strong>any</strong><strong>/</strong>
  99. <strong>array</strong><strong>/</strong>
  100. <em>…more libraries…</em>
  101. <strong>status</strong><strong>/</strong> .........................<em>Boost-wide test suite</em>
  102. <strong>tools</strong><strong>/</strong> ...........<em>Utilities, e.g. bjam, quickbook, bcp</em>
  103. <strong>more</strong><strong>/</strong> ..........................<em>Policy documents, etc.</em>
  104. <strong>doc</strong><strong>/</strong> ...............<em>A subset of all Boost library docs</em>
  105. </pre>
  106. <div class="sidebar">
  107. <p class="first sidebar-title">Header Organization</p>
  108. <p class="pre-wrap">The organization of Boost library headers isn't entirely uniform,
  109. but most libraries follow a few patterns:</p>
  110. <ul class="pre-wrap last">
  111. <li><p class="first">Some older libraries and most very small libraries place all
  112. public headers directly into <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt>.</p>
  113. </li>
  114. <li><p class="first">Most libraries' public headers live in a subdirectory of
  115. <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt>, named after the library. For example, you'll find
  116. the Python library's <tt class="docutils literal"><span class="pre">def.hpp</span></tt> header in</p>
  117. <pre class="literal-block">
  118. <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">python</span></tt><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">def.hpp</span></tt>.
  119. </pre>
  120. </li>
  121. <li><p class="first">Some libraries have an “aggregate header” in <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> that
  122. <tt class="docutils literal"><span class="pre">#include</span></tt>s all of the library's other headers. For
  123. example, <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a>'s aggregate header is</p>
  124. <pre class="literal-block">
  125. <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">python.hpp</span></tt>.
  126. </pre>
  127. </li>
  128. <li><p class="first">Most libraries place private headers in a subdirectory called
  129. <tt class="docutils literal"><span class="pre">detail</span></tt><tt class="docutils literal"><span class="pre">/</span></tt>, or <tt class="docutils literal"><span class="pre">aux_</span></tt><tt class="docutils literal"><span class="pre">/</span></tt>. Don't expect to find
  130. anything you can use in these directories.</p>
  131. </li>
  132. </ul>
  133. </div>
  134. <p>It's important to note the following:</p>
  135. <ol class="arabic" id="boost-root-directory">
  136. <li><p class="first">The path to the <strong>boost root directory</strong> (often <tt class="docutils literal"><span class="pre">/usr/local/</span></tt><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt>) is
  137. sometimes referred to as <tt class="docutils literal"><span class="pre">$BOOST_ROOT</span></tt> in documentation and
  138. mailing lists .</p>
  139. </li>
  140. <li><p class="first">To compile anything in Boost, you need a directory containing
  141. the <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> subdirectory in your <tt class="docutils literal"><span class="pre">#include</span></tt> path. <tt class="docutils literal"> </tt></p>
  142. </li>
  143. <li><p class="first">Since all of Boost's header files have the <tt class="docutils literal"><span class="pre">.hpp</span></tt> extension,
  144. and live in the <tt class="docutils literal"><span class="pre">boost</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> subdirectory of the boost root, your
  145. Boost <tt class="docutils literal"><span class="pre">#include</span></tt> directives will look like:</p>
  146. <pre class="literal-block">
  147. #include &lt;boost/<em>whatever</em>.hpp&gt;
  148. </pre>
  149. <p>or</p>
  150. <pre class="literal-block">
  151. #include &quot;boost/<em>whatever</em>.hpp&quot;
  152. </pre>
  153. <p>depending on your preference regarding the use of angle bracket
  154. includes. <tt class="docutils literal"> </tt></p>
  155. </li>
  156. <li><p class="first">Don't be distracted by the <tt class="docutils literal"><span class="pre">doc</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> subdirectory; it only
  157. contains a subset of the Boost documentation. Start with
  158. <tt class="docutils literal"><span class="pre">libs</span></tt><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">index.html</span></tt> if you're looking for the whole enchilada.</p>
  159. </li>
  160. </ol>
  161. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  162. <!-- Software License, Version 1.0. (See accompanying -->
  163. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  164. </div>
  165. <div class="section" id="header-only-libraries">
  166. <h1><a class="toc-backref" href="#id22">3&nbsp;&nbsp;&nbsp;Header-Only Libraries</a></h1>
  167. <p>The first thing many people want to know is, “how do I build
  168. Boost?” The good news is that often, there's nothing to build.</p>
  169. <div class="admonition-nothing-to-build admonition">
  170. <p class="first admonition-title">Nothing to Build?</p>
  171. <p class="last">Most Boost libraries are <strong>header-only</strong>: they consist <em>entirely
  172. of header files</em> containing templates and inline functions, and
  173. require no separately-compiled library binaries or special
  174. treatment when linking.</p>
  175. </div>
  176. <!-- .. _separate: -->
  177. <p>The only Boost libraries that <em>must</em> be built separately are:</p>
  178. <ul class="simple">
  179. <li><a class="reference external" href="../../libs/filesystem/index.html">Boost.Filesystem</a></li>
  180. <li><a class="reference external" href="../../libs/iostreams/index.html">Boost.IOStreams</a></li>
  181. <li><a class="reference external" href="../../libs/program_options/index.html">Boost.ProgramOptions</a></li>
  182. <li><a class="reference external" href="../../libs/python/doc/building.html">Boost.Python</a> (see the <a class="reference external" href="../../libs/python/doc/building.html">Boost.Python build documentation</a>
  183. before building and installing it)</li>
  184. <li><a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a></li>
  185. <li><a class="reference external" href="../../libs/serialization/index.html">Boost.Serialization</a></li>
  186. <li><a class="reference external" href="../../libs/signals/index.html">Boost.Signals</a></li>
  187. <li><a class="reference external" href="../../libs/system/index.html">Boost.System</a></li>
  188. <li><a class="reference external" href="../../doc/html/thread.html">Boost.Thread</a></li>
  189. <li><a class="reference external" href="../../libs/wave/index.html">Boost.Wave</a></li>
  190. </ul>
  191. <p>A few libraries have optional separately-compiled binaries:</p>
  192. <ul class="simple">
  193. <li><a class="reference external" href="../../libs/date_time/index.html">Boost.DateTime</a> has a binary component that is only needed if
  194. you're using its <tt class="docutils literal"><span class="pre">to_string</span></tt>/<tt class="docutils literal"><span class="pre">from_string</span></tt> or serialization
  195. features, or if you're targeting Visual C++ 6.x or Borland.</li>
  196. <li><a class="reference external" href="../../libs/graph/index.html">Boost.Graph</a> also has a binary component that is only needed if
  197. you intend to <a class="reference external" href="../../libs/graph/doc/read_graphviz.html">parse GraphViz files</a>.</li>
  198. <li><a class="reference external" href="../../libs/test/index.html">Boost.Test</a> can be used in “header-only” or “separately compiled”
  199. mode, although <strong>separate compilation is recommended for serious
  200. use</strong>.</li>
  201. </ul>
  202. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  203. <!-- Software License, Version 1.0. (See accompanying -->
  204. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  205. </div>
  206. <div class="section" id="build-a-simple-program-using-boost">
  207. <h1><a class="toc-backref" href="#id23">4&nbsp;&nbsp;&nbsp;Build a Simple Program Using Boost</a></h1>
  208. <p>To keep things simple, let's start by using a header-only library.
  209. The following program reads a sequence of integers from standard
  210. input, uses Boost.Lambda to multiply each number by three, and
  211. writes them to standard output:</p>
  212. <pre class="literal-block">
  213. #include &lt;boost/lambda/lambda.hpp&gt;
  214. #include &lt;iostream&gt;
  215. #include &lt;iterator&gt;
  216. #include &lt;algorithm&gt;
  217. int main()
  218. {
  219. using namespace boost::lambda;
  220. typedef std::istream_iterator&lt;int&gt; in;
  221. std::for_each(
  222. in(std::cin), in(), std::cout &lt;&lt; (_1 * 3) &lt;&lt; &quot; &quot; );
  223. }
  224. </pre>
  225. <p>Copy the text of this program into a file called <tt class="docutils literal"><span class="pre">example.cpp</span></tt>.</p>
  226. <p>Now, in the directory where you saved <tt class="docutils literal"><span class="pre">example.cpp</span></tt>, issue the
  227. following command:</p>
  228. <pre class="literal-block">
  229. c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt> example.cpp -o example
  230. </pre>
  231. <p>To test the result, type:</p>
  232. <pre class="literal-block">
  233. echo 1 2 3 | ./example
  234. </pre>
  235. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  236. <!-- Software License, Version 1.0. (See accompanying -->
  237. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  238. <div class="section" id="errors-and-warnings">
  239. <h2><a class="toc-backref" href="#id24">4.1&nbsp;&nbsp;&nbsp;Errors and Warnings</a></h2>
  240. <p>Don't be alarmed if you see compiler warnings originating in Boost
  241. headers. We try to eliminate them, but doing so isn't always
  242. practical.<a class="footnote-reference" href="#warnings" id="id5"><sup>3</sup></a> <strong>Errors are another matter</strong>. If you're
  243. seeing compilation errors at this point in the tutorial, check to
  244. be sure you've copied the <a class="reference internal" href="#build-a-simple-program-using-boost">example program</a> correctly and that you've
  245. correctly identified the <a class="reference internal" href="#boost-root-directory">Boost root directory</a>.</p>
  246. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  247. <!-- Software License, Version 1.0. (See accompanying -->
  248. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  249. </div>
  250. </div>
  251. <div class="section" id="prepare-to-use-a-boost-library-binary">
  252. <h1><a class="toc-backref" href="#id25">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a></h1>
  253. <p>If you want to use any of the separately-compiled Boost libraries,
  254. you'll need to acquire library binaries.</p>
  255. <div class="section" id="easy-build-and-install">
  256. <h2><a class="toc-backref" href="#id26">5.1&nbsp;&nbsp;&nbsp;Easy Build and Install</a></h2>
  257. <p>Issue the following commands in the shell (don't type <tt class="docutils literal"><span class="pre">$</span></tt>; that
  258. represents the shell's prompt):</p>
  259. <pre class="literal-block">
  260. <strong>$</strong> cd <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt>
  261. <strong>$</strong> ./bootstrap.sh --help
  262. </pre>
  263. <p>Select your configuration options and invoke <tt class="docutils literal"><span class="pre">./bootstrap.sh</span></tt> again
  264. without the <tt class="docutils literal"><span class="pre">--help</span></tt> option. Unless you have write permission in
  265. your system's <tt class="docutils literal"><span class="pre">/usr/local/</span></tt> directory, you'll probably want to at
  266. least use</p>
  267. <pre class="literal-block">
  268. <strong>$</strong> ./bootstrap.sh <strong>--prefix=</strong><em>path</em>/<em>to</em>/<em>installation</em>/<em>prefix</em>
  269. </pre>
  270. <p>to install somewhere else. Also, consider using the
  271. <tt class="docutils literal"><span class="pre">--show-libraries</span></tt> and <tt class="docutils literal"><span class="pre">--with-</span></tt><em>library_name</em> options to limit the
  272. long wait you'll experience if you build everything. Finally,</p>
  273. <pre class="literal-block">
  274. <strong>$</strong> ./bjam install
  275. </pre>
  276. <p>will leave Boost binaries in the <tt class="docutils literal"><span class="pre">lib/</span></tt> subdirectory of your
  277. installation prefix. You will also find a copy of the Boost
  278. headers in the <tt class="docutils literal"><span class="pre">include/</span></tt> subdirectory of the installation
  279. prefix, so you can henceforth use that directory as an <tt class="docutils literal"><span class="pre">#include</span></tt>
  280. path in place of the Boost root directory.</p>
  281. <p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
  282. </div>
  283. <div class="section" id="or-build-custom-binaries">
  284. <h2><a class="toc-backref" href="#id27">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a></h2>
  285. <p>If you're using a compiler other than your system's default, you'll
  286. need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create binaries.</p>
  287. <p>You'll also
  288. use this method if you need a nonstandard build variant (see the
  289. <a class="reference external" href="../../tools/build/index.html">Boost.Build documentation</a> for more details).</p>
  290. <div class="admonition-boost-cmake admonition">
  291. <p class="first admonition-title">Boost.CMake</p>
  292. <p class="last">There is also an experimental CMake build for boost, supported and distributed
  293. separately. See the <a class="reference external" href="https://svn.boost.org/trac/boost/wiki/CMake">Boost.CMake</a> wiki page for more information.</p>
  294. </div>
  295. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  296. <!-- Software License, Version 1.0. (See accompanying -->
  297. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  298. <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> is a text-based system for developing, testing, and
  299. installing software. To use it, you'll need an executable called
  300. <tt class="docutils literal"><span class="pre">bjam</span></tt>.</p>
  301. <!-- .. _Boost.Jam documentation: Boost.Jam_ -->
  302. <div class="section" id="get-bjam">
  303. <h3><a class="toc-backref" href="#id28">5.2.1&nbsp;&nbsp;&nbsp;Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
  304. <p><tt class="docutils literal"><span class="pre">bjam</span></tt> is the command-line tool that drives the Boost Build
  305. system. To build Boost binaries, you'll invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> from the
  306. Boost root.</p>
  307. <p>We suggest you <a class="reference external" href="http://sourceforge.net/project/showfiles.php?group_id=7586&amp;package_id=72941">download a pre-built <tt class="docutils literal"><span class="pre">bjam</span></tt> executable</a> for your platform.
  308. Alternatively, you can build <tt class="docutils literal"><span class="pre">bjam</span></tt> yourself using <a class="reference external" href="../../doc/html/jam/building.html">these
  309. instructions</a>.</p>
  310. <p>Move the <tt class="docutils literal"><span class="pre">bjam</span></tt> executable into a directory in your PATH. You can
  311. see the list of directories in your PATH, separated by colons,
  312. by typing “<tt class="docutils literal"><span class="pre">echo</span> <span class="pre">$PATH</span></tt>” at the command prompt.</p>
  313. </div>
  314. <div class="section" id="identify-your-toolset">
  315. <span id="toolset-name"></span><span id="toolset"></span><h3><a class="toc-backref" href="#id29">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></h3>
  316. <p>First, find the toolset corresponding to your compiler in the
  317. following table (an up-to-date list is always available <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html">in the
  318. Boost.Build documentation</a>).</p>
  319. <div class="note">
  320. <p class="first admonition-title">Note</p>
  321. <p class="last">If you previously chose a toolset for the purposes of
  322. <a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
  323. choose newly from the table below.</p>
  324. </div>
  325. <table border="1" class="docutils">
  326. <colgroup>
  327. <col width="18%" />
  328. <col width="33%" />
  329. <col width="48%" />
  330. </colgroup>
  331. <thead valign="bottom">
  332. <tr><th class="head">Toolset
  333. Name</th>
  334. <th class="head">Vendor</th>
  335. <th class="head">Notes</th>
  336. </tr>
  337. </thead>
  338. <tbody valign="top">
  339. <tr><td><tt class="docutils literal"><span class="pre">acc</span></tt></td>
  340. <td>Hewlett Packard</td>
  341. <td>Only very recent versions are
  342. known to work well with Boost</td>
  343. </tr>
  344. <tr><td><tt class="docutils literal"><span class="pre">borland</span></tt></td>
  345. <td>Borland</td>
  346. <td>&nbsp;</td>
  347. </tr>
  348. <tr><td><tt class="docutils literal"><span class="pre">como</span></tt></td>
  349. <td>Comeau Computing</td>
  350. <td>Using this toolset may
  351. require <a class="reference external" href="../../tools/build/index.html">configuring</a> another
  352. toolset to act as its backend</td>
  353. </tr>
  354. <tr><td><tt class="docutils literal"><span class="pre">cw</span></tt></td>
  355. <td>Metrowerks/Freescale</td>
  356. <td>The CodeWarrior compiler. We
  357. have not tested versions of
  358. this compiler produced since
  359. it was sold to Freescale.</td>
  360. </tr>
  361. <tr><td><tt class="docutils literal"><span class="pre">dmc</span></tt></td>
  362. <td>Digital Mars</td>
  363. <td>As of this Boost release, no
  364. version of dmc is known to
  365. handle Boost well.</td>
  366. </tr>
  367. <tr><td><tt class="docutils literal"><span class="pre">darwin</span></tt></td>
  368. <td>Apple Computer</td>
  369. <td>Apple's version of the GCC
  370. toolchain with support for
  371. Darwin and MacOS X features
  372. such as frameworks.</td>
  373. </tr>
  374. <tr><td><tt class="docutils literal"><span class="pre">gcc</span></tt></td>
  375. <td>The Gnu Project</td>
  376. <td>Includes support for Cygwin
  377. and MinGW compilers.</td>
  378. </tr>
  379. <tr><td><tt class="docutils literal"><span class="pre">hp_cxx</span></tt></td>
  380. <td>Hewlett Packard</td>
  381. <td>Targeted at the Tru64
  382. operating system.</td>
  383. </tr>
  384. <tr><td><tt class="docutils literal"><span class="pre">intel</span></tt></td>
  385. <td>Intel</td>
  386. <td>&nbsp;</td>
  387. </tr>
  388. <tr><td><tt class="docutils literal"><span class="pre">msvc</span></tt></td>
  389. <td>Microsoft</td>
  390. <td>&nbsp;</td>
  391. </tr>
  392. <tr><td><tt class="docutils literal"><span class="pre">qcc</span></tt></td>
  393. <td>QNX Software Systems</td>
  394. <td>&nbsp;</td>
  395. </tr>
  396. <tr><td><tt class="docutils literal"><span class="pre">sun</span></tt></td>
  397. <td>Sun</td>
  398. <td>Only very recent versions are
  399. known to work well with
  400. Boost.</td>
  401. </tr>
  402. <tr><td><tt class="docutils literal"><span class="pre">vacpp</span></tt></td>
  403. <td>IBM</td>
  404. <td>The VisualAge C++ compiler.</td>
  405. </tr>
  406. </tbody>
  407. </table>
  408. <p>If you have multiple versions of a particular compiler installed,
  409. you can append the version number to the toolset name, preceded by
  410. a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></tt> or
  411. <tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <tt class="docutils literal"> </tt></p>
  412. </div>
  413. <div class="section" id="select-a-build-directory">
  414. <span id="id11"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id30">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></h3>
  415. <p><a class="reference external" href="../../tools/build/index.html">Boost.Build</a> will place all intermediate files it generates while
  416. building into the <strong>build directory</strong>. If your Boost root
  417. directory is writable, this step isn't strictly necessary: by
  418. default Boost.Build will create a <tt class="docutils literal"><span class="pre">bin.v2/</span></tt> subdirectory for that
  419. purpose in your current working directory.</p>
  420. </div>
  421. <div class="section" id="invoke-bjam">
  422. <h3><a class="toc-backref" href="#id31">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
  423. <p>Change your current directory to the Boost root directory and
  424. invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> as follows:</p>
  425. <pre class="literal-block">
  426. bjam <strong>--build-dir=</strong><a class="reference internal" href="#id11"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
  427. </pre>
  428. <p>For a complete description of these and other invocation options,
  429. please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.</p>
  430. <p>For example, your session might look like this:</p>
  431. <pre class="literal-block">
  432. $ cd ~/<tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt>
  433. $ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage
  434. </pre>
  435. <p>That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “``--build-type=complete``”.</p>
  436. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  437. <!-- Software License, Version 1.0. (See accompanying -->
  438. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  439. <p>Building the special <tt class="docutils literal"><span class="pre">stage</span></tt> target places Boost
  440. library binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">/</span></tt><tt class="docutils literal"><span class="pre">lib</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> subdirectory of your <a class="reference internal" href="#build-directory">build
  441. directory</a>.</p>
  442. <div class="note">
  443. <p class="first admonition-title">Note</p>
  444. <p class="last"><tt class="docutils literal"><span class="pre">bjam</span></tt> is case-sensitive; it is important that all the
  445. parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
  446. </div>
  447. <p>For a description of other options you can pass when invoking
  448. <tt class="docutils literal"><span class="pre">bjam</span></tt>, type:</p>
  449. <pre class="literal-block">
  450. bjam --help
  451. </pre>
  452. <p>In particular, to limit the amount of time spent building, you may
  453. be interested in:</p>
  454. <ul class="simple">
  455. <li>reviewing the list of library names with <tt class="docutils literal"><span class="pre">--show-libraries</span></tt></li>
  456. <li>limiting which libraries get built with the <tt class="docutils literal"><span class="pre">--with-</span></tt><em>library-name</em> or <tt class="docutils literal"><span class="pre">--without-</span></tt><em>library-name</em> options</li>
  457. <li>choosing a specific build variant by adding <tt class="docutils literal"><span class="pre">release</span></tt> or
  458. <tt class="docutils literal"><span class="pre">debug</span></tt> to the command line.</li>
  459. </ul>
  460. <div class="note">
  461. <p class="first admonition-title">Note</p>
  462. <p class="last">Boost.Build can produce a great deal of output, which can
  463. make it easy to miss problems. If you want to make sure
  464. everything is went well, you might redirect the output into a
  465. file by appending “``&gt;build.log 2&gt;&amp;1``” to your command line.</p>
  466. </div>
  467. </div>
  468. </div>
  469. <div class="section" id="expected-build-output">
  470. <h2><a class="toc-backref" href="#id32">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></h2>
  471. <p>During the process of building Boost libraries, you can expect to
  472. see some messages printed on the console. These may include</p>
  473. <ul>
  474. <li><p class="first">Notices about Boost library configuration—for example, the Regex
  475. library outputs a message about ICU when built without Unicode
  476. support, and the Python library may be skipped without error (but
  477. with a notice) if you don't have Python installed.</p>
  478. </li>
  479. <li><p class="first">Messages from the build tool that report the number of targets
  480. that were built or skipped. Don't be surprised if those numbers
  481. don't make any sense to you; there are many targets per library.</p>
  482. </li>
  483. <li><p class="first">Build action messages describing what the tool is doing, which
  484. look something like:</p>
  485. <pre class="literal-block">
  486. <em>toolset-name</em>.c++ <em>long</em>/<em>path</em>/<em>to</em>/<em>file</em>/<em>being</em>/<em>built</em>
  487. </pre>
  488. </li>
  489. <li><p class="first">Compiler warnings.</p>
  490. </li>
  491. </ul>
  492. </div>
  493. <div class="section" id="in-case-of-build-errors">
  494. <h2><a class="toc-backref" href="#id33">5.4&nbsp;&nbsp;&nbsp;In Case of Build Errors</a></h2>
  495. <p>The only error messages you see when building Boost—if any—should
  496. be related to the IOStreams library's support of zip and bzip2
  497. formats as described <a class="reference external" href="../../libs/iostreams/doc/installation.html">here</a>. Install the relevant development
  498. packages for libz and libbz2 if you need those features. Other
  499. errors when building Boost libraries are cause for concern.</p>
  500. <p>If it seems like the build system can't find your compiler and/or
  501. linker, consider setting up a <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file as described
  502. <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html">here</a>. If that isn't your problem or the <tt class="docutils literal"><span class="pre">user-config.jam</span></tt> file
  503. doesn't work for you, please address questions about configuring Boost
  504. for your compiler to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a>.</p>
  505. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  506. <!-- Software License, Version 1.0. (See accompanying -->
  507. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  508. </div>
  509. </div>
  510. <div class="section" id="link-your-program-to-a-boost-library">
  511. <h1><a class="toc-backref" href="#id34">6&nbsp;&nbsp;&nbsp;Link Your Program to a Boost Library</a></h1>
  512. <p>To demonstrate linking with a Boost binary library, we'll use the
  513. following simple program that extracts the subject lines from
  514. emails. It uses the <a class="reference external" href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
  515. separately-compiled binary component.</p>
  516. <pre class="literal-block">
  517. #include &lt;boost/regex.hpp&gt;
  518. #include &lt;iostream&gt;
  519. #include &lt;string&gt;
  520. int main()
  521. {
  522. std::string line;
  523. boost::regex pat( &quot;^Subject: (Re: |Aw: )*(.*)&quot; );
  524. while (std::cin)
  525. {
  526. std::getline(std::cin, line);
  527. boost::smatch matches;
  528. if (boost::regex_match(line, matches, pat))
  529. std::cout &lt;&lt; matches[2] &lt;&lt; std::endl;
  530. }
  531. }
  532. </pre>
  533. <p>There are two main challenges associated with linking:</p>
  534. <ol class="arabic simple">
  535. <li>Tool configuration, e.g. choosing command-line options or IDE
  536. build settings.</li>
  537. <li>Identifying the library binary, among all the build variants,
  538. whose compile configuration is compatible with the rest of your
  539. project.</li>
  540. </ol>
  541. <p>There are two main ways to link to libraries:</p>
  542. <ol class="upperalpha">
  543. <li><p class="first">You can specify the full path to each library:</p>
  544. <pre class="literal-block">
  545. $ c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt> example.cpp -o example <strong>\</strong>
  546. <strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
  547. </pre>
  548. </li>
  549. <li><p class="first">You can separately specify a directory to search (with <tt class="docutils literal"><span class="pre">-L</span></tt><em>directory</em>) and a library name to search for (with <tt class="docutils literal"><span class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference" href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's leading <tt class="docutils literal"><span class="pre">lib</span></tt> and trailing
  550. suffix (<tt class="docutils literal"><span class="pre">.a</span></tt> in this case):</p>
  551. <pre class="literal-block">
  552. $ c++ -I <em>path/to/</em><tt class="docutils literal"><span class="pre">boost_1_43_0</span></tt> example.cpp -o example <strong>\</strong>
  553. <strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong>
  554. </pre>
  555. <p>As you can see, this method is just as terse as method A for one
  556. library; it <em>really</em> pays off when you're using multiple
  557. libraries from the same directory. Note, however, that if you
  558. use this method with a library that has both static (<tt class="docutils literal"><span class="pre">.a</span></tt>) and
  559. dynamic (<tt class="docutils literal"><span class="pre">.so</span></tt>) builds, the system may choose one
  560. automatically for you unless you pass a special option such as
  561. <tt class="docutils literal"><span class="pre">-static</span></tt> on the command line.</p>
  562. </li>
  563. </ol>
  564. <p>In both cases above, the bold text is what you'd add to <a class="reference internal" href="#build-a-simple-program-using-boost">the
  565. command lines we explored earlier</a>.</p>
  566. <div class="section" id="library-naming">
  567. <h2><a class="toc-backref" href="#id35">6.1&nbsp;&nbsp;&nbsp;Library Naming</a></h2>
  568. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  569. <!-- Software License, Version 1.0. (See accompanying -->
  570. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  571. <p>In order to choose the right binary for your build configuration
  572. you need to know how Boost binaries are named. Each library
  573. filename is composed of a common sequence of elements that describe
  574. how it was built. For example,
  575. <tt class="docutils literal"><span class="pre">libboost_regex-vc71-mt-d-1_34.lib</span></tt> can be broken down into the
  576. following elements:</p>
  577. <dl class="docutils">
  578. <dt><tt class="docutils literal"><span class="pre">lib</span></tt></dt>
  579. <dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
  580. name begins with this string. On Windows, only ordinary static
  581. libraries use the <tt class="docutils literal"><span class="pre">lib</span></tt> prefix; import libraries and DLLs do
  582. not.<a class="footnote-reference" href="#distinct" id="id17"><sup>4</sup></a></dd>
  583. <dt><tt class="docutils literal"><span class="pre">boost_regex</span></tt></dt>
  584. <dd><em>Library name</em>: all boost library filenames begin with <tt class="docutils literal"><span class="pre">boost_</span></tt>.</dd>
  585. <dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
  586. <dd><em>Toolset tag</em>: identifies the <a class="reference internal" href="#toolset">toolset</a> and version used to build
  587. the binary.</dd>
  588. <dt><tt class="docutils literal"><span class="pre">-mt</span></tt></dt>
  589. <dd><em>Threading tag</em>: indicates that the library was
  590. built with multithreading support enabled. Libraries built
  591. without multithreading support can be identified by the absence
  592. of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
  593. <dt><tt class="docutils literal"><span class="pre">-d</span></tt></dt>
  594. <dd><p class="first"><em>ABI tag</em>: encodes details that affect the library's
  595. interoperability with other compiled code. For each such
  596. feature, a single letter is added to the tag:</p>
  597. <blockquote>
  598. <table border="1" class="docutils">
  599. <colgroup>
  600. <col width="5%" />
  601. <col width="75%" />
  602. <col width="20%" />
  603. </colgroup>
  604. <thead valign="bottom">
  605. <tr><th class="head">Key</th>
  606. <th class="head">Use this library when:</th>
  607. <th class="head">Boost.Build option</th>
  608. </tr>
  609. </thead>
  610. <tbody valign="top">
  611. <tr><td><tt class="docutils literal"><span class="pre">s</span></tt></td>
  612. <td>linking statically to the C++ standard library and compiler runtime support
  613. libraries.</td>
  614. <td>runtime-link=static</td>
  615. </tr>
  616. <tr><td><tt class="docutils literal"><span class="pre">g</span></tt></td>
  617. <td>using debug versions of the standard and runtime support libraries.</td>
  618. <td>runtime-debugging=on</td>
  619. </tr>
  620. <tr><td><tt class="docutils literal"><span class="pre">y</span></tt></td>
  621. <td>using a special <a class="reference external" href="../../libs/python/doc/building.html#variants">debug build of Python</a>.</td>
  622. <td>python-debugging=on</td>
  623. </tr>
  624. <tr><td><tt class="docutils literal"><span class="pre">d</span></tt></td>
  625. <td>building a debug version of your code.<a class="footnote-reference" href="#debug-abi" id="id18"><sup>5</sup></a></td>
  626. <td>variant=debug</td>
  627. </tr>
  628. <tr><td><tt class="docutils literal"><span class="pre">p</span></tt></td>
  629. <td>using the STLPort standard library rather than the default one supplied with
  630. your compiler.</td>
  631. <td>stdlib=stlport</td>
  632. </tr>
  633. </tbody>
  634. </table>
  635. </blockquote>
  636. <p class="last">For example, if you build a debug version of your code for use
  637. with debug versions of the static runtime library and the
  638. STLPort standard library in “native iostreams” mode,
  639. the tag would be: <tt class="docutils literal"><span class="pre">-sgdpn</span></tt>. If none of the above apply, the
  640. ABI tag is ommitted.</p>
  641. </dd>
  642. <dt><tt class="docutils literal"><span class="pre">-1_34</span></tt></dt>
  643. <dd><em>Version tag</em>: the full Boost release number, with periods
  644. replaced by underscores. For example, version 1.31.1 would be
  645. tagged as &quot;-1_31_1&quot;.</dd>
  646. <dt><tt class="docutils literal"><span class="pre">.lib</span></tt></dt>
  647. <dd><em>Extension</em>: determined according to the operating system's usual
  648. convention. On most unix-style platforms the extensions are
  649. <tt class="docutils literal"><span class="pre">.a</span></tt> and <tt class="docutils literal"><span class="pre">.so</span></tt> for static libraries (archives) and shared
  650. libraries, respectively. On Windows, <tt class="docutils literal"><span class="pre">.dll</span></tt> indicates a shared
  651. library and <tt class="docutils literal"><span class="pre">.lib</span></tt> indicates a
  652. static or import library. Where supported by toolsets on unix
  653. variants, a full version extension is added (e.g. &quot;.so.1.34&quot;) and
  654. a symbolic link to the library file, named without the trailing
  655. version number, will also be created.</dd>
  656. </dl>
  657. <!-- .. _Boost.Build toolset names: toolset-name_ -->
  658. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  659. <!-- Software License, Version 1.0. (See accompanying -->
  660. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  661. </div>
  662. <div class="section" id="test-your-program">
  663. <h2><a class="toc-backref" href="#id36">6.2&nbsp;&nbsp;&nbsp;Test Your Program</a></h2>
  664. <p>To test our subject extraction, we'll filter the following text
  665. file. Copy it out of your browser and save it as <tt class="docutils literal"><span class="pre">jayne.txt</span></tt>:</p>
  666. <pre class="literal-block">
  667. To: George Shmidlap
  668. From: Rita Marlowe
  669. Subject: Will Success Spoil Rock Hunter?
  670. ---
  671. See subject.
  672. </pre>
  673. <p>If you linked to a shared library, you may need to prepare some
  674. platform-specific settings so that the system will be able to find
  675. and load it when your program is run. Most platforms have an
  676. environment variable to which you can add the directory containing
  677. the library. On many platforms (Linux, FreeBSD) that variable is
  678. <tt class="docutils literal"><span class="pre">LD_LIBRARY_PATH</span></tt>, but on MacOS it's <tt class="docutils literal"><span class="pre">DYLD_LIBRARY_PATH</span></tt>, and
  679. on Cygwin it's simply <tt class="docutils literal"><span class="pre">PATH</span></tt>. In most shells other than <tt class="docutils literal"><span class="pre">csh</span></tt>
  680. and <tt class="docutils literal"><span class="pre">tcsh</span></tt>, you can adjust the variable as follows (again, don't
  681. type the <tt class="docutils literal"><span class="pre">$</span></tt>—that represents the shell prompt):</p>
  682. <pre class="literal-block">
  683. <strong>$</strong> <em>VARIABLE_NAME</em>=<em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
  684. <strong>$</strong> export <em>VARIABLE_NAME</em>
  685. </pre>
  686. <p>On <tt class="docutils literal"><span class="pre">csh</span></tt> and <tt class="docutils literal"><span class="pre">tcsh</span></tt>, it's</p>
  687. <pre class="literal-block">
  688. <strong>$</strong> setenv <em>VARIABLE_NAME</em> <em>path/to/lib/directory</em>:${<em>VARIABLE_NAME</em>}
  689. </pre>
  690. <p>Once the necessary variable (if any) is set, you can run your
  691. program as follows:</p>
  692. <pre class="literal-block">
  693. <strong>$</strong> <em>path</em>/<em>to</em>/<em>compiled</em>/example &lt; <em>path</em>/<em>to</em>/jayne.txt
  694. </pre>
  695. <p>The program should respond with the email subject, “Will Success
  696. Spoil Rock Hunter?”</p>
  697. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  698. <!-- Software License, Version 1.0. (See accompanying -->
  699. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  700. </div>
  701. </div>
  702. <div class="section" id="conclusion-and-further-resources">
  703. <h1><a class="toc-backref" href="#id37">7&nbsp;&nbsp;&nbsp;Conclusion and Further Resources</a></h1>
  704. <p>This concludes your introduction to Boost and to integrating it
  705. with your programs. As you start using Boost in earnest, there are
  706. surely a few additional points you'll wish we had covered. One day
  707. we may have a “Book 2 in the Getting Started series” that addresses
  708. them. Until then, we suggest you pursue the following resources.
  709. If you can't find what you need, or there's anything we can do to
  710. make this document clearer, please post it to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users'
  711. mailing list</a>.</p>
  712. <ul class="simple">
  713. <li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
  714. <li><a class="reference external" href="../../tools/jam/index.html">Boost.Jam reference manual</a></li>
  715. <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
  716. <li><a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>
  717. <li><a class="reference external" href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2">Boost.Build Wiki</a></li>
  718. <li><a class="reference external" href="../../libs/index.html">Index of all Boost library documentation</a></li>
  719. </ul>
  720. <div class="admonition-onward admonition">
  721. <p class="first admonition-title">Onward</p>
  722. <blockquote class="epigraph last">
  723. <p>Good luck, and have fun!</p>
  724. <p class="attribution">&mdash;the Boost Developers</p>
  725. </blockquote>
  726. </div>
  727. <hr class="docutils" />
  728. <table class="docutils footnote" frame="void" id="packagers" rules="none">
  729. <colgroup><col class="label" /><col /></colgroup>
  730. <tbody valign="top">
  731. <tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>If developers of Boost packages would like to work
  732. with us to make sure these instructions can be used with their
  733. packages, we'd be glad to help. Please make your interest known
  734. to the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#main">Boost developers' list</a>.</td></tr>
  735. </tbody>
  736. </table>
  737. <table class="docutils footnote" frame="void" id="lowercase-l" rules="none">
  738. <colgroup><col class="label" /><col /></colgroup>
  739. <tbody valign="top">
  740. <tr><td class="label"><a class="fn-backref" href="#id15">[2]</a></td><td>That option is a dash followed by a lowercase “L”
  741. character, which looks very much like a numeral 1 in some fonts.</td></tr>
  742. </tbody>
  743. </table>
  744. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  745. <!-- Software License, Version 1.0. (See accompanying -->
  746. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  747. <table class="docutils footnote" frame="void" id="warnings" rules="none">
  748. <colgroup><col class="label" /><col /></colgroup>
  749. <tbody valign="top">
  750. <tr><td class="label"><a class="fn-backref" href="#id5">[3]</a></td><td>Remember that warnings are specific to each compiler
  751. implementation. The developer of a given Boost library might
  752. not have access to your compiler. Also, some warnings are
  753. extremely difficult to eliminate in generic code, to the point
  754. where it's not worth the trouble. Finally, some compilers don't
  755. have any source code mechanism for suppressing warnings.</td></tr>
  756. </tbody>
  757. </table>
  758. <table class="docutils footnote" frame="void" id="distinct" rules="none">
  759. <colgroup><col class="label" /><col /></colgroup>
  760. <tbody valign="top">
  761. <tr><td class="label"><a class="fn-backref" href="#id17">[4]</a></td><td>This convention distinguishes the static version of
  762. a Boost library from the import library for an
  763. identically-configured Boost DLL, which would otherwise have the
  764. same name.</td></tr>
  765. </tbody>
  766. </table>
  767. <table class="docutils footnote" frame="void" id="debug-abi" rules="none">
  768. <colgroup><col class="label" /><col /></colgroup>
  769. <tbody valign="top">
  770. <tr><td class="label"><a class="fn-backref" href="#id18">[5]</a></td><td>These libraries were compiled without optimization
  771. or inlining, with full debug symbols enabled, and without
  772. <tt class="docutils literal"><span class="pre">NDEBUG</span></tt> <tt class="docutils literal"><span class="pre">#define</span></tt>d. Although it's true that sometimes
  773. these choices don't affect binary compatibility with other
  774. compiled code, you can't count on that with Boost libraries.</td></tr>
  775. </tbody>
  776. </table>
  777. <table class="docutils footnote" frame="void" id="native" rules="none">
  778. <colgroup><col class="label" /><col /></colgroup>
  779. <tbody valign="top">
  780. <tr><td class="label">[6]</td><td>This feature of STLPort is deprecated because it's
  781. impossible to make it work transparently to the user; we don't
  782. recommend it.</td></tr>
  783. </tbody>
  784. </table>
  785. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  786. <!-- Software License, Version 1.0. (See accompanying -->
  787. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  788. <!-- This file contains all the definitions that need to be updated -->
  789. <!-- for each new release of Boost. -->
  790. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  791. <!-- Software License, Version 1.0. (See accompanying -->
  792. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  793. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  794. <!-- Software License, Version 1.0. (See accompanying -->
  795. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  796. <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  797. <!-- Software License, Version 1.0. (See accompanying -->
  798. <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  799. </div>
  800. </div>
  801. </body>
  802. </html>
粤ICP备19079148号