mgm/doc/m-battery.html

   1 <title>  xiph.org: MGM manual </title>
   2
   3 <STYLE>
   4 <!--
   5         BODY  {font-family: Verdana, Arial, Helvetica;
   6                font-size: 12pt;
   7                background-color: #ffffff}
   8 -->
   9 </STYLE>
  10
  11 <body bgcolor="#ffffff" link="#208b8b" vlink="#000080">
  12
  13 <p align=center><img src="mgm-small.gif"><br>
  14 [ <a href="index.html">home</a> | <a href="faq.html">FAQ</a> | <a href="down.html">download</a> | <a href="trouble.html">troubleshooting</a> | <a href="docs.html">manual</a> | <a href="http://www.xiph.org/cvs.html">cvs</a> | <a href="mail.html">mailing lists</a> ]<p>
  15 <hr>
  16
  17 <h1>Module: battery</h1>
  18
  19 The battery module watches the state of a portable computer's battery
  20 charge, providing a bargraph readout of charge remaining.  Normally,
  21 the bargraph uses a fixed 100% scale and a green bar.  Below 30%
  22 charge, the bar is changed to yellow.  Below 8%, the bar is changed to
  23 red and the default text changes to read 'battery low'.<p>
  24
  25 <h2>Current platforms</h2>
  26 Linux<p>
  27
  28 <h2>Instances</h2>
  29 single only
  30
  31 <h2>additional resources</h2>
  32 lowbackground, lowforeground, lowlabel, midbackground, midforeground<p>
  33
  34 Below 30%, the bar is reconfigured, by default using a yellow bar and
  35 the normal <a href=r-litforeground.html>litforeground</a>.
  36 'midbackground' and 'midforeground' may be used to configure the
  37 colors.  Similarly, below 8%, the bar normally turns red with white
  38 text.  'lowforeground' and 'lowbackground' configure these colors.
  39 Below 8%, the bar text is also changed; 'lowlabel' may set this text
  40 just as <a href=r-label.html>label</a> sets the text for 8% and above.<p>
  41
  42 <h2>Resource defaults</h2>
  43
  44 Resource defaults explicitly altered from the global defaults by this
  45 module:
  46
  47 <ul>
  48 <li>label: battery
  49 <li>litbackground: #60c060
  50 <li>lowbackground: #ff4040
  51 <li>lowforeground: #ffffff
  52 <li>lowlabel: battery low
  53 <li>midbackground: #d0d060
  54 <li>midforeground: same as litforeground
  55 <li>order: 201
  56 <li>scalelenadj: 100
  57 <li>scalerefresh:10000
  58 <li>scalereturn:1
  59 <li>scalewidadj: 80
  60 </ul>
  61
  62
  63 <h2>Possible enhancements</h2>
  64
  65 AC on/offline as well as charging status is also available from
  66 /proc/apm; battery should be enhanced to display these as well.<p>
  67
  68 <hr>
  69 <a href="http://www.xiph.org/">
  70 <img src="white-xifish.gif" align=left border=0>
  71 </a>
  72 <p>
  73 <font size=-2 color=#505050>
  74
  75 MGM will not get your whites whiter or your colors brighter.  It will,
  76 however, sit there and look spiffy while sucking down a major
  77 honking wad of RAM.<p>
  78
  79 MGM, Xiphophorus and their logos are trademarks (tm) of
  80 <a href="http://www.xiph.org/">Xiphophorus</a>.  These pages are
  81 copyright (C) 1994-1999 Xiphophorus. All rights reserved.<p>
  82
  83 </body>
  84
  85
  86
  87
  88
  89
  90