rexy712/rexbacklight
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated Readme

Browse Source
This commit is contained in:
rexy712 2018-12-15 10:01:59 -08:00
parent 80eda899e7
commit 94ce061013
1 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,31 +1,33 @@
# README
## About
rexbacklight is a program designed to operate similarly to xbacklight, though it's not a drop in replacement (possibly adding drop in replacement configure option at some point). Unlike xbacklight, this program does not use X11 to control the backlight devices. rexbacklight directly interacts with sysfs to change backlight levels, read their current status, and find their max output level. This has the advantage of allowing rexbacklight to run without the X server running and will work even if X doesn't recognize your backlight device, which was my original inspiration to make this project.
rexbacklight is a program designed to operate similarly to xbacklight. There is even a configure option to enable xbacklight arguments to make this a drop in replacement. However unlike xbacklight, this program does not use X11 to control the backlight devices. rexbacklight directly interacts with sysfs to change backlight levels, read their current status, and find their max output level. This has the advantage of allowing rexbacklight to run without the X server running and will work even if X doesn't recognize your backlight device, which was my original inspiration to make this project.
I've also since added a program to control LED devices, rexledctl (best name I could think of). This one was inspired by the fact that my laptop's keyboard backlight wasn't controllable by any program I had and the hardware button didn't work either. So now I have my own program which can control it. It was so similar in function to rexbacklight that I decided to just add some compile time `#define`'s and make a few things more modular in the code and have the same source files make 2 different programs.
Either program can be built alone or both together. This is configured using some cmake magic.
Current version is 1.0 as of writing this, so if the version is much newer, remind me to update this readme.
Current version is 1.3.1 as of writing this, so if the version is much newer, remind me to update this readme.
```
Usage: rexbacklight [argument] [options] [argument]
Options:
--device|-d
--device|-d
select which device to control
--fade|-f
--fade|-f
change brightness over time interval
--steps|-s
--steps|-s
number of steps over which to fade
--get|-g
--get|-g
print current brightness level to stdout
--list|-l
--list|-l
print device names to stdout and exit
--help|-h
--restore|-R
reassign previously saved device values
--help|-h
print this help message and exit
--version
--version
print program version and exit
Arguments:
@ -44,7 +46,8 @@ A copy of the GPLv3 is available with the source in the file 'LICENSE'
```
## Dependencies
Requires the rjp (rexy's json parser) library for reading restore file.
Requires the rjp ([rexy's json parser][rjp]) library for reading restore file, though this can be disabled via cmake configuration.
Either python3 or sh compatible shell to run some build scripts.
## Building
##### Run the following commands
@ -72,3 +75,5 @@ sudo udevadm trigger
```
sudo make uninstall
```
[rjp]: https://gitlab.com/rexy712/rjp