path: root/archive/elfutils.xml

<?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;

  <!ENTITY elfutils-download-http
    "https://sourceware.org/ftp/elfutils/&elfutils-version;/elfutils-&elfutils-version;.tar.bz2">
  <!ENTITY elfutils-download-ftp  
     "ftp://sourceware.org/pub/elfutils/&elfutils-version;/elfutils-&elfutils-version;.tar.bz2">
  <!ENTITY elfutils-md5sum        "03599aee98c9b726c7a732a2dd0245d5">
  <!ENTITY elfutils-size          "8.0 MB">
  <!ENTITY elfutils-buildsize     "78 MB (with tests)">
  <!ENTITY elfutils-time          "0.9 SBU (with tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>elfutils</application> package contains a set of
      utilities and libraries for handling ELF (Executable and Linkable Format)
      files.
    </para>

    &lfs81_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>
    </para>

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

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

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

<!-- don't disable static libs, disable-static switch doesn't work anyways -->
<screen><userinput>./configure --prefix=/usr --program-prefix="eu-" &amp;&amp;
make</userinput></screen>
<!--
    <para>
      If you wish to run the test suite, first fix it to skip two failing tests:
    </para>

<screen><userinput>sed -i '/srcdir/ iexit 77\n'         \
       tests/run-backtrace-native.sh \
       tests/run-backtrace-native-core.sh</userinput></screen>-->

    <para>
       To test the results, issue: <command>make check</command>. 
       One test, run-strip-nothing.sh, is 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>

    <para>
      <parameter>--program-prefix="eu-"</parameter>: This switch renames
      installed programs to avoid conflict with
      <application>Binutils</application> programs installed in LFS.
    </para>

    <para>
      <option>--enable-valgrind</option>: Run all tests under valgrind.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          eu-addr2line, eu-ar, eu-elfcmp, eu-elfcompress, eu-elflint,
          eu-findtextrel, eu-make-debug-archive, eu-nm, eu-objdump,
          eu-ranlib, eu-readelf, eu-size, eu-stack, eu-strings, eu-strip, and
          eu-unstrip
        </seg>
        <seg>
          libasm.{a,so}, libdw.{a,so}, libebl.a, libelf.{a,so}, and
          some for different architectures under /usr/lib/elfutils
        </seg>
        <seg>
          /usr/include/elfutils and
          /usr/lib/elfutils
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="eu-addr2line">
        <term><command>eu-addr2line</command></term>
        <listitem>
          <para>
            converts addresses into file names and line numbers.
          </para>
          <indexterm zone="elfutils eu-addr2line">
            <primary sortas="b-eu-addr2line">eu-addr2line</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-ar">
        <term><command>eu-ar</command></term>
        <listitem>
          <para>
            creates, modifies, and extracts from archives.
          </para>
          <indexterm zone="elfutils eu-ar">
            <primary sortas="b-eu-ar">eu-ar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-elfcmp">
        <term><command>eu-elfcmp</command></term>
        <listitem>
          <para>
            compares relevant parts of two ELF files for equality.
          </para>
          <indexterm zone="elfutils eu-elfcmp">
            <primary sortas="b-eu-elfcmp">eu-elfcmp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-elfcompress">
        <term><command>eu-elfcompress</command></term>
        <listitem>
          <para>
            compresses or decompresses sections in an ELF file.
          </para>
          <indexterm zone="elfutils eu-elfcompress">
            <primary sortas="b-eu-elfcompress">eu-elfcompress</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-elflint">
        <term><command>eu-elflint</command></term>
        <listitem>
          <para>
            does pedantic checking of ELF files compliance with gABI/psABI spec.
          </para>
          <indexterm zone="elfutils eu-elflint">
            <primary sortas="b-eu-elflint">eu-elflint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-findtextrel">
        <term><command>eu-findtextrel</command></term>
        <listitem>
          <para>
            locates the source of text relocations in FILEs (a.out by default).
          </para>
          <indexterm zone="elfutils eu-findtextrel">
            <primary sortas="b-eu-findtextrel">eu-findtextrel</primary>
          </indexterm>
        </listitem>
      </varlistentry>

<!--
      <varlistentry id="eu-ld">
        <term><command>eu-ld</command></term>
        <listitem>
          <para>
            combines object and archive files.
          </para>
          <indexterm zone="elfutils eu-ld">
            <primary sortas="b-eu-ld">eu-ld</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->

      <varlistentry id="eu-nm">
        <term><command>eu-nm</command></term>
        <listitem>
          <para>
            lists symbols from FILEs (a.out by default).
          </para>
          <indexterm zone="elfutils eu-nm">
            <primary sortas="b-eu-nm">eu-nm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-objdump">
        <term><command>eu-objdump</command></term>
        <listitem>
          <para>
            shows information from FILEs (a.out by default).
          </para>
          <indexterm zone="elfutils eu-objdump">
            <primary sortas="b-eu-objdump">eu-objdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-ranlib">
        <term><command>eu-ranlib</command></term>
        <listitem>
          <para>
            generates an index to speed up access to archives.
          </para>
          <indexterm zone="elfutils eu-ranlib">
            <primary sortas="b-eu-ranlib">eu-ranlib</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-readelf">
        <term><command>eu-readelf</command></term>
        <listitem>
          <para>
            prints information from ELF files in human-readable form.
          </para>
          <indexterm zone="elfutils eu-readelf">
            <primary sortas="b-eu-readelf">eu-readelf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-size">
        <term><command>eu-size</command></term>
        <listitem>
          <para>
            lists section sizes of FILEs (a.out by default).
          </para>
          <indexterm zone="elfutils eu-size">
            <primary sortas="b-eu-size">eu-size</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-stack">
        <term><command>eu-stack</command></term>
        <listitem>
          <para>
            prints a stack for each thread in a process or core file.
          </para>
          <indexterm zone="elfutils eu-stack">
            <primary sortas="b-eu-stack">eu-stack</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-strings">
        <term><command>eu-strings</command></term>
        <listitem>
          <para>
            prints the strings of printable characters in files.
          </para>
          <indexterm zone="elfutils eu-strings">
            <primary sortas="b-eu-strings">eu-strings</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-strip">
        <term><command>eu-strip</command></term>
        <listitem>
          <para>
            discards symbols from object files.
          </para>
          <indexterm zone="elfutils eu-strip">
            <primary sortas="b-eu-strip">eu-strip</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="eu-unstrip">
        <term><command>eu-unstrip</command></term>
        <listitem>
          <para>
            combines stripped files with separate symbols and debug information.
          </para>
          <indexterm zone="elfutils eu-unstrip">
            <primary sortas="b-eu-unstrip">eu-unstrip</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>