man/man3/getloadavg.3

   1 .\"     @(#)getloadavg.3
   2 .\"
   3 .TH GETLOADAVG 3 "Nov 14, 2005"
   4 .AT 3
   5 .SH NAME
   6 getloadavg \- system load average values
   7 .SH SYNOPSIS
   8 .nf
   9 .ft B
  10 #include <stdlib.h>
  11
  12 int getloadavg(double *\fIaverages\fP, int \fInelem\fP)
  13 .ft R
  14 .fi
  15 .SH DESCRIPTION
  16 .B Getloadavg
  17 returns the system load average values as elements of
  18 .IR averages
  19 up to
  20 a maximum of
  21 .IR nelem
  22 elements.
  23 The system load average is the average number of
  24 runnable processes over a certain period. Currently the averages are
  25 delivered over the last 1, 5 and 15 minutes of system usage. So
  26 currently the system maximum is 3.
  27 .SH RETURNS
  28 The returned value  of
  29 .B getloadavg
  30 is zero or more if the call was successful, or a negative value if the
  31 call was unsuccessful. If the call was successful, the number of
  32 elements entered into
  33 .IR averages
  34 is returned.
  35 .SH SEE ALSO
  36 .BR uptime (1).