Speed names can now be given, allowing the use of "full-speed".

[breezed.git] / breezed.1

diff --git a/breezed.1 b/breezed.1
index af84fd9..3fa2e9e 100644 (file)
--- a/breezed.1
+++ b/breezed.1
@@ -1,4 +1,4 @@
-.TH "BREEZED" "1"
+.TH "BREEZED" "1.4" "Mar 2010" "Francois Fleuret" "System Deamons"
 .SH "NAME"
 breezed - Fan control daemon
 .SH "SYNOPSIS"
@@ -19,7 +19,9 @@ 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.
+"level <speed_name>" into the specified fan file. The speed name is
+the leve itself if no alternative is provided with the temperature
+threshold.
 
 Options can not be specified twice, neither on the command line nor in
 the configuration file.
@@ -39,7 +41,7 @@ prevent the reading of a configuration file
 set the files to spool for temperatures.
 .IP "\fB-ff | --fan-file <file>\fP" 10
 set the file to control the fan speed.
-.IP "\fB-tt | --temperature-thresholds <temp1>[,temp2]...\fP" 10
+.IP "\fB-tt | --temperature-thresholds <temp1>[:<speed_name_1>][,temp2[:speed_name_2]]...\fP" 10
 set the temperature thresholds.
 
 .SH "CONFIGURATION FILE"
@@ -61,12 +63,14 @@ for instance with
 breezed --no-configuration-file \
  --thermal-files /proc/acpi/thermal_zone/THM0/temperature,/proc/acpi/thermal_zone/THM1/temperature \
  --fan-file /proc/acpi/ibm/fan \
- --temperature-thresholds 52,54,56,58,60,62,64
+ --temperature-thresholds 52,54,56,58,60,62,64,68:full-speed
 
 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 temperatures
-above 64C.
+2, etc. The maximum speed level 8 should be chosen for temperatures
+above 68C, and its name is "full-speed" (since no other speed name is
+provided, the other ones are the default level names, hence their
+numerical value).
 
 Due to the two degrees gap between the thresholds to increase and the
 thresholds to decrease the temperature, it will for instance remains