Update.

2001-01-07  Ben Collins  <bcollins@debian.org>

	* manual/examples/longopt.c: Make the "struct option" a little
	more like it should be, adding usage of required_argument,
	noargument and such, and also setting the options string right.

	* manual/sysinfo.texi (Load Average): New section, documents
	getloadavg().

1 files changed, 21 insertions, 0 deletions

diff --git a/manual/sysinfo.texi b/manual/sysinfo.texi
index ee5009b2ac..1768d01273 100644
--- a/manual/sysinfo.texi
+++ b/manual/sysinfo.texi
@@ -15,6 +15,7 @@ can make changes.
                                   machine type
 * Filesystem Handling::         Controlling/querying mounts
 * System Parameters::           Getting and setting various system parameters
+* Load Average::                Getting the system load average
 @end menu
 
 To get information on parameters of the system that are built into the
@@ -1190,3 +1191,23 @@ parameters are:
 @item
 @code{bdflush}
 @end itemize
+
+@node Load Average
+@section Getting the system load average
+
+This section describes the @code{getloadavg} function, which gets the 1, 5
+and 15 minute load averages of the system. The load average is the number of
+processes in the system run queue, averaged over various periods of time
+(1, 5 and 15 minutes in this case).
+
+The symbols used in this section are declared in the file @file{stdlib.h}.
+
+@comment stdlib.h
+@comment BSD
+@deftypefun int getloadavg (double @var{loadavg}[], int @var{nelem})
+This function gets the 1, 5 and 15 minute load averages of the system. The
+values are placed in @var{loadavg}. The function will place at most
+@var{nelem} elements into the array, @var{loadavg}. Never are there more
+than three elements returned and possibly less than @var{nelem}. The return
+value is the number of elements written to @var{loadavg}, or -1 on error.
+@end deftypefun