README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# NVidia eXec - `nvx`

`nvx` is a script to run programs on Pascal and older (<= 10 series) nvidia optimus setups with power management. `nvx`
tries to be extremely simple to install and use, and supports both Xorg and Wayland environments.

Note: This script is highly experimental and require very recent versions of nvidia drivers and gnome patches to work.

## Usage

The script requires `sudo` to toggle the GPU and modules. You might be asked to input your password before the program
starts (to initialize the device), and after the program finishes (to cleanup resources).

1. run `nvx start [program]`
2. that is it

`nvx start` may be called multiple times, its is only going to initialize the devices in the first call and clean
resources when the last call ends.

### Other actions

-   `nvx on` - Turn on the gpu and load the nvidia modules.
-   `nvx off` - Turn off the gpu and unload the nvidia modules. This command may hang if there are programs using it.
-   `nvx off-kill` - Kill processes using the gpu and turn it off (may still hang).
-   `nvx status` - Print **on** or **off** to indicate the current gpu status.
-   `nvx processes` - Print all processes using the gpu. In case `nvx off` hangs, you can list the processes and stop
    them manually, after that, the `nvx off` will complete
-   `nvx kill` - Kill all processes using the gpu. Some applications might still spawn another process immediately (e.g.
    google chrome), preventing the gpu from turning off.

## Installation

### Files

-   **nvx** -> _/usr/bin/nvx_ - Script that handles the gpu and run programs
-   **nvx.service** -> _/usr/lib/systemd/system/nvx.service_ - Service that turns off gpu during boot
-   **modprobe.conf** -> /usr/lib/modprobe.d/nvx.conf - Blacklisted modules