README

   1 1. What is it?
   2
   3 A plugin to indicate the status of the IBM Hard Drive Active
   4 Protection System, or HDAPS.
   5
   6 2. Requirements
   7
   8 As of Linux kernel 2.6.28, a kernel patch is no longer required to
   9 support the HDAPS functionality. As a result, this plugin will only
  10 (officially) support kernels newer than 2.6.28.
  11
  12 It will also only (officially) support the hdaps module provided
  13 by the tp_smapi project. The tp_smapi module is currently recommended
  14 by the hdaps devs, so you should be using it. In the future, the
  15 in-tree module will probably be supported as well.
  16
  17 Finally, you'll need to be running hdapsd (HDAPS daemon) if you'd like
  18 the plugin to do anything. The HDAPS daemon is what updates sysfs with
  19 the readings from the hdaps module. Get it here:
  20
  21   http://repo.or.cz/w/hdapsd.git
  22
  23 3. Installation
  24
  25 I think it builds like most XFCE panel plugins. Run './autogen.sh' in
  26 the project directory, and hopefully it will configure itself. If it
  27 does, run 'make'. With any luck, you will have an xfce-hdaps
  28 executable in your panel-plugin directory.
  29
  30 Now, there should also be an xfce4-hdaps.desktop file in the
  31 panel-plugin directory. You need to copy this to the directory where
  32 XFCE keeps all of those things. For example, the system-wide location
  33 on Gentoo is /usr/share/xfce4/panel-plugins/.
  34
  35 Finally, modify the X-XFCE-Exec parameter in the desktop file to
  36 reflect the real location of your xfce4-hdaps binary. You should now
  37 be able to add the plugin to your panel.
  38
  39
  40 4. Settings
  41
  42 4a. Poll Frequency
  43
  44 This is the frequency with which the plugin checks the status of
  45 HDAPS. If you set it to 500ms (the default), it will check every half
  46 second and update the icon according to what it finds.
  47
  48 4b. Device Name
  49
  50 The name of the device whose HDAPS status you wish to monitor. This
  51 will almost certainly be a hard drive, and will most likely be "sda".
  52 With any luck, the plugin will auto-detect the supported devices on
  53 your system. If you have more than one supported device, you will
  54 need to select it on the configuration dialog.
  55
  56 5. How to report bugs
  57
  58 Email them to me at michael@orlitzky.com.