getloadavg(3) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


GETLOADAVG(3)                           BSD Library Functions Manual                           GETLOADAVG(3)

NAME
     getloadavg -- get system load averages

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <stdlib.h>

     int
     getloadavg(double loadavg[], int nelem);

DESCRIPTION
     The getloadavg() function returns the number of processes in the system run queue averaged over various
     periods of time.  Up to nelem samples are retrieved and assigned to successive elements of loadavg[].
     The system imposes a maximum of 3 samples, representing averages over the last 1, 5, and 15 minutes,
     respectively.

DIAGNOSTICS
     If the load average was unobtainable, -1 is returned; otherwise, the number of samples actually
     retrieved is returned.

SEE ALSO
     uptime(1), kvm_getloadavg(3), sysctl(3)

HISTORY
     The getloadavg() function appeared in 4.3BSD-Reno.

BSD                                             June 4, 1993                                             BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation with the feedback links below.
Bug reports: Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?