[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[58102209] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[c6b192c] | 7 | <!ENTITY libstatgrab-download-http "https://www.mirrorservice.org/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-&libstatgrab-version;.tar.gz">
|
---|
[e1e58be] | 8 | <!ENTITY libstatgrab-download-ftp " ">
|
---|
[ca31bd3] | 9 | <!ENTITY libstatgrab-md5sum "af685494e985229e0ac46365bc0cd50e">
|
---|
[fca6d6c] | 10 | <!ENTITY libstatgrab-size "800 KB">
|
---|
[ca31bd3] | 11 | <!ENTITY libstatgrab-buildsize "7.6 MB (with tests)">
|
---|
| 12 | <!ENTITY libstatgrab-time "0.1 SBU (add 1.5 SBU for tests)">
|
---|
[58102209] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libstatgrab" xreflabel="libstatgrab-&libstatgrab-version;">
|
---|
| 16 | <?dbhtml filename="libstatgrab.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libstatgrab-&libstatgrab-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libstatgrab">
|
---|
| 22 | <primary sortas="a-libstatgrab">libstatgrab</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libstatgrab</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | This is a library that provides cross platform access to statistics about
|
---|
| 30 | the system on which it's run. It's written in C and presents a selection
|
---|
| 31 | of useful interfaces which can be used to access key system statistics.
|
---|
| 32 | The current list of statistics includes CPU usage, memory utilisation,
|
---|
| 33 | disk usage, process counts, network traffic, disk I/O, and more.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[bbfdef7] | 36 | &lfs121_checked;
|
---|
[58102209] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&libstatgrab-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&libstatgrab-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &libstatgrab-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &libstatgrab-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &libstatgrab-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &libstatgrab-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
[fd7e770a] | 72 | <bridgehead renderas="sect3">libstatgrab Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 75 | <para role="optional">
|
---|
| 76 | <xref linkend="log4cplus"/>
|
---|
| 77 | </para>
|
---|
[58102209] | 78 |
|
---|
| 79 | </sect2>
|
---|
| 80 |
|
---|
| 81 | <sect2 role="installation">
|
---|
| 82 | <title>Installation of libstatgrab</title>
|
---|
| 83 |
|
---|
| 84 | <para>
|
---|
| 85 | Install <application>libstatgrab</application> by running the following
|
---|
| 86 | commands:
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 90 | --disable-static \
|
---|
| 91 | --docdir=/usr/share/doc/libstatgrab-&libstatgrab-version; &&
|
---|
| 92 | make</userinput></screen>
|
---|
| 93 |
|
---|
[d56e7df] | 94 | <para>
|
---|
| 95 | To test the results, issue: <command>make check</command>.
|
---|
| 96 | </para>
|
---|
[58102209] | 97 |
|
---|
| 98 | <para>
|
---|
| 99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
| 102 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 103 |
|
---|
| 104 | </sect2>
|
---|
| 105 |
|
---|
| 106 | <sect2 role="commands">
|
---|
| 107 | <title>Command Explanations</title>
|
---|
| 108 |
|
---|
| 109 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 110 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 111 |
|
---|
| 112 | </sect2>
|
---|
| 113 |
|
---|
| 114 | <sect2 role="content">
|
---|
| 115 | <title>Contents</title>
|
---|
| 116 |
|
---|
| 117 | <segmentedlist>
|
---|
| 118 | <segtitle>Installed Programs</segtitle>
|
---|
| 119 | <segtitle>Installed Library</segtitle>
|
---|
| 120 | <segtitle>Installed Directories</segtitle>
|
---|
| 121 |
|
---|
| 122 | <seglistitem>
|
---|
| 123 | <seg>
|
---|
| 124 | saidar, statgrab, statgrab-make-mrtg-config, and
|
---|
| 125 | statgrab-make-mrtg-index
|
---|
| 126 | </seg>
|
---|
| 127 | <seg>
|
---|
| 128 | libstatgrab.so
|
---|
| 129 | </seg>
|
---|
| 130 | <seg>
|
---|
| 131 | /usr/share/doc/libstatgrab-&libstatgrab-version;
|
---|
| 132 | </seg>
|
---|
| 133 | </seglistitem>
|
---|
| 134 | </segmentedlist>
|
---|
| 135 |
|
---|
| 136 | <variablelist>
|
---|
| 137 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 138 | <?dbfo list-presentation="list"?>
|
---|
| 139 | <?dbhtml list-presentation="table"?>
|
---|
| 140 |
|
---|
| 141 | <varlistentry id="saidar">
|
---|
| 142 | <term><command>saidar</command></term>
|
---|
| 143 | <listitem>
|
---|
| 144 | <para>
|
---|
[4c24eb0a] | 145 | is a curses-based tool for viewing system statistics
|
---|
[58102209] | 146 | </para>
|
---|
| 147 | <indexterm zone="libstatgrab saidar">
|
---|
| 148 | <primary sortas="b-saidar">saidar</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 |
|
---|
| 153 | <varlistentry id="statgrab">
|
---|
| 154 | <term><command>statgrab</command></term>
|
---|
| 155 | <listitem>
|
---|
| 156 | <para>
|
---|
[4c24eb0a] | 157 | is a sysctl-style interface to system statistics
|
---|
[58102209] | 158 | </para>
|
---|
| 159 | <indexterm zone="libstatgrab statgrab">
|
---|
| 160 | <primary sortas="b-statgrab">statgrab</primary>
|
---|
| 161 | </indexterm>
|
---|
| 162 | </listitem>
|
---|
| 163 | </varlistentry>
|
---|
| 164 |
|
---|
| 165 | <varlistentry id="statgrab-make-mrtg-config">
|
---|
| 166 | <term><command>statgrab-make-mrtg-config</command></term>
|
---|
| 167 | <listitem>
|
---|
| 168 | <para>
|
---|
[4c24eb0a] | 169 | generates MRTG configuration
|
---|
[58102209] | 170 | </para>
|
---|
| 171 | <indexterm zone="libstatgrab statgrab-make-mrtg-config">
|
---|
| 172 | <primary sortas="b-statgrab-make-mrtg-config">statgrab-make-mrtg-config</primary>
|
---|
| 173 | </indexterm>
|
---|
| 174 | </listitem>
|
---|
| 175 | </varlistentry>
|
---|
| 176 |
|
---|
| 177 | <varlistentry id="statgrab-make-mrtg-index">
|
---|
| 178 | <term><command>statgrab-make-mrtg-index</command></term>
|
---|
| 179 | <listitem>
|
---|
| 180 | <para>
|
---|
| 181 | generates an XHTML index page from MRTG configuration files or
|
---|
[4c24eb0a] | 182 | stdin
|
---|
[58102209] | 183 | </para>
|
---|
| 184 | <indexterm zone="libstatgrab statgrab-make-mrtg-index">
|
---|
| 185 | <primary sortas="b-statgrab-make-mrtg-index">statgrab-make-mrtg-index</primary>
|
---|
| 186 | </indexterm>
|
---|
| 187 | </listitem>
|
---|
| 188 | </varlistentry>
|
---|
| 189 |
|
---|
| 190 | <varlistentry id="libstatgrab-lib">
|
---|
| 191 | <term><filename class="libraryfile">libstatgrab.so</filename></term>
|
---|
| 192 | <listitem>
|
---|
| 193 | <para>
|
---|
[4c24eb0a] | 194 | contains the <application>libstatgrab</application> API functions
|
---|
[58102209] | 195 | </para>
|
---|
| 196 | <indexterm zone="libstatgrab libstatgrab-lib">
|
---|
| 197 | <primary sortas="c-libstatgrab">libstatgrab.so</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
| 202 | </variablelist>
|
---|
| 203 |
|
---|
| 204 | </sect2>
|
---|
| 205 |
|
---|
| 206 | </sect1>
|
---|