ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/libstatgrab/docs/statgrab.xml
(Generate patch)

Comparing projects/libstatgrab/docs/statgrab.xml (file contents):
Revision 1.1 by tdb, Thu Oct 2 17:38:03 2003 UTC vs.
Revision 1.4 by ats, Mon Jan 5 17:27:29 2004 UTC

# Line 26 | Line 26
26        <funcsynopsisinfo>#include &lt;statgrab.h&gt;</funcsynopsisinfo>
27  
28        <funcprototype>
29 +        <funcdef>int <function>statgrab_init</function></funcdef>
30 +        <void/>
31 +      </funcprototype>
32 +      <funcprototype>
33 +        <funcdef>int <function>statgrab_drop_privileges</function></funcdef>
34 +        <void/>
35 +      </funcprototype>
36 +
37 +      <funcprototype>
38          <funcdef>cpu_percent_t *<function>cpu_percent_usage</function></funcdef>
39          <void/>
40        </funcprototype>
# Line 100 | Line 109
109    <refsect1>
110      <title>Description</title>
111      <para>
112 <      The statgrab library provides a cross platform interface to getting
112 >      The statgrab library provides a cross-platform interface to getting
113        system statistics. Each of the function calls returns a structure
114        containing statistics. See the manual page for each individual
115        function for more details on usage.
116      </para>
117      <para>
118 +      <function>statgrab_init</function> must be the first
119 +      function you call before you start to use libstatgrab; it performs all
120 +      the one-time initialisation operations that need setuid/setgid
121 +      privileges (for instance, on *BSD it opens a descriptor to be able to
122 +      read kernel structures later on, and on Solaris it reads the device
123 +      mappings that are only accessible by root). Once this has run,
124 +      the other libstatgrab functions no longer need elevated privileges.
125 +      It is therefore a good idea to call
126 +      <function>statgrab_drop_privileges</function>, which discards
127 +      setuid and setgid privileges, immediately after you call
128 +      <function>statgrab_init</function>, unless your application has
129 +      another reason for needing setuid or setgid privileges.
130 +    </para>
131 +    <para>
132 +      <function>statgrab_init</function> and
133 +      <function>statgrab_drop_privileges</function> return 0 on success, and
134 +      non-zero on failure.
135 +    </para>
136 +    <para>
137        The library was originally written to support the i-scream central
138        monitoring system, but has since become a standalone package. It
139 <      has been ported to work on Linux, FreeBSD, and Solaris.
139 >      has been ported to work on Linux, NetBSD, FreeBSD, Solaris and Cygwin.
140      </para>
141    </refsect1>
142    

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines