unix-variants.html 48 KB

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