Move description of libstatgrab to top of page.

[www.i-scream.org.git] / www / libstatgrab / index.xhtml

diff --git a/www/libstatgrab/index.xhtml b/www/libstatgrab/index.xhtml
index 18541b91b692c0e972067dca22c472ef40fbcb56..07e992167b909662c370e1658e65c86829f479f6 100644 (file)
--- a/www/libstatgrab/index.xhtml
+++ b/www/libstatgrab/index.xhtml
@@ -16,14 +16,20 @@
           <div id="topnav">
             <ul>
               <li>
           <div id="topnav">
             <ul>
               <li>

-                <a href="#news">News</a>
+                <a href="#what">What is libstatgrab?</a>

               </li>
               <li>
               </li>
               <li>

-                <a href="#what">What is libstatgrab?</a>
+                <a href="#news">News</a>

               </li>
               <li>
                 <a href="#download">Downloading</a>
               </li>
               </li>
               <li>
                 <a href="#download">Downloading</a>
               </li>

+              <li>
+                <a href="#bindings">Language Bindings</a>
+              </li>
+              <li>
+                <a href="#packages">Packages</a>
+              </li>

               <li>
                 <a href="#development">Development</a>
               </li>
               <li>
                 <a href="#development">Development</a>
               </li>


@@ -36,222 +42,229 @@
             </ul>
           </div>
           <h2>
             </ul>
           </div>
           <h2>

-            <a id="news">News</a>
+            <a id="what">What is libstatgrab?</a>

           </h2>
           <p>
           </h2>
           <p>

-            To get notifications of new libstatgrab releases why not
-            subscribe to our project over on
-            <a href="http://freshmeat.net/projects/libstatgrab/">freshmeat</a>?
+            libstatgrab 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.

           </p>
           </p>

-          <h3>
-            Sunday 21 March 2004
-          </h3>

           <p>
           <p>

-            pystatgrab, a new package containing a set of Python
-            bindings, has been released. Check out it's
-            <a href="/pystatgrab/">project page</a>.
+            The current list of platforms is Solaris 2.x, Linux
+            2.2/2.4/2.6, FreeBSD 4.x/5.x, NetBSD 1.6.x, OpenBSD 3.x,
+            DragonFly BSD 1.0, HP-UX, and Cygwin. The aim is to extend
+            this to include as many operating systems as possible.

           </p>
           </p>

-          <h3>
-            Wednesday 10 March 2004
-          </h3>

           <p>
           <p>

-            Version 0.9 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.9.tar.gz">
-            here</a>.
+            The package also includes a couple of useful tools. The
+            first, <a href="#screenshot">saidar</a>, provides a
+            curses-based interface to viewing the current state of the
+            system. The second, statgrab, gives a sysctl-style
+            interface to the statistics gathered by libstatgrab. This
+            extends the use of libstatgrab to people writing scripts or
+            anything else that can't easily make C function calls.
+            Included with statgrab is a script to generate an
+            <a href="http://www.mrtg.org">MRTG</a> configuration file
+            to use statgrab.

           </p>
           </p>

+          <h2>
+            <a id="news">News</a>
+          </h2>

           <p>
           <p>

-            This release brings new features and new platforms. We've
-            added information about network interfaces (duplex, speed,
-            etc) along with further statistics such as i/o packets, i/o
-            errors, and collisions. Support has also been added for
-            OpenBSD and DragonFly BSD. Finally some work has been done
-            to reduce the platforms on which libstatgrab needs elevated
-            privileges. See the NEWS file for more information.
+            To get notifications of new libstatgrab releases why not
+            subscribe to our project over on
+            <a href="http://freshmeat.net/projects/libstatgrab/">freshmeat</a>?

           </p>
           <h3>
           </p>
           <h3>

-            Wednesday 11 February 2004
+            Thursday 3 March 2005

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.8.2 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.8.2.tar.gz">
-            here</a>.
+            Version 0.11.1 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            The main focus of this release is adding support for
-            Solaris 6. We've also added Python bindings so you can use
-            libstatgrab directly from Python (see the extras
-            directory). Finally, we've tidied up a few bits of the
-            code.
+            This release fixes a handful of minor bugs. Duplex
+            settings were reported incorrectly on linux (half and
+            full duplex were swapped), saidar displayed negative
+            filesystem stats incorrectly, and NFS filesystems were
+            ignored. These have all been fixed.

           </p>
           <h3>
           </p>
           <h3>

-            Wednesday 21 January 2004
+            Friday 12 November 2004

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.8.1 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.8.1.tar.gz">
-            here</a>.
+            Version 0.11 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            This release primarily fixes bugs. On Linux a file
-            descriptor leak was fixed. On Solaris some significant
-            speed increases were made to the disk mapping code, along
-            with some bug fixes for Solaris 7 platforms. Also, the
-            library part of libstatgrab (but not the tools) is now
-            released under the LGPL instead of the GPL.
+            This release brings support for HP-UX (version 11.11), and
+            also fixes a few other minor issues.

           </p>
           <h3>
           </p>
           <h3>

-            Tuesday 6 January 2004
+            Wednesday 25 August 2004

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.8 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.8.tar.gz">
-            here</a>.
+            Version 0.10.3 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            This release brings support for Linux 2.6 and partial
-            support for Cygwin. On Solaris libstatgrab now returns disk
-            names using cNtNdNsN names rather than the older sdN names.
-            There are also a bunch of fixes and optimisations in
-            various places. Finally, a new function has been added to
-            make it quicker to drop any elevated privileges libstatgrab
-            may require on some operating systems.
+            This release adds a handful of new features to statgrab, and
+            adds support for FreeBSD 6.0-CURRENT. See the NEWS file in
+            the tarball for more details.

           </p>
           <h3>
           </p>
           <h3>

-            Wednesday 22 October 2003
+            Tuesday 27 July 2004

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.7 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.7.tar.gz">
-            here</a>.
+            Version 0.10.2 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            The most significant change in this release is support for
-            NetBSD 1.6.x. Parts of the FreeBSD code have been
-            optimised, and an initialise function has been added to
-            allow programs to drop any extra privileges libstatgrab
-            needs. The list of known file systems has been increased,
-            and libstatgrab has been tested on even more platforms.
-            Finally, saidar has been tweaked to work even if it can't
-            get all the statistics.
+            This release fixes a problem with the shared library
+            version number in the last release.

           </p>
           <h3>
           </p>
           <h3>

-            Saturday 18 October 2003
+            Monday 26 July 2004

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.6.1 of libstatgrab has been released.<br />
-            Download it
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.6.1.tar.gz">
-            here</a>.
+            Version 0.10.1 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            This release brings support for FreeBSD 5 on sparc 64, and
-            some bugfixes in FreeBSD memory statistics. Also, some
-            fixes to saidar, and statgrab.
+            This release consists almost entirely of bugfixes.
+            We've fixed compile-time errors for recent OpenBSD and
+            NetBSD platforms, and also a minor bug in statgrab
+            that broke network statistics on Solaris. New
+            variables have been added to the pkg-config file to
+            suggest ownership and permissions of binaries, and
+            we've added error reporting functions that store errno
+            values. There's also other minor fixes detailed in the
+            NEWS file.

           </p>
           <h3>
           </p>
           <h3>

-            Friday 10 October 2003
+            Thursday 20 May 2004

           </h3>
           <p>
           </h3>
           <p>

-            Version 0.6 of libstatgrab has been released.<br />
-            You can download it from our mirror site
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.6.tar.gz">
-            here</a>.
+            Version 0.10 of libstatgrab has been released.<br />
+            Download it from one of our <a href="/mirrors.xhtml">mirrors</a>.

           </p>
           <p>
           </p>
           <p>

-            This release includes some exciting new tools, support for
-            FreeBSD 5.1, and documentation in manpages. Plus some major
-            bugfixes and packaging enhancements.
+            This release concentrates heavily on standardising the names
+            of functions and structures throughout libstatgrab. Although
+            this will mean changes for existing programs, in the long run
+            we hope it'll make things both clearer and easier. However,
+            for those who still need the old functions we have provided
+            compatibility wrappers. See the NEWS file for details.

           </p>
           </p>

-          <h3>
-            Tuesday 09 September 2003
-          </h3>

           <p>
           <p>

-            We're pleased to announce a new release of
-            libstatgrab.<br />
-            You can download version 0.5.1 from
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.5.1.tar.gz">
-            here</a>.
+            The other main change in this release is a new function to
+            provide full details on currently running processes. See the
+            documentation for sg_get_process_stats for details. Along with
+            this there are compare functions for use with qsort for sorting
+            process, network, and disk io statistics. We've also introduced
+            error reporting functions that allow calling applications to
+            see why libstatgrab has returned a failure. See sg_get_error.

           </p>
           </p>

-          <h3>
-            Monday 25 August 2003
-          </h3>

           <p>
           <p>

-            We're pleased to announce a new release of
-            libstatgrab.<br />
-            You can download version 0.5 from
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/libstatgrab-0.5.tar.gz">
-            here</a>.
+            Finally, we've added support for NetBSD 2.0 and tidied up lots
+            of areas of the code. This release does not include the python
+            bindings - they're now available as their own project called
+            <a href="/pystatgrab/">pystatgrab</a>.

           </p>
           </p>

+          <h3>
+            Sunday 21 March 2004
+          </h3>

           <p>
           <p>

-            This release provides both documentation and examples,
-            which we hope will make the package more useable. Stay
-            tuned for the next release with some useful tools.
+            pystatgrab, a new package containing a set of Python
+            bindings, has been released. Check out it's
+            <a href="/pystatgrab/">project page</a>.

           </p>
           <h2>
           </p>
           <h2>

-            <a id="what">What is libstatgrab?</a>
+            <a id="download">Downloading</a>

           </h2>
           <p>
           </h2>
           <p>

-            libstatgrab 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.
+            The latest version of libstatgrab can be downloaded from
+            our <a href="/mirrors.xhtml">mirror sites</a>.
+            All downloads are pgp signed using our
+            <a href="/pgpkey.xhtml">PGP Key</a>.

           </p>
           <p>
           </p>
           <p>

-            The current list of platforms is Solaris 2.x, Linux
-            2.2/2.4/2.6, FreeBSD 4.x/5.x, NetBSD 1.6.x, OpenBSD 3.x,
-            DragonFly BSD 1.0, and Cygwin. The aim is to extend this to
-            include as many operating systems as possible.
+            For installation instructions see the README and INSTALL
+            files contained within the archive.

           </p>
           </p>

+          <h2>
+            <a id="bindings">Language Bindings</a>
+          </h2>
+          <ul>
+            <li>
+              <a href="/pystatgrab/">Python</a>
+            </li>
+            <li>
+              <a href="http://pecl.php.net/statgrab/">PHP (external)</a>
+            </li>
+            <li>
+              <a href="http://search.cpan.org/dist/Unix-Statgrab/">Perl (external)</a>
+            </li>
+          </ul>

           <p>
           <p>

-            The package also includes a couple of useful tools. The
-            first, <a href="#screenshot">saidar</a>, provides a
-            curses-based interface to viewing the current state of the
-            system. The second, statgrab, gives a sysctl-style
-            interface to the statistics gathered by libstatgrab. This
-            extends the use of libstatgrab to people writing scripts or
-            anything else that can't easily make C function calls.
-            Included with statgrab is a script to generate an
-            <a href="http://www.mrtg.org">MRTG</a> configuration file
-            to use statgrab.
+            Here are links to bindings for higher level languages
+            that provide access to libstatgrab. If you've written
+            a binding for another language, please get
+            <a href="mailto:dev@i-scream.org">in touch</a> so we
+            can add a link here.

           </p>
           <h2>
           </p>
           <h2>

-            <a id="download">Downloading</a>
+            <a id="packages">Packages of libstatgrab</a>

           </h2>
           </h2>

+          <ul>
+            <li>
+              <a href="http://www.freebsd.org/cgi/ports.cgi?query=statgrab&amp;stype=all">FreeBSD</a>
+            </li>
+            <li>
+              <a href="http://packages.gentoo.org/search/?sstring=statgrab">Gentoo Linux</a>
+            </li>
+            <li>
+              <a href="http://www.blastwave.org/packages.php/libstatgrab">Solaris (Blastwave)</a>
+            </li>
+            <li>
+              <a href="http://ftp.i-scream.org/pub/i-scream/packages/debian/">Debian (unofficial)</a>
+            </li>
+            <li>
+              <a href="ftp://ftp.netbsd.org/pub/NetBSD/packages/pkgsrc/devel/libstatgrab/README.html">NetBSD</a>
+            </li>
+          </ul>

           <p>
           <p>

-            The latest version of libstatgrab can be downloaded from
-            our primary download
-            <a href="http://www.mirror.ac.uk/sites/ftp.i-scream.org/pub/i-scream/libstatgrab/">
-            mirror</a>. All downloads are pgp signed using our
-            <a href="/pgpkey.xhtml">PGP Key</a>.
+            These are various pre-packaged versions of libstatgrab
+            that you can get for your favourite operating system. If
+            we've missed any out, please let us know.

           </p>
           <p>
           </p>
           <p>

-            For installation instructions see the README and INSTALL
-            files contained within the archive. If you're using
-            <a href="http://www.freebsd.org">FreeBSD</a> you can make
-            use of the
-            <a href="http://www.freshports.org/devel/libstatgrab">
-            devel/libstatgrab</a> port to install libstatgrab for you.
+            We've noticed that google throws up some RPM's relating
+            to Mandrake and Suse, but no webpage for them.
+          </p>
+          <p>
+            Several attempts were made to submit a port to the
+            OpenBSD folk, but they didn't seem interested in taking
+            it. You can find it
+            <a href="http://ftp.i-scream.org/pub/i-scream/tmp/libstatgrab-0.11-openbsd-port.tar.gz">
+            here</a>.

           </p>
           <h2>
             <a id="development">Development</a>
           </h2>
           <ul>
             <li>
           </p>
           <h2>
             <a id="development">Development</a>
           </h2>
           <ul>
             <li>

-              <a href="/cgi-bin/cvslog.cgi?period=thisweek&module=projects/libstatgrab">Commits this week</a>
+              <a href="/cgi-bin/cvslog.cgi?period=thisweek&amp;module=projects/libstatgrab">Commits this week</a>

             </li>
           </ul>
           <p>
             </li>
           </ul>
           <p>

-            We develop pystatgrab using the CVS revision control system.    
+            We develop libstatgrab using the CVS revision control system.

             Using this link you can see what changes we've made this week.
             Using this link you can see what changes we've made this week.

-            For more information on our CVS setup see our  
+            For more information on our CVS setup see our

             <a href="/cvs.xhtml">CVS page</a>.
           </p>
           <h2>
             <a href="/cvs.xhtml">CVS page</a>.
           </p>
           <h2>


@@ -272,34 +285,37 @@
           </p>
           <ul>
             <li>
           </p>
           <ul>
             <li>

-              <a href="cpu_percent_usage.html">cpu_percent_usage(3)</a>
+              <a href="sg_get_cpu_stats.html">sg_get_cpu_stats(3)</a>
+            </li>
+            <li>
+              <a href="sg_get_disk_io_stats.html">sg_get_disk_io_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_diskio_stats.html">get_diskio_stats(3)</a>
+              <a href="sg_get_fs_stats.html">sg_get_fs_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_general_stats.html">get_general_stats(3)</a>
+              <a href="sg_get_host_info.html">sg_get_host_info(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_load_stats.html">get_load_stats(3)</a>
+              <a href="sg_get_load_stats.html">sg_get_load_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_memory_stats.html">get_memory_stats(3)</a>
+              <a href="sg_get_mem_stats.html">sg_get_mem_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_network_iface_stats.html">get_network_iface_stats(3)</a>
+              <a href="sg_get_network_iface_stats.html">sg_get_network_iface_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_network_stats.html">get_network_stats(3)</a>
+              <a href="sg_get_network_io_stats.html">sg_get_network_io_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_page_stats.html">get_page_stats(3)</a>
+              <a href="sg_get_page_stats.html">sg_get_page_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_process_stats.html">get_process_stats(3)</a>
+              <a href="sg_get_process_stats.html">sg_get_process_stats(3)</a>

             </li>
             <li>
             </li>
             <li>

-              <a href="get_user_stats.html">get_user_stats(3)</a>
+              <a href="sg_get_user_stats.html">sg_get_user_stats(3)</a>

             </li>
           </ul>
           <h2>
             </li>
           </ul>
           <h2>