diff options
| author | B Stack <bgstack15@gmail.com> | 2020-03-21 23:27:57 +0000 |
|---|---|---|
| committer | B Stack <bgstack15@gmail.com> | 2020-03-21 23:27:57 +0000 |
| commit | e491add639370ca2be459d407d08895d919bf99d (patch) | |
| tree | 0024ce9ea4e9bee695eb4682cea400a95c7176f0 /src/usr/share/doc | |
| parent | initial commit (diff) | |
| parent | add bunch of things (diff) | |
| download | keyboard-leds-trayicons-e491add639370ca2be459d407d08895d919bf99d.tar.gz keyboard-leds-trayicons-e491add639370ca2be459d407d08895d919bf99d.tar.bz2 keyboard-leds-trayicons-e491add639370ca2be459d407d08895d919bf99d.zip | |
add bunch of things
Closes #2 and #1
See merge request bgstack15/keyboard-leds-trayicons!1
Diffstat (limited to 'src/usr/share/doc')
| -rw-r--r-- | src/usr/share/doc/keyboard-leds-trayicons/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/usr/share/doc/keyboard-leds-trayicons/README.md b/src/usr/share/doc/keyboard-leds-trayicons/README.md new file mode 100644 index 0000000..b1b727e --- /dev/null +++ b/src/usr/share/doc/keyboard-leds-trayicons/README.md @@ -0,0 +1,30 @@ +# Readme for keyboard-leds-trayicons + +This tool, written in POSIX shell, places two icons in the notification area (aka system tray), that substitute for the keyboard LEDs for Capslock and Numlock. + +## How to configure +You can set environment variable `KLT_CONF` to point to a config file, which gets loaded in a style similar to dot-sourcing a shell script. Existing environment variables will be preserved. `Keyboard-leds-trayicons` will already load the global values from `/etc/keyboard-leds-trayicons.conf` and from your user settings in `$HOME/.config/keyboard-leds-trayicons.conf`. + +Here is example config file. + + KLT_CAPS_ON_ICON=capslock-on + KLT_CAPS_OFF_ICON=capslock-off + KLT_NUM_ON_ICON=numlock-on + KLT_NUM_OFF_ICON=numlock-off + +As a side effect of using `mktrayicon`, you can use an icon name that follows the [xdg spec](https://www.freedesktop.org/wiki/Specifications/icon-theme-spec/) or you can point to a specific filename. This project includes some simple letter icons in svg format. + +## Project license +[CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) + +## Dependencies +Package manager | packages +--------------- | ------------------------------------------------------------------ +binary name | [mktrayicon](https://gitlab.com/bgstack15/mktrayicon), awk, xset +deb | [mktrayicon](https://build.opensuse.org/package/show/home:bgstack15/mktrayicon), mawk | gawk, x11-xserver-utils +rpm | undefined + +## Credits +Bundled icons are used under license from Icon8. +* little `c`: [https://visualpharm.com/free-icons/c%20letter-595b40b65ba036ed117d1027](https://visualpharm.com/free-icons/c%20letter-595b40b65ba036ed117d1027) +* License for icons: Use for free, but link to [icons8](https://icons8.com/license) |