https://github.com/extremeexploit/xindicators
Lua library to talk with XKB's indicators
https://github.com/extremeexploit/xindicators
Last synced: 8 months ago
JSON representation
Lua library to talk with XKB's indicators
- Host: GitHub
- URL: https://github.com/extremeexploit/xindicators
- Owner: EXtremeExploit
- License: lgpl-3.0
- Created: 2024-07-13T15:30:25.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-09-21T19:27:54.000Z (9 months ago)
- Last Synced: 2025-09-21T21:22:34.093Z (9 months ago)
- Language: C
- Homepage: https://luarocks.org/modules/EXtremeExploit/xindicators
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xindicators
* XIndicators is a lua library made to interact the the X server keyboard indicators (Caps lock, num lock, pause, etc)
* It follows the same spec as `xset q` (XkbUseCoreKbd)
# API
* `xindicators.caps_lock()`
* `xindicators.num_lock()`
* `xindicators.scroll_lock()`
* `xindicators.compose()`
* `xindicators.kana()`
* `xindicators.sleep()`
* `xindicators.suspend()`
* `xindicators.mute()`
* `xindicators.misc()`
* `xindicators.mail()`
* `xindicators.charging()`
* `xindicators.shift_lock()`
* `xindicators.group_2()`
* `xindicators.mouse_keys()`
* `xindicators.raw()` // Used to get all of the above at the same time in the form of a bitfield
# Example
```lua
xi = require("xindicators")
caps_lock_state = xi.caps_lock()
print(caps_lock_state) -- Prints the current active state of caps lock (0 = inactive, any other number = active)
```