source: gnome/core/libgtop.xml@ 29590dda

<?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;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="libgtop.html"?>
<title>LibGTop-&libgtop-version;</title>

<sect2>
<title>Introduction to <application>LibGTop</application></title>

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

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application>LibGTop</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="glib2"/></para>
</sect4>

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

</sect2>

<sect2>
<title>Installation of <application>LibGTop</application></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><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --infodir=$GNOME_PREFIX/share/info &amp;&amp;
make</command></userinput></screen>

<para>This package does not come with a test suite.</para>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></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 root user:</para>

<screen><userinput role='root'><command>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</command></userinput></screen>
</sect2>

<sect2>
<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>
<title>Configuring <application>LibGTop</application></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>
<title>Contents</title>

<para>The <application>LibGTop</application> package contains the 
<filename class="libraryfile">libgtop-2.0</filename> library and 
optionally, <command>file_by_inode2</command>, 
<command>mkinodedb2</command> and numerous example programs.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>libgtop-2.0 library</title>
<para><filename class="libraryfile">libgtop-2.0</filename> contains the 
functions that allow access to system performance data.</para></sect3>

</sect2>

</sect1>