1XkbGetNamedGeometry(3) XKB FUNCTIONS XkbGetNamedGeometry(3)
2
6 XkbGetNamedGeometry - Loads a keyboard geometry description from this
7 database by name
8
10 Status XkbGetNamedGeometry (Display *dpy, XkbDescPtr xkb, Atom name);
11
13 - dpy connection to the X server
14 - xkb keyboard description into which the geometry should be loaded
16 - name name of the geometry to be loaded
18
20 It is also possible to load a keyboard geometry by name. The X server
21 maintains a database of keyboard components (see below).
22 XkbGetNamedGeometry can return BadName if the name cannot be found.
24 The X server maintains a database of keyboard components, identified by
26 component type. The database contains all the information necessary to
27 build a complete keyboard description for a particular device, as well
28 as to assemble partial descriptions. Table 1 identifies the component
29 types and the type of information they contain.
30 Table 1 Server Database Keyboard Components
33 ──────────────────────────────────────────────────────────────────
34 Component Component Primary Contents May also contain
35 Type
36 ──────────────────────────────────────────────────────────────────
37 Keymap Complete keyboard descrip‐
38 tion
39 Normally assembled using a
40 complete component from
41 each of the other types
42 Keycodes Symbolic name for each key Aliases for some
44 Minimum and maximum legal keys
45 keycodes Symbolic names for
46 indicators
47 Description of indi‐
48 cators physically
49 present
50 Types Key types Real modifier bind‐
52 ings and symbolic
53 names for some vir‐
54 tual modifiers
55 Compatibility Rules used to assign Maps for some indi‐
57 actions to keysyms cators
58 Real modifier bind‐
59 ings and symbolic
60 names for some vir‐
61 tual modifiers
62 Symbols Symbol mapping for key‐ Explicit actions and
69 board keys behaviors for some
70 Modifier mapping keys
71 Symbolic names for groups Real modifier bind‐
72 ings and symbolic
73 names for some vir‐
74 tual modifiers
75 Geometry Layout of the keyboard Aliases for some
77 keys; overrides key‐
78 codes component
79 aliases
80 Symbolic names for
81 some indicators
82 Description of indi‐
83 cators physically
84 present
85 While a keymap is a database entry for a complete keyboard description,
87 and therefore logically different from the individual component data‐
88 base entries, the rules for processing keymap entries are identical to
89 those for the individual components. In the discussion that follows,
90 the term component is used to refer to either individual components or
91 a keymap.
92 There may be multiple entries for each of the component types. An entry
94 may be either complete or partial. Partial entries describe only a
95 piece of the corresponding keyboard component and are designed to be
96 combined with other entries of the same type to form a complete entry.
97 For example, a partial symbols map might describe the differences
99 between a common ASCII keyboard and some national layout. Such a par‐
100 tial map is not useful on its own because it does not include those
101 symbols that are the same on both the ASCII and national layouts (such
102 as function keys). On the other hand, this partial map can be used to
103 configure any ASCII keyboard to use a national layout.
104 When a keyboard description is built, the components are processed in
106 the order in which they appear in Table 1; later definitions override
107 earlier ones.
108
110 BadName A font or color of the specified name does not exist.
111X Version 11 libX11 1.6.5 XkbGetNamedGeometry(3)