share/man/man4/acpibat.4

   1 .\" $NetBSD: acpibat.4,v 1.6 2008/04/30 13:10:53 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2002, 2004 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd September 4, 2007
  28 .Dt ACPIBAT 4
  29 .Os
  30 .Sh NAME
  31 .Nm acpibat
  32 .Nd ACPI Control Method Battery
  33 .Sh SYNOPSIS
  34 .Cd "acpibat* at acpi?"
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 driver supports ACPI Control Method Battery.
  39 .Pp
  40 The status can be monitored by
  41 .Xr envsys 4
  42 API or
  43 .Xr envstat 8
  44 command.
  45 .Sh EVENTS
  46 The
  47 .Nm
  48 driver is able to send events to
  49 .Xr powerd 8
  50 when capacity state has been changed.
  51 The new state will be reported as the
  52 .Em fourth
  53 argument to the
  54 .Pa /etc/powerd/scripts/sensor_battery
  55 script.
  56 If a custom capacity limit was set via
  57 .Xr envstat 8 ,
  58 the
  59 .Nm
  60 driver will report a
  61 .Em user-capacity
  62 event to the same script when current capacity limit has been reached.
  63 .Sh SEE ALSO
  64 .Xr acpi 4 ,
  65 .Xr envsys 4 ,
  66 .Xr envstat 8 ,
  67 .Xr powerd 8
  68 .Sh HISTORY
  69 The
  70 .Nm
  71 driver
  72 appeared in
  73 .Nx 1.6 .
  74 .Sh BUGS
  75 Smart Battery Specification-based batteries are not supported.