[src/trunk]: src/share/man/man4 Document the recently added 'maximum-capacity...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/1749da403662
branches:  trunk
changeset: 753010:1749da403662
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Sun Mar 14 14:47:03 2010 +0000

description:
Document the recently added 'maximum-capacity' and 'high-capacity'
limits for battery sensors.

diffstat:

 share/man/man4/envsys.4 |  28 ++++++++++++++++++++++++++--
 1 files changed, 26 insertions(+), 2 deletions(-)

diffs (71 lines):

diff -r e069535eb62f -r 1749da403662 share/man/man4/envsys.4
--- a/share/man/man4/envsys.4   Sun Mar 14 12:36:32 2010 +0000
+++ b/share/man/man4/envsys.4   Sun Mar 14 14:47:03 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: envsys.4,v 1.47 2010/02/09 08:31:34 wiz Exp $
+.\"    $NetBSD: envsys.4,v 1.48 2010/03/14 14:47:03 pgoyette Exp $
 .\"
 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd February 9, 2010
+.Dd March 14, 2010
 .Dt ENVSYS 4
 .Os
 .Sh NAME
@@ -109,10 +109,14 @@
                \&\*[Lt]integer\&\*[Gt]406000\&\*[Lt]\&/integer\&\*[Gt]
                \&\*[Lt]key\&\*[Gt]description\&\*[Lt]\&/key\&\*[Gt]
                \&\*[Lt]string\&\*[Gt]CPU Temp\&\*[Lt]\&/string\&\*[Gt]
+               \&\*[Lt]key\&\*[Gt]high-capacity\&\*[Lt]\&/key\&\*[Gt]
+               \&\*[Lt]integer\&\*[Gt]21417\&\*[Lt]\&/integer\&\*[Gt]
                \&\*[Lt]string\&\*[Gt]index\&\*[Lt]\&/string\&\*[Gt]
                \&\*[Lt]string\&\*[Gt]sensor0\&\*[Lt]\&/string\&\*[Gt]
                \&\*[Lt]key\&\*[Gt]max-value\&\*[Lt]\&/key\&\*[Gt]
                \&\*[Lt]integer\&\*[Gt]3894000\&\*[Lt]\&/integer\&\*[Gt]
+               \&\*[Lt]key\&\*[Gt]maximum-capacity\&\*[Lt]\&/key\&\*[Gt]
+               \&\*[Lt]integer\&\*[Gt]21417\&\*[Lt]\&/integer\&\*[Gt]
                \&\*[Lt]key\&\*[Gt]min-value\&\*[Lt]\&/key\&\*[Gt]
                \&\*[Lt]integer\&\*[Gt]2894000\&\*[Lt]\&/integer\&\*[Gt]
                \&\*[Lt]key\&\*[Gt]monitoring-state-critical\&\*[Lt]\&/key\&\*[Gt]
@@ -182,10 +186,26 @@
 Current value in the sensor.
 .It Fa description
 Description of the sensor.
+.It Fa high-capacity
+High capacity set previously by the
+.Dv ENVSYS_SETDICTIONARY
+.Xr ioctl 2 .
+Only available on sensors with the
+.Em want-percentage
+object enabled.
+Used to monitor possible over-charging of batteries.
 .It Fa index
 Index position of the sensor.
 .It Fa max-value
 Current max value in the sensor.
+.It Fa maximum-capacity
+Maximum capacity set previously by the
+.Dv ENVSYS_SETDICTIONARY
+.Xr ioctl 2 .
+Only available on sensors with the
+.Em want-percentage
+object enabled.
+Used to monitor possible over-charging of batteries.
 .It Fa min-value
 Current min value in the sensor.
 .It Fa monitoring-state-critical
@@ -267,6 +287,10 @@
        \&\*[Lt]integer\&\*[Gt]3400\&\*[Lt]\&/integer\&\*[Gt]
        \&\*[Lt]key\&\*[Gt]critical-min\&\*[Lt]\&/key\&\*[Gt]
        \&\*[Lt]integer\&\*[Gt]2800\&\*[Lt]\&/integer\&\*[Gt]
+       \&\*[Lt]key\&\*[Gt]high-capacity\&\*[Lt]\&/key\&\*[Gt]
+       \&\*[Lt]integer\&\*[Gt]95\&\*[Lt]\&/integer\&\*[Gt]
+       \&\*[Lt]key\&\*[Gt]maximum-capacity\&\*[Lt]\&/key\&\*[Gt]
+       \&\*[Lt]integer\&\*[Gt]100\&\*[Lt]\&/integer\&\*[Gt]
        \&\*[Lt]key\&\*[Gt]warning-capacity\&\*[Lt]\&/key\&\*[Gt]
        \&\*[Lt]integer\&\*[Gt]15\&\*[Lt]\&/integer\&\*[Gt]
        \&\*[Lt]key\&\*[Gt]warning-max\&\*[Lt]\&/key\&\*[Gt]