summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Baulig <martin@src.gnome.org>1999-05-11 13:15:50 +0000
committerMartin Baulig <martin@src.gnome.org>1999-05-11 13:15:50 +0000
commit7d216d364eb2b71f709c9e8642b99d3b092dc392 (patch)
tree3b5246866c93eed766ae68370215ba8c97539b24 /doc
parent9e16f6e88ccdd0c351cf7c7f6fb53bfbd26947d5 (diff)
downloadlibgtop-7d216d364eb2b71f709c9e8642b99d3b092dc392.tar.gz
Added proc_mem.
Diffstat (limited to 'doc')
-rw-r--r--doc/libgtop.texi11
-rw-r--r--doc/reference.texi55
2 files changed, 63 insertions, 3 deletions
diff --git a/doc/libgtop.texi b/doc/libgtop.texi
index c728af3b..bbe5b451 100644
--- a/doc/libgtop.texi
+++ b/doc/libgtop.texi
@@ -31,6 +31,14 @@
About LibGTop
+
+
+
+
+ --- The Detailed Node Listing ---
+
+About LibGTop
+
* Availability:: Where to get LibGTop
* Supported Platforms:: Supported Platforms
* Mailing List:: Helping with LibGTop development
@@ -46,8 +54,7 @@ LibGTop Reference Manual
* glibtop_proclist:: Process List.
* glibtop_proc_state:: Process State.
* glibtop_proc_uid:: Process UID and TTY Information.
-
-@end detailmenu
+* glibtop_proc_mem:: Process Memory Information.
@end menu
@include about.texi
diff --git a/doc/reference.texi b/doc/reference.texi
index f0a4df18..7ae34f3e 100644
--- a/doc/reference.texi
+++ b/doc/reference.texi
@@ -10,6 +10,7 @@
* glibtop_proclist:: Process List.
* glibtop_proc_state:: Process State.
* glibtop_proc_uid:: Process UID and TTY Information.
+* glibtop_proc_mem:: Process Memory Information.
@end menu
@node glibtop_cpu, glibtop_mem, Reference Manual, Reference Manual
@@ -553,7 +554,7 @@ The process is currently swapping.
@end table
@page
-@node glibtop_proc_uid, , glibtop_proc_state, Reference Manual
+@node glibtop_proc_uid, glibtop_proc_mem, glibtop_proc_state, Reference Manual
@section Process UID and TTY information
Library function @code{glibtop_get_proc_uid}:
@@ -632,3 +633,55 @@ Array of additional process groups (@code{GLIBTOP_MAX_GROUPS} is
defined in @file{<glibtop/limits.h>}).
@end table
+@page
+@node glibtop_proc_mem, , glibtop_proc_uid, Reference Manual
+@section Process Memory information
+
+Library function @code{glibtop_get_proc_mem}:
+
+@example
+@cartouche
+void
+glibtop_get_proc_mem (glibtop_proc_mem *buf, pid_t pid);
+
+void
+glibtop_get_proc_mem_l (glibtop *server, glibtop_proc_mem *buf,
+ pid_t pid);
+@end cartouche
+@end example
+
+Declaration of @code{glibtop_proc_mem} in @file{<glibtop/procmem.h>}:
+
+@example
+@cartouche
+typedef struct _glibtop_proc_mem glibtop_proc_mem;
+
+struct _glibtop_proc_mem
+@{
+ u_int64_t flags,
+ size,
+ vsize,
+ resident,
+ share,
+ rss,
+ rss_rlim;
+@};
+@end cartouche
+@end example
+
+@table @code
+@item size
+Total number of pages of memory.
+@item vsize
+Number of pages of virtual memory.
+@item resident
+Number of residnet set (non-swapped) pages.
+@item share
+Number of pages of shared (mmap'd) memory.
+@item rss
+Number of pages the process has in real memory, minus 3 for administrative purposes.
+This is just the pages which count towards text, data, or stack space. This does not
+include pages which have not been demand-loaded in, or which are swapped out.
+@item rss_rlim
+Current limit in bytes on the rss of the process (usually 2,147,483,647).
+@end table