automatic commit

diff --git a/README.txt b/README.txt
index 1b2b76b..1434303 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -39,40 +39,8 @@
    be enough. Please let me know if you have problem with the
    resulting overall behavior.
 
- * ARGUMENTS
-
-   The breezed executable can read a configuration file (which is
-   /etc/breezed.conf by default, but that you can specify with
-   --configuration-file <file>) or get the various parameters on the
-   command line.
-
-   The thermal files can be specified either with the --thermal-files
-   options on the command line or the thermal_files keyword in the
-   configuration file. The provided value should be a comma-separated
-   list of filenames. When it want to pool the temperature, the daemon
-   will read those files and compute the maximum integer value they
-   contains.
-
-   The fan file can be specified with either --fan-file or the
-   fan_file keyword. The specified file will be used by the daemon to
-   control the fan speed by writing "level n" into it.
-
-   The temperature thresholds can be specified either with the
-   --temperature-thresholds argument, or with the
-   temperature_thresholds keyword in the configuration file. The
-   provided value should be a comma separated list of integers. The
-   first one is actually ignored and forced to -1. Each value states
-   which temperature should trigger the given level.
-
-   For instance, my X61s has 8 fan levels, from 0 to 7. The thresholds
-   I picked are -1,52,54,56,58,60,62,64. Hence, when the temperature
-   reaches 52C, the fan is set to level 1, when it reached 54C it is
-   set to level 2, etc. The maximum speed level 7 is chosen for any
-   temperature equal or greater than 64C. As said above, the
-   temperature to decrease the speed has to be two degrees below the
-   provided thresholds. Hence, the temperature of my X61s has to go
-   down to 50C (52C - 2) for the fan to switch off. Also, the daemon
-   waits at least 30s before reducing the speed of the fan.
+   See the man page for details about the arguments and configuration
+   file.
 
  * NOTES
 

diff --git a/breezed.1 b/breezed.1
index 14f0f8d..2f01520 100644 (file)
--- a/breezed.1
+++ b/breezed.1
@@ -1,15 +1,29 @@
-.TH "BREEZED" "1" 
-.SH "NAME" 
+.TH "BREEZED" "1"
+.SH "NAME"
 breezed - Fan control daemon
-.SH "SYNOPSIS" 
-.PP 
-\fBbreezed\fP [\fBoptions\fP] 
-.SH "DESCRIPTION" 
-.PP 
-\fBbreezed\fP 
-Adjusts the fan speed according to the temperature of the computer.
-.SH "OPTIONS" 
-.IP "\fB-h | --help\fP         " 10 
+.SH "SYNOPSIS"
+.PP
+\fBbreezed\fP [\fBoptions\fP]
+.SH "DESCRIPTION"
+.PP
+\fBbreezed\fP Adjusts the fan speed according to the computer
+temperature. It should be started through the adequate script in
+/etc/rc?.d.
+
+Every 5s, this daemon gathers all integer values from the thermal
+files, and keep the max as the overall computer temperature T. It then
+pick the highest temperature threshold lower than T and set the fan
+speed to the corresponding level. To avoid oscillations, T has to be
+two degrees below threshold to reduce the temperature. Also, the
+daemon waits for at least 30s after any change of the fan speed before
+reducing it. The fan speed is set by writing "level %d" into the
+specified fan file.
+
+Options can not be specified twice, neither on the command line nor in
+the configuration file.
+
+.SH "OPTIONS"
+.IP "\fB-h | --help\fP         " 10
 display help and exits
 .IP "\fB-v | --version\fP " 10
 display the version number and exits
@@ -26,8 +40,35 @@ set the file to control the fan speed.
 .IP "\fB-tt | --temperature-thresholds <temp1>[,temp2]...\fP " 10
 set the temperature thresholds.
 
-.SH "AUTHOR" 
-.PP 
+.SH "CONFIGURATION FILE"
+
+The configuration file is a succession of lines, each starting with
+one of the three keywords thermal_files, fan_file or
+temperature_thresholds, followed by the same parameter values as for
+the command line arguments. The default configuration file is located
+at /etc/breezed.conf
+
+.SH "EXAMPLES"
+
+A typical way of starting breezed is
+
+breezed --thermal-files /proc/acpi/thermal_zone/THM0/temperature,/proc/acpi/thermal_zone/THM1/temperature \
+ --fan-file /proc/acpi/ibm/fan \
+ --temperature-thresholds -1,52,54,56,58,60,62,64
+
+which specifies that when the temperature raises above 52C, the fan
+level should be 1, when the temperature raises above 54C it should be
+2, etc. The maximum speed level 7 should be chosen for temperature
+above 64C. Due to the two degrees gap between the thresholds to
+increase and thresholds to decrease the temperature, it will for
+instance remains at speed 1 until the temperature goes down to 50C.
+
+Because it takes into account all the values found in the thermal
+files, you can use as well /proc/acpi/thermal_zone/THM?/temperature or
+/proc/acpi/ibm/thermal.
+
+.SH "AUTHOR"
+.PP
 Written by Francois Fleuret <francois@fleurer.org>. Permission is
 granted to copy, distribute and/or modify this document under the
 terms of the GNU GPL.

diff --git a/install.sh b/install.sh
index 79a022a..86be280 100755 (executable)
--- a/install.sh
+++ b/install.sh
@@ -30,6 +30,7 @@ fi
 cp ./breezed /usr/local/bin/
 cp ./breezed.sh /etc/init.d/
 cp ./breezed-resume.sh /etc/acpi/resume.d/99-breezed.sh
+cp ./breezed.1 /usr/share/man/man1/
 
 update-rc.d breezed.sh defaults
 

diff --git a/remove.sh b/remove.sh
index 32fbb57..a458566 100755 (executable)
--- a/remove.sh
+++ b/remove.sh
@@ -20,8 +20,10 @@
 #  along with breezed.  If not, see <http://www.gnu.org/licenses/>.
 
 /etc/init.d/breezed.sh stop
+
 update-rc.d -f breezed.sh remove
 
+rm /usr/share/man/man1/breezed.1
 rm /usr/local/bin/breezed
 rm /etc/init.d/breezed.sh
 rm /etc/acpi/resume.d/99-breezed.sh