source: gnome/core/libgtop.xml@ c64a089

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libgtop-download-http "http://ftp.gnome.org/pub/GNOME/sources/libgtop/&gnome-version;/libgtop-&libgtop-version;.tar.bz2">
  <!ENTITY libgtop-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/libgtop/&gnome-version;/libgtop-&libgtop-version;.tar.bz2">
  <!ENTITY libgtop-md5sum "b006baa3bd486005411a03534b45708e">
  <!ENTITY libgtop-size "750 KB">
  <!ENTITY libgtop-buildsize "14 MB">
  <!ENTITY libgtop-time "0.3 SBU">
]>

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

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

  <title>LibGTop-&libgtop-version;</title>

  <indexterm zone="libgtop">
    <primary sortas="a-LibGTop">LibGTop</primary>
  </indexterm>

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

    <para>The <application>LibGTop</application> package contains the
    <application>GNOME</application> top libraries.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="glib2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="popt"/>,
    <xref linkend="gdbm"/> and
    X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>)</para>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../without-gnome.xml"/>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --infodir=$GNOME_PREFIX/share/info &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>

    <para>If you passed <option>--with-libgtop-examples</option> to the
    <command>configure</command> script to build the example programs, install
    them using the following commands as the <systemitem
    class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d $GNOME_PREFIX/share/libgtop-&libgtop-version;/examples &amp;&amp;
install -v -m755 examples/.libs/* \
    $GNOME_PREFIX/share/libgtop-&libgtop-version;/examples</userinput></screen>

  </sect2>

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

    <para><parameter>--infodir=$GNOME_PREFIX/share/info</parameter>: This switch
    installs the info documentation in
    <filename class='directory'>$GNOME_PREFIX/share/info</filename> instead of
    <filename class='directory'>$GNOME_PREFIX/info</filename>.</para>

    <para><option>--with-libgtop-examples</option>: Adding this parameter to
    the <command>configure</command> script will build numerous example
    programs.</para>

    <para><option>--with-libgtop-inodedb</option>: Add this parameter to the
    <command>configure</command> script if you have
    <application>GDBM</application> installed and wish to build the inodedb
    programs.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring LibGTop</title>

    <sect3>
      <title>Configuration Information</title>

      <para>If <envar>$GNOME_PREFIX</envar> is anything other than
      <filename class='directory'>/usr</filename>, update the
      <envar>INFOPATH</envar> environment variable by adding the following
      to your system-wide or personal profile:</para>

<screen><literal>export INFOPATH=/usr/share/info:$GNOME_PREFIX/share/info</literal></screen>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>file_by_inode2, mkinodedb2</seg>
        <seg>libgtop-2.0</seg>
        <seg>$GNOME_PREFIX/include/libgtop-2.0 and
        and $GNOME_PREFIX/share/libgtop-2.10.1</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgtop-2">
        <term><filename class='libraryfile'>libgtop-2.0.[so,a]</filename></term>
        <listitem>
          <para>contains the functions that allow access to system
          performance data.</para>
          <indexterm zone="libgtop libgtop-2">
            <primary sortas="c-libgtop-2">libgtop-2.0.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>