| | 1 | .\" Copyright (c) 1989, 1991, 1993 |
| | 2 | .\" The Regents of the University of California. 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 8.1 (Berkeley) 6/4/93 |
| | 33 | .\" $FreeBSD: src/lib/libc/gen/getloadavg.3,v 1.8 2001/10/01 16:08:51 ru Exp $ |
| | 34 | .\" |
| | 35 | .Dd June 4, 1993 |
| | 36 | .Dt GETLOADAVG 3 |
| | 37 | .Os |
| | 38 | .Sh NAME |
| | 39 | .Nm getloadavg |
| | 40 | .Nd get system load averages |
| | 41 | .Sh LIBRARY |
| | 42 | .Lb libc |
| | 43 | .Sh SYNOPSIS |
| | 44 | .In stdlib.h |
| | 45 | .Ft int |
| | 46 | .Fn getloadavg "double loadavg[]" "int nelem" |
| | 47 | .Sh DESCRIPTION |
| | 48 | The |
| | 49 | .Fn getloadavg |
| | 50 | function returns the number of processes in the system run queue |
| | 51 | averaged over various periods of time. |
| | 52 | Up to |
| | 53 | .Fa nelem |
| | 54 | samples are retrieved and assigned to successive elements of |
| | 55 | .Fa loadavg Ns Bq . |
| | 56 | The system imposes a maximum of 3 samples, representing averages |
| | 57 | over the last 1, 5, and 15 minutes, respectively. |
| | 58 | .Sh DIAGNOSTICS |
| | 59 | If the load average was unobtainable, \-1 is returned; otherwise, |
| | 60 | the number of samples actually retrieved is returned. |
| | 61 | .Sh SEE ALSO |
| | 62 | .Xr uptime 1 , |
| | 63 | .Xr kvm_getloadavg 3 , |
| | 64 | .Xr sysctl 3 |
| | 65 | .Sh HISTORY |
| | 66 | The |
| | 67 | .Fn getloadavg |
| | 68 | function appeared in |
| | 69 | .Bx 4.3 Reno . |
projects / apple / libc.git / blame_incremental