Re-arranged the reference manual a bit: put everything into subsections, not

sections and sort them by "System Dependent Function", "Common Functions" etc.
This commit is contained in:
Martin Baulig
1999-05-21 18:03:33 +00:00
parent 953f59195f
commit 3eb5394474
2 changed files with 72 additions and 40 deletions

View File

@@ -15,6 +15,15 @@
--- The Detailed Node Listing --- --- The Detailed Node Listing ---
@@ -37,6 +46,11 @@ Overview
LibGTop Reference Manual LibGTop Reference Manual
* System Dependent:: System Dependent Functions.
* Common Functions:: Common Functions.
System Dependent Functions
* glibtop_cpu:: CPU Usage. * glibtop_cpu:: CPU Usage.
* glibtop_mem:: Memory Usage. * glibtop_mem:: Memory Usage.
* glibtop_swap:: Swap Usage. * glibtop_swap:: Swap Usage.
@@ -54,6 +68,9 @@ LibGTop Reference Manual
* glibtop_proc_map:: Process Memory Maps. * glibtop_proc_map:: Process Memory Maps.
* glibtop_netload:: Network Load. * glibtop_netload:: Network Load.
* glibtop_ppp:: PPP Usage. * glibtop_ppp:: PPP Usage.
Common Functions
* glibtop_mountlist:: Mount List. * glibtop_mountlist:: Mount List.
* glibtop_fsusage:: File System Usage. * glibtop_fsusage:: File System Usage.
@end menu @end menu

View File

@@ -1,6 +1,14 @@
@node Reference Manual, , White Paper, Top @node Reference Manual, , White Paper, Top
@chapter LibGTop Reference Manual @chapter LibGTop Reference Manual
@menu
* System Dependent:: System Dependent Functions.
* Common Functions:: Common Functions.
@end menu
@node System Dependent, Common Functions, Reference Manual, Reference Manual
@section System Dependent Functions
@menu @menu
* glibtop_cpu:: CPU Usage. * glibtop_cpu:: CPU Usage.
* glibtop_mem:: Memory Usage. * glibtop_mem:: Memory Usage.
@@ -19,12 +27,10 @@
* glibtop_proc_map:: Process Memory Maps. * glibtop_proc_map:: Process Memory Maps.
* glibtop_netload:: Network Load. * glibtop_netload:: Network Load.
* glibtop_ppp:: PPP Usage. * glibtop_ppp:: PPP Usage.
* glibtop_mountlist:: Mount List.
* glibtop_fsusage:: File System Usage.
@end menu @end menu
@node glibtop_cpu, glibtop_mem, Reference Manual, Reference Manual @node glibtop_cpu, glibtop_mem, System Dependent, System Dependent
@section CPU Usage @subsection CPU Usage
Library function @code{glibtop_get_cpu}: Library function @code{glibtop_get_cpu}:
@@ -112,8 +118,8 @@ result, wait some time and then call it again and divide the differences of
the two values by the time you have waited. the two values by the time you have waited.
@page @page
@node glibtop_mem, glibtop_swap, glibtop_cpu, Reference Manual @node glibtop_mem, glibtop_swap, glibtop_cpu, System Dependent
@section Memory Usage @subsection Memory Usage
Library function @code{glibtop_get_mem}: Library function @code{glibtop_get_mem}:
@@ -180,8 +186,8 @@ Memory in locked segments.
@end table @end table
@page @page
@node glibtop_swap, glibtop_uptime, glibtop_mem, Reference Manual @node glibtop_swap, glibtop_uptime, glibtop_mem, System Dependent
@section Swap Usage @subsection Swap Usage
Library function @code{glibtop_get_swap}: Library function @code{glibtop_get_swap}:
@@ -239,8 +245,8 @@ Total number of swap pages that have been brought out since system boot
@end table @end table
@page @page
@node glibtop_uptime, glibtop_loadavg, glibtop_swap, Reference Manual @node glibtop_uptime, glibtop_loadavg, glibtop_swap, System Dependent
@section Uptime @subsection Uptime
Library function @code{glibtop_get_uptime}: Library function @code{glibtop_get_uptime}:
@@ -291,8 +297,8 @@ Time of last system boot in seconds since the epoch.
@end table @end table
@page @page
@node glibtop_loadavg, glibtop_proclist, glibtop_uptime, Reference Manual @node glibtop_loadavg, glibtop_proclist, glibtop_uptime, System Dependent
@section Load Average @subsection Load Average
Library function @code{glibtop_get_loadavg}: Library function @code{glibtop_get_loadavg}:
@@ -343,8 +349,8 @@ Last PID.
@end table @end table
@page @page
@node glibtop_proclist, glibtop_proc_state, glibtop_loadavg, Reference Manual @node glibtop_proclist, glibtop_proc_state, glibtop_loadavg, System Dependent
@section Process List @subsection Process List
Library function @code{glibtop_get_proclist}: Library function @code{glibtop_get_proclist}:
@@ -461,8 +467,8 @@ The returned list is allocated using @code{glibtop_malloc} and must be freed
using @code{glibtop_free} to avoid a memory leak. using @code{glibtop_free} to avoid a memory leak.
@page @page
@node glibtop_proc_state, glibtop_proc_uid, glibtop_proclist, Reference Manual @node glibtop_proc_state, glibtop_proc_uid, glibtop_proclist, System Dependent
@section Process State @subsection Process State
Library function @code{glibtop_get_proc_state}: Library function @code{glibtop_get_proc_state}:
@@ -571,8 +577,8 @@ The process is currently swapping.
@end table @end table
@page @page
@node glibtop_proc_uid, glibtop_proc_mem, glibtop_proc_state, Reference Manual @node glibtop_proc_uid, glibtop_proc_mem, glibtop_proc_state, System Dependent
@section Process UID and TTY information @subsection Process UID and TTY information
Library function @code{glibtop_get_proc_uid}: Library function @code{glibtop_get_proc_uid}:
@@ -651,8 +657,8 @@ Array of additional process groups@*
@end table @end table
@page @page
@node glibtop_proc_mem, glibtop_proc_time, glibtop_proc_uid, Reference Manual @node glibtop_proc_mem, glibtop_proc_time, glibtop_proc_uid, System Dependent
@section Process Memory information @subsection Process Memory information
Library function @code{glibtop_get_proc_mem}: Library function @code{glibtop_get_proc_mem}:
@@ -766,8 +772,8 @@ The hints above describe how it works under Linux - but we should try to make
@code{glibtop_get_proc_mem} show the same behavior under every other system. @code{glibtop_get_proc_mem} show the same behavior under every other system.
@page @page
@node glibtop_proc_time, glibtop_proc_signal, glibtop_proc_mem, Reference Manual @node glibtop_proc_time, glibtop_proc_signal, glibtop_proc_mem, System Dependent
@section Process Time information @subsection Process Time information
Library function @code{glibtop_get_proc_time}: Library function @code{glibtop_get_proc_time}:
@@ -834,8 +840,8 @@ SMP kernel-mode CPU time accumulated by process
@end table @end table
@page @page
@node glibtop_proc_signal, glibtop_proc_kernel, glibtop_proc_time, Reference Manual @node glibtop_proc_signal, glibtop_proc_kernel, glibtop_proc_time, System Dependent
@section Process Signal information @subsection Process Signal information
Library function @code{glibtop_get_proc_signal}: Library function @code{glibtop_get_proc_signal}:
@@ -879,8 +885,8 @@ Mask of caught signals
@end table @end table
@page @page
@node glibtop_proc_kernel, glibtop_proc_segment, glibtop_proc_signal, Reference Manual @node glibtop_proc_kernel, glibtop_proc_segment, glibtop_proc_signal, System Dependent
@section Process Kernel Data information @subsection Process Kernel Data information
Library function @code{glibtop_get_proc_kernel}: Library function @code{glibtop_get_proc_kernel}:
@@ -979,8 +985,8 @@ Process was killed by a signal.
@end table @end table
@page @page
@node glibtop_proc_segment, glibtop_proc_args, glibtop_proc_kernel, Reference Manual @node glibtop_proc_segment, glibtop_proc_args, glibtop_proc_kernel, System Dependent
@section Process Segment information @subsection Process Segment information
Library function @code{glibtop_get_proc_segment}: Library function @code{glibtop_get_proc_segment}:
@@ -1045,38 +1051,47 @@ Address of the bottom of stack segmen
@end table @end table
@page @page
@node glibtop_proc_args, glibtop_proc_map, glibtop_proc_segment, Reference Manual @node glibtop_proc_args, glibtop_proc_map, glibtop_proc_segment, System Dependent
@section Process Arguments @subsection Process Arguments
[Not yet written.] [Not yet written.]
@page @page
@node glibtop_proc_map, glibtop_netload, glibtop_proc_args, Reference Manual @node glibtop_proc_map, glibtop_netload, glibtop_proc_args, System Dependent
@section Process Memory Maps @subsection Process Memory Maps
[Not yet written.] [Not yet written.]
@page @page
@node glibtop_netload, glibtop_ppp, glibtop_proc_map, Reference Manual @node glibtop_netload, glibtop_ppp, glibtop_proc_map, System Dependent
@section Network Load @subsection Network Load
[Not yet written.] [Not yet written.]
@page @page
@node glibtop_ppp, glibtop_mountlist, glibtop_netload, Reference Manual @node glibtop_ppp, , glibtop_netload, System Dependent
@section PPP Statistics @subsection PPP Statistics
[Not yet written.] [Not yet written.]
@page @page
@node glibtop_mountlist, glibtop_fsusage, glibtop_ppp, Reference Manual @node Common Functions, , System Dependent, Reference Manual
@section Mount List @section Common Functions
@menu
* glibtop_mountlist:: Mount List.
* glibtop_fsusage:: File System Usage.
@end menu
@page
@node glibtop_mountlist, glibtop_fsusage, Common Functions, Common Functions
@subsection Mount List
[Not yet written.] [Not yet written.]
@page @page
@node glibtop_fsusage, , glibtop_mountlist, Reference Manual @node glibtop_fsusage, , glibtop_mountlist, Common Functions
@section File System Usage @subsection File System Usage
[Not yet written.] [Not yet written.]