public inbox for linux-acpi@vger.kernel.org
 help / color / mirror / Atom feed
From: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
To: lenb@kernel.org
Cc: linux-acpi@vger.kernel.org, ibm-acpi-devel@lists.sourceforge.net,
	Henrique de Moraes Holschuh <hmh@hmh.eng.br>
Subject: [PATCH 6/6] ACPI: ibm-acpi: update documentation
Date: Sun, 11 Mar 2007 21:20:49 -0300	[thread overview]
Message-ID: <11736588493866-git-send-email-hmh@hmh.eng.br> (raw)
In-Reply-To: <117365884923-git-send-email-hmh@hmh.eng.br>

Update documentation header, and relocate a hunk of text that was missplaced.

Signed-off-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
---
 Documentation/ibm-acpi.txt |   85 +++++++++++++-------------------------------
 1 files changed, 25 insertions(+), 60 deletions(-)

diff --git a/Documentation/ibm-acpi.txt b/Documentation/ibm-acpi.txt
index cdcef01..f409f4b 100644
--- a/Documentation/ibm-acpi.txt
+++ b/Documentation/ibm-acpi.txt
@@ -1,16 +1,17 @@
 		    IBM ThinkPad ACPI Extras Driver
 
-                            Version 0.12
-                           17 August 2005
+                            Version 0.13
+                           31 December 2006
 
                Borislav Deianov <borislav@users.sf.net>
+	     Henrique de Moraes Holschuh <hmh@hmh.eng.br>
 		      http://ibm-acpi.sf.net/
 
 
 This is a Linux ACPI driver for the IBM ThinkPad laptops. It supports
 various features of these laptops which are accessible through the
-ACPI framework but not otherwise supported by the generic Linux ACPI
-drivers.
+ACPI framework but not otherwise fully supported by the generic Linux
+ACPI drivers.
 
 
 Status
@@ -638,6 +639,26 @@ The ThinkPad's ACPI DSDT code will reprogram the fan on its own when
 certain conditions are met.  It will override any fan programming done
 through ibm-acpi.
 
+The ibm-acpi kernel driver can be programmed to revert the fan level
+to a safe setting if userspace does not issue one of the fan commands:
+"enable", "disable", "level" or "watchdog" within a configurable
+ammount of time.  To do this, use the "watchdog" command.
+
+	echo 'watchdog <interval>' > /proc/acpi/ibm/fan
+
+Interval is the ammount of time in seconds to wait for one of the
+above mentioned fan commands before reseting the fan level to a safe
+one.  If set to zero, the watchdog is disabled (default).  When the
+watchdog timer runs out, it does the exact equivalent of the "enable"
+fan command.
+
+Note that the watchdog timer stops after it enables the fan.  It will
+be rearmed again automatically (using the same interval) when one of
+the above mentioned fan commands is received.  The fan watchdog is,
+therefore, not suitable to protect against fan mode changes made
+through means other than the "enable", "disable", and "level" fan
+commands.
+
 EXPERIMENTAL: WAN -- /proc/acpi/ibm/wan
 ---------------------------------------
 
@@ -670,59 +691,3 @@ example:
 
 	modprobe ibm_acpi hotkey=enable,0xffff video=auto_disable
 
-The ibm-acpi kernel driver can be programmed to revert the fan level
-to a safe setting if userspace does not issue one of the fan commands:
-"enable", "disable", "level" or "watchdog" within a configurable
-ammount of time.  To do this, use the "watchdog" command.
-
-	echo 'watchdog <interval>' > /proc/acpi/ibm/fan
-
-Interval is the ammount of time in seconds to wait for one of the
-above mentioned fan commands before reseting the fan level to a safe
-one.  If set to zero, the watchdog is disabled (default).  When the
-watchdog timer runs out, it does the exact equivalent of the "enable"
-fan command.
-
-Note that the watchdog timer stops after it enables the fan.  It will
-be rearmed again automatically (using the same interval) when one of
-the above mentioned fan commands is received.  The fan watchdog is,
-therefore, not suitable to protect against fan mode changes made
-through means other than the "enable", "disable", and "level" fan
-commands.
-
-
-Example Configuration
----------------------
-
-The ACPI support in the kernel is intended to be used in conjunction
-with a user-space daemon, acpid. The configuration files for this
-daemon control what actions are taken in response to various ACPI
-events. An example set of configuration files are included in the
-config/ directory of the tarball package available on the web
-site. Note that these are provided for illustration purposes only and
-may need to be adapted to your particular setup.
-
-The following utility scripts are used by the example action
-scripts (included with ibm-acpi for completeness):
-
-	/usr/local/sbin/idectl -- from the hdparm source distribution,
-		see http://www.ibiblio.org/pub/Linux/system/hardware
-	/usr/local/sbin/laptop_mode -- from the Linux kernel source
-		distribution, see Documentation/laptop-mode.txt
-	/sbin/service -- comes with Redhat/Fedora distributions
-	/usr/sbin/hibernate -- from the Software Suspend 2 distribution,
-		see http://softwaresuspend.berlios.de/
-
-Toan T Nguyen <ntt@physics.ucla.edu> notes that Suse uses the
-powersave program to suspend ('powersave --suspend-to-ram') or
-hibernate ('powersave --suspend-to-disk'). This means that the
-hibernate script is not needed on that distribution.
-
-Henrik Brix Andersen <brix@gentoo.org> has written a Gentoo ACPI event
-handler script for the X31. You can get the latest version from
-http://dev.gentoo.org/~brix/files/x31.sh
-
-David Schweikert <dws@ee.eth.ch> has written an alternative blank.sh
-script which works on Debian systems. This scripts has now been
-extended to also work on Fedora systems and included as the default
-blank.sh in the distribution.
-- 
1.5.0.3


  reply	other threads:[~2007-03-12  0:21 UTC|newest]

Thread overview: 60+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-03-12  0:20 [GIT PULL] ibm-acpi changes acpi-test/2.6.22 Henrique de Moraes Holschuh
2007-03-12  0:20 ` [PATCH 1/6] ACPI: ibm-acpi: kill trailing whitespace Henrique de Moraes Holschuh
     [not found]   ` <11736588493322-git-send-email-hmh-N3TV7GIv+o9fyO9Q7EP/yw@public.gmane.org>
2007-03-12  0:20     ` [PATCH 2/6] ACPI: ibm-acpi: rename some identifiers Henrique de Moraes Holschuh
     [not found]       ` <11736588491476-git-send-email-hmh-N3TV7GIv+o9fyO9Q7EP/yw@public.gmane.org>
2007-03-12  0:20         ` [PATCH 3/6] ACPI: ibm-acpi: add header file Henrique de Moraes Holschuh
     [not found]           ` <11736588493502-git-send-email-hmh-N3TV7GIv+o9fyO9Q7EP/yw@public.gmane.org>
2007-03-12  0:20             ` [PATCH 4/6] ACPI: ibm-acpi: organize code Henrique de Moraes Holschuh
2007-03-12  0:20               ` [PATCH 5/6] ACPI: ibm-acpi: update copyright notice Henrique de Moraes Holschuh
2007-03-12  0:20                 ` Henrique de Moraes Holschuh [this message]
2007-03-12  0:54 ` [GIT PULL] ibm-acpi changes acpi-test/2.6.22 Len Brown
2007-03-12  1:27   ` Henrique de Moraes Holschuh
2007-03-15  3:10     ` [GIT PULL] ibm-acpi move to drivers/misc Henrique de Moraes Holschuh
2007-03-15  3:12       ` [PATCH] ACPI: ibm-acpi: move driver to drivers/misc hierarchy Henrique de Moraes Holschuh
2007-03-15  6:06         ` CONFIG_IBM_BAY Len Brown
2007-03-15 13:39           ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-15 15:06             ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-15 17:55               ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-15 18:01                 ` CONFIG_IBM_BAY Kristen Carlson Accardi
     [not found]                   ` <20070315110156.09e80b99.kristen.c.accardi-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2007-03-15 19:31                     ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-15 19:50                       ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-18  5:38                         ` CONFIG_IBM_BAY Tejun Heo
2007-03-18  8:27                           ` CONFIG_IBM_BAY Holger Macht
2007-03-18 18:36                             ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-18 18:55                               ` CONFIG_IBM_BAY Holger Macht
2007-03-18 19:00                                 ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-19 18:04                                 ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-20 15:53                                   ` CONFIG_IBM_BAY Holger Macht
2007-03-20 16:19                                     ` CONFIG_IBM_BAY Kristen Carlson Accardi
     [not found]                                       ` <20070320091932.f61bbdcc.kristen.c.accardi-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2007-03-20 16:34                                         ` CONFIG_IBM_BAY Holger Macht
2007-03-19 18:17                               ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-20  0:07                                 ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
     [not found]                                   ` <20070320000706.GE5932-ZGHd14iZgfaRjzvQDGKj+xxZW9W5cXbT@public.gmane.org>
2007-03-20 16:14                                     ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-19 13:22                             ` CONFIG_IBM_BAY Matthew Garrett
     [not found]                               ` <20070319132243.GA2869-1xO5oi07KQx4cg9Nei1l7Q@public.gmane.org>
2007-03-19 13:48                                 ` CONFIG_IBM_BAY Holger Macht
2007-03-19 14:04                                   ` CONFIG_IBM_BAY Matthew Garrett
2007-03-19 14:37                                     ` CONFIG_IBM_BAY Holger Macht
     [not found]                                       ` <20070319143746.GC4885-tB0uoaAy/Z1bpigZmTR7Iw@public.gmane.org>
2007-03-19 18:11                                         ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-19 23:11                                           ` [ibm-acpi-devel] CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-19 23:56                                             ` Kristen Carlson Accardi
2007-03-20  0:12                                               ` Henrique de Moraes Holschuh
2007-03-20 16:11                                                 ` Kristen Carlson Accardi
2007-03-20 16:07                                           ` CONFIG_IBM_BAY Holger Macht
     [not found]                                             ` <20070320160707.GB6079-tB0uoaAy/Z1bpigZmTR7Iw@public.gmane.org>
2007-03-20 16:16                                               ` CONFIG_IBM_BAY Holger Macht
     [not found]                                     ` <20070319140403.GA3697-1xO5oi07KQx4cg9Nei1l7Q@public.gmane.org>
2007-03-19 15:36                                       ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-19 15:47                                         ` CONFIG_IBM_BAY Holger Macht
     [not found]                                         ` <20070319153659.GB15942-ZGHd14iZgfaRjzvQDGKj+xxZW9W5cXbT@public.gmane.org>
2007-03-19 16:41                                           ` CONFIG_IBM_BAY Shem Multinymous
     [not found]                                             ` <41840b750703190941p77fc4a64k49361b678dd6aa90-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2007-03-19 23:04                                               ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-20 14:18                                                 ` [ibm-acpi-devel] CONFIG_IBM_BAY Shem Multinymous
2007-03-20 15:12                                                   ` Henrique de Moraes Holschuh
2007-03-19 18:00                               ` CONFIG_IBM_BAY Kristen Carlson Accardi
     [not found]                           ` <45FCD062.3050001-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2007-03-18 18:26                             ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-15 20:31                       ` [ibm-acpi-devel] CONFIG_IBM_BAY Shem Multinymous
2007-03-15 20:49                         ` Henrique de Moraes Holschuh
2007-03-19 12:04                       ` Theodore Tso
2007-03-19 23:24                         ` Henrique de Moraes Holschuh
2007-03-20 14:57                           ` Theodore Tso
2007-03-20 15:14                             ` Henrique de Moraes Holschuh
2007-03-20 18:45                               ` Theodore Tso
2007-03-20 20:25                                 ` Shem Multinymous
     [not found]                                 ` <20070320184541.GB29493-AKGzg7BKzIDYtjvyW6yDsg@public.gmane.org>
2007-03-20 20:44                                   ` CONFIG_IBM_BAY Henrique de Moraes Holschuh
2007-03-15 18:22                 ` CONFIG_IBM_BAY Kristen Carlson Accardi
2007-03-15 19:33                   ` CONFIG_IBM_BAY Henrique de Moraes Holschuh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11736588493866-git-send-email-hmh@hmh.eng.br \
    --to=hmh@hmh.eng.br \
    --cc=ibm-acpi-devel@lists.sourceforge.net \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox