Clean up #include's in the SYNOPSIS.
[dragonfly.git] / lib / libkvm / kvm_getloadavg.3
1 .\" Copyright (c) 1992, 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 .\"     @(#)kvm_getloadavg.3    8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libkvm/kvm_getloadavg.3,v 1.8.2.2 2001/12/17 10:08:30 ru Exp $
34 .\" $DragonFly: src/lib/libkvm/kvm_getloadavg.3,v 1.2 2003/06/17 04:26:49 dillon Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt KVM_GETLOADAVG 3
38 .Os
39 .Sh NAME
40 .Nm kvm_getloadavg
41 .Nd get load average of the system
42 .Sh LIBRARY
43 .Lb libkvm
44 .Sh SYNOPSIS
45 .In sys/types.h
46 .In kvm.h
47 .Ft int
48 .Fn kvm_getloadavg "kvm_t *kd" "double loadavg[]" "int nelem"
49 .Sh DESCRIPTION
50 The
51 .Fn kvm_getloadavg
52 function returns the number of processes in the system run queue
53 of the kernel indicated by
54 .Fa kd ,
55 averaged over various periods of time.
56 Up to
57 .Fa nelem
58 samples are retrieved and assigned to successive elements of
59 .Fa loadavg Ns Bq .
60 The system imposes a maximum of 3 samples, representing averages
61 over the last 1, 5, and 15 minutes, respectively.
62 .Sh DIAGNOSTICS
63 If the load average was unobtainable, \-1 is returned; otherwise,
64 the number of samples actually retrieved is returned.
65 .Sh SEE ALSO
66 .Xr uptime 1 ,
67 .Xr getloadavg 3 ,
68 .Xr kvm 3