glfs/general/genlib/libstatgrab.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 libstatgrab-download-http "https://www.mirrorservice.org/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-&libstatgrab-version;.tar.gz">
  <!ENTITY libstatgrab-download-ftp  " ">
  <!ENTITY libstatgrab-md5sum        "af685494e985229e0ac46365bc0cd50e">
  <!ENTITY libstatgrab-size          "800 KB">
  <!ENTITY libstatgrab-buildsize     "7.6 MB (with tests)">
  <!ENTITY libstatgrab-time          "0.1 SBU (add 1.5 SBU for tests)">
]>

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


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

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

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

    <para>
      This is a library that provides cross platform access to statistics about
      the system on which it's run. It's written in C and presents a selection
      of useful interfaces which can be used to access key system statistics.
      The current list of statistics includes CPU usage, memory utilisation,
      disk usage, process counts, network traffic, disk I/O, and more.
    </para>

    &lfs120_checked;

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

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr   \
            --disable-static \
            --docdir=/usr/share/doc/libstatgrab-&libstatgrab-version; &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 install</userinput></screen>

  </sect2>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          saidar, statgrab, statgrab-make-mrtg-config, and
          statgrab-make-mrtg-index
        </seg>
        <seg>
          libstatgrab.so
        </seg>
        <seg>
          /usr/share/doc/libstatgrab-&libstatgrab-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="saidar">
        <term><command>saidar</command></term>
        <listitem>
          <para>
            is a curses-based tool for viewing system statistics
          </para>
          <indexterm zone="libstatgrab saidar">
            <primary sortas="b-saidar">saidar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="statgrab">
        <term><command>statgrab</command></term>
        <listitem>
          <para>
            is a sysctl-style interface to system statistics
          </para>
          <indexterm zone="libstatgrab statgrab">
            <primary sortas="b-statgrab">statgrab</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="statgrab-make-mrtg-config">
        <term><command>statgrab-make-mrtg-config</command></term>
        <listitem>
          <para>
            generates MRTG configuration
          </para>
          <indexterm zone="libstatgrab statgrab-make-mrtg-config">
            <primary sortas="b-statgrab-make-mrtg-config">statgrab-make-mrtg-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="statgrab-make-mrtg-index">
        <term><command>statgrab-make-mrtg-index</command></term>
        <listitem>
          <para>
            generates an XHTML index page from MRTG configuration files or
            stdin
          </para>
          <indexterm zone="libstatgrab statgrab-make-mrtg-index">
            <primary sortas="b-statgrab-make-mrtg-index">statgrab-make-mrtg-index</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libstatgrab-lib">
        <term><filename class="libraryfile">libstatgrab.so</filename></term>
        <listitem>
          <para>
            contains the <application>libstatgrab</application> API functions
          </para>
          <indexterm zone="libstatgrab libstatgrab-lib">
            <primary sortas="c-libstatgrab">libstatgrab.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>