projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
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. Neither the name of the University nor the names of its contributors | |
| 13 | .\" may be used to endorse or promote products derived from this software | |
| 14 | .\" without specific prior written permission. | |
| 15 | .\" | |
| 16 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
| 17 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 18 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 19 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
| 20 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 21 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 22 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 23 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 24 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 25 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 26 | .\" SUCH DAMAGE. | |
| 27 | .\" | |
| 28 | .\" @(#)getloadavg.3 8.1 (Berkeley) 6/4/93 | |
| 29 | .\" | |
| 352bedee | 30 | .\" 2007-12-08, mtk, Converted from mdoc to man macros |
| 3233d665 | 31 | .\" |
| 352bedee | 32 | .TH GETLOADAVG 3 2007-12-08 "Linux" "Linux Programmer's Manual" |
| 3233d665 MK |
33 | .SH NAME |
| 34 | getloadavg \- get system load averages | |
| 35 | .SH SYNOPSIS | |
| 36 | .nf | |
| b80f966b | 37 | .BR "#define _BSD_SOURCE" " /* See feature_test_macros(7) */" |
| 3233d665 MK |
38 | .B #include <stdlib.h> |
| 39 | .sp | |
| 40 | .BI "int getloadavg(double " loadavg[] ", int " nelem ); | |
| 41 | .fi | |
| 42 | .SH DESCRIPTION | |
| fea681da | 43 | The |
| 3233d665 | 44 | .BR getloadavg () |
| fea681da MK |
45 | function returns the number of processes in the system run queue |
| 46 | averaged over various periods of time. | |
| 47 | Up to | |
| 3233d665 | 48 | .I nelem |
| fea681da | 49 | samples are retrieved and assigned to successive elements of |
| 3233d665 | 50 | .IR loadavg []. |
| fea681da MK |
51 | The system imposes a maximum of 3 samples, representing averages |
| 52 | over the last 1, 5, and 15 minutes, respectively. | |
| 3233d665 | 53 | .SH RETURN VALUE |
| fea681da MK |
54 | If the load average was unobtainable, \-1 is returned; otherwise, |
| 55 | the number of samples actually retrieved is returned. | |
| 3233d665 | 56 | .\" .SH HISTORY |
| bed8a6f2 | 57 | .\" The |
| 3233d665 | 58 | .\" BR getloadavg () |
| bed8a6f2 | 59 | .\" function appeared in |
| 3233d665 MK |
60 | .\" 4.3BSD Reno . |
| 61 | .SH VERSIONS | |
| b62a20b7 | 62 | This function is available in glibc since version 2.2. |
| 3233d665 | 63 | .SH "CONFORMING TO" |
| c13182ef | 64 | Not in POSIX.1-2001. |
| a7fadb55 | 65 | Present on the BSDs and Solaris. |
| 08f75afe | 66 | .\" mdoc seems to have a bug - there must be no newline here |
| 3233d665 MK |
67 | .SH SEE ALSO |
| 68 | .BR uptime (1), | |
| 0a4f8b7b | 69 | .BR proc (5) |