.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar-modules-xkb" "5" "2024-04-20"
.PP
.SH NAME
xkb - This module monitors the currently active XKB keyboard layout
.PP
.SH DESCRIPTION
.PP
This module monitors the currently active XKB keyboard layout and
lock-key states.\&
.PP
Note: this module is X11 only.\& It does not work in Wayland.\&
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx
l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
name
T}	T{
string
T}	T{
Name of currently selected layout, long version (e.\&g.\& "English (US)")
T}
T{
symbol
T}	T{
string
T}	T{
Name of currently selected layout, short version (e.\&g.\& "us")
T}
T{
caps_lock
T}	T{
bool
T}	T{
True if \fBCapsLock\fR is enabled
T}
T{
num_lock
T}	T{
bool
T}	T{
True if \fBNumLock\fR is enabled
T}
T{
scroll_lock
T}	T{
bool
T}	T{
True if \fBScrollLock\fR is enabled
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
No additional attributes supported, only the generic ones (see
\fBGENERIC CONFIGURATION\fR in \fByambar-modules\fR(5))
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    - xkb:
        content:
          string: {text: "{symbol}"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar-modules-sway-xkb\fR(5), \fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.PP