]> gitweb.michael.orlitzky.com - xfce4-hdaps.git/blob - README
Added tooltip support for the three states.
[xfce4-hdaps.git] / 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 3. Installation
18
19 I think it builds like most XFCE panel plugins. Run ./autogen.sh in
20 the project directory, and hopefully it will compile. At that point,
21 you should have an xfce-hdaps executable in your panel-plugin
22 directory.
23
24 Now, there should also be an xfce4-hdaps.desktop file in the
25 panel-plugin directory. You need to copy this to the directory where
26 XFCE keeps all of those things. For example, the system-wide location
27 on Gentoo is /usr/share/xfce4/panel-plugins/.
28
29 Finally, modify the X-XFCE-Exec parameter in the desktop file to
30 reflect the real location of your xfce4-hdaps binary. You should now
31 be able to add the plugin to your panel.
32
33
34 4. Settings
35
36 4a. Poll Frequency
37
38 This is the frequency with which the plugin checks the status of
39 HDAPS. If you set it to 500ms (the default), it will check every half
40 second and update the icon according to what it finds.
41
42 4b. Device Name
43
44 The name of the device whose HDAPS status you wish to monitor. This
45 will almost certainly be a hard drive, and will most likely be "sda".
46 With any luck, the plugin will auto-detect the supported devices on
47 your system. If you have more than one supported device, you will
48 need to select it on the configuration dialog.
49
50 5. How to report bugs
51
52 Email them to me at michael@orlitzky.com.