man/xkb/XkbSetDebuggingFlags.man

   1 '\" t
   2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .TH XkbSetDebuggingFlags __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbSetDebuggingFlags \- Change the values of any of the debug controls
  26 .SH SYNOPSIS
  27 .HP
  28 .B Bool XkbSetDebuggingFlags
  29 .BI "(\^Display *" "display" "\^,"
  30 .BI "unsigned int " "mask" "\^,"
  31 .BI "unsigned int " "flags" "\^,"
  32 .BI "char *" "msg" "\^,"
  33 .BI "unsigned int " "ctrls_mask" "\^,"
  34 .BI "unsigned int " "ctrls" "\^,"
  35 .BI "unsigned int *" "ret_flags" "\^,"
  36 .BI "unsigned int *" "ret_ctrls" "\^);"
  37 .if n .ti +5n
  38 .if t .ti +.5i
  39 .SH ARGUMENTS
  40 .TP
  41 .I \- display
  42 connection to X server
  43 .TP
  44 .I \- mask
  45 mask selecting debug output flags to change
  46 .TP
  47 .I \- flags
  48 values for debug output flags selected by mask
  49 .TP
  50 .I \- msg
  51 message to print right now
  52 .TP
  53 .I \- ctrls_mask
  54 mask selecting debug controls to change
  55 .TP
  56 .I \- ctrls
  57 values for debug controls selected by ctrls_mask
  58 .TP
  59 .I \- ret_flags
  60 resulting state of all debug output flags
  61 .TP
  62 .I \- ret_ctrls
  63 resulting state of all debug controls
  64 .SH DESCRIPTION
  65 .LP
  66 The debugging aids are intended for use primarily by Xkb implementors and are
  67 optional in any implementation.
  68
  69 There are two bitmasks that may be used to control debugging. One bitmask
  70 controls the output of debugging information, and the other controls behavior.
  71 Both bitmasks are initially all zeros.
  72
  73 To change the values of any of the debug controls, use
  74 .I XkbSetDebuggingFlags.
  75
  76 .I XkbSetDebuggingFlags
  77 modifies the debug output flags as specified by
  78 .I mask
  79 and
  80 flags,
  81 modifies the debug controls flags as specified by
  82 .I ctrls_mask
  83 and
  84 ctrls,
  85 prints the message
  86 .I msg,
  87 and backfills
  88 .I ret_flags
  89 and
  90 .I ret_ctrls
  91 with the resulting debug output and debug controls flags.
  92
  93 When bits are set in the debug output masks,
  94 .I mask
  95 and
  96 .I flags,
  97 Xkb prints debug information corresponding to each bit at appropriate points
  98 during its processing. The device to which the output is written is
  99 implementation-dependent, but is normally the same device to which X server
 100 error messages are directed; thus the bits that can be set in
 101 .I mask
 102 and
 103 .I flags
 104 is implementation-specific. To turn on a debug output selection, set the bit for
 105 the output in the
 106 .I mask
 107 parameter and set the corresponding bit in the
 108 .I flags
 109 parameter. To turn off event selection for an event, set the bit for the output
 110 in the
 111 .I mask
 112 parameter and do not set the corresponding bit in the
 113 .I flags
 114 parameter.
 115
 116 When bits are set in the debug controls masks,
 117 .I ctrls_mask
 118 and
 119 .I ctrls,
 120 Xkb modifies its behavior according to each controls bit.
 121 .I ctrls_mask
 122 and
 123 ctrls
 124 are related in the same way that
 125 .I mask
 126 and
 127 .I flags
 128 are. The valid controls bits are defined in Table 1.
 129
 130 .TS
 131 c s s
 132 l l l.
 133 Table 1 Debug Control Masks
 134 _
 135 Debug Control Mask      Value   Meaning
 136 _
 137 XkbDF_DisableLocks      (1 << 0)        Disable actions that lock modifiers
 138 .TE
 139
 140 .I XkbSetDebuggingFlags
 141 returns True if successful and False otherwise. The only protocol error it may
 142 generate is BadAlloc, if for some reason it is unable to allocate storage.
 143
 144 .I XkbSetDebuggingFlags
 145 is intended for developer use and may be disabled in production X servers. If it
 146 is disabled,
 147 .I XkbSetDebuggingFlags
 148 has no effect and does not generate any protocol errors.
 149
 150 The message in
 151 .I msg
 152 is written immediately. The device to which it is written is implementation
 153 dependent but is normally the same device where X server error messages are
 154 directed.
 155 .SH "RETURN VALUES"
 156 .TP 15
 157 True
 158 The
 159 .I XkbSetDebuggingFlags
 160 function returns True when successful.
 161 .TP 15
 162 False
 163 The
 164 .I XkbSetDebuggingFlags
 165 function returns False when not successful.
 166 .SH DIAGNOSTICS
 167 .TP 15
 168 .B BadAlloc
 169 Unable to allocate storage