From ed89b140a1359dc97f420255813599954b5d334b Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 30 Nov 2010 09:49:41 -0500 Subject: specs: convert xkbproto from Framemaker to DocBook/XML Signed-off-by: Gaetan Nadon --- specs/ch04.xml | 867 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 867 insertions(+) create mode 100644 specs/ch04.xml (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml new file mode 100644 index 0000000..4ea8e92 --- /dev/null +++ b/specs/ch04.xml @@ -0,0 +1,867 @@ + +Global Keyboard Controls + + +The X Keyboard Extension supports a number of +global key controls +, which affect the way that XKB handles the keyboard as a whole. Many of these +controls make the keyboard more accessible to the physically impaired and are +based on the AccessDOS package +AccessDOS provides access to the DOS operating system for people with physical +impairments and was developed by the Trace R&D Center at the University of +Wisconsin. For more information on AccessDOS, contact the Trace R&D Center, +Waisman Center and Department of Industrial Engineering, University of +Wisconsin-Madison WI 53705-2280. Phone: 608-262-6966. e-mail: +info@trace.wisc.edu.. + + + +The RepeatKeys Control + + +The core protocol only allows control over whether or not the entire keyboard +or individual keys should autorepeat when held down. The +RepeatKeys + control extends this capability by adding control over the delay until a key +begins to repeat and the rate at which it repeats. +RepeatKeys + is also coupled with the core autorepeat control; changes to one are always +reflected in the other. + + + + +The +RepeatKeys + control has two parameters. The +autorepeat delay + specifies the delay between the initial press of an autorepeating key and the +first generated repeat event in milliseconds. The +autorepeat interval + specifies the delay between all subsequent generated repeat events in +milliseconds. + + + + +The PerKeyRepeat Control + + +When +RepeatKeys + are active, the +PerKeyRepeat + control specifies whether or not individual keys should autorepeat when held +down. XKB provides the +PerKeyRepeat + for convenience only, and it always parallels the +auto-repeats + field of the core protocol +GetKeyboardControl + request — changes to one are always reflected in the other. + + + + + +Detectable Autorepeat + + +The X server usually generates both press and release events whenever an +autorepeating key is held down. If an XKB-aware client enables the +DetectableAutorepeat + per-client option for a keyboard, the server sends that client a key release +event only when the key is +physically + released. For example, holding down a key to generate three characters without +detectable autorepeat yields: + + + +Press -> Release -> Press -> Release -> Press -> Release + + + +If detectable autorepeat is enabled, the client instead receives: + + + +Press-> Press -> Press -> Release + + + +Note that only clients that request detectable autorepeat are affected; other +clients continue to receive both press and release events for autorepeating +keys. Also note that support for detectable autorepeat is optional; servers are +not required to support detectable autorepeat, but they must correctly report +whether or not it is supported. + + + + +See Querying and Changing Per-Client +Flags describes the +XkbPerClientFlags + request, which reports or changes values for all of the per-client flags, and +which lists the per-client flags that are supported. + + + + + + +The SlowKeys Control + + +Some users often bump keys accidentally while moving their hand or typing stick +toward the key they want. Usually, the keys that are bumped accidentally are +hit only for a very short period of time. The +SlowKeys + control helps filter these accidental bumps by telling the server to wait a +specified period, called the +SlowKeys acceptance delay +, before delivering key events. If the key is released before this period +elapses, no key events are generated. The user can then bump any number of keys +on their way to the one they want without generating unwanted characters. Once +they have reached the key they want, they can then hold it long enough for + +SlowKeys + to accept it. + + + + +The +SlowKeys + control has one parameter; the +slow keys delay + specifies the length of time, in milliseconds, that a key must be held down +before it is accepted. + + + + +When +SlowKeys + are active, the X Keyboard Extension reports the initial press, acceptance, +rejection or release of any key to interested clients using +AccessXNotify + events. The +AccessXNotify + event is described in more detail in See Events. + + + + +The BounceKeys Control + + +Some people with physical impairments accidentally "bounce" on a key when they +press it. That is, they press it once, then accidentally press it again +immediately. The +BounceKeys + control temporarily disables a key after it has been pressed, effectively +"debouncing" the keyboard. + + + + +The +BounceKeys + has a single parameter. The +BounceKeys delay + specifies the period of time, in milliseconds, that the key is disabled after +it is pressed. + + + + +When +BounceKeys + are active, the server reports the acceptance or rejection of any key to +interested clients by sending an +AccessXNotify + event. The +AccessXNotify + event is described in more detail in See Events. + + + + +The StickyKeys Control + + +Some people find it difficult or impossible to press two keys at once. The + +StickyKeys + control makes it easier for them to type by changing the behavior of the +modifier keys. When +StickyKeys + are enabled, a modifier is latched when the user presses it just once, so the +user can first press a modifier, release it, then press another key. For +example, to get an exclamation point (!) on a PC-style keyboard, the user can +press the +Shift + key, release it, then press the +1 + key. + + + + +By default, +StickyKeys + also allows users to lock modifier keys without requiring special locking +keys. The user can press a modifier twice in a row to lock it, and then unlock +it by pressing it one more time. + + + + +Modifiers are automatically unlatched when the user presses a non-modifier key. +For instance, to enter the sequence +Shift ++ +Ctrl ++ +Z + the user could press and release the +Shift + key to latch the +Shift + modifier, then press and release the +Ctrl + key to latch the +Control + modifier — the +Ctrl + key is a modifier key, so pressing it does not unlatch the +Shift + modifier, but leaves both the +Shift + and +Control + modifiers latched, instead. When the user presses the +Z + key, it will be as though the user pressed +Shift ++ +Ctrl ++ +Z + simultaneously. The +Z + key is not a modifier key, so the +Shift + and +Control + modifiers are unlatched after the event is generated. + + + + +A locked a modifier remains in effect until the user unlocks it. For example, +to enter the sequence ("XKB") on a PC-style keyboard with a typical US/ASCII +layout, the user could press and release the +Shift + key twice to lock the +Shift + modifier. Then, when the user presses the +9 +, +‘ +, +x +, +k +, +b +, +‘ +, and +0 + keys in sequence, it will generate ("XKB"). To unlock the +Shift + modifier, the user can press and release the +Shift + key. + + + + +Two option flags modify the behavior of the +StickyKeys + control: + + + + + If the +XkbAX_TwoKeys + flag is set, XKB automatically turns +StickyKeys + off if the user presses two or more keys at once. This serves to automatically +disable StickyKeys when a user who does not require sticky keys is using the +keyboard. + + + + The +XkbAX_LatchToLock + controls the locking behavior of +StickyKeys +; the +StickyKeys + control only locks modifiers as described above if the +XkbAX_LatchToLock + flag is set. + + + + + + +The MouseKeys Control + + +The +MouseKeys + control lets a user control all the mouse functions from the keyboard. When + +MouseKeys + are enabled, all keys with +MouseKeys + actions bound to them generate core pointer events instead of normal key press +and release events. + + + + +The +MouseKeys + control has a single parameter, the +mouse keys default button +, which specifies the core pointer button to be used by mouse keys actions that +do not explicitly specify a button. + + + + + +The MouseKeysAccel Control + + +If the +MouseKeysAccel + control is enabled, the effect of a pointer motion action changes as a key is +held down. The +mouse keys delay + specifies the amount of time between the initial key press and the first +repeated motion event. The +mouse keys interval + specifies the amount of time between repeated mouse keys events. The +steps to maximum acceleration + field specifies the total number of events before the key is travelling at +maximum speed. The +maximum acceleration + field specifies the maximum acceleration. The +curve + parameter controls the ramp used to reach maximum acceleration. + + + + +When +MouseKeys + are active and a +SA_MovePtr + key action (see See Key +Actions) is activated, a pointer motion event is generated immediately. +If +MouseKeysAccel + is enabled and if acceleration is enabled for the key in question, a second +event is generated after +mouse keys delay +milliseconds, and additional events are generated every +mouse keys interval + milliseconds for as long as the key is held down. + + + + +Relative Pointer Motion + + +If the +SA_MovePtr + action specifies relative motion, events are generated as follows: The initial +event always moves the cursor the distance specified in the action; after + +steps to maximum acceleration + events have been generated, all subsequent events move the pointer the +distance specified in the action times the +maximum acceleration. + Events after the first but before maximum acceleration has been achieved are +accelerated according to the formula: + + + + + + + + + + +Where +action_delta + is the offset specified by the mouse keys action, +max_accel +and +steps_to_max + are parameters to the +MouseKeysAccel + ctrl, and the curveFactor is computed using the +MouseKeysAccel + +curve + parameter as follows: + + + + + + + + + +With the result that a +curve + of +0 + causes the distance moved to increase linearly from +action_delta + to + + + + +, and the minimum legal +curve + of - +1000 + causes all events after the first move at +max_accel +. A negative +curve + causes an initial sharp increase in acceleration which tapers off, while a +positive curve yields a slower initial increase in acceleration followed by a +sharp increase as the number of pointer events generated by the action +approaches +steps_to_max +. + + + + + +Absolute Pointer Motion + + +If an +SA_MovePtr + action specifies an absolute position for one of the coordinates but still +allows acceleration, all repeated events contain any absolute coordinates +specified in the action. + + + + + + +The AccessXKeys Control + + +If +AccessXKeys + is enabled many controls can also be turned on or off from the keyboard by +entering the following standard key sequences: + + + + + Holding down a shift key by itself for eight seconds toggles the + +SlowKeys + control. + + + + Pressing and releasing a shift key five times in a row without any +intervening key events and with less than 30 seconds delay between consecutive +presses toggles the state of the +StickyKeys + control. + + + + Simultaneously operating two or more modifier keys deactivates the + +StickyKeys + control. + + + + + +Some of these key sequences optionally generate audible feedback of the change +in state, as described in See The +AccessXFeedback Control, or cause +XkbAccessXNotify + events as described in See +Events. + + + + + +The AccessXTimeout Control + + +In environments where computers are shared, features such as +SlowKeys + present a problem: if +SlowKeys + is on, the keyboard can appear to be unresponsive because keys have no effect +unless they are held for a certain period of time. To help address this +problem, XKB provides an +AccessXTimeout + control to automatically change the value of any global controls or AccessX +options if the keyboard is idle for a specified period of time. + + + + +The AccessXTimeout control has a number of parameters which affect the duration +of the timeout and the features changed when the timeout expires. + + + + +The +AccessX Timeout + field specifies the number of seconds the keyboard must be idle before the +global controls and AccessX options are modified. The +AccessX Options Mask + field specifies which values in the +AccessX Options + field are to be changed, and the +AccessX Options Values + field specifies the new values for those options. The +AccessX Controls Mask + field specifies which controls are to be changed in the global set of + +enabled controls +, and the +AccessX Controls Values + field specifies the new values for those controls. + + + + + +The AccessXFeedback Control + + +If +AccessXFeedback + is enabled, special beep-codes indicate changes in keyboard controls (or some +key events when +SlowKeys + or +StickyKeys + are active). Many beep codes sound as multiple tones, but XKB reports a single + +XkbBellNotify + event for the entire sequence of tones. + + + + +All feedback tones are governed by the +AudibleBell + control. Individual feedback tones can be explicitly enabled or disabled using +the +accessX options mask + or set to deactivate after an idle period using the +accessX timeout options mask +. XKB defines the following feedback tones: + + + + + + + + + + + Feedback Name + Bell Name + Default Sound + Indicates + + + + + FeatureFB + AX_FeatureOn + rising tone + Keyboard control enabled + + + + AX_FeatureOff + falling tone + Keyboard control disabled + + + + AX_FeatureChange + two tones + Several controls changed state + + + IndicatorFB + AX_IndicatorOn + high tone + Indicator Lit + + + + AX_IndicatorOff + low tone + Indicator Extinguished + + + + AX_IndicatorChange + two high tones + Several indicators changed state + + + SlowWarnFB + AX_SlowKeysWarning + three high tones + Shift key held for four seconds + + + SKPressFB + AX_SlowKeyPress + single tone + Key press while +SlowKeys + are on + + + SKReleaseFB + AX_SlowKeyRelease + single tone + Key release while +SlowKeys + are on + + + SKAcceptFB + AX_SlowKeyAccept + single tone + Key event accepted by +SlowKeys + + + + SKRejectFB + AX_SlowKeyReject + low tone + Key event rejected by +SlowKeys + + + + StickyKeysFB + AX_StickyLatch + low tone then high tone + Modifier latched by +StickyKeys + + + + + AX_StickyLock + high tone + Modifier locked by +StickyKeys + + + + + AX_StickyUnlock + low tone + Modifier unlocked by +StickyKeys + + + + BKRejectFB + AX_BounceKeysReject + low tone + Key event rejected by +BounceKeys + + + + + + + +Implementations that cannot generate continuous tones may generate multiple +beeps instead of falling and rising tones; for example, they can generate a +high-pitched beep followed by a low-pitched beep instead of a continuous +falling tone. + + + + +If the physical keyboard bell is not very capable, attempts to simulate a +continuous tone with multiple bells can sound horrible. Set the +DumbBellFB + AccessX option to inform the server that the keyboard bell is not very capable +and that XKB should use only simple bell combinations. Keyboard capabilities +vary wildly, so the sounds generated for the individual bells when the + +DumbBellFB + option is set are implementation specific. + + + + + +The Overlay1 and Overlay2 Controls + + +A keyboard overlay allows some subset of the keyboard to report alternate +keycodes when the overlay is enabled. For example a keyboard overlay can be +used to simulate a numeric or editing keypad on keyboard that does not actually +have one by generating alternate of keycodes for some keys when the overlay is +enabled. This technique is very common on portable computers and embedded +systems with small keyboards. + + + + +XKB includes direct support for two keyboard overlays, using the +Overlay1 + and +Overlay2 + controls. When +Overlay1 + is enabled, all of the keys that are members of the first keyboard overlay +generate an alternate keycode. When +Overlay2 + is enabled, all of the keys that are members of the second keyboard overlay +generate an alternate keycode. + + + + +To specify the overlay to which a key belongs and the alternate keycode it +should generate when that overlay is enabled, assign it either the +KB_Overlay1 + or +KB_Overlay2 + key behaviors, as described in See +Key Behavior. + + + + + +"Boolean" Controls and The EnabledControls Control + + +All of the controls described above, along with the +AudibleBell + control (described in See Disabling +Server Generated Bells) and the +IgnoreGroupLock + control (described in See Server +Internal Modifiers and Ignore Locks Behavior) comprise the +boolean controls +. In addition to any parameters listed in the descriptions of the individual +controls, the boolean controls can be individually enabled or disabled by +changing the value of the +EnabledControls + control. + + + + +The following +non-boolean + controls are always active and cannot be changed using the +EnabledControls + control or specified in any context that accepts only boolean controls: + +GroupsWrap + (See Computing Effective Modifier and +Group), +EnabledControls +, +InternalMods + (See Server Internal Modifiers and +Ignore Locks Behavior), and +IgnoreLockMods + (See Server Internal Modifiers and +Ignore Locks Behavior) and +PerKeyRepeat + (See The RepeatKeys Control) + + + + + +Automatic Reset of Boolean Controls + + +The +auto-reset controls + are a per-client value which consist of two masks that can contain any of the +boolean controls (see See "Boolean" +Controls and The EnabledControls Control). Whenever the client exits +for any reason, any boolean controls specified in the +auto-reset mask + are set to the corresponding value from the +auto-reset values + mask. This makes it possible for clients to "clean up after themselves" +automatically, even if abnormally terminated. + + + + +For example, a client that replace the keyboard bell with some other audible +cue might want to turn off the +AudibleBell + control (See Disabling Server +Generated Bells) to prevent the server from also generating a sound and +thus avoid cacophony. If the client were to exit without resetting the + +AudibleBell +control, the user would be left without any feedback at all. Setting +AudibleBell + in both the auto-reset mask and auto-reset values guarantees that the audible +bell will be turned back on when the client exits. + + + -- cgit v1.2.3 From 4adfcde42846d19ad49557880978247dc4ea2f0f Mon Sep 17 00:00:00 2001 From: Gaetan Nadon Date: Tue, 28 Dec 2010 17:21:11 -0500 Subject: specs: convert images from gif to svg format. Signed-off-by: Gaetan Nadon --- specs/ch04.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml index 4ea8e92..33b77b3 100644 --- a/specs/ch04.xml +++ b/specs/ch04.xml @@ -409,7 +409,7 @@ accelerated according to the formula: - + @@ -431,7 +431,7 @@ curve - + @@ -444,7 +444,7 @@ curve causes the distance moved to increase linearly from action_delta to - + -- cgit v1.2.3 From c336374f3bf34ce875b29001548470f8d824141e Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Wed, 2 Mar 2011 17:11:05 -0700 Subject: Fix bad link anchors. Fix broken links in kxproto. The old links hardcoded the output filename 'XKBproto.htm' and used anchors that didn't convert correctly. The new anchors are strings that use the same convention as other anchors in other docs. Fix links like: Compute State Field to be: Compute State Field Signed-off-by: Matt Dew Reviewed-by: Gaetan Nadon Reviewed-by: Alan Coopersmith --- specs/ch04.xml | 56 +++++++++++++++++++++++++++----------------------------- 1 file changed, 27 insertions(+), 29 deletions(-) (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml index 33b77b3..631d1b0 100644 --- a/specs/ch04.xml +++ b/specs/ch04.xml @@ -99,8 +99,8 @@ whether or not it is supported. -See Querying and Changing Per-Client -Flags describes the +See Querying and Changing Per-Client +Flags describes the XkbPerClientFlags request, which reports or changes values for all of the per-client flags, and which lists the per-client flags that are supported. @@ -148,8 +148,7 @@ rejection or release of any key to interested clients using AccessXNotify events. The AccessXNotify - event is described in more detail in See Events. + event is described in more detail in See Events. @@ -184,8 +183,7 @@ interested clients by sending an AccessXNotify event. The AccessXNotify - event is described in more detail in See Events. + event is described in more detail in See Events. @@ -377,8 +375,8 @@ When MouseKeys are active and a SA_MovePtr - key action (see See Key -Actions) is activated, a pointer motion event is generated immediately. + key action (see See Key +Actions) is activated, a pointer motion event is generated immediately. If MouseKeysAccel is enabled and if acceleration is enabled for the key in question, a second @@ -517,11 +515,11 @@ StickyKeys Some of these key sequences optionally generate audible feedback of the change -in state, as described in See The -AccessXFeedback Control, or cause +in state, as described in See The +AccessXFeedback Control, or cause XkbAccessXNotify - events as described in See -Events. + events as described in See +Events. @@ -781,8 +779,8 @@ should generate when that overlay is enabled, assign it either the KB_Overlay1 or KB_Overlay2 - key behaviors, as described in See -Key Behavior. + key behaviors, as described in See +Key Behavior. @@ -793,11 +791,11 @@ Key Behavior. All of the controls described above, along with the AudibleBell - control (described in See Disabling -Server Generated Bells) and the + control (described in See Disabling +Server Generated Bells) and the IgnoreGroupLock - control (described in See Server -Internal Modifiers and Ignore Locks Behavior) comprise the + control (described in See Server +Internal Modifiers and Ignore Locks Behavior) comprise the boolean controls . In addition to any parameters listed in the descriptions of the individual controls, the boolean controls can be individually enabled or disabled by @@ -815,18 +813,18 @@ EnabledControls control or specified in any context that accepts only boolean controls: GroupsWrap - (See Computing Effective Modifier and -Group), + (See Computing Effective Modifier and +Group), EnabledControls , InternalMods - (See Server Internal Modifiers and -Ignore Locks Behavior), and + (See Server Internal Modifiers and +Ignore Locks Behavior), and IgnoreLockMods - (See Server Internal Modifiers and -Ignore Locks Behavior) and + (See Server Internal Modifiers and +Ignore Locks Behavior) and PerKeyRepeat - (See The RepeatKeys Control) + (See The RepeatKeys Control) @@ -838,8 +836,8 @@ PerKeyRepeat The auto-reset controls are a per-client value which consist of two masks that can contain any of the -boolean controls (see See "Boolean" -Controls and The EnabledControls Control). Whenever the client exits +boolean controls (see See "Boolean" +Controls and The EnabledControls Control). Whenever the client exits for any reason, any boolean controls specified in the auto-reset mask are set to the corresponding value from the @@ -853,8 +851,8 @@ automatically, even if abnormally terminated. For example, a client that replace the keyboard bell with some other audible cue might want to turn off the AudibleBell - control (See Disabling Server -Generated Bells) to prevent the server from also generating a sound and + control (See Disabling Server +Generated Bells) to prevent the server from also generating a sound and thus avoid cacophony. If the client were to exit without resetting the AudibleBell -- cgit v1.2.3 From b82c9b3f752c89d3328c0257d8a386024c9023ee Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 15 Mar 2011 23:30:15 -0600 Subject: Remove duplicate 'See see' text in docs - take 2 --- specs/ch04.xml | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml index 631d1b0..ab1547a 100644 --- a/specs/ch04.xml +++ b/specs/ch04.xml @@ -99,7 +99,7 @@ whether or not it is supported. -See Querying and Changing Per-Client +Querying and Changing Per-Client Flags describes the XkbPerClientFlags request, which reports or changes values for all of the per-client flags, and @@ -148,7 +148,7 @@ rejection or release of any key to interested clients using AccessXNotify events. The AccessXNotify - event is described in more detail in See Events. + event is described in more detail in Events. @@ -183,7 +183,7 @@ interested clients by sending an AccessXNotify event. The AccessXNotify - event is described in more detail in See Events. + event is described in more detail in Events. @@ -375,7 +375,7 @@ When MouseKeys are active and a SA_MovePtr - key action (see See Key + key action (see Key Actions) is activated, a pointer motion event is generated immediately. If MouseKeysAccel @@ -515,11 +515,10 @@ StickyKeys Some of these key sequences optionally generate audible feedback of the change -in state, as described in See The +in state, as described in The AccessXFeedback Control, or cause XkbAccessXNotify - events as described in See -Events. + events as described in Events. @@ -779,7 +778,7 @@ should generate when that overlay is enabled, assign it either the KB_Overlay1 or KB_Overlay2 - key behaviors, as described in See + key behaviors, as described in Key Behavior. @@ -791,10 +790,10 @@ Key Behavior. All of the controls described above, along with the AudibleBell - control (described in See Disabling + control (described in Disabling Server Generated Bells) and the IgnoreGroupLock - control (described in See Server + control (described in Server Internal Modifiers and Ignore Locks Behavior) comprise the boolean controls . In addition to any parameters listed in the descriptions of the individual @@ -813,18 +812,18 @@ EnabledControls control or specified in any context that accepts only boolean controls: GroupsWrap - (See Computing Effective Modifier and + (Computing Effective Modifier and Group), EnabledControls , InternalMods - (See Server Internal Modifiers and + (Server Internal Modifiers and Ignore Locks Behavior), and IgnoreLockMods - (See Server Internal Modifiers and + (Server Internal Modifiers and Ignore Locks Behavior) and PerKeyRepeat - (See The RepeatKeys Control) + (The RepeatKeys Control) @@ -836,7 +835,7 @@ PerKeyRepeat The auto-reset controls are a per-client value which consist of two masks that can contain any of the -boolean controls (see See "Boolean" +boolean controls (see "Boolean" Controls and The EnabledControls Control). Whenever the client exits for any reason, any boolean controls specified in the auto-reset mask @@ -851,7 +850,7 @@ automatically, even if abnormally terminated. For example, a client that replace the keyboard bell with some other audible cue might want to turn off the AudibleBell - control (See Disabling Server + control (Disabling Server Generated Bells) to prevent the server from also generating a sound and thus avoid cacophony. If the client were to exit without resetting the -- cgit v1.2.3 From cb49f95af605bd5019e194eeb656d8789d57756a Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Mon, 3 Oct 2011 18:06:16 -0600 Subject: 1 - fix the capitolization of the ID attriutes to match either the or <funcdef> string it goes with. 2 - fix any <linkend>'s that were affected by 1. 3 - any <function> in the docs that has an actual funcdef, will become an olink. Signed-off-by: Matt Dew <marcoz@osource.org> --- specs/ch04.xml | 64 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 32 insertions(+), 32 deletions(-) (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml index ab1547a..4d804e2 100644 --- a/specs/ch04.xml +++ b/specs/ch04.xml @@ -1,4 +1,4 @@ -<chapter id='global_keyboard_controls'> +<chapter id='Global_Keyboard_Controls'> <title>Global Keyboard Controls @@ -15,7 +15,7 @@ Wisconsin-Madison WI 53705-2280. Phone: 608-262-6966. e-mail: info@trace.wisc.edu.. - + The RepeatKeys Control @@ -43,7 +43,7 @@ milliseconds. - + The PerKeyRepeat Control @@ -63,7 +63,7 @@ GetKeyboardControl - + Detectable Autorepeat @@ -99,7 +99,7 @@ whether or not it is supported. -Querying and Changing Per-Client +Querying and Changing Per-Client Flags describes the XkbPerClientFlags request, which reports or changes values for all of the per-client flags, and @@ -109,7 +109,7 @@ which lists the per-client flags that are supported. - + The SlowKeys Control @@ -148,11 +148,11 @@ rejection or release of any key to interested clients using AccessXNotify events. The AccessXNotify - event is described in more detail in Events. + event is described in more detail in Events. - + The BounceKeys Control @@ -183,11 +183,11 @@ interested clients by sending an AccessXNotify event. The AccessXNotify - event is described in more detail in Events. + event is described in more detail in Events. - + The StickyKeys Control @@ -320,7 +320,7 @@ XkbAX_LatchToLock - + The MouseKeys Control @@ -347,7 +347,7 @@ do not explicitly specify a button. - + The MouseKeysAccel Control @@ -375,7 +375,7 @@ When MouseKeys are active and a SA_MovePtr - key action (see Key + key action (see Key Actions) is activated, a pointer motion event is generated immediately. If MouseKeysAccel @@ -388,7 +388,7 @@ mouse keys interval - + Relative Pointer Motion @@ -464,7 +464,7 @@ steps_to_max - + Absolute Pointer Motion @@ -478,7 +478,7 @@ specified in the action. - + The AccessXKeys Control @@ -515,15 +515,15 @@ StickyKeys Some of these key sequences optionally generate audible feedback of the change -in state, as described in The +in state, as described in The AccessXFeedback Control, or cause XkbAccessXNotify - events as described in Events. + events as described in Events. - + The AccessXTimeout Control @@ -568,7 +568,7 @@ AccessX Controls Values - + The AccessXFeedback Control @@ -744,7 +744,7 @@ DumbBellFB - + The Overlay1 and Overlay2 Controls @@ -778,22 +778,22 @@ should generate when that overlay is enabled, assign it either the KB_Overlay1 or KB_Overlay2 - key behaviors, as described in + key behaviors, as described in Key Behavior. - + "Boolean" Controls and The EnabledControls Control All of the controls described above, along with the AudibleBell - control (described in Disabling + control (described in Disabling Server Generated Bells) and the IgnoreGroupLock - control (described in Server + control (described in Server Internal Modifiers and Ignore Locks Behavior) comprise the boolean controls . In addition to any parameters listed in the descriptions of the individual @@ -812,30 +812,30 @@ EnabledControls control or specified in any context that accepts only boolean controls: GroupsWrap - (Computing Effective Modifier and + (Computing Effective Modifier and Group), EnabledControls , InternalMods - (Server Internal Modifiers and + (Server Internal Modifiers and Ignore Locks Behavior), and IgnoreLockMods - (Server Internal Modifiers and + (Server Internal Modifiers and Ignore Locks Behavior) and PerKeyRepeat - (The RepeatKeys Control) + (The RepeatKeys Control) - + Automatic Reset of Boolean Controls The auto-reset controls are a per-client value which consist of two masks that can contain any of the -boolean controls (see "Boolean" +boolean controls (see "Boolean" Controls and The EnabledControls Control). Whenever the client exits for any reason, any boolean controls specified in the auto-reset mask @@ -850,7 +850,7 @@ automatically, even if abnormally terminated. For example, a client that replace the keyboard bell with some other audible cue might want to turn off the AudibleBell - control (Disabling Server + control (Disabling Server Generated Bells) to prevent the server from also generating a sound and thus avoid cacophony. If the client were to exit without resetting the -- cgit v1.2.3 From b0f7912512091ea58dfaf8dffb2a658a6afeb96d Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Mon, 16 Jan 2012 15:38:49 -0700 Subject: informaltable cleanup On certain tables, add top and bottom borders to table header and a bottom border to the table. This matches what those tables in the old pdfs looked like. the prevents tables from splitting across pages. Useful for tiny tables. Converting the colwidth to a floating point, IE, 1* -> 1.0* cleans up these build errors: WARNING: table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) Signed-off-by: Matt Dew --- specs/ch04.xml | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) (limited to 'specs/ch04.xml') diff --git a/specs/ch04.xml b/specs/ch04.xml index 4d804e2..d35e2b4 100644 --- a/specs/ch04.xml +++ b/specs/ch04.xml @@ -597,12 +597,13 @@ accessX timeout options mask . XKB defines the following feedback tones: - - - - - - + + + + + + + Feedback Name @@ -612,49 +613,49 @@ accessX timeout options mask - + FeatureFB AX_FeatureOn rising tone Keyboard control enabled - + AX_FeatureOff falling tone Keyboard control disabled - + AX_FeatureChange two tones Several controls changed state - + IndicatorFB AX_IndicatorOn high tone Indicator Lit - + AX_IndicatorOff low tone Indicator Extinguished - + AX_IndicatorChange two high tones Several indicators changed state - + SlowWarnFB AX_SlowKeysWarning three high tones Shift key held for four seconds - + SKPressFB AX_SlowKeyPress single tone @@ -662,7 +663,7 @@ accessX timeout options mask SlowKeys are on - + SKReleaseFB AX_SlowKeyRelease single tone @@ -670,7 +671,7 @@ SlowKeys SlowKeys are on - + SKAcceptFB AX_SlowKeyAccept single tone @@ -678,7 +679,7 @@ SlowKeys SlowKeys - + SKRejectFB AX_SlowKeyReject low tone @@ -686,7 +687,7 @@ SlowKeys SlowKeys - + StickyKeysFB AX_StickyLatch low tone then high tone @@ -694,7 +695,7 @@ SlowKeys StickyKeys - + AX_StickyLock high tone @@ -702,7 +703,7 @@ StickyKeys StickyKeys - + AX_StickyUnlock low tone @@ -710,7 +711,7 @@ StickyKeys StickyKeys - + BKRejectFB AX_BounceKeysReject low tone -- cgit v1.2.3