.\" Copyright (c) 1989 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted
.\" provided that the above copyright notice and this paragraph are
.\" duplicated in all such forms and that any documentation,
.\" advertising materials, and other materials related to such
.\" distribution and use acknowledge that the software was developed
.\" by the University of California, Berkeley.  The name of the
.\" University may not be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"	@(#)getloadavg.3	6.1 (Berkeley) %G%
.\"
.TH GETLOADAVG 3  ""
.UC 7
.SH NAME
getloadavg \- get system load averages
.SH SYNOPSIS
.nf
.B getloadavg(loadavg, nelem)
.B double loadavg[nelem];
.B int nelem;
.fi
.SH DESCRIPTION
.I Getloadavg
returns the number of processes in the system run queue
averaged over various periods of time.  Up to
.I nelem
samples are retrieved and assigned to successive elements of
.I loadavg[].
The system imposes a maximum of 3 samples, representing averages
over the last 1, 5, and 15 minutes, respectively.
.SH "SEE ALSO"
uptime(1), nlist(3), kmem(4)
.SH DIAGNOSTICS
If the load average was unobtainable, \-1 is returned; otherwise,
the number of samples actually retrieved is returned.
.SH BUGS
Programs using this utility must have read permission on
.I /dev/kmem.
This restriction will eventually be lifted.