A Linux program to handle GPU switching on Optimus laptops.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kr1ss 67d51d0116 fix exception because of non-existent dict key 2 weeks ago
.github/ISSUE_TEMPLATE Update issue templates 5 months ago
config New xsetup files paths 3 weeks ago
login_managers Updated to reflect newer lightdm.conf 1 year ago
modules [Meta] Moved system files to subfolders 2 years ago
optimus_manager fix exception because of non-existent dict key 1 week ago
package Implemented automatic re-power on before suspend 2 weeks ago
systemd Implemented automatic re-power on before suspend 2 weeks ago
var No-DM-restart : added default requested/startup modes 1 year ago
.gitignore Updated .gitignore 2 years ago
LICENSE Initial commit 2 years ago
README.md README fixes following AMD support merge 3 weeks ago
optimus-manager.conf Merge branch 'master' into amd_support 1 month ago
setup.py Removed leftover icon files 6 months ago
systray.png README : replaced built-in tray by optimus-manager-qt 1 year ago

README.md

optimus-manager

IMPORTANT : this README is for the current master branch, which contains some new features that have not been added to an official release yet (most notably, support for AMD GPUs). If you are using the latest stable release (v1.3.1), the corresponding README is available here : https://github.com/Askannz/optimus-manager/wiki/v1.3.1-README.

This Linux program provides a solution for GPU switching on Optimus laptops (i.e laptops with a dual Nvidia/Intel or Nvidia/AMD configuration).

Obviously this is unofficial, I am not affiliated with Nvidia in any way.

Only Archlinux and Archlinux-based distributions (such as Manjaro) are supported for now. Only Xorg sessions are supported (no Wayland).

Supported display managers are : SDDM, LightDM, GDM.

optimus-manager can also work with other display managers (or with no display manager at all) but you have to configure them manually (see FAQ section 1 FAQ section 2 ).

Introduction

GPU offloading and power management with Nvidia cards are not properly supported on Linux (though there has been some great progress recently), which can make it hard to use your Optimus laptop at full performance. optimus-manager provides a workaround to this problem by allowing you to run your whole desktop session on the Nvidia GPU, while the Intel/AMD GPU only acts as a “relay” between the Nvidia GPU and your screen.

This is essentially a port to Archlinux of the nvidia-prime solution created by Canonical for Ubuntu.

To learn more about the current Optimus situation on Linux and how this solution works, read the Home Wiki page.

IMPORTANT : Gnome and GDM users

If you use Gnome or the Gnome Display Manager (GDM), there are a couple extra requirements to be able to use optimus-manager :

  • The default gdm package from the Archlinux and Manjaro repositories is not compatible with optimus-manager, so you must replace it with this patched version : gdm-prime (also replaces libgdm). The patch was written by Canonical for Ubuntu and simply adds two script entry points specifically for Prime switching. The package is otherwise identical to the official one.

  • Gnome launches Wayland sessions by default, which are incompatible with optimus-manager. To force Xorg sessions, You need to edit the file /etc/gdm/custom.conf and remove the # before the line #WaylandEnable=false.

Another quirk of GDM is that the X server may not automatically restart after a GPU switch. If you see an empty black screen or a black screen with a blinking cursor, try switching back to an empty TTY (with Ctrl+Alt+F5 for instance), then back to TTY1 with Ctrl+Alt+F1. See this FAQ question.

IMPORTANT : Manjaro KDE users

Manjaro ships with a default configuration for SDDM (the default login manager for KDE) which overrides some keys needed by optimus-manager. To use optimus-manager, you need to edit the file /etc/sddm.conf and simply put a # before the line starting with DisplayCommandand the one starting with DisplayStopCommand.

Installation

Naturally, you must have the proprietary nvidia driver installed on your system. On Archlinux, you can use the packages nvidia or nvidia-dkms. On Manjaro, it is fine to use the built-in driver utility.

You can install optimus-manager from this AUR package : optimus-manager

After installation, the optimus-manager daemon should have been started automatically, but you can check its status with systemctl status optimus-manager.service.

Important notes :

  • Custom Xorg config : optimus-manager works by auto-generating a Xorg configuration file and putting it into /etc/X11/xorg.conf.d/. If you already have custom Xorg configuration files at that location or at /etc/X11/xorg.conf , it is strongly advised that you remove anything GPU-related from them to make sure that they do not interfere with the GPU switching process.

  • Nvidia-generated Xorg config : Similarly, if you have ever used the nvidia-xonfig utility or the Save to X Configuration File button in the Nvidia control panel, a Xorg config file may have been generated at /etc/X11/xorg.conf . It is highly recommended to delete it before trying to switch GPUs.

  • Manjaro-generated Xorg config : Manjaro has its own driver utility called MHWD that also auto-generates a Xorg config file at /etc/X11/xorg.conf.d/90-mhwd.conf. optimus-manager will automatically delete that file to avoid issues.

  • Manjaro Gnome : see the previous section Gnome and GDM users

  • Manjaro KDE : see the previous section Manjaro KDE users

  • Bumblebee : optimus-manager is incompatible with Bumblebee since both tools would be trying to control GPU power switching at the same time. If Bumblebee is installed, you must disable its daemon (sudo systemctl disable bumblebeed.service, then reboot). This is particularly important for Manjaro users since Bumblebee is installed by default.

  • nvidia-xrun : if you have previously installed nvidia-xrun by following instructions on the Arch Wiki, make sure all its configuration files are removed. See issue (https://github.com/Askannz/optimus-manager/issues/135).

  • GPU monitoring apps : if you have an application (or tray widget) that automatically monitors the Nvidia GPU for things like load, temperature, VRAM usage, etc, make sure it is not running before switching to integrated mode. Those applications work by constantly polling the nvidia driver, which may prevent it from being unloaded by optimus-manager.

Uninstallation

To uninstall the program, simply remove the optimus-manager package. The auto-generated Xorg config file will be automatically cleaned up.

You can also force cleanup by running optimus-manager --cleanup.

You can also disable optimus-manager by disabling the systemd service optimus-manager.service (needs a reboot to be applied).

Usage

Run

  • optimus-manager --switch nvidia to switch to the Nvidia GPU
  • optimus-manager --switch integrated to switch to the integrated GPU and power the Nvidia GPU off
  • optimus-manager --switch hybrid to switch to the iGPU but leave the Nvidia GPU available for on-demand offloading, similar to how Optimus works on Windows. See the Wiki for more details.

WARNING : Switching mode automatically logs you out, so make sure you save your work and close all your applications before doing so.

Auto-logout is supported for Gnome, KDE Plasma, LXDE, Deepin, Xfce, i3, Openbox, AwesomeWM, bspwm and dwm. You can disable it in the configuration file. In that case, the GPU switch will not be effective until the next login.

You can also specify which GPU you want to be used by default when the system boots, by setting startup_mode in the [configuration file]optimus-manager.conf at /etc/optimus-manager/optimus-manager.conf.

System Tray App

optimus-manager systray screenshot

The program optimus-manager-qt provides a system tray icon for easy switching. It also includes a GUI for setting options without editing the configuration file manually.
AUR package : optimus-manager-qt

Unofficial Gnome Shell extensions are also avaialble :

Kernel parameter

As an alternative to startup_mode, optimus-manager also allows you to set the startup GPU mode using a kernel parameter. This is useful if you want to create multiple entries in your bootloader with different GPU startup modes (for instance a “battery-saving” mode that starts with the integrated GPU, and a “gaming” mode that starts with Nvidia).

Simply add optimus-manager.startup=MODE to your kernel parameters list, where MODE can be any startup mode. Note that this parameter overrides whatever startup mode was set in the config file.

Also note that this parameter only affects which GPU your desktop session starts with ; it has absolutely no effect on the boot process before that, because optimus-manager has no control over it.

Power management

Since version v1.2, power management is disabled by default, so the Nvidia GPU will stay powered on (consuming energy) until manual configuration is done. This choice was made because there is no catch-all configuration that works for all laptop models, and incorrect configurations often break the boot process.

Please refer to the guide on power management in the Wiki.

Configuration

The default configuration file can be found at /usr/share/optimus-manager.conf. Please do not edit this file ; instead, edit the config file at /etc/optimus-manager/optimus-manager.conf (or create it if it does not exist).

Any parameter not specified in your config file will take value from the default file. Remember to include the section headers of the options you override.

Please refer to the comments in the default config file for descriptions of the available parameters. In particular, it is possible to set common Xorg options like DRI version or triple buffering, as well as some kernel module loading options.

No config changes will be effective until you computer is rebooted or the optimus-manager service is restarted.

You can also add your own Xorg options in /etc/optimus-manager/xorg-nvidia-gpu.conf, /etc/optimus-manager/xorg-integrated-gpu.conf and /etc/optimus-manager/xorg-hybrid.conf. Anything you put in those files will be written to the “Device” section of the auto-generated Xorg configuration file corresponding to their respective GPU mode.

If you need the display manager to run some specific commands to set up the display (to force a particular resolution, for instance), you can write them to /etc/optimus-manager/xsetup-integrated.sh, /etc/optimus-manager/xsetup-nvidia.sh and /etc/optimus-manager/xsetup-hybrid.sh.

Finally, if you need to run some specific code prior to enabling or after disabling the nvidia graphics card (for example, to manually enable the card if bbswitch is not supported), you can write the commands to /etc/optimus-manager/nvidia-enable.sh and /etc/optimus-manager/nvidia-disable.sh.

FAQ / Troubleshooting

See the FAQ section in the Wiki.

Credit

The Qt tray app was created by Shatur95.