Table of contents

  1. Dependencies
  2. Releases page
  3. Gnome extensions repository
  4. Git sources
  5. Packaging
  6. Installation script
  7. Source Archive
  8. Gnome Tweak Tool
  9. Restarting Gnome Shell
  10. Managing Extensions
  11. Finishing the installation
  12. Upgrading the extension
  13. Uninstalling
  14. Troubleshooting

Dependencies

  • Gtk 3.14+
  • GJS
  • fonts-roboto fonts-lato (optionally)

Releases page

A simple way to install the application from compiled deb packages for Debian/Ubuntu flavors. There are available GNOME Extension cpufreq@konkor.zip packages so.

Releases page on GitHub

You can install downloaded package from GUI package managers like GDEBI or other system utilities or just using CLI.

sudo dpkg -i cpufreq_VERSION_all.deb
sudo apt-get -f install

Gnome extensions

The official and easiest way to install the extension version on the Gnome Desktop.

Official repository of the extension on extensions.gnome.org

You have to select Install... or Install Updates... in the extension menu after installation/updating to finish the configuration.

You could try to install the extension through the Gnome Software center so. It’s available in many modern distributions.

Git sources

Building dependencies

  • autogen automake
  • gnome-autogen
  • devscripts (for DEB packaging only)
sudo apt-get install autogen automake gnome-common

## for debian packaging
sudo apt-get install devscripts

Building and installing from sources

git clone https://github.com/konkor/cpufreq
cd cpufreq

./autogen.sh && make
sudo make install

Packaging

Debian

Make a DEB package:

./autogen.sh && make && make dist
cd packaging/
./packaging.sh

GNOME Extension

Make a ZIP package for GNOME Shell:

./autogen.sh && make && make zip-file

Installation script

Installing the extension through the installation script from the GitHub repository.

  1. Run install script (default master branch) 
    chmod a+x install_extension.sh
./install_extension.sh

    or for gtk branch to example

    ./install_extension.sh gtk
  2. Restart Gnome Shell to reload extensions.

Top

Source Archive

Manual installation of GNOME Extension from the GitHub branch's source archive.

  1. Download zip archive from GitHub page cpufreq-master.zip.
  2. Extract cpufreq-master.zip archive and copy all to the ~/.local/share/gnome-shell/extensions/cpufreq@konkor folder.
  3. Optionally, check/fix the executing bit: 
    chmod +x ~/.local/share/gnome-shell/extensions/cpufreq@konkor/cpufreqctl
  4. Restart Gnome Shell to reload extensions.
  5. Enable the cpufreq extension. See Managing Extensions.

PS: I recommend you to install it through the extensions.gnome.org repository and just update files from the GitHub archive. This makes you avoid a few steps of the manual method.

Top

Gnome Tweak Tool

installation of GNOME Extension cpufreq@konkor.zip packages from GitHub through Gnome Tweak Tool.

Download zip archive from GitHub page. Run gnome-tweak-tool go to extensions tab, click Install Shell Extension from a drive and select cpufreq-master.zip or downloaded cpufreq@konkor.zip. Detailed steps below:

wget https://github.com/konkor/cpufreq/archive/master.zip
gnome-tweak-tool # Select 'Install Shell Extension' button on the Extensions Tab.
chmod +x ~/.local/share/gnome-shell/extensions/cpufreq@konkor/cpufreqctl
  • Now close gnome-tweak-tool and restart gnome-shell to reload extensions.
  • Enable extension (See Managing Extensions so) 
    gnome-tweak-tool # Turn on the extension.
  • Finish the installation inside the extension menu to enable the extension policy and CLI. 
    cpufreq extension => ⚠ Install...

Top

Restarting Gnome Shell

Different ways to restart or re-log current Gnome Shell session

  • user’s Log-out / Log-in (X11/Wayland)
  • Alt+F2 and enter r command (X11 only)
  • or just reboot PC (X11/Wayland)

Top

Managing Extensions

Here are some ways to manipulate the extension state (enabling, disabling, installing, updating, removing settings...).

You can manage your extensions in many ways:

  • gnome-shell-extension-prefs
  • web browser page Installed Extensions
  • gnome-tweak-tool
  • Gnome Software Center.
  • Manual method by removing any extension folder you will remove the extension. After this operation you have to restart current Gnome session.

Top

Finishing the installation

After installing/updating the extension on the system, you have to finalize the procedure in order to allow it to manage the system's power settings

A couple ways to do so:

  • In the extension menu Select ⚠ Install… or ⚠ Install Updates… menu item.
  • In the terminal Run install command 
    sudo ~/.local/share/gnome-shell/extensions/cpufreq@konkor/cpufreqctl install

Top

Upgrading the extension

Here are some ways to upgrade the extension

Hopefuly frequently, the extension will receives updates to fix bugs, update the documentation or add new features and abilities. So here is a few ways to do this:

  1. You can update the extension through the web browser page Installed Extensions
  2. You can do this in the Gnome Software Center.
  3. You can get the development version from GitHub.
    • Download desired archive from GitHub 
      wget https://github.com/konkor/cpufreq/archive/master.zip
    • Extract cpufreq-master.zip.
    • Replace all files in the ~/.local/share/gnome-shell/extensions/cpufreq@konkor folder.
    • Restart GNOME Shell.
  4. You can use installation script to do it. Using the command will switch you to the latest desired GitHub branch: 
    ./install.sh [GITHUB_BRANCH]

    After Upgrading you may have to finish the installation as the extension could also update its API.

Top

Uninstalling

Sometimes we need to remove some extension. The cause could be for example complete reinstallation or bugs. It can be useful if you have saved broken settings values or to clean up previous installations.

Completly removing the extension and stored settings.

  1. Remove the extension folder 
    rm -Rf ~/.local/share/gnome-shell/extensions/cpufreq@konkor

    Be careful with this command as any mistake could cause a data loss!!!

  2. You can check this values in the dconf-editor at /org/gnome/shell/extensions/cpufreq/ 
    dconf reset -f "/org/gnome/shell/extensions/cpufreq/"
sudo rm /usr/share/polkit-1/actions/konkor.cpufreq.policy
sudo rm /usr/bin/cpufreqctl

    If you want reset the extension’s values to defaults just run it and restart gnome-shell.

    dconf reset -f "/org/gnome/shell/extensions/cpufreq/"

Top

Troubleshooting

Missing symbols

If you have missing symbols you are, probably, missing some fonts, try to install TTF Freefonts, DejaVu or/and Droid font packages to fix it.

Gathering information for reports

Provide more information about your hardware and system like:

  • Intel or AMD CPU
  • intel_pstate or acpi_cpufreq CPU driver
  • Kernel version
  • IRQ Balance enabled or disabled
  • Are you using CPU powering off/on in your profiles
  • Include system journal log’s messages or just related parts. See more about logs below.

Report to issues with included system information like distributions, CPU, acpi-cpufreq/intel_pstate mode, system journal errors and description of the issue.

Debugging

  1. First thing to do is check your clean desktop environment to do so you should disable all Gnome shell extensions including this one. Some distributions including pre-installed many extensions and they could conflict with new updates or each other. If all looking fine you can go to the next step.

  2. Enable only this extension to test it and easy check system messages. You can check the system journal messages in a terminal.

  3. Run the command sudo journalctl -f in a terminal to see real-time system messages monitoring and restart Gnome Shell (X11 only): Alt+F2 and enter r command.

sudo journalctl -f

  • Do not close the monitor in a terminal. Open the extension menu and try to change profiles and/or other settings. You could see maybe some warnings, errors or when it locks. Copy/paste related messages to text file and include it in your report.

  • Alternatively, you can just grep all messages and check for errors and other warnings.

# For cpufreq messages
sudo journalctl |grep cpufreq

# For all gnome-session messages
sudo journalctl |grep gnome-session

Top