.\" Copyright (c) 1989, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" %sccs.include.redist.man%
.\"
.\"     @(#)getloadavg.3	6.5 (Berkeley) 04/27/93
.\"
.Dd 
.Dt GETLOADAVG 3
.Os
.Sh NAME
.Nm getloadavg
.Nd get system load averages
.Sh SYNOPSIS
.Fd #include <sys/resource.h>
.Fn getloadavg "double loadavg[]" "int nelem"
.Sh DESCRIPTION
The
.Fn getloadavg
function returns the number of processes in the system run queue
averaged over various periods of time.
Up to
.Fa nelem
samples are retrieved and assigned to successive elements of
.Fa loadavg Ns Bq .
The system imposes a maximum of 3 samples, representing averages
over the last 1, 5, and 15 minutes, respectively.
.Sh DIAGNOSTICS
If the load average was unobtainable, \-1 is returned; otherwise,
the number of samples actually retrieved is returned.
.Sh SEE ALSO
.Xr uptime 1 ,
.Xr sysctl 2 ,
.Xr kvm_getloadavg 3
.Sh HISTORY
The
.Fn getloadavg
function appeared in
.Bx 4.3 Reno .