source: general/genlib/libstatgrab.xml@ 6aa631b

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 6aa631b was 6aa631b, checked in by Bruce Dubbs <bdubbs@…>, 10 months ago

Tag most of the remaining general libraries.

  • Property mode set to 100644
File size: 6.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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
7 <!ENTITY libstatgrab-download-http "https://www.mirrorservice.org/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-&libstatgrab-version;.tar.gz">
8 <!ENTITY libstatgrab-download-ftp "ftp://www.mirrorservice.org/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-&libstatgrab-version;.tar.gz">
9 <!ENTITY libstatgrab-md5sum "af685494e985229e0ac46365bc0cd50e">
10 <!ENTITY libstatgrab-size "800 KB">
11 <!ENTITY libstatgrab-buildsize "7.6 MB (with tests)">
12 <!ENTITY libstatgrab-time "0.1 SBU (add 1.5 SBU for tests)">
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
36 &lfs120_checked;
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
72
73 </sect2>
74
75 <sect2 role="installation">
76 <title>Installation of libstatgrab</title>
77
78 <para>
79 Install <application>libstatgrab</application> by running the following
80 commands:
81 </para>
82
83<screen><userinput>./configure --prefix=/usr \
84 --disable-static \
85 --docdir=/usr/share/doc/libstatgrab-&libstatgrab-version; &amp;&amp;
86make</userinput></screen>
87
88 <para>
89 To test the results, issue: <command>make check</command>.
90 </para>
91
92 <para>
93 Now, as the <systemitem class="username">root</systemitem> user:
94 </para>
95
96<screen role="root"><userinput>make install</userinput></screen>
97
98 </sect2>
99
100 <sect2 role="commands">
101 <title>Command Explanations</title>
102
103 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
104 href="../../xincludes/static-libraries.xml"/>
105
106 </sect2>
107
108 <sect2 role="content">
109 <title>Contents</title>
110
111 <segmentedlist>
112 <segtitle>Installed Programs</segtitle>
113 <segtitle>Installed Library</segtitle>
114 <segtitle>Installed Directories</segtitle>
115
116 <seglistitem>
117 <seg>
118 saidar, statgrab, statgrab-make-mrtg-config, and
119 statgrab-make-mrtg-index
120 </seg>
121 <seg>
122 libstatgrab.so
123 </seg>
124 <seg>
125 /usr/share/doc/libstatgrab-&libstatgrab-version;
126 </seg>
127 </seglistitem>
128 </segmentedlist>
129
130 <variablelist>
131 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
132 <?dbfo list-presentation="list"?>
133 <?dbhtml list-presentation="table"?>
134
135 <varlistentry id="saidar">
136 <term><command>saidar</command></term>
137 <listitem>
138 <para>
139 is a curses-based tool for viewing system statistics
140 </para>
141 <indexterm zone="libstatgrab saidar">
142 <primary sortas="b-saidar">saidar</primary>
143 </indexterm>
144 </listitem>
145 </varlistentry>
146
147 <varlistentry id="statgrab">
148 <term><command>statgrab</command></term>
149 <listitem>
150 <para>
151 is a sysctl-style interface to system statistics
152 </para>
153 <indexterm zone="libstatgrab statgrab">
154 <primary sortas="b-statgrab">statgrab</primary>
155 </indexterm>
156 </listitem>
157 </varlistentry>
158
159 <varlistentry id="statgrab-make-mrtg-config">
160 <term><command>statgrab-make-mrtg-config</command></term>
161 <listitem>
162 <para>
163 generates MRTG configuration
164 </para>
165 <indexterm zone="libstatgrab statgrab-make-mrtg-config">
166 <primary sortas="b-statgrab-make-mrtg-config">statgrab-make-mrtg-config</primary>
167 </indexterm>
168 </listitem>
169 </varlistentry>
170
171 <varlistentry id="statgrab-make-mrtg-index">
172 <term><command>statgrab-make-mrtg-index</command></term>
173 <listitem>
174 <para>
175 generates an XHTML index page from MRTG configuration files or
176 stdin
177 </para>
178 <indexterm zone="libstatgrab statgrab-make-mrtg-index">
179 <primary sortas="b-statgrab-make-mrtg-index">statgrab-make-mrtg-index</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="libstatgrab-lib">
185 <term><filename class="libraryfile">libstatgrab.so</filename></term>
186 <listitem>
187 <para>
188 contains the <application>libstatgrab</application> API functions
189 </para>
190 <indexterm zone="libstatgrab libstatgrab-lib">
191 <primary sortas="c-libstatgrab">libstatgrab.so</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 </variablelist>
197
198 </sect2>
199
200</sect1>
Note: See TracBrowser for help on using the repository browser.