--- projects/libstatgrab/docs/statgrab.xml 2004/01/05 17:20:29 1.3 +++ projects/libstatgrab/docs/statgrab.xml 2004/01/05 17:27:29 1.4 @@ -6,8 +6,8 @@ - $Date: 2004/01/05 17:20:29 $ - $Id: statgrab.xml,v 1.3 2004/01/05 17:20:29 ats Exp $ + $Date: 2004/01/05 17:27:29 $ + $Id: statgrab.xml,v 1.4 2004/01/05 17:27:29 ats Exp $ @@ -109,19 +109,20 @@ Description - The statgrab library provides a cross platform interface to getting + The statgrab library provides a cross-platform interface to getting system statistics. Each of the function calls returns a structure containing statistics. See the manual page for each individual function for more details on usage. - statgrab_init(void) should be the first - function you call before you start to use libstatgrab. This - function on *bsd systems opens up the kernel structures and - leaves them open for future use. Because of this, any special - privileges the program has (e.g. setgid kmem) can be dropped - after this call, and all the libstatgrab calls should continue to - work. It is therefore a good idea to call + statgrab_init must be the first + function you call before you start to use libstatgrab; it performs all + the one-time initialisation operations that need setuid/setgid + privileges (for instance, on *BSD it opens a descriptor to be able to + read kernel structures later on, and on Solaris it reads the device + mappings that are only accessible by root). Once this has run, + the other libstatgrab functions no longer need elevated privileges. + It is therefore a good idea to call statgrab_drop_privileges, which discards setuid and setgid privileges, immediately after you call statgrab_init, unless your application has @@ -135,7 +136,7 @@ The library was originally written to support the i-scream central monitoring system, but has since become a standalone package. It - has been ported to work on Linux, FreeBSD, and Solaris. + has been ported to work on Linux, NetBSD, FreeBSD, Solaris and Cygwin.