386BSD 0.1 development

[unix-history] / usr / src / lib / libutil / getloadavg.3

diff --git a/usr/src/lib/libutil/getloadavg.3 b/usr/src/lib/libutil/getloadavg.3
index b3a2b41..6864ec7 100644 (file)
--- a/usr/src/lib/libutil/getloadavg.3
+++ b/usr/src/lib/libutil/getloadavg.3
@@ -1,47 +1,68 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)getloadavg.3        6.2 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH GETLOADAVG 3  "June 23, 1990"
-.UC 7
-.SH NAME
-getloadavg \- get system load averages
-.SH SYNOPSIS
-.nf
-.B getloadavg(loadavg, nelem)
-.B double loadavg[nelem];
-.B int nelem;
-.fi
-.SH DESCRIPTION
-.I Getloadavg
+.\"     @(#)getloadavg.3       6.3 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt GETLOADAVG 3
+.Os
+.Sh NAME
+.Nm getloadavg
+.Nd get system load averages
+.Sh SYNOPSIS
+.Fn getloadavg "double loadavg[]" "int nelem"
+.Sh DESCRIPTION
+The
+.Fn getloadavg
+function

 returns the number of processes in the system run queue
 averaged over various periods of time.  Up to
 returns the number of processes in the system run queue
 averaged over various periods of time.  Up to

-.I nelem
+.Fa nelem

 samples are retrieved and assigned to successive elements of
 samples are retrieved and assigned to successive elements of

-.I loadavg[].
+.Fa loadavg Ns Bq .

 The system imposes a maximum of 3 samples, representing averages
 over the last 1, 5, and 15 minutes, respectively.
 The system imposes a maximum of 3 samples, representing averages
 over the last 1, 5, and 15 minutes, respectively.

-.SH "SEE ALSO"
-uptime(1), nlist(3), kmem(4)
-.SH DIAGNOSTICS
+.Sh DIAGNOSTICS

 If the load average was unobtainable, \-1 is returned; otherwise,
 the number of samples actually retrieved is returned.
 If the load average was unobtainable, \-1 is returned; otherwise,
 the number of samples actually retrieved is returned.

-.SH BUGS
+.Sh SEE ALSO
+.Xr uptime 1 ,
+.Xr nlist 3 ,
+.Xr kmem 4
+.Sh HISTORY
+The
+.Fn getloadavg
+function is
+.Ud .
+.Sh BUGS

 Programs using this utility must have read permission on
 Programs using this utility must have read permission on

-.I /dev/kmem.
+.Pa /dev/kmem .

 This restriction will eventually be lifted.
 This restriction will eventually be lifted.