From 69026ec7da4e7af5a29bfb8c6a4f0398404c903f Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 24 Feb 2026 21:35:19 -0500 Subject: [PATCH] README: convert to reStructuredText and update This will look nice on Codeberg, and the text was pretty outdated to begin with. The build/dist might be broken due to the rename, but that can be dealt with when it becomes a problem. --- README | 60 --------------------------------------------------- README.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 60 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index 8967e7f..0000000 --- a/README +++ /dev/null @@ -1,60 +0,0 @@ -1. What is it? - -A plugin to indicate the status of the IBM Hard Drive Active -Protection System, or HDAPS. - -2. Requirements - -As of Linux kernel 2.6.28, a kernel patch is no longer required to -support the HDAPS functionality. As a result, this plugin will only -(officially) support kernels newer than 2.6.28. - -It will also only (officially) support the hdaps module provided -by the tp_smapi project. The tp_smapi module is currently recommended -by the hdaps devs, so you should be using it. In the future, the -in-tree module will probably be supported as well. - -Finally, you'll need to be running hdapsd (HDAPS daemon) if you'd like -the plugin to do anything. The HDAPS daemon is what updates sysfs with -the readings from the hdaps module. Get it here: - - http://repo.or.cz/w/hdapsd.git - -3. Installation - -I think it builds like most XFCE panel plugins. Git users, run -'./autogen.sh' in the project directory, and hopefully it will do -whatever it does to make your project directory look like the tarball -release. If it does (or if you just downloaded the tarball), run, - -./configure -make - -With any luck, you will have a libhdaps.so module in your -panel-plugin/.libs/ directory. There should also be an hdaps.desktop -file in the panel-plugin directory. - -You need to copy these to the directories where XFCE keeps such -things. For example, the system-wide desktop file location on Gentoo -is /usr/share/xfce4/panel/plugins/, and the module itself goes in -/usr/lib/xfce4/panel/plugins/. - -4. Settings - -4a. Poll Frequency - -This is the frequency with which the plugin checks the status of -HDAPS. If you set it to 500ms (the default), it will check every half -second and update the icon according to what it finds. - -4b. Device Name - -The name of the device whose HDAPS status you wish to monitor. This -will almost certainly be a hard drive, and will most likely be "sda". -With any luck, the plugin will auto-detect the supported devices on -your system. If you have more than one supported device, you will -need to select it on the configuration dialog. - -5. How to report bugs - -Email them to me at michael@orlitzky.com. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f1ee363 --- /dev/null +++ b/README.rst @@ -0,0 +1,63 @@ +**Warning**: I switched to wayland on my thinkpad due to the worsening +performance of webkit-gtk under X. At the time, XFCE did not support +wayland, so tl;dr I am no longer using XFCE. I will try to keep this +working, but it is lightly doomed and will not be getting a port to +the next version of XFCE/GTK unless someone else takes over. + + +What is it? +=========== + +A plugin to indicate the status of the IBM Hard Drive Active +Protection System, or HDAPS. + + +Requirements +============ + +#. The hdaps kernel module from the + `tp_smapi `_ project. +#. A running `hdaps daemon `_, at + least if you'd like the plugin to do anything. The daemon is what + updates sysfs with the readings from the hdaps module. + + +Installation +============ + +I think it builds like most XFCE panel plugins. Git users, run + +.. code-block:: console + + $ ./autogen.sh + +in the project directory to bootstrap autotools. Afterwards, it's an +autotools project that installs like any other, e.g. + +.. code-block:: console + + $ ./configure + $ make + $ make install + + +Settings +======== + +Poll Frequency + This is the frequency with which the plugin checks the status of + HDAPS. If you set it to 500ms (the default), it will check every half + second and update the icon according to what it finds. +Device Name + The name of the device whose HDAPS status you wish to monitor. This + will almost certainly be a hard drive, and will most likely be "sda". + With any luck, the plugin will auto-detect the supported devices on + your system. If you have more than one supported device, you will + need to select it on the configuration dialog. + + +How to report bugs +================== + +Email them to me at michael@orlitzky.com, or report them on `Codeberg +`_. -- 2.51.0