Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emgyrz/backlight-change
backlight-change description
https://github.com/emgyrz/backlight-change
backlight bash-script brightness i3 linux
Last synced: about 1 month ago
JSON representation
backlight-change description
- Host: GitHub
- URL: https://github.com/emgyrz/backlight-change
- Owner: emgyrz
- License: mit
- Created: 2024-02-24T17:57:35.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-04-03T22:22:58.000Z (9 months ago)
- Last Synced: 2024-04-03T23:27:49.303Z (9 months ago)
- Topics: backlight, bash-script, brightness, i3, linux
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# backlight-change
The script for manipulating (set/increase/decrease/store/resume) the brightness (exact value or percent) of the screen using `/sys/class/backlight` device files.
## Usage
`backlight-change --help` output:
```sh
Usage: backlight-change [VALUE] [arguments] [command]
The VALUE can be specified as a percentage or an exact value.
If it is prefixed with - or +, the brightness will be reduced or increased based on the current value. Otherwise, the specified value will be set.
Arguments:
-h, --help Show this message and exit
-d DEV_NAME Specify the device to work with. By default first device in /sys/class/backlight/ is used
-f FILE_NAME Specify the file to save the value to and from which to take the value. By default - ~/.backlight_stored_value
Commands:
store Store current brightness value
resume Set current brightness value from stored value
Examples: backlight-change 50%
backlight-change +10% -d amdgpu_bl0
backlight-change -33
backlight-change store
backlight-change resume -f ~/.config/backlight_stored_value
```
## Install
Put the `backlight-change` file somewhere where your `$PATH` variable points. For example, `~/.local/bin/`
```sh
cd /tmp &&\
git clone --depth=1 https://github.com/emgyrz/backlight-change.git backlight-change &&\
cd $_ &&\
cp ./backlight-change ~/.local/bin/ &&\
echo Done
```
#### Permissions
It will be good to grant the permission to user
There is some info from [ArchWiki](https://wiki.archlinux.org/title/backlight#ACPI) for `systemd` users:
> By default, only root can change the brightness by this method. To allow users in the video group to change the brightness, a udev rule such as the following can be used (Logging out/Rebooting may be necessary to changes take effects):
>
> `/etc/udev/rules.d/backlight.rule`
>
> `ACTION=="add", SUBSYSTEM=="backlight", RUN+="/bin/chgrp video $sys$devpath/brightness", RUN+="/bin/chmod g+w $sys$devpath/brightness"`
Or you can just run same commands sometime on system boot. E.g. `openrc` users can [create](https://wiki.gentoo.org/wiki//etc/local.d) file in `/etc/local.d/` with `.start` postfix (remember to mark the script as executable):
`/etc/local.d/backlight_rights.start`
```sh
#!/bin/sh
/bin/chgrp video /sys/class/backlight/*/brightness
/bin/chmod g+w /sys/class/backlight/*/brightness
```
#### Key binding
Also you may want to add some key bindings.
If your keyboard has buttons to control brightness,
most likely their key codes are as follows - `XF86MonBrightnessDown` and `XF86MonBrightnessUp`.
In this case, config, for example, for i3 will look like this
```sh
# ~/.config/i3/config
bindsym XF86MonBrightnessUp exec --no-startup-id backlight-change +5%
bindsym XF86MonBrightnessDown exec --no-startup-id backlight-change -5%
```
## License
MIT