automatic commit
[breezed.git] / breezed.1
index 2f01520..7a7e3bd 100644 (file)
--- a/breezed.1
+++ b/breezed.1
@@ -6,38 +6,40 @@ breezed - Fan control daemon
 \fBbreezed\fP [\fBoptions\fP]
 .SH "DESCRIPTION"
 .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.
+\fBbreezed\fP is a daemon to adjust 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.
+Every 5s, \fBbreezed\fP gathers all integer values from the thermal
+files, and takes the max as the overall temperature T. It then
+computes the highest fan speed whose temperature threshold is lower
+than T. If that speed is above the current speed, the daemon changes
+the fan speed accordingly. Otherwise it computes the lowest fan speed
+whose temperature threshold is two degrees above T, and sets the fan
+speed one level below. This two degree gap avoids too many
+oscillations. 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 <level>" into the specified fan file.
 
 Options can not be specified twice, neither on the command line nor in
 the configuration file.
 
 .SH "OPTIONS"
 
 Options can not be specified twice, neither on the command line nor in
 the configuration file.
 
 .SH "OPTIONS"
-.IP "\fB-h | --help\fP         " 10
+.IP "\fB-h | --help\fP" 10
 display help and exits
 display help and exits
-.IP "\fB-v | --version\fP " 10
+.IP "\fB-v | --version\fP" 10
 display the version number and exits
 display the version number and exits
-.IP "\fB-d | --debug\fP " 10
+.IP "\fB-d | --debug\fP" 10
 run in verbose mode
 run in verbose mode
-.IP "\fB-cf | --configuration-file <file>\fP " 10
+.IP "\fB-cf | --configuration-file <file>\fP" 10
 set the configuration file (default is /etc/breezed.conf)
 set the configuration file (default is /etc/breezed.conf)
-.IP "\fB-ncf | --no-configuration-file\fP " 10
+.IP "\fB-ncf | --no-configuration-file\fP" 10
 prevent the reading of a configuration file
 prevent the reading of a configuration file
-.IP "\fB-tf | --thermal-file <file1>[,file2]...\fP " 10
+.IP "\fB-tf | --thermal-file <file1>[,file2]...\fP" 10
 set the files to spool for temperatures.
 set the files to spool for temperatures.
-.IP "\fB-ff | --fan-file <file>\fP " 10
+.IP "\fB-ff | --fan-file <file>\fP" 10
 set the file to control the fan speed.
 set the file to control the fan speed.
-.IP "\fB-tt | --temperature-thresholds <temp1>[,temp2]...\fP " 10
+.IP "\fB-tt | --temperature-thresholds <temp1>[,temp2]...\fP" 10
 set the temperature thresholds.
 
 .SH "CONFIGURATION FILE"
 set the temperature thresholds.
 
 .SH "CONFIGURATION FILE"
@@ -54,7 +56,7 @@ 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 \
 
 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
+ --temperature-thresholds 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
 
 which specifies that when the temperature raises above 52C, the fan
 level should be 1, when the temperature raises above 54C it should be