A program to read and control device brightness
Clone or download
Latest commit 6a791e7 Sep 4, 2018

README.md

brightnessctl

This program allows you read and control device brightness. Devices, by default, include backlight and LEDs (searched for in corresponding classes). If omitted, the first found device is selected.

It can also preserve current brightness before applying the operation (allowing for usecases like disabling backlight on lid close).

Installation

The program is available in:

One can build and install the program using make install. Consult the Makefile for relevant build-time options.

Permissions

Modifying brightness requires write permissions for device files. brightnessctl accomplishes this (without using sudo/su/etc.) by either of the following means:

  1. installing relevant udev rules to add permissions to backlight class devices for users in video and leds for users in input. (done by default)

  2. installing brightnessctl as a suid binary.

The behavior is controlled by the INSTALL_UDEV_RULES flag (setting it to 1 installs the udev rules, 0 is the default value).

Usage

Usage: brightnessctl [options] [operation] [value]

Options:
  -l, --list			list devices with available brightness controls.
  -q, --quiet			suppress output.
  -p, --pretend			do not perform write operations.
  -m, --machine-readable	produce machine-readable output.
  -n, --min-value		set minimum brightness, defaults to 1.
  -s, --save			save previous state in a temporary file.
  -r, --restore			restore previous saved state.
  -h, --help			print this help.
  -d, --device=DEVICE		specify device name (can be a wildcard).
  -c, --class=CLASS		specify device class.
  -V, --version			print version and exit.

Operations:
  i, info			get device info.
  g, get			get current brightness of the device.
  m, max			get maximum brightness of the device.
  s, set VALUE			set brightness of the device.

Valid values:
  specific value		Example: 500
  percentage value		Example: 50%
  specific delta		Example: 50- or +10
  percentage delta		Example: 50%- or +10%