Documentation #458
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # auto-cpufreq | ||
|
|
||
| Automatic CPU speed & power optimizer for, Linux based on active monitoring of a laptop's battery state, CPU usage, CPU temperature and system load. Ultimately allowing you to improve battery life without making any compromises. | ||
|
|
||
| For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtube.com/watch?v=QkYRpVEEIlg) | ||
|
|
||
|
|
@@ -12,17 +12,17 @@ auto-cpufreq is looking for [co-maintainers & open source developers to help sha | |
|
|
||
| ## Why do I need auto-cpufreq? | ||
|
|
||
| One of the problems with Linux today on laptops is that the CPU will run in an unoptimized manner which will negatively reflect on battery life. For example, the CPU will run using "performance" governor with turbo boost enabled regardless if it's plugged in to power or not. | ||
|
|
||
| These issues can be mitigated by using tools like [indicator-cpufreq](https://itsfoss.com/cpufreq-ubuntu/) or [cpufreq](https://github.com/konkor/cpufreq), but these still require manual action from your side which can be daunting and cumbersome. | ||
|
|
||
| Using tools like [TLP](https://github.com/linrunner/TLP) can help in this situation with extending battery life (which is something I used to do for numerous years), but it also might come with its own set of problems, like losing turbo boost. | ||
|
|
||
| With that said, I needed a simple tool which would automatically make "cpufreq" related changes, save battery like TLP, but let Linux kernel do most of the heavy lifting. That's how auto-cpufreq was born. | ||
|
|
||
| Please note: auto-cpufreq aims to replace TLP in terms of functionality and after you install auto-cpufreq _it's recommended to remove TLP_. If both are used for same functionality, i.e: to set CPU frequencies it'll lead to unwanted results like overheating. Hence, only use [both tools in tandem](https://github.com/AdnanHodzic/auto-cpufreq/discussions/176) if you know what you're doing. | ||
|
|
||
| The Tool/daemon that does not conflict with auto-cpufreq in any way, and is even recommended to have running alongside, is [thermald](https://wiki.debian.org/thermald). | ||
|
|
||
| #### Supported architectures and devices | ||
|
|
||
|
|
@@ -48,7 +48,7 @@ Supported devices must have an Intel, AMD or ARM CPUs. This tool was developed t | |
|
|
||
| ### Snap store | ||
|
|
||
| auto-cpufreq is available on the [snap store](https://snapcraft.io/auto-cpufreq), or can be installed using CLI: | ||
|
|
||
| ``` | ||
| sudo snap install auto-cpufreq | ||
|
|
@@ -57,7 +57,7 @@ sudo snap install auto-cpufreq | |
| **Please note:** | ||
| * Make sure [snapd](https://snapcraft.io/docs/installing-snapd) is installed and `snap version` version is >= 2.44 for `auto-cpufreq` to fully work due to [recent snapd changes](https://github.com/snapcore/snapd/pull/8127). | ||
|
|
||
| * Fedora users will [encounter following error](https://twitter.com/killyourfm/status/1291697985236144130) due to `cgroups v2` [being in development](https://github.com/snapcore/snapd/pull/7825). This problem can be resolved by either running `sudo snap run auto-cpufreq` after the snap installation or by using the [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) which doesn't have this issue. | ||
|
|
||
| ### auto-cpufreq-installer | ||
|
|
||
|
|
@@ -78,19 +78,18 @@ In case you encounter any problems with `auto-cpufreq-installer`, please [submit | |
| (For the latest commits/changes) \ | ||
| Please note that this git package is currently unmaintained & has issues. Until someone starts maintaining it, use the [manual script installer](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-installer) if you intend to have the latest changes. | ||
|
|
||
| ## Post Installation | ||
| After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options)for more information on how to run and configure `auto-cpufreq`. | ||
|
|
||
| ## Configuring auto-cpufreq | ||
|
|
||
| auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. However, it's possible to perform additional configurations in 2 ways: | ||
|
|
||
| ### 1: power_helper.py script | ||
|
|
||
| If detected as running, auto-cpufreq will disable [GNOME Power profiles service](https://twitter.com/fooctrl/status/1467469508373884933), which would otherwise cause conflicts and cause problems. | ||
|
|
||
| By default auto-cpufreq uses `balanced` mode which works the best on various systems. However, if you're not reaching maximum frequencies your CPU is capable of with auto-cpufreq ([#361](https://github.com/AdnanHodzic/auto-cpufreq/issues/361)), you can switch to `performance` mode. Which will result in higher frequencies by default, but also results in higher energy use (battery consumption). | ||
|
|
||
| If you installed auto-cpufreq using [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/edit/master/README.md#auto-cpufreq-installer), you can switch to `performance` mode by running: | ||
|
|
||
|
|
@@ -100,15 +99,17 @@ Or if you installed auto-cpufreq using [Snap package](https://github.com/AdnanHo | |
|
|
||
| `sudo python3 power_helper.py --gnome_power_disable performance` | ||
|
|
||
| **Please Note:** | ||
| The `power_helper.py` script is located at `auto_cpufreq/power_helper.py` | ||
|
|
||
|
|
||
| After this step, all necessary changes will still be made automatically. However, if you wish to perform additional "manual" settings this can be done by following instructions explained in next step. | ||
|
|
||
| ### 2: auto-cpufreq config file | ||
|
|
||
| You can configure seperate profiles for the battery and power supply. These profiles will let you pick which governor to use, and how and when turbo boost is enabled. The possible values for turbo boost behavior are `always`, `auto` and `never`. The default behavior is `auto`, which only kicks in during high load. | ||
|
|
||
| By default, auto-cpufreq does not use the config file! If you wish to use it, the location where config needs to be placed for it to be read automatically is: `/etc/auto-cpufreq.conf` | ||
|
|
||
| #### Example config file contents | ||
| ``` | ||
|
|
@@ -156,11 +157,48 @@ turbo = auto | |
| ``` | ||
|
|
||
| ## How to run auto-cpufreq | ||
| Running just `auto-cpufreq` like so: | ||
|
There was a problem hiding this comment. Let's remove line 160 to 166, i.e: No need to get into so much detail, and even if someone runs it, message is returned and it's self explanatory what they should do. |
||
|
|
||
| `sudo auto-cpufreq` | ||
|
|
||
| will give an error: | ||
|
|
||
| `auto-cpufreq: wrong invocation. try --help for help.` | ||
|
|
||
| auto-cpufreq should be run with with one of the following long options: | ||
|
There was a problem hiding this comment.
Let's just say:
There was a problem hiding this comment. I like that you created this new section, let's add a line here for full description of each option please to auto-cpufreq modes and options section. |
||
|
|
||
| * monitor | ||
| - Monitor and see suggestions for CPU optimizations | ||
|
|
||
| * live | ||
| - Monitor and make (temp.) suggested CPU optimizations | ||
|
|
||
| * install / remove | ||
| - Install/remove daemon for (permanent) automatic CPU optimizations | ||
|
|
||
| * install_performance | ||
| - Install daemon in "performance" mode. | ||
|
|
||
| * stats | ||
| - View live stats of CPU optimizations made by daemon | ||
|
|
||
| * config TEXT | ||
| - Use config file at defined path | ||
|
|
||
| * debug | ||
| - Show debug info (include when submitting bugs) | ||
|
|
||
| * version | ||
| - Show currently installed version | ||
|
|
||
| * donate | ||
| - To support the project | ||
|
|
||
| * help | ||
| - Shows all of the above options | ||
|
|
||
| Running `auto-cpufreq --help` will print the same list of options as above. Read [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) for more details. | ||
|
|
||
| ## auto-cpufreq modes and options | ||
|
|
||
| ### Monitor | ||
|
|
@@ -177,17 +215,27 @@ Necessary changes are temporarily made to the system which are lost with system | |
|
|
||
| ### Install - auto-cpufreq daemon | ||
|
|
||
| Necessary changes are made to the system for auto-cpufreq CPU optimization to persist across reboots. The daemon is deployed and then started as a systemd service. Changes are made automatically and live stats are generated for monitoring purposes. | ||
|
|
||
| Install the daemon using this command (after installing auto-cpufreq): | ||
|
|
||
| `sudo auto-cpufreq --install` | ||
|
|
||
| After the daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats` | ||
|
|
||
| Alternatively, using just systemd: | ||
|
There was a problem hiding this comment. Instead of saying "Alternatively, using just systemd" and lines 226 to 232 let's rephrase this or completely remove these lines not to encourage users to do this, as it can only lead to user breaking stuff. Since |
||
|
|
||
| `systemctl start auto-cpufreq` | ||
| will start the service, and | ||
|
|
||
| `systemctl enable auto-cpufreq` | ||
| will persistently start the daemon on boot. | ||
|
|
||
| Since daemon is running as a systemd service, its status can be seen by running: | ||
|
|
||
| `systemctl status auto-cpufreq` | ||
|
|
||
| If the install has been performed as part of snap package, daemon status can be verified by running: | ||
|
|
||
| `systemctl status snap.auto-cpufreq.service.service` | ||
|
|
||
|
|
@@ -197,6 +245,14 @@ auto-cpufreq daemon and its systemd service, along with all its persistent chang | |
|
|
||
| `sudo auto-cpufreq --remove` | ||
|
|
||
| You can also stop the service with: | ||
|
There was a problem hiding this comment. Just as in section above with install same goes for 248 to 255, |
||
|
|
||
| `systemctl stop auto-cpufreq` | ||
|
|
||
| and stop it from persistenctly starting with: | ||
|
|
||
| `systemctl disable auto-cpufreq` | ||
|
|
||
| ### Stats | ||
|
|
||
| If daemon has been installed, live stats of CPU/system load monitoring and optimization can be seen by running: | ||
|
|
@@ -245,6 +301,6 @@ If auto-cpufreq helped you out and you find it useful, show your appreciation by | |
|
|
||
| ### Code contribution | ||
|
|
||
| Other ways of supporting the project consists of making a code or documentation contribution. If you have an idea for a new features or want to implement some of the existing feature requests or fix some of the [bugs & issues](https://github.com/AdnanHodzic/auto-cpufreq/issues) please make your changes and submit a [pull request](https://github.com/AdnanHodzic/auto-cpufreq/pulls) which I'll be glad to review. If your changes are accepted you'll be credited as part of [releases page](https://github.com/AdnanHodzic/auto-cpufreq/releases). | ||
|
|
||
| **Please note: auto-cpufreq is looking for co-maintainers & open source developers to [help shape future of the project!](https://github.com/AdnanHodzic/auto-cpufreq/discussions/312)** | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add space between
(https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options)andfor more, i.e:(https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options) for more