aboutsummaryrefslogtreecommitdiffstats
path: root/general/genlib/libunwind.xml
blob: 6c1d42c42d068da3c40022c45567c42c63b79eb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<?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        "10c96118ff30b88c9eeb6eac8e75599d">
  <!ENTITY libunwind-size          "940 KB">
  <!ENTITY libunwind-buildsize     "21 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>

    &lfs122_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 (symlink to libunwind-x86_64.so),
          libunwind-ptrace.so,
          libunwind-setjmp.so, and
          libunwind-x86_64.so (libunwind-x86.so on i686)
        </seg>
        <seg>
          /usr/libexec/libunwind
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>