From 29a7635543f7bbdb33849119474a3413c75257ce Mon Sep 17 00:00:00 2001 From: Al Stone Date: Oct 26 2018 21:57:02 +0000 Subject: Update documentation to describe what's happening Signed-off-by: Al Stone --- diff --git a/ChangeLog b/ChangeLog index e78e8a2..4fef87d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +acpitool-0.5.2 - 26 Oct 2018 + + * README, INSTALL, TODO: + - rewrite and update based on changing circumstances + + acpitool-0.5.1 - 13-08-2008 * toshiba.cpp, freq.cpp: diff --git a/INSTALL b/INSTALL index 24bfc68..460d4fa 100644 --- a/INSTALL +++ b/INSTALL @@ -1,30 +1,33 @@ Installation requirements ========================= - 1. A computer(laptop) running a fairly recent Linux distro, preferably with a kernel from the 2.6 series. + 1. A computer(laptop) running a fairly recent Linux distro, preferably + the latest kernel (2.6 or newer) - 2. That kernel MUST have ACPI support enabled and /proc file support. Sysfs support - is required for a kernel from the 2.6 series (not for 2.4). + 2. That kernel MUST have ACPI support enabled, /proc file support, and + sysfs support. - - For ACPI, enable all options applicable to your system. You should enable at least the following: + For ACPI, enable all options applicable to your system. You should + enable at least the following: - sleep states - processor - button - thermal zone - battery - - ac adapter + - AC adapter - fan - 3. If you have a Toshiba laptop, you can enable kernel support the Toshiba ACPI extensions. + 3. If you have a Toshiba laptop, you can enable kernel support via + the Toshiba ACPI extensions. - 4. If you have an Asus laptop, you can enable kernel support the ASUS ACPI extensions. + 4. If you have an Asus laptop, you can enable kernel support the ASUS + ACPI extensions. 5. a C++ compiler (gcc-g++ is fine, it worked for me anyway). - 6. If you have a pretty recent laptop, check out if supports frequency scaling, and enable - kernel support for it if it does. + 6. If you have a pretty recent laptop, check out if supports frequency + scaling (cpufreq or CPPC), and enable kernel support for it if it does. 7. GNU Make @@ -37,11 +40,12 @@ Basic Installation 1. `cd' to the directory containing the package's source code and type `sh configure'. When that's done, type `make' to compile the package. - 2. Type `make install' to install the program and any data files and documentation. + 2. Type `make install' to install the program and any data files and + documentation. - 3. You can remove the program binaries and object files from the source code directory - by typing `make clean'. To remove the installed files that `make install' created, - type `make uninstall'. + 3. You can remove the program binaries and object files from the source + code directory by typing `make clean'. To remove the installed files + that `make install' created, type `make uninstall'. 4. You can set the CXXFLAGS environment variable to define compile options. @@ -49,15 +53,17 @@ Basic Installation Installation Names ================== - By default, `make install' will install the package's files in `/usr/local/bin'. - You can edit the Makefile and specify an installation prefix other than `/usr/local'. + By default, `make install' will install the package's files in + `/usr/local/bin'. You can edit the Makefile and specify an installation + prefix other than `/usr/local', or you can configure in a new path by + using `sh configure --prefix=/newpath'. How to use it ============= - Acpitool is a CLI application, that means it has no fancy GUI with buttons or other crap. - So, just type "acpitool", without the quotes, at your shell prompt and you should get some text output. - If you want to find out which arguments it can handle, type "acpitool --help". - - \ No newline at end of file + Acpitool is a CLI application, that means it has no fancy GUI with + buttons or other crap. So, just type "acpitool", without the quotes, + at your shell prompt and you should get some text output. If you want + to find out which arguments it can handle, type "acpitool --help". + diff --git a/README b/README index 6a1d66c..42d07ff 100644 --- a/README +++ b/README @@ -1,51 +1,71 @@ - ------------------------------------------------------------------------------ A C P I T O O L ------------------------------------------------------------------------------ - - This is an ACPI client for Linux, written by David Leemans. - Copyright (C) 2004, 2005, 2006, 2007, 2008 David Leemans. Please see - the INSTALL file for installation info. +Copyright (C) 2004, 2005, 2006, 2007, 2008 David Leemans. +Some Copyright (c) 2018, Al Stone + +Additional contributions from Debian patches under GPLv2 (best we can +tell). + +This is an ACPI client for Linux, originally written by David Leemans, +and now with maintenance and improvement being attempted by Al Stone. + +Please see the INSTALL file for installation info. + +This version on pagure.io started with the original work from David (i.e., +the 0.5.1 version). I am now trying to see how or if this work may be +carried forward, given the changes in ACPI, procfs and sysfs that have +occurred since that last version. As such changes may occur, but I have +no idea at what rate those may happen yet. YMMV, TBD, and so on. At a +minimum, we will incorporate patches collected by some of the distributions +and re-use them as much as possible. + +The original homepage for this software was here: - - See the homepage for this software: http://freeunix.dyndns.org:8000/site/acpitool.shtml - for more information and download link. - - This ACPI client is intended to be a replacement for the apm tool. - Even though APM works fine on a lot of laptops, it is deprecated - and will be replaced by ACPI. Most newer laptops even require ACPI - to boot properly. As such, it will be nice to have an ACPI client. +and was used for more information and a download link. Since then, it +has been moved at least once and is now here: + + https://sourceforge.net/projects/acpitool/ + +That version has become static since the 0.5.1 release. We hope to +improve on that on pagure.io. + +This ACPI client is intended to be a replacement for the apm tool. Even +though APM used to work fine on a lot of laptops, it was deprecated and +has long since been replaced by ACPI; this is true of servers, as well. +Many, many systems require ACPI to boot properly today. As such, it would +be nice to have an ACPI client. - - Obviously, you need a computer running a Linux kernel from the - 2.4.x or 2.6.x series with ACPI enabled, to use this program. - A kernel from the 2.6 series is recommended, since that's where - development of Linux ACPI code is going on. - Intended audience of this applictaion are laptop users, since these are - the people most interested in stuff like battery status, thermal status and - the ability to put their precious laptop to sleep. Most of this does not - apply to desktop systems. - - - WARNING : Linux ACPI support MIGHT work fine, as it does on my laptop, - might work, but with annoying problems or in a limited way, or might not work - at all. See the "view existing bug reports" link on http://acpi.sourceforge.net/ - to get an idea of what can go wrong. - - - Development of Acpitool started in June 2004, on a Toshiba Satellite Pro 6000, - then running Slackware 9.1. The Toshiba remained in use till September 2006, - when it was replaced with a Dell Latitude C640, currently running Slackware 11 - with kernel 2.6.20. - The C640 was replaced in July 2008 with a Dell Latitude D610, curently running - Slackware 12.1 with kernel 2.6.26. - - - If you think you found a bug, have a feature request, would like to give some - feedback, or just would like to contact me for whatever reason, DO NOT HESITATE - to do so. - It is the only way I will ever know there is a bug, or that you want some - feature added. With your much appreciated help, Acpitool can only get better ;) +For this client, you need a computer running a Linux kernel from at least +the 2.4.x series with ACPI enabled. Using the latest upstream or distro +provided kernel is recommended, since that's where development of Linux +ACPI code is happening. + +The intended audience of this applictaion are the people interested in +stuff like battery status, thermal status and the ability to put their +system to sleep. + +Development of acpitool started in June 2004, on a Toshiba Satellite Pro +6000, then running Slackware 9.1. The Toshiba remained in use till +September 2006, when it was replaced with a Dell Latitude C640, running +Slackware 11 with kernel 2.6.20. The C640 was replaced in July 2008 with +a Dell Latitude D610, running Slackware 12.1 with kernel 2.6.26. + +I've started picking this back up again in 2018 to see if improvements +can be made. + +If you think you found a bug, have a feature request, would like to give +some feedback, or just would like to contact me for whatever reason, DO +NOT HESITATE to do so. It is the only way I will ever know there is a bug, +or that you want some feature added. With your help, acpitool can only +get better ;) - - To contact me, send mail to davidleemans AT scarlet DOT be or fill in the form - at http://freeunix.dyndns.org:8000/site/contact.shtml +To contact me, please post an issue, pull request, or send me a message +via https://pagure.io/acpitool - - Last updated: 24-Jul-2008 +Last updated: 26 Oct 2018 ------------------------------------------------------------------------------- diff --git a/TODO b/TODO index ee4d568..5c839d3 100644 --- a/TODO +++ b/TODO @@ -1,6 +1,10 @@ Todo list for acpitool: - - maybe add APM support after all, to make it a "complete" pm tool + - make sure everything still works + + - move from procfs to sysfs if at all possible + + - verify support on other architectures Done : @@ -19,4 +23,4 @@ Done : - add support for frequency scaling (since 0.4.7) - \ No newline at end of file +