source: general/genlib/libunwind.xml

<?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 libunwind-download-http "https://download.savannah.nongnu.org/releases/libunwind/libunwind-&libunwind-version;.tar.gz">
  <!ENTITY libunwind-download-ftp  " ">
  <!ENTITY libunwind-md5sum        "f625b6a98ac1976116c71708a73dc44a">
  <!ENTITY libunwind-size          "884 KB">
  <!ENTITY libunwind-buildsize     "20 MB (with tests)">
  <!ENTITY libunwind-time          "0.2 SBU (with tests)">
]>

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

  <title>libunwind-&libunwind-version;</title>

  <indexterm zone="libunwind">
    <primary sortas="a-libunwind">libunwind</primary>
  </indexterm>

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

    <para>
      The <application>libunwind</application> package contains a portable and
      efficient C programming interface (API) to determine the call-chain of a
      program. The API additionally provides the means to manipulate the
      preserved (callee-saved) state of each call-frame and to resume execution
      at any point in the call-chain (non-local goto). The API supports both
      local (same-process) and remote (across-process) operation.
    </para>

    &lfs121_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libunwind-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libunwind-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libunwind-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libunwind-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libunwind-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libunwind-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="texlive"/> (for latex2man)
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libunwind</title>

    <para>
      Install <application>libunwind</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.  Two
      tests, run-coredump-unwind and run-coredump-unwind-mdi are known
      to fail.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">

    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libunwind.so,
          libunwind-coredump.so,
          libunwind-generic.so,
          libunwind-ptrace.so,
          libunwind-setjmp.so, and
          libunwind-x86_64.so (libunwind-x86.so on i686)
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>