man/xkb/XkbIgnoreExtension.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbIgnoreExtension __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbIgnoreExtension \-  Prevents core X library keyboard functions from using the
  25 X Keyboard Extension
  26 .SH SYNOPSIS
  27 .HP
  28 .B Bool XkbIgnoreExtension
  29 .BI "(\^Bool *" "ignore" "\^);"
  30 .if n .ti +5n
  31 .if t .ti +.5i
  32 .SH ARGUMENTS
  33 .TP
  34 .I ignore
  35 True means ignore the extension
  36 .SH DESCRIPTION
  37 .LP
  38 If a server supports the Xkb extension, the X library normally implements preXkb
  39 keyboard functions using the Xkb keyboard description and state. The server Xkb
  40 keyboard state may differ from the preXkb keyboard state. This difference does
  41 not affect most clients, but there are exceptions. To allow these clients to
  42 work properly, you may instruct the extension not to use Xkb functionality.
  43
  44 Call
  45 .I XkbIgnoreExtension
  46 to prevent core X library keyboard functions from using
  47 the X Keyboard Extension. You must call
  48 .I XkbIgnoreExtension
  49 before you open a
  50 server connection; Xkb does not provide a way to enable or disable use of the
  51 extension once a connection is established.
  52
  53 .I XkbIgnoreExtension
  54 tells the X library whether to use the X Keyboard Extension
  55 on any subsequently opened X display connections. If ignore is True, the library
  56 does not initialize the Xkb extension when it opens a new display. This forces
  57 the X server to use compatibility mode and communicate with the client using
  58 only core protocol requests and events. If ignore is False, the library treats
  59 subsequent calls to
  60 .I XOpenDisplay
  61 normally and uses Xkb extension requests,
  62 events, and state. Do not explicitly use Xkb on a connection for which it is
  63 disabled.
  64 .I XkbIgnoreExtension
  65 returns False if it was unable to apply the ignore
  66 request.
  67 .SH "RETURN VALUES"
  68 .TP 15
  69 True
  70 The
  71 .I XkbIgnoreExtension
  72 returns True if
  73 .TP 15
  74 False
  75 The
  76 .I XkbIgnoreExtension
  77 function returns False if it was unable to apply the ignore request.
  78 .SH "SEE ALSO"
  79 .BR XOpenDisplay (__libmansuffix__)