diff --git a/specs/XKB/ch01.xml b/specs/XKB/ch01.xml index 3095830d..03cc3d66 100644 --- a/specs/XKB/ch01.xml +++ b/specs/XKB/ch01.xml @@ -219,7 +219,7 @@ and incremental reconfiguration are both supported. The graphic characters or control functions that may be accessed by one key are -logically arranged in groups and levels. See section 14.1for a complete +logically arranged in groups and levels. See section 14.1 for a complete description of groups and levels. @@ -307,7 +307,7 @@ configuration. The Xkb extension adds a single protocol error, BadKeyboard, -to the core protocol error set. See section 2.6 for a discussion of the +to the core protocol error set. See section 2.6 for a discussion of the BadKeyboard protocol error. diff --git a/specs/XKB/ch02.xml b/specs/XKB/ch02.xml index d0f97604..dc93fac0 100644 --- a/specs/XKB/ch02.xml +++ b/specs/XKB/ch02.xml @@ -62,7 +62,7 @@ The name of the Xkb extension is given in Most extensions to the X protocol are initialized by calling XInitExtension - and passing the extension name. However, as explained in section 2.4, Xkb + and passing the extension name. However, as explained in section 2.4, Xkb requires a more complex initialization sequence, and a client program should not call XInitExtension @@ -308,7 +308,7 @@ and the major and minor version numbers of the extension in The major opcode is reported in the req_major fields of some Xkb events. For a discussion of the base event code, see -section 4.1. +section 4.1. diff --git a/specs/XKB/ch04.xml b/specs/XKB/ch04.xml index 31c65bdc..7879db17 100644 --- a/specs/XKB/ch04.xml +++ b/specs/XKB/ch04.xml @@ -17,7 +17,7 @@ Xkb keyboard status events are reported to all interested clients, regardless of which window currently has the keyboard focus and regardless of the grab state of the keyboard.The one exception to this rule is the XkbExtensionDeviceNotify event report that is sent when a client attempts to -use an unsupported feature of an X Input Extension device (see section 21.4). +use an unsupported feature of an X Input Extension device (see section 21.4). @@ -651,7 +651,7 @@ if you have requested them via a call to or XkbSelectEventDetails. Specify the event types in which you are interested in a mask, as described -in section 4.3. +in section 4.3. @@ -788,7 +788,7 @@ type and for the core protocol type field to determine if the event is an Xkb event ( type - equals the Xkb base event code; see section 2.4). If the event is an Xkb + equals the Xkb base event code; see section 2.4). If the event is an Xkb event, you may then use the any.xkb_type field to determine the type of Xkb event and thereafter access the diff --git a/specs/XKB/ch05.xml b/specs/XKB/ch05.xml index 8d6fabbb..179803f3 100644 --- a/specs/XKB/ch05.xml +++ b/specs/XKB/ch05.xml @@ -166,7 +166,7 @@ The global locked or effective group changes. In this case, the changed group is groups_wrap field of the XkbControlsRec - structure for the keyboard (see section 10.7.1). + structure for the keyboard (see section 10.7.1). @@ -257,7 +257,7 @@ The If the server’s IgnoreGroupLock - control (see section 10.7.3) is not set, the grab group is the same as the effective group. Otherwise, the grab group is computed from the base group and latched group, ignoring the locked group. + control (see section 10.7.3) is not set, the grab group is the same as the effective group. Otherwise, the grab group is computed from the base group and latched group, ignoring the locked group. @@ -867,7 +867,7 @@ To track changes in the keyboard state for a particular device, select to receiv XkbSelectEvents or XkbSelectEventDetails - (see section 4.3). + (see section 4.3). diff --git a/specs/XKB/ch06.xml b/specs/XKB/ch06.xml index 2adf47a5..63bb7dfe 100644 --- a/specs/XKB/ch06.xml +++ b/specs/XKB/ch06.xml @@ -275,7 +275,7 @@ The valid masks for To free the returned keyboard description, use XkbFreeKeyboard - (see section 6.4). + (see section 6.4). @@ -285,7 +285,7 @@ To free the returned keyboard description, use The server can generate events whenever its copy of the keyboard description -for a device changes. Refer to section 14.4 for detailed information on +for a device changes. Refer to section 14.4 for detailed information on tracking changes to the keyboard description. diff --git a/specs/XKB/ch07.xml b/specs/XKB/ch07.xml index a6fcb59c..bef683ef 100644 --- a/specs/XKB/ch07.xml +++ b/specs/XKB/ch07.xml @@ -70,7 +70,7 @@ Virtual modifiers are named by converting their string name to an X names.vmods array in an XkbDescRec - structure (see section 6.1). The position of a name Atom in the + structure (see section 6.1). The position of a name Atom in the names.vmods array defines the bit position used to represent the virtual modifier and also the index used when accessing virtual modifier information in arrays: the name @@ -110,8 +110,10 @@ bind those modifiers to any particular key or to each other. Modifier definitions are included in a number of structures in the keyboard description to define the collection of modifiers that affect or are affected by some other entity. A modifier definition is relevant only in the context of some other -entity such as an indicator map, a control, or a key type. (See sections 8.2.2, -10.8, and 15.2.) +entity such as an indicator map, a control, or a key type. (See +section 8.2.2, +section 10.8, and +section 15.2.) @@ -197,7 +199,7 @@ The vmods members of the server map are the "master" virtual modifier definitions. Xkb automatically propagates any changes to these fields to all other fields that -use virtual modifier mappings (see section 16.4). +use virtual modifier mappings (see section 16.4). @@ -219,7 +221,7 @@ For example, if The virtual modifier mapping is normally updated whenever actions are -automatically applied to symbols (see section 16.4 for details), and few +automatically applied to symbols (see section 16.4 for details), and few applications should need to change the virtual modifier mapping explicitly. @@ -227,14 +229,14 @@ applications should need to change the virtual modifier mapping explicitly. Use XkbGetMap -(see section 14.2) to get the virtual modifiers from the server or use +(see section 14.2) to get the virtual modifiers from the server or use XkbGetVirtualMods - (see section 16.4.1) to update a local copy of the virtual modifiers bindings + (see section 16.4.1) to update a local copy of the virtual modifiers bindings from the server. To set the binding of a virtual modifier to a real modifier, use XkbSetMap (see -section 14.3 +section 14.3 ). diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index 2b1c0c98..ea4f58d9 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -53,7 +53,8 @@ specific indicators, use XkbSetNames as discussed in . Then set the map using XkbSetMap - (see section 14.3) or + (see section 14.3) + or XkbSetNamedIndicator (below). To retrieve indicator names, use XkbGetNames @@ -187,7 +188,7 @@ using the functions For more information on the effects of explicit changes to indicators and the -relationship to the indicator map, see section 8.4.1. +relationship to the indicator map, see section 8.4.1. @@ -530,7 +531,7 @@ field specifies what modifiers an indicator watches. The mods field is an Xkb modifier definition, XkbModsRec, -as described in section 7.2, which can specify both real and virtual +as described in section 7.2, which can specify both real and virtual modifiers. The mods field takes effect even if some or all of the virtual indicators specified in @@ -1012,7 +1013,7 @@ and To free the indicator maps, use XkbFreeIndicatorMaps - (see section 8.6). + (see section 8.6). @@ -1583,11 +1584,11 @@ in map. BadImplementation errors. In addition, it can also generate XkbIndicatorStateNotify - (see section 8.5), + (see section 8.5), XkbIndicatorMapNotify, and XkbNamesNotify - events (see section 18.5). + events (see section 18.5). @@ -1716,7 +1717,7 @@ s can generate XkbIndicatorStateNotify and XkbIndicatorMapNotify - events (see section 8.5). + events (see section 8.5). @@ -1740,7 +1741,7 @@ To receive XkbIndicatorStateNotify events, use XkbSelectEvents - (see section 4.3) with both the + (see section 4.3) with both the bits_to_change and values_for_bits @@ -1990,7 +1991,7 @@ If the indicators field, use XkbFreeIndicators - (see section 8.6). + (see section 8.6). diff --git a/specs/XKB/ch09.xml b/specs/XKB/ch09.xml index 54e1aba0..e8536e01 100644 --- a/specs/XKB/ch09.xml +++ b/specs/XKB/ch09.xml @@ -16,7 +16,7 @@ opposed to any other audible sound generated elsewhere in the system. You can ask to receive XkbBellNotify - events (see section 9.4) when any client rings any one of the following: + events (see section 9.4) when any client rings any one of the following: @@ -75,7 +75,7 @@ spite of the setting of the XkbForceDeviceBell or XkbForceBell - (see section 9.3.3). In this case the server does not generate a bell event. + (see section 9.3.3). In this case the server does not generate a bell event. @@ -85,7 +85,7 @@ or repeating, Xkb can provide feedback for the controls by using special beep codes. The AccessXFeedback control is used to configure the specific types of operations that generate -feedback. See section 10.6.3 for a discussion on +feedback. See section 10.6.3 for a discussion on AccessXFeedback control. @@ -109,7 +109,7 @@ any sounds. Any sounds or other effects (such as visual bells on the screen) must be generated by a client application upon receipt of the bell event containing the name. There is no default name for the default keyboard bell. The server does generate some predefined bells for the AccessX controls (see -section 10.6.3). These named bells are shown in Table 9.1; the name is included +section 10.6.3). These named bells are shown in Table 9.1; the name is included in any bell event sent to clients that have requested to receive XkbBellNotify events. @@ -202,7 +202,7 @@ bell. This is useful if you need to use an audio server instead of the system beep. For example, when an audio client starts, it could disable the audible bell (the system bell) and then listen for XkbBellNotify - events (see section 9.4). When it receives a + events (see section 9.4). When it receives a XkbBellNotify event, the audio client could then send a request to an audio server to play a sound. @@ -214,7 +214,7 @@ You can control the audible bells feature by passing the XkbAudibleBellMask to XkbChangeEnabledControls - (see section 10.1.1). If you set + (see section 10.1.1). If you set XkbAudibleBellMask on, the server rings the system bell when a bell event occurs. This is the default. If you set @@ -224,12 +224,12 @@ you call XkbForceDeviceBell or XkbForceBell - (see section 9.3.3). + (see section 9.3.3). Audible bells are also part of the per-client auto-reset controls. For more -information on auto-reset controls, see section 10.1.2. +information on auto-reset controls, see section 10.1.2. @@ -1072,7 +1072,7 @@ and values_for_bits parameters to XkbSelectEvents - (see section 4.3). + (see section 4.3). diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index 4957ae66..bc112885 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -34,7 +34,7 @@ describing how the control should work, and a state describing whether the behavior as a whole is enabled or disabled. The attributes and state for most of these controls are held in the XkbControlsRec - structure (see section 10.8). + structure (see section 10.8). @@ -45,7 +45,7 @@ as a whole. To treat them as a group, modify an structure to describe all of the changes to be made, and then pass that structure and appropriate flags to an Xkb library function, or use a XkbControlsChangesRec - (see section 10.10.1) to reduce network traffic. When using a convenience + (see section 10.10.1) to reduce network traffic. When using a convenience function to manipulate one control individually, you do not use an XkbControlsRec structure directly. @@ -221,7 +221,7 @@ control is enabled, and when turned off, disabled. It corresponds to the enabled_ctrls field of an XkbControlsRec - structure (see section 10.8). The bits describing which controls are turned on + structure (see section 10.8). The bits describing which controls are turned on or off are defined in Table 10.7. @@ -614,10 +614,10 @@ and disable it using either the EnabledControls control or the AutoReset - control discussed in section 10.1.1. When enabled, protocol requests to + control discussed in section 10.1.1. When enabled, protocol requests to generate a sound result in the X server actually producing a real sound; when disabled, requests to the server to generate a sound are ignored unless the -sound is forced. See section 9.2. +sound is forced. See section 9.2. @@ -661,7 +661,7 @@ control. The per_key_repeat field of an XkbControlsRec - structure, discussed in section 10.8. + structure, discussed in section 10.8. @@ -691,7 +691,7 @@ generated repeat event. The second, interval, is the delay between all subsequent generated repeat events. As with all boolean controls, configuring the attributes that determine how the control -operates does not automatically enable the control as a whole; see section 10.1. +operates does not automatically enable the control as a whole; see section 10.1. @@ -1146,7 +1146,7 @@ the EnabledControls control or the AutoReset - control discussed in section 10.1.1. + control discussed in section 10.1.1. @@ -1156,7 +1156,7 @@ should generate when that overlay is enabled, assign it either the XkbKB_Overlay1 or XkbKB_Overlay2 - key behaviors, as described in section 16.2. + key behaviors, as described in section 16.2. @@ -1179,7 +1179,7 @@ and disable them using either the EnabledControls control or the AutoReset - control discussed in section 10.1.1. The individual keys that simulate + control discussed in section 10.1.1. The individual keys that simulate different aspects of the pointer device are determined by the keyboard mapping, discussed in . @@ -1215,7 +1215,7 @@ or setting the attribute; instead use XkbGetControls and XkbSetControls - (see sections 10.9 and 10.10). + (see section 10.9 and section 10.10). @@ -1242,7 +1242,7 @@ mouse-pointer key yields one mouse event. When XkbSA_MovePtr action and the following fields in the XkbControlsRec - structure (see section 10.8). + structure (see section 10.8). @@ -1291,7 +1291,7 @@ There are no convenience functions to query or change the attributes of the XkbGetControls and XkbSetControls - (see sections 10.9 and 10.10). + (see section 10.9 and section 10.10). @@ -1300,7 +1300,7 @@ The effects of the attributes of the MouseKeysAccel control depend on whether the XkbSA_MovePtr - action (see section 16.1) specifies relative or absolute pointer motion. + action (see section 16.1) specifies relative or absolute pointer motion. @@ -1498,7 +1498,7 @@ Enabling or disabling the keyboard controls through a graphical user interface may be impossible for people who need to use the controls. For example, a user who needs SlowKeys - (see section 10.6.6) may not even be able to start the graphical application, + (see section 10.6.6) may not even be able to start the graphical application, let alone use it, if SlowKeys is not enabled. To allow easier access to some of the controls, the @@ -1551,9 +1551,9 @@ When the Some of these key sequences optionally generate audible feedback of the change -in state, as described in section 10.6.3, or +in state, as described in section 10.6.3, or XkbControlsNotify - events, described in section 10.11. + events, described in section 10.11. @@ -1585,7 +1585,7 @@ When a timeout as specified by XkbControlsNotify event. For more information on XkbControlsNotify - events, refer to section 10.11. + events, refer to section 10.11. @@ -1706,7 +1706,7 @@ The parameters ax_options, which is a field in the XkbControlsRec - structure (see section 10.8). + structure (see section 10.8). XkbGetAccessXTimeout returns True @@ -1826,8 +1826,8 @@ are modified. 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 (see section -10.1.1). The +correspond to those for enabling and disabling boolean controls +(see section 10.1.1). The opts_mask field specifies which attributes of the AccessXKeys @@ -1840,7 +1840,7 @@ for the ax_options field of an XkbDescRec - (see section 10.8). + (see section 10.8). @@ -1875,14 +1875,14 @@ codes. Use the There is no convenience function for modifying the AccessXFeedback control, although the feedback as a whole can be enabled or disabled just as -other boolean controls are (see section 10.1). Individual beep codes are turned +other boolean controls are (see section 10.1). Individual beep codes are turned on or off by modifying the following bits in the ax_options field of an XkbControlsRec structure and using XkbSetControls - (see section 10.10): + (see section 10.10):
@@ -1995,7 +1995,7 @@ pitch. In these cases, use the When any of the above feedbacks occur, Xkb may generate a XkbBellNotify - event (see section 9.4). + event (see section 9.4). @@ -2108,7 +2108,7 @@ To receive XkbAccessXNotify events under all possible conditions, use XkbSelectEvents - (see section 4.3) and pass + (see section 4.3) and pass XkbAccesXNotifyMask in both bits_to_change @@ -2208,13 +2208,13 @@ locking, or unlocking of modifiers using StickyKeys generates XkbStateNotify - events as described in section 5.4. Repeating keys generate normal + events as described in section 5.4. Repeating keys generate normal KeyPress and KeyRelease events, though the auto-repeat can be detected using DetectableAutorepeat - (see section 10.3.3). Finally, + (see section 10.3.3). Finally, MouseKeys generates pointer events identical to those of the core pointer device. @@ -2248,7 +2248,7 @@ When the acceptance or rejection, and release of any key to interested clients by sending an appropriate AccessXNotify - event (see section 10.6.4). + event (see section 10.6.4). @@ -2428,7 +2428,7 @@ When the control is active, the server reports acceptance or rejection of any key to interested clients by sending an appropriate AccessXNotify - event (see section 10.6.4). + event (see section 10.6.4). @@ -2705,7 +2705,7 @@ The ax_options of an XkbControlsRec - structure (see section 10.8). The first option, + structure (see section 10.8). The first option, TwoKeys, specifies whether StickyKeys @@ -3013,10 +3013,10 @@ There are no convenience functions for manipulating the XkbSetControls and XkbGetControls - (see section 10.9 and section 10.10) to query and change this control. + (see section 10.9 and section 10.10) to query and change this control. -See also section 15.3.2 or a discussion of the related field, +See also section 15.3.2 or a discussion of the related field, group_info, which also normalizes a group under certain circumstances. @@ -3055,7 +3055,7 @@ Manipulate the XkbSetControls and XkbGetControls - (see sections 10.9 and 10.10) to query and change this control. Alternatively, + (see section 10.9 and section 10.10) to query and change this control. Alternatively, use XkbSetIgnoreLockMods. @@ -3200,7 +3200,7 @@ be added and removed from the server’s are removed from the server’s IgnoreLockMods control. -See section 7.1 for a discussion of virtual modifier masks to use in +See section 7.1 for a discussion of virtual modifier masks to use in affect_virtual and virtual_values. @@ -3228,7 +3228,7 @@ passive grabs. Because IgnoreGroupLock is a boolean control with no attributes, use the general boolean controls -functions (see section 10.1) to change its state. +functions (see section 10.1) to change its state. @@ -3265,7 +3265,8 @@ Manipulate the XkbSetControls and XkbGetControls - (see sections10.9 and 10.10). Alternatively, use + (see section 10.9 + and section 10.10). Alternatively, use XkbSetServerInternalMods. @@ -3398,7 +3399,7 @@ selected by both but not by virtual_values are removed from the server’s internal modifiers control. -See section 7.1 for a discussion of virtual modifier masks to use in +See section 7.1 for a discussion of virtual modifier masks to use in affect_virtual and virtual_values. @@ -3510,14 +3511,14 @@ is described in more detail. XkbAccessXFeedbackMask ax_options: XkbAX_*FBMask XkbAccessXFeedback­Mask - 10.6.3 + 10.6.3 AccessXKeys XkbAccessXKeys­Mask - 10.6.1 + 10.6.1 AccessXTimeout @@ -3530,77 +3531,77 @@ is described in more detail. axt_ctrls_values XkbAccessXTimeout­Mask - 10.6.2 + 10.6.2 AudibleBell XkbAudibleBellMask - 9.2 + 9.2 AutoReset - 10.1.2 + 10.1.2 BounceKeys XkbBounceKeysMask debounce_delay XkbBounceKeysMask - 10.6.7 + 10.6.7 Detectable-Autorepeat - 10.3.3 + 10.3.3 EnabledControls XkbControlsEnabledMask enabled_ctrls Non-Boolean Control - 10.1.1 + 10.1.1 GroupsWrap XkbGroupsWrapMask groups_wrap Non-Boolean Control - 10.7.1 + 10.7.1 IgnoreGroupLock XkbIgnoreGroupLock­Mask - 10.7.3 + 10.7.3 IgnoreLockMods XkbIgnoreLockModsMask ignore_lock Non-Boolean Control - 5.1 + 5.1 InternalMods XkbInternalModsMask internal Non-Boolean Control - 5.1 + 5.1 MouseKeys XkbMouseKeysMask mk_dflt_btn XkbMouseKeysMask - 10.5.1 + 10.5.1 MouseKeysAccel @@ -3613,28 +3614,28 @@ is described in more detail. mk_curve XkbMouseKeysAccel­Mask - 10.5.2 + 10.5.2 Overlay1 XkbOverlay1Mask - 10.4 + 10.4 Overlay2 XkbOverlay2Mask - 10.4 + 10.4 PerKeyRepeat XkbPerKeyRepeatMask per_key_repeat Non-Boolean Control - 10.3.1 + 10.3.1 RepeatKeys @@ -3644,14 +3645,14 @@ is described in more detail. repeat_interval XkbRepeatKeysMask - 10.3 + 10.3 SlowKeys XkbSlowKeysMask slow_keys_delay XkbSlowKeysMask - 10.6.6 + 10.6.6 StickyKeys @@ -3662,7 +3663,7 @@ is described in more detail. XkbAX_Latch­ToLockMask XkbStickyKeysMask - 10.6.8 + 10.6.8 @@ -3843,8 +3844,7 @@ The individual fields of the mk_dflt_btn is an attribute of the MouseKeys control - (see section 10.5 -). It + (see section 10.5). It specifies the mouse button number to use for keyboard simulated mouse button operations. Its value should be one of the core symbols Button1 @@ -3875,7 +3875,7 @@ computed automatically by the server whenever the keyboard mapping changes. groups_wrap is an attribute of the GroupsWrap - control (see section 10.7.1). It specifies the handling of illegal groups on a + control (see section 10.7.1). It specifies the handling of illegal groups on a global basis. Valid values for groups_wrap are shown in Table 10.8. @@ -3927,7 +3927,7 @@ its four low-order bits specify the index of the group to use. internal is an attribute of the InternalMods - control (see section 10.7.4). It specifies modifiers to be consumed in the + control (see section 10.7.4). It specifies modifiers to be consumed in the server and not passed on to clients when events are reported. Valid values consist of any combination of the eight core modifier bits: ShiftMask, @@ -3947,7 +3947,7 @@ consist of any combination of the eight core modifier bits: ignore_lock is an attribute of the IgnoreLockMods - control (see section 10.7.2). It specifies modifiers to be ignored in grab + control (see section 10.7.2). It specifies modifiers to be ignored in grab calculations. Valid values consist of any combination of the eight core modifier bits: ShiftMask, @@ -3967,7 +3967,7 @@ modifier bits: enabled_ctrls is an attribute of the EnabledControls - control (see section 10.1.1). It contains one bit per boolean control. Each + control (see section 10.1.1). It contains one bit per boolean control. Each bit determines whether the corresponding control is enabled or disabled; a one bit means the control is enabled. The mask bits used to enable these controls are listed in Table 10.7, using only those masks with "ok" in the @@ -3986,7 +3986,7 @@ are listed in Table 10.7, using only those masks with "ok" in the repeat_interval are attributes of the RepeatKeys - control (see section 10.3.2). + control (see section 10.3.2). repeat_delay is the initial delay before a key begins repeating, in milliseconds; repeat_interval @@ -4002,7 +4002,7 @@ repeat_delay slow_keys_delay is an attribute of the SlowKeys - control (see section 10.6.6). Its value specifies the + control (see section 10.6.6). Its value specifies the SlowKeys acceptance delay period in milliseconds before a key press is accepted by the server. @@ -4017,7 +4017,7 @@ server. debounce_delay is an attribute of the BounceKeys - control (see section 10.6.7). Its value specifies the + control (see section 10.6.7). Its value specifies the BounceKeys delay period in milliseconds for which the key is disabled after having been pressed before another press of the same key is accepted by the server. @@ -4037,7 +4037,7 @@ and mk_curve are attributes of the MouseKeysAccel - control. Refer to section 10.5.2 for a description of these fields and the + control. Refer to section 10.5.2 for a description of these fields and the units involved. @@ -4051,9 +4051,9 @@ The ax_options field contains attributes used to configure two different controls, the StickyKeys - control (see section 10.6.8) and the + control (see section 10.6.8) and the AccessXFeedback - control (see section 10.6.3). The + control (see section 10.6.3). The ax_options field is a bitmask and may include any combination of the bits defined in Table 10.9. @@ -4254,7 +4254,7 @@ and axt_ctrls_values are attributes of the AccessXTimeout - control. Refer to section 10.6.2 for a description of these fields and the + control. Refer to section 10.6.2 for a description of these fields and the units involved. @@ -4417,7 +4417,7 @@ To free the ctrls member of a keyboard description, use XkbFreeControls - (see section 10.12) + (see section 10.12) @@ -4552,7 +4552,7 @@ the corresponding values are still updated in the X server. For example, the set in enabled_ctrls ). It is permissible to modify the attributes of a control in one call to -XkbSetControls and enable the control in a subsequent call. See section 10.1.1 +XkbSetControls and enable the control in a subsequent call. See section 10.1.1 for more information on enabling and disabling controls. @@ -4574,7 +4574,7 @@ Because this is somewhat awkward if all you want to do is enable and disable controls, and not modify any of their attributes, a convenience function is also provided for this purpose ( XkbChangeEnabledControls, -section 10.1.1). +section 10.1.1). @@ -4709,7 +4709,7 @@ description, the server sends an XkbControlsNotify events under all possible conditions, use XkbSelectEvents - (see section 4.3) and pass + (see section 4.3) and pass XkbControlsNotifyMask in both bits_to_change @@ -4986,7 +4986,7 @@ results into the ctrls field, use XkbFreeControls - (see section 10.12). + (see section 10.12). @@ -5197,7 +5197,7 @@ and sets You can configure the boolean per-client controls which affect the state -reported in button and key events. See section 12.1.1, 12.3, 12.5, and 16.3.11 +reported in button and key events. See section 12.1.1, 12.3, 12.5, and 16.3.11 of the XKB Protocol specification for more details. diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 0d28a803..66927ec9 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -179,7 +179,7 @@ The modifiers when processing all keys, even if the definition for the key type does not specify these modifiers. The AlwaysConsumeShiftAndLock - control is unset by default. See section 15.2 for a discussion of key types. + control is unset by default. See section 15.2 for a discussion of key types. diff --git a/specs/XKB/ch12.xml b/specs/XKB/ch12.xml index 3506cbea..43a356a2 100644 --- a/specs/XKB/ch12.xml +++ b/specs/XKB/ch12.xml @@ -31,7 +31,7 @@ includes ways to control or disable it. Because XOpenDisplay initializes Xkb, some events contain an Xkb description of the keyboard state -instead of that normally used by the core protocol. See section 17.1.1 for more +instead of that normally used by the core protocol. See section 17.1.1 for more information about the differences between Xkb keyboard state and that reported by the core protocol. @@ -105,7 +105,7 @@ client’s knowledge. Most clients don’t really care about the range of legal keycodes, but some clients maintain information about each key and might have problems with events that come from unexpected keys. Such clients can set the XkbLC_IgnoreNewKeyboards - library control (see section 11.3.1) to prevent the implicit support from + library control (see section 11.3.1) to prevent the implicit support from requesting notification of changes to the legal range of keycodes. @@ -145,7 +145,7 @@ key. The index specifies a column of symbols in the core keyboard mapping (that is, as reported by the core protocol GetKeyboardMapping request). The order of the symbols in the core mapping does not necessarily -correspond to the order of the symbols used by Xkb; section 17.1.3 describes +correspond to the order of the symbols used by Xkb; section 17.1.3 describes the differences. @@ -186,7 +186,7 @@ Xkb is present, is allowed, but not required, to return strings in character sets other than ISO Latin-1, depending on the current locale. If any key bindings are defined, XLookupString - does not use any consumed modifiers (see sections 11.1.2 and 15.2) to + does not use any consumed modifiers (see section 11.1.2 and section 15.2) to determine matching bindings. @@ -859,7 +859,7 @@ To translate a keycode to a key symbol and modifiers, use Mod5Mask. The AlwaysConsumeShiftAndLock - library control (see section 11.1.3), if enabled, causes + library control (see section 11.1.3), if enabled, causes XkbTranslateKeyCode to consume shift and lock. XkbTranslateKeyCode diff --git a/specs/XKB/ch14.xml b/specs/XKB/ch14.xml index 232dbe54..5dab015f 100644 --- a/specs/XKB/ch14.xml +++ b/specs/XKB/ch14.xml @@ -177,7 +177,7 @@ exception of compatibility mapping, discussed in section 16.1.4. @@ -192,14 +192,14 @@ type and specifies the modifier combinations necessary to access each level. For example, Xkb allows key types where the Control modifier can be used to access the shift level two of a key. Key types are in -the client map component and are described in detail in section 15.2. +the client map component and are described in detail in section 15.2. Xkb provides precise specification of the behavior of a key using key behaviors. Key behaviors are in the server map component and are described in -detail in section 16.2. +detail in section 16.2. @@ -234,7 +234,7 @@ map, use XkbGetMap is similar to XkbGetKeyboard - (see section 6.2), but is used only for obtaining the address of an + (see section 6.2), but is used only for obtaining the address of an XkbDescRec structure that is populated with keyboard mapping components. It allows finer control over which substructures of the keyboard mapping components are to be @@ -977,7 +977,7 @@ To receive XkbMapNotify events under all possible conditions, use XkbSelectEvents - (see section 4.3) and pass + (see section 4.3) and pass XkbMapNotifyMask in both bits_to_change @@ -1047,7 +1047,7 @@ The inclusive OR of the mask bits defined in Table 14.1. The other fields in this event are interpreted as the like-named fields in an XkbMapChangesRec - (see section 14.3.1). The + (see section 14.3.1). The XkbMapNotifyEvent structure also has an additional resized @@ -1062,7 +1062,7 @@ event are interpreted as the like-named fields in an Calling XkbGetMap - (see section 14.2) should be sufficient for most applications to get client + (see section 14.2) should be sufficient for most applications to get client and server maps. As a result, most applications do not need to directly allocate client and server maps. @@ -1185,7 +1185,7 @@ field specifies the number of entries to preallocate for the type_count field is less than XkbNumRequiredTypes - (see section 15.2.1), returns + (see section 15.2.1), returns BadValue. diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index c41d9023..2e23c15c 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -31,7 +31,7 @@ Xkb Client Map The map -field of the complete Xkb keyboard description (see section 6.1) is a pointer +field of the complete Xkb keyboard description (see section 6.1) is a pointer to the Xkb client map, which is of type XkbClientMapRec : @@ -106,7 +106,7 @@ The mods field of a key type is an XkbModsRec - (see section 7.2) specifying the modifiers the key type uses when calculating + (see section 7.2) specifying the modifiers the key type uses when calculating the shift level, and can be composed of both the core modifiers and virtual modifiers. To set the modifiers associated with a key type, modify the real_mods @@ -136,7 +136,7 @@ The num_levels directly to change the number if shift levels for a key type. Instead, use XkbResizeKeyType - (see section 15.2.3). + (see section 15.2.3). @@ -197,7 +197,7 @@ Any modifiers specified in consumed by XkbTranslateKeyCode - (see section 12.1.3). For those rare occasions a modifier + (see section 12.1.3). For those rare occasions a modifier should be considered despite having been used to look up a symbol, key types include an optional @@ -350,7 +350,7 @@ that the virtual Shift level three can be reached only if the virtual modifier LevelThree - is bound to a real modifier (see section 16.4). If + is bound to a real modifier (see section 16.4). If LevelThree is not bound to a real modifier, the map @@ -811,7 +811,7 @@ use bound to individual keys. To obtain the key types bound to an individual key, refer to the key_sym_map - field of the client map (see section 15.3.1). + field of the client map (see section 15.3.1). XkbGetKeyTypes @@ -1279,7 +1279,7 @@ The kt_index array of the XkbSymMapRec - structure contains the indices of the key types (see section 15.2) for each + structure contains the indices of the key types (see section 15.2) for each possible group of symbols associated with the key. To obtain the index of a key type or the pointer to a key type, Xkb provides the following macros, to access the key types: @@ -1430,7 +1430,7 @@ To obtain the number of groups of symbols bound to the key, use XkbKeyNumGroups. To change the number of groups bound to a key, use XkbChangeTypesOfKey - (see section 15.3.6). To obtain a mask that determines the treatment of + (see section 15.3.6). To obtain a mask that determines the treatment of out-of-range groups, use XkbKeyGroupInfo and @@ -1469,7 +1469,7 @@ Out-of-range groups for individual keys are mapped to a legal group using the same options as are used for the overall keyboard group. The particular type of mapping used is controlled by the bits set in the group_info - flag, as shown in Table 15.2. See section 10.7.1 for more details on the + flag, as shown in Table 15.2. See section 10.7.1 for more details on the normalization methods in this table. @@ -2255,7 +2255,7 @@ as appropriate. If the p_changes to include the key - that was changed. See section 14.3.1 for more information on the + that was changed. See section 14.3.1 for more information on the XkbMapChangesPtr structure. If successful, XkbChangeTypesOfKey @@ -2503,7 +2503,7 @@ the key, A change to the number of symbols bound to a key should be accompanied by a change in the number of actions bound to a key. Refer to -section 16.1.16 for more information on changing the number of actions bound to +section 16.1.16 for more information on changing the number of actions bound to a key. diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index 29b1a4b1..259d77b4 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -4,7 +4,7 @@ The server - field of the complete Xkb keyboard description (see section 6.1) is a pointer + field of the complete Xkb keyboard description (see section 6.1) is a pointer to the Xkb server map. @@ -56,9 +56,9 @@ The acts, and key_acts - fields specify the key actions, defined in section 16.1. The + fields specify the key actions, defined in section 16.1. The behaviors - field describes the behavior for each key and is defined in section 16.2. The + field describes the behavior for each key and is defined in section 16.2. The explicit field describes the explicit components for a key and is defined in section 16.3. The @@ -66,7 +66,7 @@ and and the vmodmap fields describe the virtual modifiers and the per-key virtual modifier mapping -and are defined in section 16.4. +and are defined in section 16.4. @@ -244,7 +244,7 @@ to key actions: keycode. This should be the same value as the result of XkbKeyNumSyms - (see section 15.3.3). + (see section 15.3.3). @@ -874,8 +874,8 @@ The vmods1, and vmods2 - fields represent the components of an Xkb modifier description (see section -7.2). While the + fields represent the components of an Xkb modifier description +(see section 7.2). While the mask and real_mods @@ -1044,14 +1044,14 @@ the field to the base keyboard group. In either case, the resulting effective keyboard group is brought back into range depending on the value of the groups_wrap - field of the controls structure (see section 10.7.1). + field of the controls structure (see section 10.7.1). If a key with an XkbSA_ISOLock - action (see section 16.1.8) is pressed while this key is down, the key release + action (see section 16.1.8) is pressed while this key is down, the key release of this key has no effect. Otherwise, the key release cancels the effects of the key press. @@ -1306,7 +1306,7 @@ typedef struct _XkbPtrAction { If the MouseKeys - control is not enabled (see section 10.5.1), + control is not enabled (see section 10.5.1), KeyPress and KeyRelease @@ -1366,7 +1366,7 @@ The If not set, and the MouseKeysAccel - control is enabled (see section 10.5.2), the + control is enabled (see section 10.5.2), the KeyPress initiates a mouse keys timer for this key; every time the timer expires, the cursor moves. @@ -1597,7 +1597,7 @@ typedef struct _XkbPtrBtnAction { If the MouseKeys - (see section 10.5.1) control is not enabled, + (see section 10.5.1) control is not enabled, KeyPress and KeyRelease @@ -1639,7 +1639,7 @@ If mk_dflt_btn attribute of the MouseKeys - control (see section 10.5.1). Otherwise, the event is generated for the button + control (see section 10.5.1). Otherwise, the event is generated for the button specified by the button field. @@ -1765,7 +1765,7 @@ If set, the action uses the pointer button specified by the mk_dflt_btn attribute of the MouseKeys - control (see section 10.5.1). Otherwise, the action uses the pointer button + control (see section 10.5.1). Otherwise, the action uses the pointer button specified by the button field. @@ -1802,7 +1802,7 @@ Actions associated with the mk_dflt_btn attribute of the MouseKeys - control (see section 10.5.1): + control (see section 10.5.1): @@ -1891,7 +1891,7 @@ The mk_dflt_btn attribute of the MouseKeys - control (see section 10.5.1). If + control (see section 10.5.1). If XkbSA_DfltBtnAbsolute is set in flags, @@ -2219,7 +2219,7 @@ the vmods1, and vmods2 -fields (see section 16.1.3). If no other actions are transformed by the +fields (see section 16.1.3). If no other actions are transformed by the XkbISO_Lock action, a key release locks the action modifiers. Otherwise, a key release clears the base modifiers set by the key press. @@ -2319,8 +2319,8 @@ The vmods1, and vmods2 - fields represent the components of an Xkb modifier description (see section -7.2). While the + fields represent the components of an Xkb modifier description + (see section 7.2). While the mask and real_mods @@ -2335,7 +2335,7 @@ and fields are combined to correspond to the vmods field of an Xkb modifier description. Xkb provides macros to convert between -the two formats as shown in section 16.1.3. +the two formats as shown in section 16.1.3. @@ -2600,7 +2600,7 @@ signed character value for screen numbers in Actions associated with the XkbCtrlsAction - structure change the state of the boolean controls (see section 10.1): + structure change the state of the boolean controls (see section 10.1): @@ -2659,7 +2659,7 @@ A key release disables any controls enabled by the key press. This action can cause XkbControlsNotify - events (see section 10.1). + events (see section 10.1). @@ -2695,7 +2695,7 @@ If the This action can cause XkbControlsNotify - events (see section 10.1). + events (see section 10.1). @@ -2770,7 +2770,7 @@ and ctrls3 fields represent the boolean controls in the enabled_ctrls - field of the controls structure (see section 10.1). Xkb provides the following + field of the controls structure (see section 10.1). Xkb provides the following macros, to convert between the two formats: @@ -2963,7 +2963,7 @@ To receive XkbSelectEvents or XkbSelectEventDetails - (see section 4.3). + (see section 4.3). @@ -3930,7 +3930,7 @@ the key, A change to the number of actions bound to a key should be accompanied by a change in the number of symbols bound to a key. Refer to -section 15.3.7 for more information on changing the number of symbols bound to +section 15.3.7 for more information on changing the number of symbols bound to a key. @@ -4086,7 +4086,7 @@ All other key release events are ignored. If the Overlay1 - control is enabled (see section 10.4), + control is enabled (see section 10.4), data is interpreted as a keycode, and events from this key are reported as if they came from @@ -4099,7 +4099,7 @@ came from If the Overlay2 - control is enabled (see section 10.4), + control is enabled (see section 10.4), data is interpreted as a keycode, and events from this key are reported as if they came from @@ -4255,7 +4255,7 @@ If any allocation errors occur, Whenever a client remaps the keyboard using core protocol requests, Xkb examines the map to determine likely default values for the components that -cannot be specified using the core protocol (see section 17.1.2 for more +cannot be specified using the core protocol (see section 17.1.2 for more information on how Xkb chooses the default values). @@ -4517,7 +4517,7 @@ The vmodmap member of the server map is similar to the modmap - array of the client map (see section 15.4), but is used to define the virtual + array of the client map (see section 15.4), but is used to define the virtual modifier mapping for each key. Like the modmap member, it is indexed by keycode, and each entry is a mask representing the @@ -4644,7 +4644,7 @@ To obtain a subset of the virtual modifier bindings (the vmods entries for the virtual modifiers specified in the mask, which, -and waits for a reply. See section 7.1 for a description of how to determine +and waits for a reply. See section 7.1 for a description of how to determine the virtual modifier mask. For each bit set in which, XkbGetVirtualMods diff --git a/specs/XKB/ch17.xml b/specs/XKB/ch17.xml index 69f7418c..c19a8e19 100644 --- a/specs/XKB/ch17.xml +++ b/specs/XKB/ch17.xml @@ -132,7 +132,7 @@ contained in an structure; plus a set of explicit override controls used to prevent particular components of type 2 (core-to-Xkb keyboard mapping) transformations from automatically occurring. These explicit override controls are maintained in a -separate data structure discussed in section 16.3. +separate data structure discussed in section 16.3. @@ -181,7 +181,7 @@ As shown in Figure 17.3, there are four [0..3]) in the XkbCompatMapRec structure, one per possible Xkb group. Each group compatibility map is a -modifier definition (see section 7.2 for a description of modifier +modifier definition (see section 7.2 for a description of modifier definitions). The mask component of the definition specifies which real modifiers should be set in @@ -258,7 +258,7 @@ Xkb keyboard mapping in the server, this automatic regeneration of the Xkb keyboard mapping from the core protocol keyboard mapping should not modify any components of the Xkb keyboard mapping that were explicitly set by a client. The client must set explicit override controls to prevent this from happening -(see section 16.3). The core-to-Xkb mapping is done as follows: +(see section 16.3). The core-to-Xkb mapping is done as follows: @@ -367,7 +367,7 @@ Apply symbol interpretations to modify key operation. This phase is completely skipped if the ExplicitInterpret override control bit is set in the explicit controls mask for the Xkb key (see -section 16.3). +section 16.3). @@ -407,7 +407,7 @@ Symbol interpretations are used to guide the X server when it modifies the Xkb keymap in step 2. An initial set of symbol interpretations is loaded by the server when it starts. A client may add new ones using XkbSetCompatMap - (see section 17.4). + (see section 17.4). @@ -421,7 +421,7 @@ processing may be modified for the particular key involved: Virtual modifier map Auto repeat Key behavior (may be set to XkbKB_Lock) - Key action (see section 16.1) + Key action (see section 16.1) @@ -605,7 +605,7 @@ The act field specifies a single action to be bound to the symbol position; any key event that selects the symbol causes the action to be taken. Valid actions are -defined in section 16.1. +defined in section 16.1. @@ -666,7 +666,7 @@ If the Xkb keyboard map for the key does not have its XkbSI_LockingKey is set, the key behavior is set to KB_Lock -; otherwise, it is turned off (see section 16.3). +; otherwise, it is turned off (see section 16.3). @@ -744,7 +744,7 @@ Use server. When another client modifies the compatibility map, you are notified if you have selected for XkbCompatMapNotify - events (see section 17.5). + events (see section 17.5). XkbGetCompatMap is particularly useful when you receive an event of this type, as it allows you to update your program’s version of the compatibility map to match the @@ -1150,7 +1150,7 @@ key in a core keyboard mapping. Use and types in types_inout according to the rules specified in section 12 of the core protocol, then -chooses canonical key types (canonical key types are defined in section 15.2.1) +chooses canonical key types (canonical key types are defined in section 15.2.1) for groups 1 and 2 using the rules specified by the Xkb protocol and places them in xkb_syms_rtrn, @@ -1266,7 +1266,7 @@ semantics updated, use XkbApplyCompatMapToKey - essentially performs the operation described in section 17.1.2 to a specific + essentially performs the operation described in section 17.1.2 to a specific key. This updates the behavior, actions, repeat status, and virtual modifier bindings of the key. @@ -1282,7 +1282,7 @@ Xkb compatibility map, then call XkbSetCompatMap. You may allocate a new compatibility map for this purpose using XkbAllocCompatMap - (see section 17.6). You may also use a compatibility map from another server, + (see section 17.6). You may also use a compatibility map from another server, although you need to adjust the device_spec field in the @@ -1525,7 +1525,7 @@ To receive XkbCompatMapNotify events under all possible conditions, use XkbSelectEvents - (see section 4.3) and pass + (see section 4.3) and pass XkbCompatMapNotifyMask in both bits_to_change @@ -1690,7 +1690,7 @@ allocated. The compatibility map is the which specifies the compatibility map components to be allocated (see XkbGetCompatMap, -in section 17.2). +in section 17.2). which is an inclusive OR of the bits shown in Table 17.2. @@ -1796,7 +1796,7 @@ To free an entire compatibility map or selected portions of one, use which specifies the compatibility map components to be freed (see XkbGetCompatMap, -in section 17.2). +in section 17.2). which is an inclusive OR of the bits shown in Table 17.2 diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 0090feb3..8b361dfc 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -123,7 +123,7 @@ English US engravings, but that is using Swiss German symbols might have a The types - name provides some information about the set of key types (see section 15.2) + name provides some information about the set of key types (see section 15.2) that can be associated with the keyboard. In addition, each key type can have a name, and each shift level of a type can have a name. Although these names are stored in the map description with each of the types, they are accessed using @@ -485,7 +485,7 @@ and To free symbolic names, use XkbFreeNames - (see section 18.6) + (see section 18.6) @@ -835,7 +835,7 @@ server sends a XkbNamesNotify event to all interested clients. To receive name notify events, use XkbSelectEvents - (see section 4.3) with + (see section 4.3) with XkbNamesNotifyMask in both the bits_to_change diff --git a/specs/XKB/ch19.xml b/specs/XKB/ch19.xml index 37ed405a..1c210695 100644 --- a/specs/XKB/ch19.xml +++ b/specs/XKB/ch19.xml @@ -187,7 +187,7 @@ typedef struct _XkbNewKeyboardNotify { To receive name notify events, use XkbSelectEvents - (see section 4.3) with + (see section 4.3) with XkbNewKeyboardNotifyMask in both the bits_to_change @@ -309,7 +309,7 @@ If the keyboard change is the result of an X_kbGetKbdByName request, req_major - contains the Xkb extension base event code (see section 2.4), and + contains the Xkb extension base event code (see section 2.4), and req_minor contains the event code for the Xkb extension request X_kbGetKbdByName. diff --git a/specs/XKB/ch20.xml b/specs/XKB/ch20.xml index f2d23ede..bf7548b7 100644 --- a/specs/XKB/ch20.xml +++ b/specs/XKB/ch20.xml @@ -253,8 +253,8 @@ composed of characters from the ISO ? ’ and ‘ * -’, and characters permitted in a component class or member name (see section -20.1). A pattern may be +’, and characters permitted in a component class or member name +(see section 20.1). A pattern may be NULL, in which case no components for that type is returned. Pattern matches with component names are case sensitive. The ‘ @@ -265,7 +265,7 @@ the ‘ ’ wildcard matches any number of characters, except a left or right parenthesis. If an implementation allows additional characters in a component class or member name other than those required by the Xkb extension (see -section 20.1), the result of comparing one of the additional characters to +section 20.1), the result of comparing one of the additional characters to either of the wildcard characters is implementation-dependent. @@ -1099,7 +1099,7 @@ If you simply want to obtain information about the current keyboard device, rather than generating a new keyboard description from elements in the server database, use XkbGetKeyboard - (see section 6.2). + (see section 6.2). XkbGetKeyboard diff --git a/specs/XKB/ch21.xml b/specs/XKB/ch21.xml index 302ab21b..f71d54ed 100644 --- a/specs/XKB/ch21.xml +++ b/specs/XKB/ch21.xml @@ -596,8 +596,8 @@ the function description are updated. The XkbDeviceInfo Rec structure used in the function call can be obtained by calling -XkbGetDeviceInfo or can be allocated by calling XkbAllocDeviceInfo (see section -21.3). +XkbGetDeviceInfo or can be allocated by calling XkbAllocDeviceInfo +(see section 21.3). @@ -1407,7 +1407,7 @@ modify a local copy of the device structure and then use either XkbSetDeviceInfo, or, to save network traffic, use an XkbDeviceChangesRec - structure (see section 21.6) and call + structure (see section 21.6) and call XkbChangeDeviceInfo to download the changes to the server. @@ -1751,7 +1751,7 @@ unsupported features of a device, select to receive XkbSelectEvents or XkbSelectEventDetails - (see section 4.3). + (see section 4.3).