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,
10              unsigned 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
20              values for debug output flags selected by mask
21
22       - msg  message to print right now
23
24       - ctrls_mask
25              mask selecting debug controls to change
26
27       - ctrls
28              values for debug controls selected by ctrls_mask
29
30       - ret_flags
31              resulting state of all debug output flags
32
33       - ret_ctrls
34              resulting state of all debug controls
35

DESCRIPTION

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

RETURN VALUES

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

DIAGNOSTICS

95       BadAlloc       Unable to allocate storage
96
97
98
99X Version 11                     libX11 1.6.12         XkbSetDebuggingFlags(3)
Impressum