carta
XkbGetState(3)

XkbGetState3

Obtains the keyboard state

Usage

Status XkbGetState (Display *display, unsigned int device_spec, XkbStatePtr state_return);

Arguments

display

connection to the X server

device_spec

device ID, or XkbUseCoreKbd

state_return

backfilled with Xkb state

Overview

The XkbGetState function queries the server for the current keyboard state, waits for a reply, and then backfills state_return with the results.

All group values are expressed as group indices in the range [0..3]. Modifiers and the compatibility modifier state values are expressed as the bitwise union of the core X11 modifier masks. The pointer button state is reported as in the core X11 protocol.

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 13 (Trixie)
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)
  • Debian 8 (Jessie)
  • Debian 7 (Wheezy)
  • Debian 6.0 (Squeeze)
  • Debian 5.0 (Lenny)

From libx11 1.8.14-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.