khdapsmon 0.1.2
Copyright (c) 2006 Andrew Barr <andrew.james.barr@gmail.com>

Licensed pursuant to the GNU General Public License, version 2 or later. See the
text of the COPYING file for more details.

Table of Contents
-----------------

0. What's new
1. Introduction
2. Requirements
3. Disclaimer
4. Obtaining the program
5. Support
6. APT Repository


0. What's new
-------------

* Version 0.1.2
	- Refactor GUI to better deal with large(r) fonts.
	- Clean up cruft in source distribution.


1. Introduction
---------------

khdapsmon is a monitor primarily for the Hard Drive Active Protection System
(HDAPS) found in IBM ThinkPads. It's primary interface is a system tray icon
that indicates whether the queue is frozen or not on the selected hard disk
device. This is similar to the tray icon found on the pre-installed OS on
ThinkPads. It should work with other systems similar to the ThinkPad's, such as
those found in Apple PowerBooks but this has not been tested and is probably
dependent upon kernel code that is not yet available. A status dialog also
prints out useful information like accelerometer status and keyboard/mouse
activity status. It also allows for the selection of the monitored device if
you have more than one hard disk that supports queue freezing.

2. Requirements
---------------

Debian users may download these requirements from an APT repository, see below 
for more information.

- Linux 2.6.14 or later, with patches

You need Linux 2.6 or later for sysfs support. Also, you need Linux 2.6.14 or
an earlier kernel patched with support for the HDAPS accelerometer in ThinkPads. 
Finally, you need the queue freezing patches. These are not "official" patches,
per se, because official in-tree support for queue freezing is waiting on other,
infrastructure changes in the kernel. See http://www.thinkwiki.org/wiki/HDAPS
for links to these patches.

- hdapsd daemon

This is also not yet ready for wide consumption but it does work. The source
code and a Gentoo init script are available at 
http://bugs.gentoo.org/show_bug.cgi?id=100167 (a Debianized version of the init
script is available in the source distribution for this program).

NOTE: the hdapsd daemon does the actual parking of the heads. YOU MUST HAVE THIS
RUNNING if you want protection for your disk. khdapsmon will NOT park your
heads, but simply report if they are or not.

- recent version of KDE 3

This program has been developed on KDE 3.5, and I did not check to see if
the APIs I used are available on earlier versions. YMMV.

3. Disclaimer
-------------

THIS PROGRAM DOES *NOT* PARK DISK HEADS BASED ON ACCELEROMETER DATA. That is the
job of the hdapsd daemon. The author is not responsible for lost data or other
damage resulting from a misconfigured HDAPS setup. In fact, no one is
responsible for any damage resulting from anything except you. But since you 
are a seasoned user of open-source software, you already knew that. :)

4. Obtaining the program
-------------------------

The latest version is always posted at: 

http://www.oakcourt.dyndns.org/projects/khdapsmon/

In addition to source code, there will usually be Debian "sid" binary packages 
and maybe a Gentoo ebuild. Thanks to Tobias Roeser <le.petit.fou@gmail.com> for
working on the ebuild.

This program is registered with kde-apps.org:
<http://www.kde-apps.org/content/show.php?content=34134>

5. Support, Feedback, and Suggestions
-------------------------------------

Please mail me <andrew.james.barr@gmail.com> if you have any problems. PLEASE DO
NOT LEAVE SUPPORT QUERIES IN THE COMMENTS SECTION OF KDE-APPS.ORG. I also do not
want basic queries about computers, KDE, or Linux not related to khdapsmon. I'm
not running a consulting business and I don't want to. Feedback or suggestions, 
however, are most appreciated both at kde-apps.org and in my inbox.

6. APT Repository
-----------------

deb http://www.oakcourt.dyndns.org/debian/ ./
deb-src http://www.oakcourt.dyndns.org/debian/ ./

This includes the hdapsd daemon and the queuefreezing patch for 2.6.14 and
2.6.15 in kernel-package format, as well as khdapsmon. Binaries are for sid
but could be rebuilt for other distributions or derivatives. If you do this, 
and you would like me to post them, please let me know.