X-Git-Url: https://www.fleuret.org/cgi-bin/gitweb/gitweb.cgi?p=breezed.git;a=blobdiff_plain;f=README.txt;h=1b2b76b2b63a30a2e3f91c25cc3d6de9a33578ad;hp=ea3b4cc2f2d3d0636a3f02524f80416870d0c434;hb=fee51a9e44a65d80e921559b8ea4451d3e71c645;hpb=e41931ad13ec563225b0b12ef24cdf7a18499aad

diff --git a/README.txt b/README.txt
index ea3b4cc..1b2b76b 100644
--- a/README.txt
+++ b/README.txt
@@ -39,6 +39,41 @@
    be enough. Please let me know if you have problem with the
    resulting overall behavior.
 
+ * ARGUMENTS
+
+   The breezed executable can read a configuration file (which is
+   /etc/breezed.conf by default, but that you can specify with
+   --configuration-file <file>) or get the various parameters on the
+   command line.
+
+   The thermal files can be specified either with the --thermal-files
+   options on the command line or the thermal_files keyword in the
+   configuration file. The provided value should be a comma-separated
+   list of filenames. When it want to pool the temperature, the daemon
+   will read those files and compute the maximum integer value they
+   contains.
+
+   The fan file can be specified with either --fan-file or the
+   fan_file keyword. The specified file will be used by the daemon to
+   control the fan speed by writing "level n" into it.
+
+   The temperature thresholds can be specified either with the
+   --temperature-thresholds argument, or with the
+   temperature_thresholds keyword in the configuration file. The
+   provided value should be a comma separated list of integers. The
+   first one is actually ignored and forced to -1. Each value states
+   which temperature should trigger the given level.
+
+   For instance, my X61s has 8 fan levels, from 0 to 7. The thresholds
+   I picked are -1,52,54,56,58,60,62,64. Hence, when the temperature
+   reaches 52C, the fan is set to level 1, when it reached 54C it is
+   set to level 2, etc. The maximum speed level 7 is chosen for any
+   temperature equal or greater than 64C. As said above, the
+   temperature to decrease the speed has to be two degrees below the
+   provided thresholds. Hence, the temperature of my X61s has to go
+   down to 50C (52C - 2) for the fan to switch off. Also, the daemon
+   waits at least 30s before reducing the speed of the fan.
+
  * NOTES
 
    I wrote this daemon for my personal usage on a X61s, and using it