XkbSetDebuggingFlags(3)

💅 XkbSetDebuggingFlags(3) — an XKB FUNCTIONS page with main character energy ✨

okay so bestie, welcome to the glow-up of XkbSetDebuggingFlags(3) — it lives in XKB FUNCTIONS and it's here to change the values of any of the debug controls. periodt. 🎀

---

🌸 NAME 🌸

XkbSetDebuggingFlags — change the values of any of the debug controls. that's the whole name vibe, no cap. 💅

---

✨ SYNOPSIS ✨

Bool XkbSetDebuggingFlags (Display *display, unsigned int mask, unsigned
       int flags, char *msg, unsigned int ctrls_mask, unsigned int
       ctrls, unsigned int *ret_flags, unsigned int *ret_ctrls);

---

🦋 ARGUMENTS 🦋

• display — connection to X server. your link to the mothership, basically. 🫶
• mask — mask selecting debug output flags to change. the "which ones are we touching" selector. ✨
• flags — values for debug output flags selected by mask. the actual values for the selected bits. 💖
• msg — message to print right now. immediate message behavior, lowkey iconic. 📣
• ctrls_mask — mask selecting debug controls to change. same selector energy, but for controls. 🎀
• ctrls — values for debug controls selected by ctrls_mask. the control values, slay. 🦋
• ret_flags — resulting state of all debug output flags. backfilled with the aftermath. 🌸
• ret_ctrls — resulting state of all debug controls. also backfilled, also giving results. 💜

---

🌈 DESCRIPTION 🌈

okay so bestie, the debugging aids are intended for use primarily by Xkb implementors and are optional in any implementation. lowkey developer-only territory, no cap. 💅

There are two bitmasks that may be used to control debugging. One bitmask controls the output of debugging information, and the other controls behavior. Both bitmasks are initially all zeros. periodt. ✨

To change the values of any of the debug controls, use XkbSetDebuggingFlags. that's the move. 🫶

XkbSetDebuggingFlags modifies the debug output flags as specified by mask and flags, modifies the debug controls flags as specified by ctrls_mask and ctrls, prints the message msg, and backfills ret_flags and ret_ctrls with the resulting debug output and debug controls flags. like a little state update, obsessed. 💖

When bits are set in the debug output masks, mask and flags, Xkb prints debug information corresponding to each bit at appropriate points during its processing. The device to which the output is written is implementation-dependent, but is normally the same device to which X server error messages are directed; thus the bits that can be set in mask and flags is implementation-specific. To turn on a debug output selection, set the bit for the output in the mask parameter and set the corresponding bit in the flags parameter. To turn off event selection for an event, set the bit for the output in the mask parameter and do not set the corresponding bit in the flags parameter. yes bestie, that's the exact wording — we keep the details. 🎀

When bits are set in the debug controls masks, ctrls_mask and ctrls, Xkb modifies its behavior according to each controls bit. ctrls_mask and ctrls are related in the same way that mask and flags are. The valid controls bits are defined in Table 1. 💅

⭐ Table 1 Debug Control Masks ⭐

• XkbDF_DisableLocks — value (1 << 0) — disable actions that lock modifiers. the one and only table entry, and it ate. 👑

XkbSetDebuggingFlags returns True if successful and False otherwise. The only protocol error it may generate is BadAlloc, if for some reason it is unable to allocate storage. 😭

XkbSetDebuggingFlags is intended for developer use and may be disabled in production X servers. If it is disabled, XkbSetDebuggingFlags has no effect and does not generate any protocol errors. so if prod says nope, it's not being shady — it's just disabled. 💀

The message in msg is written immediately. The device to which it is written is implementation dependent but is normally the same device where X server error messages are directed. immediate message behavior, same-device energy normally. 📣

---

🔥 RETURN VALUES 🔥

• True — the XkbSetDebuggingFlags function returns True when successful. success era. 🌟
• False — the XkbSetDebuggingFlags function returns False when not successful. not-success era, and that's okay. 🫶

---

🩹 DIAGNOSTICS 🩹

• BadAlloc — unable to allocate storage. the allocation said no, bestie. 💀

---

💖 that's the whole page, bestie. sourced from X Version 11, libX11 1.8.14, footer tag XkbSetDebuggingFlags(3) — and the footer didn't print a date, so that's the tea. 🫶✨