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