======================================================================
=	xbatcheck.tcl						    
=
= 	$Id: README,v 1.1 1997/08/20 07:33:18 stefan Exp stefan $
=
======================================================================

This program monitors the battery status and ac-line connection of
portables. Furthermore it can warn you when battery power turns to
critical.

Requirements
------------

	* The program requires Tcl/Tk (the wish binary). I tested it 
	  with Tk version 4.2
	* Kernel compilation with /proc support and apm support. You
	  should have a /proc/apm file then.

Installation
------------

As root, copy the xbatcheck.tcl to a common place, like /usr/local/bin
and you might change the path for the 'wish' in the first lines of the
Tcl script. Furthermore, you might want to change the default options
in the 'Options definitions' chapter.

Execution
---------

Just run the 'xbatcheck.tcl' from the command line or put it in your
.xinit file.

You should see the windowin either one of the corners of your screen. When
you move your move over the 2 images, a "balloon" is displayed showing
more information about the battery an AC-line status. The images itself
can have the following colors:

	battery image		AC-line image
	-------------------------------------
	green  : high		green : online
	yellow : low		red   : offline
	red    : critical
	orange : charging
	
If no battery is inserted, a special image is used.

If you click on the GUI, an option menu is shown. With this menu, you can
set the palcement of the GUI, change the check interval (the interval to
read and process the /proc/apm file) and enable or disable the critical
power alarm. This alarm will pop up a window stating that your battery is
almost empty. This alarm is repeated every minute until you shut it off or
the power is no longer critical.

Bug reports and suggestions
---------------------------

Please send bug reports and suggestions to stefan@irdeto.nl

Have Fun



