diff options
-rw-r--r-- | doc/ChangeLog | 5 | ||||
-rw-r--r-- | doc/about.texi | 113 | ||||
-rw-r--r-- | doc/libgtop.texi | 118 | ||||
-rw-r--r-- | doc/reference.texi | 73 |
4 files changed, 199 insertions, 110 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index a1d05301..6073fbd4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,4 +1,9 @@ 1999-05-09 Martin Baulig <martin@home-of-linux.org> + * about.texi: Split the `libgtop.texi' into one file pro chapter, + this is the "About LibGTop". + + * reference.texi: The "LibGTop Reference Manual". + * libgtop.texi: Initial version of the new LibGTop Manual. diff --git a/doc/about.texi b/doc/about.texi new file mode 100644 index 00000000..bed42aca --- /dev/null +++ b/doc/about.texi @@ -0,0 +1,113 @@ +@node About, Reference Manual, Top, Top +@chapter About LibGTop + +LibGTop is a library to get system specific data such as CPU and Memory Usage +and information about running Processes. + +On Systems like Solaris or Digital Unix where you need special privileges to +get those data, it uses a setuid/setgid server to do so. + +@menu +* Availability:: Where to get LibGTop +* Supported Platforms:: Supported Platforms +* Mailing List:: Helping with LibGTop development +* Thanks:: People who contributed to LibGTop +@end menu + +@node Availability, Supported Platforms, About, About +@section Availability + +The master source of LibGTop is the GNOME CVS tree +(see @uref{http://www.gnome.org} for details), but you can also get the +latest release tarballs from + +@display +@uref{ftp://ftp.gnome.org/pub/GNOME/sources/libgtop/} +@end display + +@noindent +or any of its mirror sites. + +The latest stable version of LibGTop is 1.0.1 which is also the one that comes +together with GNOME 1.0. In CVS, there is a @code{LIBGTOP_STABLE_1_0} branch +which is rooted at the @code{LIBGTOP_1_0_1} tag while actual development occurs +in the @code{HEAD} which currently has version 1.1.0. + +@node Supported Platforms, Mailing List, Availability, About +@section Supported Platforms + +The stable branch currently supports the following platforms: + +@itemize @bullet +@item All versions of Linux + +LibGTop was tested under Linux 2.0.x and 2.2.x on the ix86 and the alpha, but +it should also work without problems on SparcLinux. + +@item FreeBSD, NetBSD and OpenBSD + +LibGTop was tested under FreeBSD 2.2.6 and 3.0, NetBSD 1.3.2 and OpenBSD 2.4. + +@end itemize + +The platforms listed above are known to be stable and working. However, if +you're using the latest development version, you can use it on the following +platforms as well: + +@itemize @bullet +@item BSD/OS + +There is a port for BSD/OS (aka BSDI) 2.x and 3.x from Timur Bakeyev which +should also work with 4.x. This isn't tested very well, but it should be +working. + +@item Digital Unix + +There is some basic support for Digital Unix (formerly DEC OSF/1) V3.2C, but +this may still be a bit unstable. I'm currently working on this port as time +permits so it should be fully supported soon. + +@item Solaris + +There will be a Solaris port of LibGTop very soon. Especially Drazen Kacar and +some other people have been doing excellent work here and I'm sure that this +port will be ready soon. + +@end itemize + +@node Mailing List, Thanks, Supported Platforms, About +@section Mailing List + +There is a @email{libgtop-devel-list@@egroups.com} mailing list for people who +want to help with the development of LibGTop. + +It is meant as a low-traffic, but high content-list where we can discuss +technical details such as adding new sysdeps ports etc. + +Especially, I'd like to see people with a deeper knowledge of operating systems +internals joining my list so we can discuss technical details of the sysdeps +code. + +It is *not* for users that want to know how to compile LibGTop etc. + +You can subscribe to this mailing list and view the mailing list archives +on the LibGTop Page at @uref{http://www.home-of-linux.org/gnome/libgtop}. + +@node Thanks, , Mailing List, About +@section Thanks + +At the place I'd like to thank the following people who contributed to +LibGTop (listed in chronological order): + +@itemize @bullet +@item Sebastian Wilhelmi who had the initial idea of LibGTop and helped +me a lot in the early beginning. +@item Josh Sled for the initial FreeBSD port. +@item Jeremy Lea for his BSD patches. +@item Timur Bakeyev for the BSDI port. +@item Drazen Kacar and the other people on the LibGTop development mailing +list for the Solaris port. +@item All people sending me patches, having good ideas, ... +@item Everyone I have forgotten in this list ... +@end itemize + diff --git a/doc/libgtop.texi b/doc/libgtop.texi index 8d1558ac..27869a52 100644 --- a/doc/libgtop.texi +++ b/doc/libgtop.texi @@ -9,129 +9,27 @@ @menu * About:: About LibGTop +* Reference Manual:: LibGTop Reference Manual - --- The Detailed Node Listing --- - -About LibGTop -* Availability:: Where to get LibGTop -* Supported Platforms:: Supported Platforms -* Mailing List:: Helping with LibGTop development -* Thanks:: People who contributed to LibGTop -@end menu -@node About, , Top, Top -@chapter About LibGTop -LibGTop is a library to get system specific data such as CPU and Memory Usage -and information about running Processes. + --- The Detailed Node Listing --- -On Systems like Solaris or Digital Unix where you need special privileges to -get those data, it uses a setuid/setgid server to do so. +About LibGTop -@menu * Availability:: Where to get LibGTop * Supported Platforms:: Supported Platforms * Mailing List:: Helping with LibGTop development * Thanks:: People who contributed to LibGTop -@end menu - -@node Availability, Supported Platforms, About, About -@section Availability - -The master source of LibGTop is the GNOME CVS tree -(see @uref{http://www.gnome.org} for details), but you can also get the -latest release tarballs from - -@display -@uref{ftp://ftp.gnome.org/pub/GNOME/sources/libgtop/} -@end display - -@noindent -or any of its mirror sites. - -The latest stable version of LibGTop is 1.0.1 which is also the one that comes -together with GNOME 1.0. In CVS, there is a @code{LIBGTOP_STABLE_1_0} branch -which is rooted at the @code{LIBGTOP_1_0_1} tag while actual development occurs -in the @code{HEAD} which currently has version 1.1.0. - -@node Supported Platforms, Mailing List, Availability, About -@section Supported Platforms - -The stable branch currently supports the following platforms: - -@itemize @bullet -@item All versions of Linux -LibGTop was tested under Linux 2.0.x and 2.2.x on the ix86 and the alpha, but -it should also work without problems on SparcLinux. +LibGTop Reference Manual -@item FreeBSD, NetBSD and OpenBSD - -LibGTop was tested under FreeBSD 2.2.6 and 3.0, NetBSD 1.3.2 and OpenBSD 2.4. - -@end itemize - -The platforms listed above are known to be stable and working. However, if -you're using the latest development version, you can use it on the following -platforms as well: - -@itemize @bullet -@item BSD/OS - -There is a port for BSD/OS (aka BSDI) 2.x and 3.x from Timur Bakeyev which -should also work with 4.x. This isn't tested very well, but it should be -working. - -@item Digital Unix - -There is some basic support for Digital Unix (formerly DEC OSF/1) V3.2C, but -this may still be a bit unstable. I'm currently working on this port as time -permits so it should be fully supported soon. - -@item Solaris - -There will be a Solaris port of LibGTop very soon. Especially Drazen Kacar and -some other people have been doing excellent work here and I'm sure that this -port will be ready soon. - -@end itemize - -@node Mailing List, Thanks, Supported Platforms, About -@section Mailing List - -There is a @email{libgtop-devel-list@@egroups.com} mailing list for people who -want to help with the development of LibGTop. - -It is meant as a low-traffic, but high content-list where we can discuss -technical details such as adding new sysdeps ports etc. - -Especially, I'd like to see people with a deeper knowledge of operating systems -internals joining my list so we can discuss technical details of the sysdeps -code. - -It is *not* for users that want to know how to compile LibGTop etc. - -You can subscribe to this mailing list and view the mailing list archives -at @uref{http://www.home-of-linux.org/gnome/libgtop}. - -@node Thanks, , Mailing List, About -@section Thanks - -At the place I'd like to thank the following people who contributed to -LibGTop (listed in chronological order): +* glibtop_cpu:: CPU Usage. +@end menu -@itemize @bullet -@item Sebastian Wilhelmi who had the initial idea of LibGTop and helped -me a lot in the early beginning. -@item Josh Sled for the initial FreeBSD port. -@item Jeremy Lea for his BSD patches. -@item Timur Bakeyev for the BSDI port. -@item Drazen Kacar and the other people on the LibGTop development mailing -list for the Solaris port. -@item All people sending me patches, having good ideas, ... -@item Everyone I have forgotten in this list ... -@end itemize +@include about.texi +@include reference.texi @bye diff --git a/doc/reference.texi b/doc/reference.texi new file mode 100644 index 00000000..a3044247 --- /dev/null +++ b/doc/reference.texi @@ -0,0 +1,73 @@ +@node Reference Manual, , About, Top +@chapter LibGTop Reference Manual + +@menu +* glibtop_cpu:: CPU Usage. +@end menu + +@node glibtop_cpu, , Reference Manual, Reference Manual +@section CPU Usage + +Declaration of @code{glibtop_cpu} in @file{<glibtop/cpu.h}: + +@example +@cartouche +typedef struct _glibtop_cpu glibtop_cpu; + +struct _glibtop_cpu +@{ + u_int64_t flags, + total, + user, + nice, + sys, + idle, + frequency, + xcpu_total [GLIBTOP_NCPU], + xcpu_user [GLIBTOP_NCPU], + xcpu_nice [GLIBTOP_NCPU], + xcpu_sys [GLIBTOP_NCPU], + xcpu_idle [GLIBTOP_NCPU], + xcpu_flags; +@}; +@end cartouche +@end example + +All CPU units are measured in @dfn{jiffies} which are normally 1/100th of a +second (in which case @code{frequency} equals 100), but can also be in any +other unit. To get seconds, divide them by @code{frequency}. + +@table @code +@item total +Number of clock ticks since system boot. + +@item user +Number of clock ticks the system spent in user mode. + +@item nice +Number of clock ticks the system spent in user mode (nice). + +@item sys +Number of clock ticks the system spent in system mode. + +@item idle +Number of clock ticks the system spent in the idle task. + +@item frequency +Tick frequency (default is 100). + +@end table + +The @samp{xcpu_} values are for SMP systems - they are the same than +@code{total}, @code{user}, @code{nice}, @code{sys} and @code{idle} +except that they are arrays of @code{GLIBTOP_NCPU} (defined in +@file{<glibtop/limits.h>}) elements and contain one value for each CPU +in the system. + +@table @code +@item xcpu_flags +This is interpreted as a bit-field: on systems like Solaris, not all CPUs +need to be running all the time, so we set the corresponding bit for each +CPU that is currently running. +@end table + |