glfs/general/prog/gdb.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 gdb-download-http "http://ftp.gnu.org/gnu/gdb/gdb-&gdb-version;.tar.bz2">
  <!ENTITY gdb-download-ftp  "ftp://ftp.gnu.org/gnu/gdb/gdb-&gdb-version;.tar.bz2">
  <!ENTITY gdb-md5sum        "8854d34691087ec127d934692639855f">
  <!ENTITY gdb-size          "20 MB">
  <!ENTITY gdb-buildsize     "375 MB (552 MB with checks)">
  <!ENTITY gdb-time          "1.8 SBU (5.9 SBU with checks)">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para><application>GDB</application>, the GNU Project debugger, allows you
    to see what is going on `inside' another program while it executes -- or
    what another program was doing at the moment it crashed.</para>

    &lfs71_checked;

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

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

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

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

  </sect2>

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

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

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

    <para>To test the results, issue: <command>make check</command>.</para>

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

<screen role="root"><userinput>make -C gdb install</userinput></screen>

  </sect2>
<!--
  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>- -disable-werror</command>: Recent versions of
    <application>gcc</application> generate warnings for a lot more
    <emphasis>possible</emphasis> errors. Because the <filename>Makefile</filename>
    uses the <literal>-Werror</literal> switch by default (to treat warnings as
    errors), this override is needed to allow the package to compile.</para>

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

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

      <seglistitem>
        <seg>gdb, gdbserver, and gdbtui</seg>
        <seg>libinproctrace.so</seg>
        <seg>/usr/share/gdb/{python/gdb/command,syscalls}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gdb-prog">
        <term><command>gdb</command></term>
        <listitem>
          <para>is the GNU Debugger.</para>
          <indexterm zone="gdb gdb-prog">
            <primary sortas="b-gdb-prog">gdb-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdbserver">
        <term><command>gdbserver</command></term>
        <listitem>
          <para>is a remote server for the GNU debugger (it allows programs to be
          debugged from a different machine).</para>
          <indexterm zone="gdb gdbserver">
            <primary sortas="b-gdbserver">gdbserver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gdbtui">
        <term><command>gdbtui</command></term>
        <listitem>
          <para>is a text user interface for <application>gdb</application>.</para>
          <indexterm zone="gdb gdbtui">
            <primary sortas="b-gdbtui">gdbtui</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <!-- commenting, unless anyone feels able to describe this.
      <varlistentry id="libinproctrace">
        <term><filename class='libraryfile'>libinproctrace.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gdb libinproctrace">
            <primary sortas="c-libinproctrace">libinproctrace.so</primary>
          </indexterm>
        </listitem>
      </varlistentry> -->

    </variablelist>

  </sect2>

</sect1>