doc: xkb

doc/f00bar-modules.5.scd

@@ -540,6 +540,49 @@ bar:
                   deco: {underline: {size: 2, color: ffffffff}}
 ```
 
+# XKB
+
+This module monitors the currently active XKB keyboard layout and
+lock-key states.
+
+Note: this module is X11 only. It does not work in Wayland.
+
+## TAGS
+
+[[ *Name*
+:[ *Type*
+:[ *Description*
+|  name
+:  string
+:  Name of currently selected layout, long version (e.g. "English (US)")
+|  symbol
+:  string
+:  Name of currently selected layout, short version (e.g. "us")
+|  caps_lock
+:  bool
+:  True if *CapsLock* is enabled
+|  num_lock
+:  bool
+:  True if *NumLock* is enabled
+|  scroll_lock
+:  bool
+:  True if *ScrollLock* is enabled
+
+## CONFIGURATION
+
+No additional attributes supported, only the generic ones (see
+*GENERIC CONFIGURATION*)
+
+## EXAMPLES
+
+```
+bar:
+  left:
+    - xkb:
+        content:
+          string: {text: "{symbol}"}
+```
+
 # SEE ALSO
 
 *f00bar-particles*(5), *f00bar-tags*(5), *f00bar-decorations*(5)