From 040aa9417b3875f22378590d25efd69532578888 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Mon, 22 Apr 2019 12:28:58 +0200
Subject: [PATCH] doc: xkb

---
 doc/f00bar-modules.5.scd | 43 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/doc/f00bar-modules.5.scd b/doc/f00bar-modules.5.scd
index 47c077b..e8e1e80 100644
--- a/doc/f00bar-modules.5.scd
+++ b/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)