1.\" Copyright (c) 1989, 1991 The Regents of the University of California. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getloadavg.3 6.3 (Berkeley) 4/19/91 33.\" 34.Dd April 19, 1991 35.Dt GETLOADAVG 3 36.Os 37.Sh NAME 38.Nm getloadavg 39.Nd get system load averages 40.Sh SYNOPSIS 41.Fn getloadavg "double loadavg[]" "int nelem" 42.Sh DESCRIPTION 43The 44.Fn getloadavg 45function 46returns the number of processes in the system run queue 47averaged over various periods of time. Up to 48.Fa nelem 49samples are retrieved and assigned to successive elements of 50.Fa loadavg Ns Bq . 51The system imposes a maximum of 3 samples, representing averages 52over the last 1, 5, and 15 minutes, respectively. 53.Sh DIAGNOSTICS 54If the load average was unobtainable, \-1 is returned; otherwise, 55the number of samples actually retrieved is returned. 56.Sh SEE ALSO 57.Xr uptime 1 , 58.Xr nlist 3 , 59.Xr kmem 4 60.Sh HISTORY 61The 62.Fn getloadavg 63function is 64.Ud . 65.Sh BUGS 66Programs using this utility must have read permission on 67.Pa /dev/kmem . 68This restriction will eventually be lifted. 69