diff options
| -rw-r--r-- | README.html | 43 |
1 files changed, 33 insertions, 10 deletions
diff --git a/README.html b/README.html index 4c07d64..614e0c1 100644 --- a/README.html +++ b/README.html @@ -1,6 +1,6 @@ <h1>cputemp2maxfreq</h1> <p> - This daemon sets the cpufreq scale_max_freq setting and scales it down when + This daemon sets the cpufreq scaling_max_freq setting and scales it down when the CPU reaches a given temperature. </p> <h2>Why this program?</h2> @@ -28,10 +28,8 @@ There is a lot you can tune and do with this basic function, these are the options you can pass to cputemp2maxfreq: </p> +<p><strong>Scaling options:</strong></p> <ul> - <li><strong>-c or -C</strong> will log data to a CSV file which can be used - for analysis later. See the paragraph below on how to use it with - LibreOffice. -c will append data, -C will overwrite an existing file</li> <li><strong>-f</strong> sets the fallback frequency. In case something goes wrongthe program sets the CPU frequency to it's minimum. In case that fails too it will try the fallback frequency</li> @@ -40,6 +38,17 @@ "keep" to prevent this daemon from changing the governor</li> <li><strong>-i</strong> set the file for CPU temperature readout. Most sensors should be available in sysfs somewhere</li> + <li><strong>-p</strong> set poll interval</li> + <li><strong>-s</strong> set the step size to increase/decrease CPU speed. + Note that this value will be multiplied by the difference between the CPU + temperature and the set temperature to calculate the actual change.</li> + <li><strong>-t</strong> set the temperature limit</li> +</ul> +<p><strong>Logging options:</strong></p> +<ul> + <li><strong>-c or -C</strong> will log data to a CSV file which can be used + for analysis later. See the paragraph below on how to use it with + LibreOffice. -c will append data, -C will overwrite an existing file</li> <li><strong>-l</strong> set the logging mechanism to use. Possible values: <ul> <li><strong>none</strong>: No logging at all</li> @@ -47,12 +56,9 @@ <li><strong>stdout</strong>: Log to stdout, especially useful when testing/tuning</li> <li><strong>syslog</strong>: Log to syslog, it will use facility Daemon and level Critical</li> </ul></li> - <li><strong>-m</strong> log measurements (CPU temperature and frequency)</li> - <li><strong>-p</strong> set poll interval</li> - <li><strong>-s</strong> set the step size to increase/decrease CPU speed. - Note that this value will be multiplied by the difference between the CPU - temperature and the set temperature to calculate the actual change.</li> - <li><strong>-t</strong> set the temperature limit</li> + <li><strong>-m</strong> log measurements (CPU temperature and frequency) via logger</li> + <li><strong>-u</strong> use unix timestamps in log and CSV outputs instead of YYYY-MM-DD + HH:MM:SS</li> </ul> <p> To use the CSV file with libreOffice first stop the daemon to make sure all @@ -99,6 +105,23 @@ the CPU's Maximum Frequency again. The scaling between 12:37:26 and 12:40:19 was done by this daemon. </p> +<p> + Also note that the temperature given to this program is not a <i>maximum</i> + temperature but a target. As can be seen in the graph above the temperature + will rise above this temperature before action is taken. Depending on the CPU + load and poll interval this could be a significant difference, so keep the + target temperature well below your CPU's maximum temperature. +</p> +<h3>Hardware requirements</h3> +<p> + In order to be able to use this program there are some hardware requirements: +</p> +<ul> + <li>Your CPU should have a temperature sensor that is available in sysfs (most CPU's + have this)</li> + <li>Your CPU should be able to be set to any frequency in a range. Especially some older + CPU's could only use a limited set of fixed frequencies, this is unusable.</li> +</ul> <h2>How to install this program</h2> <p> Since i'm a Gentoo user i made an ebuild provided in the gentoo directory of |