more/getting_started/detail/header-only.rst

   1 .. Copyright David Abrahams 2006. Distributed under the Boost
   2 .. Software License, Version 1.0. (See accompanying
   3 .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   4
   5 Header-Only Libraries
   6 =====================
   7
   8 The first thing many people want to know is, “how do I build
   9 Boost?”  The good news is that often, there's nothing to build.
  10
  11 .. admonition:: Nothing to Build?
  12
  13   Most Boost libraries are **header-only**: they consist *entirely
  14   of header files* containing templates and inline functions, and
  15   require no separately-compiled library binaries or special
  16   treatment when linking.
  17
  18 .. .. _separate:
  19
  20 The only Boost libraries that *must* be built separately are:
  21
  22 * Boost.Filesystem_
  23 * Boost.IOStreams_
  24 * Boost.ProgramOptions_
  25 * Boost.Python_ (see the `Boost.Python build documentation`__
  26   before building and installing it)
  27 * Boost.Regex_
  28 * Boost.Serialization_
  29 * Boost.Signals_
  30 * Boost.System_
  31 * Boost.Thread_
  32 * Boost.Wave_
  33
  34 __ ../../libs/python/doc/building.html
  35
  36 A few libraries have optional separately-compiled binaries:
  37
  38 * Boost.DateTime_ has a binary component that is only needed if
  39   you're using its ``to_string``\ /\ ``from_string`` or serialization
  40   features, or if you're targeting Visual C++ 6.x or Borland.
  41
  42 * Boost.Graph_ also has a binary component that is only needed if
  43   you intend to `parse GraphViz files`__.
  44
  45 * Boost.Test_ can be used in “header-only” or “separately compiled”
  46   mode, although **separate compilation is recommended for serious
  47   use**.
  48
  49 __ ../../libs/graph/doc/read_graphviz.html