Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefano-m/awesome-capslock_widget
A widget to display when CAPS LOCK is active
https://github.com/stefano-m/awesome-capslock_widget
List: awesome-capslock_widget
awesomewm caps-lock capslock widget
Last synced: 3 months ago
JSON representation
A widget to display when CAPS LOCK is active
- Host: GitHub
- URL: https://github.com/stefano-m/awesome-capslock_widget
- Owner: stefano-m
- License: gpl-3.0
- Created: 2017-07-20T21:00:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-28T18:59:46.000Z (over 7 years ago)
- Last Synced: 2024-11-07T20:00:39.950Z (3 months ago)
- Topics: awesomewm, caps-lock, capslock, widget
- Language: Lua
- Size: 20.5 KB
- Stars: 14
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-awesomewm-modules-widgets-and-libraries - awesomewm-capslock_widget
- awesome-awesomewm-modules-widgets-and-libraries - awesomewm-capslock_widget
README
# A simple CAPS LOCK widget for Awesome
Useful when you have a keyboard that does not have a CAPS LOCK indicator.
This widget is really simple and parses the output of `xset` to figure out
whether CAPS LOCK is active or not. (Hint: you need the `xset` utility for this
widget to work)
# Installation
1. Ensure that `xset` is available to you on your system.
2. Copy `capslock.lua` in your `~/.config/awesome/ folder` (e.g. by cloning this
repository).
3. Restart Awesome (e.g. press `modkey + Control` or run `awesome-client
"awesome.restart()"` from a terminal).
# Usage
For **Awesome 4.x**, add the following to your `~/.config/awesome/rc.lua`:
``` lua
-- If you just copied the file in ~/.config/awesome
local capslock = require("capslock")
-- If you cloned the repo as a submodule in
-- ~/.config/awesome/external/capslock
-- local capslock = require("external.capslock.capslock")
-- more config here
-- Add widgets to the wibox
s.mywibox:setup {
-- more config here
{ -- Right widgets
layout = wibox.layout.fixed.horizontal,
wibox.widget.systray(),
capslock,
-- more config here
-- {{{ Key bindings
local globalkeys = awful.util.table.join(
capslock.key,
-- more config follows
```
Now, when CAPS LOCK is active, an uppercase letter **A** will be displayed
when CAPS LOCK is inactive, a lowecase letter **a** will be displayed:
These can be changed by changing the `activated` and `deactivated`
attributes of the widget
as
[Pango markup](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html)
strings. You will probably need to adjust the `forced_width` attribute too.
For example:
``` lua
local capslock = require("capslock")
capslock.forced_width = 35
capslock.activated = "CAPS"
capslock.deactivated = "caps"
```
When the mouse is over the widget, a tooltip that says `Caps Lock on`/`Caps
Lock off` is also shown.
# Contributing
If you have ideas about how to make this better, feel free to open an issue or
submit a pull request.