xbatt -- battery status display for X11
							   1.0  1995/04/04
							   1.1  1995/04/28
							   1.2  1997/03/07
							      Tohihisa Eto
							   eto@forus.or.jp
						     eto@osl.fujitsu.co.jp
Note: this program currently does not work on FreeBSD

1. WHAT IS XBATT? 

  xbatt is an X11 client which displays the battery status of your
notebook computer equiped with ACPI.
It currently works only on Linux.  The status displayed consists of
the remaining battery life, the AC line status, and the charging
status.

2. SYSTEM REQUIREMENT

  xbatt acquires the battery status via the ACPI driver.
  The ACPI driver should be already configured on your Linux system, if it is not, you will have to load the correct driver module, consult your distribution's documentation for more information.
  If xbatt issues errors about not being able to open files, your ACPI driver may be using different names for the kernel interface directories under /sys/class/power_supply/. If it is, replace the ACLINE and BATTERY environment variables in the Imakefile
3. INSTALLATION

  To build xbatt, you will need the XPM library (libXpm), which is
included in X11R6 contrib.  If you use FreeBSD, and you don't want
make xbatt from the source, install package named `xpm-3.4*.tgz'.

  To make the program, type:
	xmkmf
	make
  To install the program, type:
	make install


4. FEATURES

  xbatt checks a battery status once in every 30 seconds, and updates
its display if necessary.  If you move your mouse cursor to the
battery icon, xbatt will get current battery information, and display
in 1% units (if your BIOS supports this).

  To change the update interval, specify the -titerInterval option, or
change the macro UPDATE_INTERVAL which written in Imakefile.

  If xbatt doesn't display the correct status after resume, then move
the mouse cursor to battery icon.  This action will reset the xbatt
timer.

  If you use fvwm, you can 'stick' xbatt to the screen's glass by
adding the following line to ~/.fvwmrc:

	Style "xbatt" NoTitle,Sticky,StaysOnTop,WindowListSkip,CirculateSkip

  If you use FvwmButtons, you can put xbatt to your button area by
adding the following line to ~/.fvwmrc:

	*FvwmButtons(Title xbatt, Swallow(UseOld) "xbatt" \
		'Exec /usr/local/bin/xbatt &')


5. ACKNOWLEDGMENT

  The author would like to express his sincere appreciation to the
following people:

    for FreeBSD support
	Tatsumi Hosokawa (hosokawa@jp.FreeBSD.org)
	Noriyuki Takahashi (nor@aecl.ntt.jp)
	Hajimu UMEMOTO (ume@iabs.hitachi.co.jp)
	Kouki Higuchi <luke@fct.kgc.co.jp>
	EGUCHI Osamu <eguchi@shizuokanet.or.jp>
	and BSD-Nomads mailing list member

    for Linux support
	Koyama Tadayoshi (pcs00294@asciinet.or.jp)
	Hisamatsu Hiroshi (hisama@pfu.co.jp)
	Shoichi NAKAYAMA (naka@fadev.fvd.fujitsu.co.jp)
	Yoshihito Yamagami (yoshi@funival.mfd.cs.fujitsu.co.jp)
	Masahide NODA (mac@pssys.flab.fujitsu.co.jp)
	M Ishigaki <mi@sy.ssl.fujitsu.co.jp>
	Kunihiko IMAI <imai@musen.ts.fujitsu.co.jp>
	Toshio Fujishiro <fjsr@s4w021.ss.ts.fujitsu.co.jp>

6. QUESTIONS?  

  Comments, bug-reports, and patches are welcome. The original author can be reached at eto@forus.or.jp or eto@osl.fujitsu.co.jp, however questions regarding the ACPI interface should not be directed to them, and should instead be directed to github.com/plutonull/xbatt/issues.


<END-OF-FILE>