1yambar-modules-xkb(5)         File Formats Manual        yambar-modules-xkb(5)
2
3
4

NAME

6       xkb - This module monitors the currently active XKB keyboard layout
7

DESCRIPTION

9       This module monitors the currently active XKB keyboard layout and lock-
10       key states.
11
12       Note: this module is X11 only. It does not work in Wayland.
13

TAGS

15       ┌────────────┬────────┬─────────────────────┐
16       │Name        │ Type   │ Description         │
17       ├────────────┼────────┼─────────────────────┤
18       │name        │ string │ Name of currently   │
19       │            │        │ selected layout,    │
20       │            │        │ long version (e.g.  │
21       │            │        │ "English (US)")     │
22       ├────────────┼────────┼─────────────────────┤
23       │symbol      │ string │ Name of currently   │
24       │            │        │ selected layout,    │
25       │            │        │ short version (e.g. │
26       │            │        │ "us")               │
27       ├────────────┼────────┼─────────────────────┤
28       │caps_lock   │ bool   │ True if CapsLock is │
29       │            │        │ enabled             │
30       ├────────────┼────────┼─────────────────────┤
31       │num_lock    │ bool   │ True if NumLock is  │
32       │            │        │ enabled             │
33       ├────────────┼────────┼─────────────────────┤
34       │scroll_lock │ bool   │ True if ScrollLock  │
35       │            │        │ is enabled          │
36       └────────────┴────────┴─────────────────────┘
37

CONFIGURATION

39       No additional attributes supported, only the generic ones (see GENERIC
40       CONFIGURATION in yambar-modules(5))
41

EXAMPLES

43           bar:
44             left:
45               - xkb:
46                   content:
47                     string: {text: "{symbol}"}
48

SEE ALSO

50       yambar-modules-sway-xkb(5), yambar-modules(5), yambar-particles(5),
51       yambar-tags(5), yambar-decorations(5)
52
53                                  2022-08-26             yambar-modules-xkb(5)
Impressum