breezed.1

   1 .TH "BREEZED" "1.4" "Mar 2010" "Francois Fleuret" "System Deamons"
   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 is a daemon to adjust the fan speed according to the
  10 computer temperature. It should be started through the adequate
  11 systemd configuration or script in /etc/rc?.d.
  12
  13 Every 5s, \fBbreezed\fP gathers all integer values from the thermal
  14 files, and takes the max as the overall temperature T. It then
  15 computes the highest fan speed whose temperature threshold is lower
  16 than T. If that speed is above the current speed, the daemon changes
  17 the fan speed accordingly. Otherwise it computes the lowest fan speed
  18 whose temperature threshold is two degrees above T, and sets the fan
  19 speed one level below. This two degree gap avoids too many
  20 oscillations. Also, the daemon waits for at least 30s after any change
  21 of the fan speed before reducing it. The fan speed is set by writing
  22 "level <speed_name>" into the specified fan file. The speed name is
  23 the level itself if no alternative is provided with the temperature
  24 threshold.
  25
  26 Options cannot be specified twice, neither on the command line nor in
  27 the configuration file.
  28
  29 .SH "OPTIONS"
  30 .IP "\fB-h | --help\fP" 10
  31 display help and exits
  32 .IP "\fB-v | --version\fP" 10
  33 display the version number and exits
  34 .IP "\fB-d | --debug\fP" 10
  35 run in verbose mode
  36 .IP "\fB-cf | --configuration-file <file>\fP" 10
  37 set the configuration file (default is /etc/breezed.conf)
  38 .IP "\fB-ncf | --no-configuration-file\fP" 10
  39 prevent the reading of a configuration file
  40 .IP "\fB-tf | --thermal-file <file1>[,file2]...\fP" 10
  41 set the files to spool for temperatures.
  42 .IP "\fB-ff | --fan-file <file>\fP" 10
  43 set the file to control the fan speed.
  44 .IP "\fB-tt | --temperature-thresholds <temp1>[:<speed_name_1>][,temp2[:speed_name_2]]...\fP" 10
  45 set the temperature thresholds.
  46
  47 .SH "CONFIGURATION FILE"
  48
  49 The configuration file is a succession of lines, each starting with
  50 one of the three keywords thermal_files, fan_file or
  51 temperature_thresholds, followed by the same parameter values as for
  52 the command line arguments. The default configuration file is located
  53 at /etc/breezed.conf
  54
  55 .SH "EXAMPLES"
  56
  57 If a configuration file exists, the standard way to start breezed is
  58 to run it without arguments.
  59
  60 Starting it with all the arguments on the commande line can be done
  61 for instance with
  62
  63 .P
  64 .nf
  65 .B breezed --no-configuration-file \e
  66 .B \ \ \ \ \ \ \ \ --thermal-files /proc/acpi/thermal_zone/THM0/temperature,/proc/acpi/thermal_zone/THM1/temperature \e
  67 .B \ \ \ \ \ \ \ \ --fan-file /proc/acpi/ibm/fan \e
  68 .B \ \ \ \ \ \ \ \ --temperature-thresholds 52,54,56,58,60,62,64,68:full-speed
  69
  70 which specifies that when the temperature raises above 52C, the fan
  71 level should be 1, when the temperature raises above 54C it should be
  72 2, etc. The maximum speed level 8 should be chosen for temperatures
  73 above 68C, and its name is "full-speed" (since no other speed name is
  74 provided, the other ones are the default level names, hence their
  75 numerical value).
  76
  77 Due to the two degrees gap between the thresholds to increase and the
  78 thresholds to decrease the temperature, it will for instance remains
  79 at speed 1 until the temperature goes down to 50C.
  80
  81 Because it takes into account all the values found in the thermal
  82 files, you can use as well /proc/acpi/thermal_zone/THM?/temperature or
  83 /proc/acpi/ibm/thermal.
  84
  85 .SH "AUTHOR"
  86 .PP
  87 Written by Francois Fleuret <francois@fleuret.org>. Permission is
  88 granted to copy, distribute and/or modify this document under the
  89 terms of the GNU GPL.