source: chapter08/libelf.xml@ a747ea2

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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;
]>

<sect1 id="ch-system-libelf" role="wrap">
  <?dbhtml filename="libelf.html"?>

  <sect1info condition="script">
    <productname>libelf</productname>
    <productnumber>&elfutils-version;</productnumber>
    <address>&elfutils-url;</address>
  </sect1info>

  <title>Libelf from Elfutils-&elfutils-version;</title>

  <indexterm zone="ch-system-libelf">
    <primary sortas="a-Libelf">Libelf</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>Libelf is a library for handling ELF (Executable and Linkable Format)
    files.</para>

    <segmentedlist>
      <segtitle>&buildtime;</segtitle>
      <segtitle>&diskspace;</segtitle>

      <seglistitem>
        <seg>&elfutils-fin-sbu;</seg>
        <seg>&elfutils-fin-du;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

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

      <para>Libelf is part of the elfutils-&elfutils-version; package. Use
      the elfutils-&elfutils-version;.tar.bz2 file as the source tarball.</para>

    <para>Prepare Libelf for compilation:</para>

    <screen><userinput remap="configure">./configure --prefix=/usr                \
            --disable-debuginfod         \
            --enable-libdebuginfod=dummy</userinput></screen>

    <para>Compile the package:</para>

<screen><userinput remap="make">make</userinput></screen>

    <para>To test the results, issue:</para>

<screen><userinput remap="test">make check</userinput></screen>

    <para>One test named <filename>run-low_high_pc.sh</filename> is known to
    fail on ARM64 systems.</para>

    <para>Install only Libelf:</para>

<screen><userinput remap="install">make -C libelf install
install -vm644 config/libelf.pc /usr/lib/pkgconfig
rm /usr/lib/libelf.a</userinput></screen>

  </sect2>

  <sect2 id="contents-elfutils" role="content">
    <title>Contents of Libelf</title>

    <segmentedlist>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          libelf.so (symlink) and libelf-&elfutils-version;.so
        </seg>
        <seg>
          /usr/include/elfutils
        </seg>
      </seglistitem>

    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libelf">
        <term><filename class="libraryfile">libelf</filename></term>
        <listitem>
          <para>Contains API functions to handle ELF object files</para>
          <indexterm zone="ch-system-libelf libelf">
            <primary sortas="c-libelf">libelf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>