source: gnome/add/bug-buddy.xml@ e05cd03f

<?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 bug-buddy-download-http "&gnome-download-http;/bug-buddy/&gnome-version;/bug-buddy-&bug-buddy-version;.tar.bz2">
  <!ENTITY bug-buddy-download-ftp  "&gnome-download-ftp;/bug-buddy/&gnome-version;/bug-buddy-&bug-buddy-version;.tar.bz2">
  <!ENTITY bug-buddy-md5sum        "ee9c586fee2e6b8ce3b787e696f37100">
  <!ENTITY bug-buddy-size          "1.1 MB">
  <!ENTITY bug-buddy-buildsize     "37 MB">
  <!ENTITY bug-buddy-time          "0.4 SBU">
]>

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

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

  <title>bug-buddy-&bug-buddy-version;</title>

  <indexterm zone="bug-buddy">
    <primary sortas="a-Bug-buddy">Bug-buddy</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to bug-buddy</title>

    <para>The <application>bug-buddy</application> package contains a graphical
    bug reporting tool. This can extract debugging information from a core file
    or crashed application.</para>

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

    <bridgehead renderas="sect3">bug-buddy Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="evolution-data-server"/>,
    <xref linkend="gnome-doc-utils"/>,
    <xref linkend="libelf"/>, and
    <xref linkend="libgtop"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="rarian"/></para>

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

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of bug-buddy</title>

    <para>Install <application>bug-buddy</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib \
            --mandir=$(pkg-config \
                --variable=prefix ORBit-2.0)/share/man &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</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/gnome-prefix.xml"/>

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

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

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

    <para><option>--disable-scrollkeeper</option>: This parameter disables
    updates to the scrollkeeper database.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>bug-buddy, minidump_dump, and minidump_stackwalk</seg>
        <seg>libbreakpad.{so,a} and libgnomebreakpad.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{lib/bug-buddy,share/bug-buddy}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="bug-buddy-prog">
        <term><command>bug-buddy</command></term>
        <listitem>
          <para>is a graphical bug reporting system.</para>
          <indexterm zone="bug-buddy bug-buddy-prog">
            <primary sortas="b-bug-buddy">bug-buddy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libbreakpad">
        <term><filename class='libraryfile'>libbreakpad.{so,a}</filename></term>
        <listitem>
          <para>contains the Google breakpad API functions.</para>
          <indexterm zone="bug-buddy libbreakpad">
            <primary sortas="c-libbreakpad">libbreakpad.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgnomebreakpad">
        <term><filename class='libraryfile'>libgnomebreakpad.so</filename></term>
        <listitem>
          <para>is a <application>GTK+</application> breakpad module.</para>
          <indexterm zone="bug-buddy libgnomebreakpad">
            <primary sortas="c-libgnomebreakpad">libgnomebreakpad.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>