libdockapp: bump library version to 3.0.1.
[dockapps.git] / wmthrottle / README
blob2f0a04fd37f605b16af0384ce3b267eed57a0f7b
1 A small app of questionable value (myself I use it to throttle the CPU when I perceive it 
2 is getting too hot). At the moment the code is optimized for a dell laptop but should work 
3 on most ACPI systems.
5 Supports changing cpu speed via performance (Intl's enhanced speedstep in 
6 Centrino/Pentium M cpus) as well, via the -p command line option. This is good for
7 saving energy while on batteries and it can also avoid fan noise.
9 It also features automatic, dynamic downclocking/throttling depending on the cpu
10 temperature. This can be useful to avoid fan noise. To enable this feature, simply
11 run wmthrottle with the -t <temperature> option and give it a certain temperature
12 threshold. Starting at this threshold, it will change performance/throttle states.
13 This is dynamic, i.e. a higher temperature will result in a lower clock speed 
14 (or higher throttling).
15 The temperature threshold depends on the machine you use it on and on workload.
16 The machine it was tested on (Acer TravelMate 800) requires a 
17 threshold of 49/50 degrees (Celsius) when having 100% cpu usage to keep the cpu fan
18 from turning on.
19 Note that although the numbers above are in Celsius, this feature should work with
20 Fahrenheit as well. Simply check /proc/acpi/thermal_zone/THRM/temperature to see
21 if your acpi is set to use Celsius or Fahrenheit.
23 When the -t switch is set, wmthrottle will change cpu performance/throttling 
24 states every one degree. Example: You start wmthrottle with -t 49, which means
25 that it will change from state 0 to state 1 when the cpu is at 49 degrees,
26 and will change from state 1 to 2 when the temperature increases by 1 degree,
27 i.e. at 50 degrees, and so on.
28 If your setup requires a different temperature delta value, e.g. when your
29 system is using Fahrenheit, you can set this value using the -e switch.
30 You will probably have to plain with both the -t and the -e switches since
31 all computers are different.
34 Once you have started wmthrottle, change throttle/performance states by 
35 clicking on state numbers.
36 If started with the -t <temperature> option, clicking on the [T] toggles
37 dynamic performance/throttle changes. If you turn it off, you can also choose
38 states manually again.
39 Clicking anywhere else will toggle the back light.
41 If you want to use wmthrottle with a windowmanager other than windowmaker, the
42 -bw (--broken-wm) flag will probably be your friend.
45 wmthrottle certainly needs to be run as root. To always run it as root, simply set the
46 setuid bit on wmthrottle after installing:
47 # chmod u+s wmthrottle
49 This means that wmthrottle is always run by whoever owns it (root in this case), 
50 no matter who started it.
53 Also remember that playing around with your CPU etc can be a bad thing so saying 
54 standard I take no responsibility for damage to your machine disclaimer applies.