From d8bb202fbdcd8a4664add12d15ccc26765d638e7 Mon Sep 17 00:00:00 2001
From: Martin Baulig <martin@src.gnome.org>
Date: Sun, 9 May 1999 15:33:02 +0000
Subject: [PATCH] Added information about the library function.

---
 doc/reference.texi | 51 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/doc/reference.texi b/doc/reference.texi
index c2a556b2..18c109c6 100644
--- a/doc/reference.texi
+++ b/doc/reference.texi
@@ -12,6 +12,15 @@
 @node glibtop_cpu, glibtop_mem, Reference Manual, Reference Manual
 @section CPU Usage
 
+Library function @code{glibtop_get_cpu}:
+
+@example
+@cartouche
+void glibtop_get_cpu (glibtop_cpu *buf);
+void glibtop_get_cpu_l (glibtop *server, glibtop_cpu *buf);
+@end cartouche
+@end example
+
 Declaration of @code{glibtop_cpu} in @file{<glibtop/cpu.h}:
 
 @example
@@ -75,10 +84,25 @@ need to be running all the time, so we set the corresponding bit for each
 CPU that is currently running.
 @end table
 
+Please note that all of the cpu values are absolute values measured in
+certain units (to get seconds, divide them by @code{frequency}) since system
+boot. To get percentual values, you need to call @code{glibtop_cpu}, save the
+result, wait some time and then call it again and divide the differences of
+the two values by the time you have waited.
+
 @page
 @node glibtop_mem, glibtop_swap, glibtop_cpu, Reference Manual
 @section Memory Usage
 
+Library function @code{glibtop_get_mem}:
+
+@example
+@cartouche
+void glibtop_get_mem (glibtop_mem *buf);
+void glibtop_get_mem_l (glibtop *server, glibtop_mem *buf);
+@end cartouche
+@end example
+
 Declaration of @code{glibtop_mem} in @file{<glibtop/mem.h}:
 
 @example
@@ -138,6 +162,15 @@ Memory in locked segments.
 @node glibtop_swap, glibtop_uptime, glibtop_mem, Reference Manual
 @section Swap Usage
 
+Library function @code{glibtop_get_swap}:
+
+@example
+@cartouche
+void glibtop_get_swap (glibtop_swap *buf);
+void glibtop_get_swap_l (glibtop *server, glibtop_swap *buf);
+@end cartouche
+@end example
+
 Declaration of @code{glibtop_swap} in @file{<glibtop/swap.h}:
 
 @example
@@ -188,6 +221,15 @@ Total number of swap pages that have been brought out since system boot
 @node glibtop_uptime, glibtop_loadavg, glibtop_swap, Reference Manual
 @section Uptime
 
+Library function @code{glibtop_get_uptime}:
+
+@example
+@cartouche
+void glibtop_get_uptime (glibtop_uptime *buf);
+void glibtop_get_uptime_l (glibtop *server, glibtop_uptime *buf);
+@end cartouche
+@end example
+
 Declaration of @code{glibtop_uptime} in @file{<glibtop/uptime.h}:
 
 @example
@@ -231,6 +273,15 @@ Time of last system boot in seconds since the epoch.
 @node glibtop_loadavg,  , glibtop_uptime, Reference Manual
 @section Load Average
 
+Library function @code{glibtop_get_loadavg}:
+
+@example
+@cartouche
+void glibtop_get_loadavg (glibtop_loadavg *buf);
+void glibtop_get_loadavg_l (glibtop *server, glibtop_loadavg *buf);
+@end cartouche
+@end example
+
 Declaration of @code{glibtop_loadavg} in @file{<glibtop/loadavg.h}:
 
 @example