2f0152055b16067a9e6eaca322aa66ba4667912e
[breezed.git] / breezed.1
1 .TH "BREEZED" "1"
2 .SH "NAME"
3 breezed - Fan control daemon
4 .SH "SYNOPSIS"
5 .PP
6 \fBbreezed\fP [\fBoptions\fP]
7 .SH "DESCRIPTION"
8 .PP
9 \fBbreezed\fP Adjusts the fan speed according to the computer
10 temperature. It should be started through the adequate script in
11 /etc/rc?.d.
12
13 Every 5s, this daemon gathers all integer values from the thermal
14 files, and keep the max as the overall computer temperature T. It then
15 pick the highest temperature threshold lower than T and set the fan
16 speed to the corresponding level. To avoid oscillations, T has to be
17 two degrees below threshold to reduce the temperature. Also, the
18 daemon waits for at least 30s after any change of the fan speed before
19 reducing it. The fan speed is set by writing "level %d" into the
20 specified fan file.
21
22 Options can not be specified twice, neither on the command line nor in
23 the configuration file.
24
25 .SH "OPTIONS"
26 .IP "\fB-h | --help\fP         " 10
27 display help and exits
28 .IP "\fB-v | --version\fP " 10
29 display the version number and exits
30 .IP "\fB-d | --debug\fP " 10
31 run in verbose mode
32 .IP "\fB-cf | --configuration-file <file>\fP " 10
33 set the configuration file (default is /etc/breezed.conf)
34 .IP "\fB-ncf | --no-configuration-file\fP " 10
35 prevent the reading of a configuration file
36 .IP "\fB-tf | --thermal-file <file1>[,file2]...\fP " 10
37 set the files to spool for temperatures.
38 .IP "\fB-ff | --fan-file <file>\fP " 10
39 set the file to control the fan speed.
40 .IP "\fB-tt | --temperature-thresholds <temp1>[,temp2]...\fP " 10
41 set the temperature thresholds.
42
43 .SH "CONFIGURATION FILE"
44
45 The configuration file is a succession of lines, each starting with
46 one of the three keywords thermal_files, fan_file or
47 temperature_thresholds, followed by the same parameter values as for
48 the command line arguments. The default configuration file is located
49 at /etc/breezed.conf
50
51 .SH "EXAMPLES"
52
53 A typical way of starting breezed is
54
55 breezed --thermal-files /proc/acpi/thermal_zone/THM0/temperature,/proc/acpi/thermal_zone/THM1/temperature \
56  --fan-file /proc/acpi/ibm/fan \
57  --temperature-thresholds -1,52,54,56,58,60,62,64
58
59 which specifies that when the temperature raises above 52C, the fan
60 level should be 1, when the temperature raises above 54C it should be
61 2, etc. The maximum speed level 7 should be chosen for temperature
62 above 64C. Due to the two degrees gap between the thresholds to
63 increase and thresholds to decrease the temperature, it will for
64 instance remains at speed 1 until the temperature goes down to 50C.
65
66 Because it takes into account all the values found in the thermal
67 files, you can use as well /proc/acpi/thermal_zone/THM?/temperature or
68 /proc/acpi/ibm/thermal.
69
70 .SH "AUTHOR"
71 .PP
72 Written by Francois Fleuret <francois@fleurer.org>. Permission is
73 granted to copy, distribute and/or modify this document under the
74 terms of the GNU GPL.