This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • For more information about the manual page format, see the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



XkbGetKeyboard(3)                               XKB FUNCTIONS                              XkbGetKeyboard(3)



NAME
       XkbGetKeyboard -   Retrieves one or more components of a keyboard device description

SYNOPSIS
       Bool XkbGetKeyboard ( display, which, device_spec )
             Display * display;
             unsigned int which;
             unsigned int device_spec;

ARGUMENTS
       display
              connection to the X server

       device_spec
              device ID, or XkbUseCoreKbd

       bits_to_change
              determines events to be selected / deselected

       values_for_bits
              1=>select, 0->deselect; for events in bits_to_change

DESCRIPTION
       XkbGetKeyboard  allocates  and returns a pointer to a keyboard description. It queries the server for
       those components specified in the which parameter for device device_spec and copies  the  results  to
       the  XkbDescRec  it  allocated. The remaining fields in the keyboard description are set to NULL. The
       valid masks for which are those listed in Table 1.


               Table 1 Mask Bits for XkbDescRec
       --------------------------------------------------Mask -------------------------------------------------Mask
       Mask Bit               XkbDescRec Field   Value
       --------------------------------------------------XkbControlsMask -------------------------------------------------XkbControlsMask
       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         (1L<<7)

       XkbGetKeyboard is used to read the current description for one  or  more  components  of  a  keyboard
       device. It calls XkbGetKeyboardByName as follows:

       XkbGetKeyboardByName(dpy, device_spec, NULL, which, which, False).

DIAGNOSTICS
       BadAlloc       Unable to allocate storage




X Version 11                                    libX11 1.2.1                               XkbGetKeyboard(3)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you? Yes It's good, but... Not helpful...