source: general/genlib/boost.xml@ 9d75494

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY boost-download-http "https://github.com/boostorg/boost/releases/download/boost-&boost-version;/boost-&boost-version;.tar.xz">
  <!ENTITY boost-download-ftp  " ">
  <!ENTITY boost-md5sum        "893b5203b862eb9bbd08553e24ff146a">
  <!ENTITY boost-size          "90 MB">
  <!ENTITY boost-buildsize     "1.1 GB (199 MB installed)">
  <!ENTITY boost-time          "1.7 SBU (Using parallelism=4; add 0.1 SBU for tests)">
]>

<sect1 id="boost" xreflabel="Boost-&boost-version;">
  <?dbhtml filename="boost.html"?>


  <title>Boost-&boost-version;</title>

  <indexterm zone="boost">
    <primary sortas="a-Boost">Boost</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Boost</title>

    <para>
      <application>Boost</application> provides a set of free peer-reviewed
      portable C++ source libraries. It includes libraries for linear algebra,
      pseudorandom number generation, multithreading, image processing, regular
      expressions and unit testing.
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&boost-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&boost-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &boost-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &boost-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &boost-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &boost-time;
        </para>
      </listitem>
    </itemizedlist>
    <!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Recommended patch, required to build <xref linkend="libreoffice"/>:
          <ulink url="&patch-root;/boost-&boost-version;-gcc_10-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
    -->

    <bridgehead renderas="sect3">Boost Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="which"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="icu"/> and
      <ulink url="https://www.open-mpi.org/">Open MPI</ulink>
    </para>

    <para condition="html" role="usernotes">Editor Notes:
      <ulink url="&blfs-wiki;/boost"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Boost</title>
<!--
    <para>
      A change in this version of <application>boost</application> breaks
      the few packages which use the <application>phoenix</application>
      module when compiled with current <application>GCC</application>. In BLFS,
      that affects <xref linkend="libreoffice"/>. Fix this with the following
      command:
    </para>

<screen><userinput>sed -i '/#include.*phoenix.*tuple.hpp.*/d' \
  boost/phoenix/stl.hpp</userinput></screen>
-->
    <para>
      This package can be built with several jobs running in parallel. In
      the instructions below, <parameter>&lt;N&gt;</parameter> stands for the
      number of jobs. Install <application>Boost</application> by running the
      following commands:
    </para>


<screen><userinput>./bootstrap.sh --prefix=/usr --with-python=python3 &amp;&amp;
./b2 stage -j<replaceable>&lt;N&gt;</replaceable> threading=multi link=shared</userinput></screen>

    <para>
      To run Boost.Build's regression tests, issue
      <command>pushd tools/build/test; python3 test_all.py; popd</command>.
      With python-3.11.x all 169 tests should pass.  With
      <xref linkend='python3'/>, 7 tests fail for undetermined reasons.
      <!-- This was fixed in 1.83.0 and broken for python-3.12 and 1.84.0 -->
    </para>

    <para>
      To run every library's regression tests, issue <command>pushd status;
      ../b2; popd</command>.  A few tests may fail. They take a very long time
      (over 119 SBU at -j4) and use a very large amount of disk space
      (46 GB). You should use the <parameter>-jN</parameter> switch to
      speed them up.
    </para>

    <note>
      <para>
        Boost installs many versioned directories in /usr/lib/cmake.
        If a new version of <application>Boost</application> is installed over a
        previous version, the older cmake directories need to be
        explicitly removed.  To do this, run as the
        <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>rm -rf /usr/lib/cmake/[Bb]oost*</userinput></screen>

      <para>
        before installing the new version.
      </para>
    </note>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<!-- dev note: ./b2 - -prefix=<DESTDIR>/usr install threading=multi link=shared -->

<screen role="root"><userinput>./b2 install threading=multi link=shared</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>
<!--
    <para>
      <command>sed -i '/#include ...</command>: This removes the inclusion
      of <filename>boost/phoenix/stl/tuple.hpp</filename> from this header-only
      library, allowing applications which use it to link using recent C++.
    </para>
-->
    <para>
      <parameter>threading=multi</parameter>: This parameter ensures that
      <application>Boost</application> is built with multithreading support.
    </para>

    <para>
      <parameter>link=shared</parameter>: This parameter ensures that only
      shared libraries are created, except for libboost_exception and
      libboost_test_exec_monitor which are created as static. Most people
      will not need the static libraries, and most programs using
      <application>Boost</application> only use the headers. Omit
      this parameter if you do need static libraries.
    </para>

    <para>
      <parameter>--with-python=python3</parameter>: This switch ensures Python3
      is used if Python2 is installed.
    </para>

    <para>
       <option>-jN</option>: This switch may be added to the
       <command>b2</command> command lines, to run up to N processes in
       parallel.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libboost_atomic.so, libboost_chrono.so, libboost_container.so,
          libboost_context.so, libboost_contract.so, libboost_coroutine.so,
          libboost_date_time.so, libboost_exception.a, libboost_fiber.so,
          libboost_filesystem.so, libboost_graph.so, libboost_iostreams.so,
          libboost_json.so, libboost_locale.so,
          libboost_log_setup.so, libboost_log.so, libboost_math_c99.so,
          libboost_math_c99f.so, libboost_math_c99l.so, libboost_math_tr1.so,
          libboost_math_tr1f.so, libboost_math_tr1l.so,
          libboost_nowide.so, libboost_numpy3&python3-minor;.so,
          libboost_prg_exec_monitor.so, libboost_program_options.so,
          libboost_python3&python3-minor;.so, libboost_random.so,
          libboost_regex.so, libboost_serialization.so,
          libboost_stacktrace_addr2line.so, libboost_stacktrace_basic.so,
          libboost_stacktrace_noop.so, libboost_system.so,
          libboost_test_exec_monitor.a, libboost_thread.so, libboost_timer.so,
          libboost_type_erasure.so, libboost_unit_test_framework.so,
          libboost_url.so, libboost_wave.so, and libboost_wserialization.so
        </seg>
        <seg>
          /usr/include/boost
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>