Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xkbsetdebuggingflags(3) [centos man page]

XkbSetDebuggingFlags(3) 					   XKB FUNCTIONS					   XkbSetDebuggingFlags(3)

XkbSetDebuggingFlags - Change the values of any of the debug controls 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 - mask mask selecting debug output flags to change - flags values for debug output flags selected by mask - msg message to print right now - ctrls_mask mask selecting debug controls to change - ctrls values for debug controls selected by ctrls_mask - ret_flags resulting state of all debug output flags - ret_ctrls resulting state of all debug controls DESCRIPTION
The debugging aids are intended for use primarily by Xkb implementors and are optional in any implementation. There are two bitmasks that may be used to control debugging. One bitmask controls the output of debugging information, and the other con- trols behavior. Both bitmasks are initially all zeros. To change the values of any of the debug controls, use XkbSetDebuggingFlags. 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. 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 selec- tion for an event, set the bit for the output in the mask parameter and do not set the corresponding bit in the flags parameter. 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 -------------------------------------------------------------------- Debug Control Mask Value Meaning -------------------------------------------------------------------- XkbDF_DisableLocks (1 << 0) Disable actions that lock modifiers XkbSetDebuggingFlags returns True if successful and False otherwise. The only protocol error it may generate is BadAlloc, if for some rea- son 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. 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. RETURN VALUES
True The XkbSetDebuggingFlags function returns True when successful. False The XkbSetDebuggingFlags function returns False when not successful. DIAGNOSTICS
BadAlloc Unable to allocate storage X Version 11 libX11 1.6.0 XkbSetDebuggingFlags(3)

Check Out this Related Man Page

XkbSetAccessXTimeout(3) 					   XKB FUNCTIONS					   XkbSetAccessXTimeout(3)

XkbSetAccessXTimeout - Configures the AccessXTimeout options for a keyboard device SYNOPSIS
Bool XkbSetAccessXTimeout ( display, device_spec, timeout, ctrls_mask, ctrls_values, opts_mask, opts_values ) Display * display ; unsigned int device_spec ; unsigned short timeout ; unsigned int ctrls_mask ; unsigned int ctrls_values ; unsigned short opts_mask ; unsigned short opts_values ; ARGUMENTS
- display connection to X server - device_spec device to configure, or XkbUseCoreKbd - timeout seconds idle until AccessXTimeout occurs - ctrls_mask boolean controls to modify - ctrls_values new bits for controls selected by ctrls_mask - opts_mask ax_options to change - opts_values new bits for ax_options selected by opts_mask DESCRIPTION
In environments where computers are shared, features such as SlowKeys present a problem: if SlowKeys is on, the keyboard can appear to be unresponsive because keys are not accepted until they are held for a certain period of time. To help solve this problem, Xkb provides an AccessXTimeout control to automatically change the enabled/disabled state of any boolean controls and to change the value of the AccessXKeys and AccessXFeedback control attributes if the keyboard is idle for a specified period of time. When a timeout as specified by AccessXTimeout occurs and a control is consequently modified, Xkb generates an XkbControlsNotify event. For more information on XkbControlsNotify events. timeout specifies the number of seconds the keyboard must be idle before the controls are modified. ctrls_mask specifies what controls are to be enabled or disabled, and ctrls_values specifies whether those controls are to be enabled or disabled. The bit values correspond to those for enabling and disabling boolean controls using XkbChangeEnabledControls. The opts_mask field specifies which attributes of the AccessXKeys and AccessXFeedback controls are to be changed, and opts_values speci- fies the new values for those options. The bit values correspond to those for the ax_options field of an XkbDescRec. XkbSetAccessXTimeout sends a request to configure the AccessXTimeout control to the server. It does not wait for a reply, and normally returns True. If a compatible version of the Xkb extension is not available in the server, XkbSetAccessXTimeout returns False. RETURN VALUES
True The XkbSetAccessXTimeout function returns True when a compatible version of the Xkb extension is available in the server. False The XkbSetAccessXTimeout function returns False when a compatible version of the Xkb extension is not available in the server. STRUCTURES
The complete description of an Xkb keyboard is given by an XkbDescRec. The component structures in the XkbDescRec represent the major Xkb components. typedef struct { struct _XDisplay * display; /* connection to X server */ unsigned short flags; /* private to Xkb, do not modify */ unsigned short device_spec; /* device of interest */ KeyCode min_key_code; /* minimum keycode for device */ KeyCode max_key_code; /* maximum keycode for device */ XkbControlsPtr ctrls; /* controls */ XkbServerMapPtr server; /* server keymap */ XkbClientMapPtr map; /* client keymap */ XkbIndicatorPtr indicators; /* indicator map */ XkbNamesPtr names; /* names for all components */ XkbCompatMapPtr compat; /* compatibility map */ XkbGeometryPtr geom; /* physical geometry of keyboard */ } XkbDescRec, *XkbDescPtr; The display field points to an X display structure. The flags field is private to the library: modifying flags may yield unpredictable results. The device_spec field specifies the device identifier of the keyboard input device, or XkbUseCoreKeyboard, which specifies the core keyboard device. The min_key_code and max_key_code fields specify the least and greatest keycode that can be returned by the keyboard. Each structure component has a corresponding mask bit that is used in function calls to indicate that the structure should be manipulated in some manner, such as allocating it or freeing it. These masks and their relationships to the fields in the XkbDescRec are shown in Table 1. Table 1 Mask Bits for XkbDescRec -------------------------------------------------- Mask Bit XkbDescRec Field Value -------------------------------------------------- XkbControlsMask ctrls (1L<<0) XkbServerMapMask server (1L<<1) XkbIClientMapMask map (1L<<2) XkbIndicatorMapMask indicators (1L<<3) XkbNamesMask names (1L<<4) XkbCompatMapMask compat (1L<<5) XkbGeometryMask geom (1L<<6) XkbAllComponentsMask All Fields (0x7f) The structure for the XkbControlsNotify event is defined as follows: typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */ Bool send_event; /* True => synthetically generated */ Display * display; /* server connection where event generated */ Time time; /* server time when event generated */ int xkb_type; /* XkbCompatMapNotify */ int device; /* Xkb device ID, will not be XkbUseCoreKbd */ unsigned int changed_ctrls; /* bits indicating which controls data have changed*/ unsigned int enabled_ctrls; /* controls currently enabled in server */ unsigned int enabled_ctrl_changes; /* bits indicating enabled/disabled controls */ int num_groups; /* current number of keyboard groups */ KeyCode keycode; /* != 0 => keycode of key causing change */ char event_type; /* Type of event causing change */ char req_major; /* major event code of event causing change */ char req_minor; /* minor event code of event causing change */ } XkbControlsNotifyEvent; SEE ALSO
XkbChangeEnabledControls(3) X Version 11 libX11 1.2.1 XkbSetAccessXTimeout(3)
Man Page