1XkbSetDebuggingFlags(3)          XKB FUNCTIONS         XkbSetDebuggingFlags(3)
2
3
4

NAME

6       XkbSetDebuggingFlags - Change the values of any of the debug controls
7

SYNOPSIS

9       Bool  XkbSetDebuggingFlags  (Display  *display,  unsigned int mask, un‐
10              signed int flags, char *msg, unsigned int  ctrls_mask,  unsigned
11              int ctrls, unsigned int *ret_flags, unsigned int *ret_ctrls);
12

ARGUMENTS

14       display
15              connection to X server
16
17       mask   mask selecting debug output flags to change
18
19       flags  values for debug output flags selected by mask
20
21       msg    message to print right now
22
23       ctrls_mask
24              mask selecting debug controls to change
25
26       ctrls  values for debug controls selected by ctrls_mask
27
28       ret_flags
29              resulting state of all debug output flags
30
31       ret_ctrls
32              resulting state of all debug controls
33

DESCRIPTION

35       The  debugging  aids are intended for use primarily by Xkb implementors
36       and are optional in any implementation.
37
38       There are two bitmasks that may be used to control debugging. One  bit‐
39       mask  controls  the output of debugging information, and the other con‐
40       trols behavior.  Both bitmasks are initially all zeros.
41
42       To change the values of any of the  debug  controls,  use  XkbSetDebug‐
43       gingFlags.
44
45       XkbSetDebuggingFlags  modifies  the  debug output flags as specified by
46       mask and flags, modifies the  debug  controls  flags  as  specified  by
47       ctrls_mask  and  ctrls, prints the message msg, and backfills ret_flags
48       and ret_ctrls with the resulting debug output and debug controls flags.
49
50       When bits are set in the debug output masks, mask and flags, Xkb prints
51       debug  information corresponding to each bit at appropriate points dur‐
52       ing its processing. The device to which the output is written is imple‐
53       mentation-dependent,  but is normally the same device to which X server
54       error messages are directed; thus the bits that can be set in mask  and
55       flags  is implementation-specific. To turn on a debug output selection,
56       set the bit for the output in the mask parameter  and  set  the  corre‐
57       sponding bit in the flags parameter. To turn off event selection for an
58       event, set the bit for the output in the mask parameter and do not  set
59       the corresponding bit in the flags parameter.
60
61       When  bits  are  set in the debug controls masks, ctrls_mask and ctrls,
62       Xkb modifies its behavior according to each controls  bit.   ctrls_mask
63       and  ctrls  are  related  in  the same way that mask and flags are. The
64       valid controls bits are defined in Table 1.
65
66
67                           Table 1 Debug Control Masks
68       ────────────────────────────────────────────────────────────────────
69       Debug Control Mask   Value      Meaning
70       ────────────────────────────────────────────────────────────────────
71       XkbDF_DisableLocks   (1 << 0)   Disable actions that lock modifiers
72
73       XkbSetDebuggingFlags returns True if successful  and  False  otherwise.
74       The only protocol error it may generate is BadAlloc, if for some reason
75       it is unable to allocate storage.
76
77       XkbSetDebuggingFlags is intended for developer use and may be  disabled
78       in production X servers. If it is disabled, XkbSetDebuggingFlags has no
79       effect and does not generate any protocol errors.
80
81       The message in msg is written immediately. The device to  which  it  is
82       written  is  implementation  dependent  but is normally the same device
83       where X server error messages are directed.
84

RETURN VALUES

86       True           The XkbSetDebuggingFlags function returns True when suc‐
87                      cessful.
88
89       False          The XkbSetDebuggingFlags function returns False when not
90                      successful.
91

DIAGNOSTICS

93       BadAlloc       Unable to allocate storage
94
95
96
97X Version 11                     libX11 1.8.7          XkbSetDebuggingFlags(3)
Impressum