aboutsummaryrefslogtreecommitdiff
path: root/src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md
diff options
context:
space:
mode:
authorB Stack <bgstack15@gmail.com>2020-03-21 23:27:57 +0000
committerB Stack <bgstack15@gmail.com>2020-03-21 23:27:57 +0000
commite491add639370ca2be459d407d08895d919bf99d (patch)
tree0024ce9ea4e9bee695eb4682cea400a95c7176f0 /src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md
parentinitial commit (diff)
parentadd bunch of things (diff)
downloadkeyboard-leds-trayicons-master.tar.gz
keyboard-leds-trayicons-master.tar.bz2
keyboard-leds-trayicons-master.zip
Merge branch 'dev' into 'master'HEADmaster
add bunch of things Closes #2 and #1 See merge request bgstack15/keyboard-leds-trayicons!1
Diffstat (limited to 'src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md')
-rw-r--r--src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md b/src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md
new file mode 100644
index 0000000..03f56b3
--- /dev/null
+++ b/src/usr/share/man/man5/keyboard-leds-trayicons.conf.5.md
@@ -0,0 +1,38 @@
+keyboard-leds-trayicons.conf 5 "March 2020" keyboard-leds-trayicons "File Formats and Conventions"
+================================================================
+# NAME
+keyboard-leds-trayicons.conf - the configuration file for keyboard-leds-trayicons
+# FILE FORMAT
+The file consists of key-value pairs, and is used primarily for changing what icons are displayed in the system tray. The file will be parsed in a manner similar to shell dot-sourcing the file.
+
+*key*=*value*
+
+Icon names will be resolved according to the xdg specification for icon lookups `[1]` as they will be sent through gtk3.
+
+# FULL EXAMPLE
+
+```
+KLT_CAPS_ON_ICON=capslock-on
+KLT_CAPS_OFF_ICON=capslock-off
+KLT_NUM_ON_ICON=numlock-on
+KLT_NUM_OFF_ICON=numlock-off
+KLT_KILLFILE="/var/run/user/$( id -u )/kill-all-leds-trayicons"
+```
+
+# DEFAULT ORDER
+The various config files, by default, are read in this order. First value defined take precedence, so once a variable is defined, it will not be used by a later file.
+
+1. File named in environment variable *KLT_CONF*
+2. $HOME/.config/keyboad-leds-trayicons.conf
+3. /etc/keyboard-leds-trayicons.conf
+
+# AUTHOR
+bgstack15
+# REPORTING BUGS
+Bug tracker: `<https://gitlab.com/bgstack15/keyboard-leds-trayicons>`
+# COPYRIGHT
+Copyright (C) 2020 bgstack15. License CC-BY-SA 4.0.
+This is free software: you are free to change it and redistribute it. There is NO WARRANTY, to the extent permitted by law.
+# SEE ALSO
+keyboard-leds-trayicons(1)
+[1] `https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html#icon_lookup`
bgstack15