Tue Jun 7 17:29:00 2011 UTC ()
Add a BUGS section to point out that the statistic "average" is an
average only of the current, minimum, and maximum values, and not a
running average of all displayed current values.


(pgoyette)
diff -r1.58 -r1.59 src/usr.sbin/envstat/envstat.8
cvs diff -r1.58 -r1.59 src/usr.sbin/envstat/envstat.8 (expand / switch to unified diff)

--- src/usr.sbin/envstat/envstat.8 2010/10/05 10:03:53 1.58
+++ src/usr.sbin/envstat/envstat.8 2011/06/07 17:28:59 1.59
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: envstat.8,v 1.58 2010/10/05 10:03:53 njoly Exp $ 1.\" $NetBSD: envstat.8,v 1.59 2011/06/07 17:28:59 pgoyette Exp $
2.\" 2.\"
3.\" Copyright (c) 2000, 2007, 2008, 2009 The NetBSD Foundation, Inc. 3.\" Copyright (c) 2000, 2007, 2008, 2009 The NetBSD Foundation, Inc.
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation 6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Juan Romero Pardines and Bill Squier. 7.\" by Juan Romero Pardines and Bill Squier.
8.\" 8.\"
9.\" Redistribution and use in source and binary forms, with or without 9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions 10.\" modification, are permitted provided that the following conditions
11.\" are met: 11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright 12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer. 13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -17,27 +17,27 @@ @@ -17,27 +17,27 @@
17.\" 17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE. 28.\" POSSIBILITY OF SUCH DAMAGE.
29.\" 29.\"
30.Dd October 5, 2010 30.Dd June 7, 2011
31.Dt ENVSTAT 8 31.Dt ENVSTAT 8
32.Os 32.Os
33.Sh NAME 33.Sh NAME
34.Nm envstat 34.Nm envstat
35.Nd utility to handle environmental sensors 35.Nd utility to handle environmental sensors
36.Sh SYNOPSIS 36.Sh SYNOPSIS
37.Nm 37.Nm
38.Op Fl DfIklSTWx 38.Op Fl DfIklSTWx
39.Op Fl c Ar file 39.Op Fl c Ar file
40.Op Fl d Ar device 40.Op Fl d Ar device
41.Op Fl i Ar interval 41.Op Fl i Ar interval
42.Op Fl s Ar "device:sensor,..." 42.Op Fl s Ar "device:sensor,..."
43.Op Fl w Ar width 43.Op Fl w Ar width
@@ -221,26 +221,32 @@ invalid states every second: @@ -221,26 +221,32 @@ invalid states every second:
221.Xr lm 4 , 221.Xr lm 4 ,
222.Xr lmtemp 4 , 222.Xr lmtemp 4 ,
223.Xr mfi 4 , 223.Xr mfi 4 ,
224.Xr nsclpcsio 4 , 224.Xr nsclpcsio 4 ,
225.Xr owtemp 4 , 225.Xr owtemp 4 ,
226.Xr pic16lc 4 , 226.Xr pic16lc 4 ,
227.Xr smsc 4 , 227.Xr smsc 4 ,
228.Xr tctrl 4 , 228.Xr tctrl 4 ,
229.Xr thinkpad 4 , 229.Xr thinkpad 4 ,
230.Xr tm121temp 4 , 230.Xr tm121temp 4 ,
231.Xr ug 4 , 231.Xr ug 4 ,
232.Xr viaenv 4 , 232.Xr viaenv 4 ,
233.Xr envsys.conf 5 233.Xr envsys.conf 5
 234.Sh BUGS
 235When displaying statistics using the
 236.Fl T
 237option, the average value is an average of the minimum, maximum, and
 238current sensor values.
 239It is not an average of all current values displayed during the session.
234.Sh HISTORY 240.Sh HISTORY
235.Nm 241.Nm
236appeared in 242appeared in
237.Nx 1.5 . 243.Nx 1.5 .
238It was completely rewritten from scratch for 244It was completely rewritten from scratch for
239.Nx 5.0 . 245.Nx 5.0 .
240.Sh AUTHORS 246.Sh AUTHORS
241.An -nosplit 247.An -nosplit
242The 248The
243.Nm 249.Nm
244utility that appeared in 250utility that appeared in
245.Nx 5.0 251.Nx 5.0
246was written by 252was written by