1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
|
<chapter id='Global_Keyboard_Controls'>
<title>Global Keyboard Controls</title>
<para>
The X Keyboard Extension supports a number of <emphasis>
global key controls</emphasis>
, 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<footnote><para>
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.</para></footnote>.
</para>
<sect1 id='The_RepeatKeys_Control'>
<title>The RepeatKeys Control</title>
<para>
The core protocol only allows control over whether or not the entire keyboard
or individual keys should autorepeat when held down. The <emphasis>
RepeatKeys</emphasis>
control extends this capability by adding control over the delay until a key
begins to repeat and the rate at which it repeats. <emphasis>
RepeatKeys</emphasis>
is also coupled with the core autorepeat control; changes to one are always
reflected in the other.
</para>
<para>
The <emphasis>
RepeatKeys</emphasis>
control has two parameters. The <emphasis>
autorepeat delay</emphasis>
specifies the delay between the initial press of an autorepeating key and the
first generated repeat event in milliseconds. The <emphasis>
autorepeat interval</emphasis>
specifies the delay between all subsequent generated repeat events in
milliseconds.
</para>
<sect2 id='The_PerKeyRepeat_Control'>
<title>The PerKeyRepeat Control</title>
<para>
When <emphasis>
RepeatKeys</emphasis>
are active, the <emphasis>
PerKeyRepeat</emphasis>
control specifies whether or not individual keys should autorepeat when held
down. XKB provides the <emphasis>
PerKeyRepeat</emphasis>
for convenience only, and it always parallels the <emphasis>
auto-repeats</emphasis>
field of the core protocol <emphasis>
GetKeyboardControl</emphasis>
request — changes to one are always reflected in the other.
</para>
</sect2>
<sect2 id='Detectable_Autorepeat'>
<title>Detectable Autorepeat</title>
<para>
The X server usually generates both press and release events whenever an
autorepeating key is held down. If an XKB-aware client enables the <emphasis>
DetectableAutorepeat</emphasis>
per-client option for a keyboard, the server sends that client a key release
event only when the key is <emphasis>
physically</emphasis>
released. For example, holding down a key to generate three characters without
detectable autorepeat yields:
</para>
<literallayout class='monospaced'>
Press <emphasis>-></emphasis> Release <emphasis>-></emphasis> Press <emphasis>-></emphasis> Release <emphasis>-></emphasis> Press <emphasis>-></emphasis> Release
</literallayout>
<para>
If detectable autorepeat is enabled, the client instead receives:
</para>
<literallayout class='monospaced'>
Press<emphasis>-></emphasis> Press <emphasis>-></emphasis> Press <emphasis>-></emphasis> Release
</literallayout>
<para>
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.
</para>
<para>
<link linkend='Querying_and_Changing_Per_Client_Flags'>Querying and Changing Per-Client
Flags</link> describes the <emphasis>
XkbPerClientFlags</emphasis>
request, which reports or changes values for all of the per-client flags, and
which lists the per-client flags that are supported.
</para>
</sect2>
</sect1>
<sect1 id='The_SlowKeys_Control'>
<title>The SlowKeys Control</title>
<para>
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 <emphasis>
SlowKeys</emphasis>
control helps filter these accidental bumps by telling the server to wait a
specified period, called the <emphasis>
SlowKeys acceptance delay</emphasis>
, 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
<emphasis>
SlowKeys</emphasis>
to accept it.
</para>
<para>
The <emphasis>
SlowKeys</emphasis>
control has one parameter; the <emphasis>
slow keys delay</emphasis>
specifies the length of time, in milliseconds, that a key must be held down
before it is accepted.
</para>
<para>
When <emphasis>
SlowKeys</emphasis>
are active, the X Keyboard Extension reports the initial press, acceptance,
rejection or release of any key to interested clients using <emphasis>
AccessXNotify</emphasis>
events. The <emphasis>
AccessXNotify</emphasis>
event is described in more detail in <link linkend='Events'>Events</link>.
</para>
</sect1>
<sect1 id='The_BounceKeys_Control'>
<title>The BounceKeys Control</title>
<para>
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 <emphasis>
BounceKeys</emphasis>
control temporarily disables a key after it has been pressed, effectively
"debouncing" the keyboard.
</para>
<para>
The <emphasis>
BounceKeys</emphasis>
has a single parameter. The <emphasis>
BounceKeys delay</emphasis>
specifies the period of time, in milliseconds, that the key is disabled after
it is pressed.
</para>
<para>
When <emphasis>
BounceKeys</emphasis>
are active, the server reports the acceptance or rejection of any key to
interested clients by sending an <emphasis>
AccessXNotify</emphasis>
event. The <emphasis>
AccessXNotify</emphasis>
event is described in more detail in <link linkend='Events'>Events</link>.
</para>
</sect1>
<sect1 id='The_StickyKeys_Control'>
<title>The StickyKeys Control</title>
<para>
Some people find it difficult or impossible to press two keys at once. The
<emphasis>
StickyKeys</emphasis>
control makes it easier for them to type by changing the behavior of the
modifier keys. When <emphasis>
StickyKeys</emphasis>
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 <emphasis>
Shift</emphasis>
key, release it, then press the <emphasis>
1</emphasis>
key.
</para>
<para>
By default, <emphasis>
StickyKeys</emphasis>
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.
</para>
<para>
Modifiers are automatically unlatched when the user presses a non-modifier key.
For instance, to enter the sequence <emphasis>
Shift</emphasis>
+<emphasis>
Ctrl</emphasis>
+<emphasis>
Z</emphasis>
the user could press and release the <emphasis>
Shift</emphasis>
key to latch the <emphasis>
Shift</emphasis>
modifier, then press and release the <emphasis>
Ctrl</emphasis>
key to latch the <emphasis>
Control</emphasis>
modifier — the <emphasis>
Ctrl</emphasis>
key is a modifier key, so pressing it does not unlatch the <emphasis>
Shift</emphasis>
modifier, but leaves both the <emphasis>
Shift</emphasis>
and <emphasis>
Control</emphasis>
modifiers latched, instead. When the user presses the <emphasis>
Z</emphasis>
key, it will be as though the user pressed <emphasis>
Shift</emphasis>
+<emphasis>
Ctrl</emphasis>
+<emphasis>
Z</emphasis>
simultaneously. The <emphasis>
Z</emphasis>
key is not a modifier key, so the <emphasis>
Shift</emphasis>
and <emphasis>
Control</emphasis>
modifiers are unlatched after the event is generated.
</para>
<para>
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 <emphasis>
Shift</emphasis>
key twice to lock the <emphasis>
Shift</emphasis>
modifier. Then, when the user presses the <emphasis>
9</emphasis>
, <emphasis>
‘</emphasis>
, <emphasis>
x</emphasis>
, <emphasis>
k</emphasis>
, <emphasis>
b</emphasis>
, <emphasis>
‘</emphasis>
, and <emphasis>
0</emphasis>
keys in sequence, it will generate ("XKB"). To unlock the <emphasis>
Shift</emphasis>
modifier, the user can press and release the <emphasis>
Shift</emphasis>
key.
</para>
<para>
Two option flags modify the behavior of the <emphasis>
StickyKeys</emphasis>
control:
</para>
<itemizedlist>
<listitem>
<para>If the <emphasis>
XkbAX_TwoKeys</emphasis>
flag is set, XKB automatically turns <emphasis>
StickyKeys</emphasis>
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.
</para>
</listitem>
<listitem>
<para>The <emphasis>
XkbAX_LatchToLock</emphasis>
controls the locking behavior of <emphasis>
StickyKeys</emphasis>
; the <emphasis>
StickyKeys</emphasis>
control only locks modifiers as described above if the <emphasis>
XkbAX_LatchToLock</emphasis>
flag is set.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id='The_MouseKeys_Control'>
<title>The MouseKeys Control</title>
<para>
The <emphasis>
MouseKeys</emphasis>
control lets a user control all the mouse functions from the keyboard. When
<emphasis>
MouseKeys</emphasis>
are enabled, all keys with <emphasis>
MouseKeys</emphasis>
actions bound to them generate core pointer events instead of normal key press
and release events.
</para>
<para>
The <emphasis>
MouseKeys</emphasis>
control has a single parameter, the <emphasis>
mouse keys default button</emphasis>
, which specifies the core pointer button to be used by mouse keys actions that
do not explicitly specify a button.
</para>
</sect1>
<sect1 id='The_MouseKeysAccel_Control'>
<title>The MouseKeysAccel Control</title>
<para>
If the <emphasis>
MouseKeysAccel</emphasis>
control is enabled, the effect of a pointer motion action changes as a key is
held down. The <emphasis>
mouse keys delay</emphasis>
specifies the amount of time between the initial key press and the first
repeated motion event. The <emphasis>
mouse keys interval</emphasis>
specifies the amount of time between repeated mouse keys events. The <emphasis>
steps to maximum acceleration</emphasis>
field specifies the total number of events before the key is travelling at
maximum speed. The <emphasis>
maximum acceleration</emphasis>
field specifies the maximum acceleration. The <emphasis>
curve</emphasis>
parameter controls the ramp used to reach maximum acceleration.
</para>
<para>
When <emphasis>
MouseKeys</emphasis>
are active and a <emphasis>
SA_MovePtr</emphasis>
key action (see <link linkend='Key_Actions'>Key
Actions</link>) is activated, a pointer motion event is generated immediately.
If <emphasis>
MouseKeysAccel</emphasis>
is enabled and if acceleration is enabled for the key in question, a second
event is generated after <emphasis>
mouse keys delay </emphasis>
milliseconds, and additional events are generated every <emphasis>
mouse keys interval</emphasis>
milliseconds for as long as the key is held down.
</para>
<sect2 id='Relative_Pointer_Motion'>
<title>Relative Pointer Motion</title>
<para>
If the <emphasis>
SA_MovePtr</emphasis>
action specifies relative motion, events are generated as follows: The initial
event always moves the cursor the distance specified in the action; after
<emphasis>
steps to maximum acceleration</emphasis>
events have been generated, all subsequent events move the pointer the
distance specified in the action times the <emphasis>
maximum acceleration.</emphasis>
Events after the first but before maximum acceleration has been achieved are
accelerated according to the formula:
</para>
<mediaobject>
<imageobject>
<imagedata format="SVG" fileref="XKBproto-1.svg"/>
</imageobject>
</mediaobject>
<para>
Where <emphasis>
action_delta</emphasis>
is the offset specified by the mouse keys action, <emphasis>
max_accel </emphasis>
and <emphasis>
steps_to_max</emphasis>
are parameters to the <emphasis>
MouseKeysAccel</emphasis>
ctrl, and the curveFactor is computed using the <emphasis>
MouseKeysAccel</emphasis>
<emphasis>
curve</emphasis>
parameter as follows:
</para>
<mediaobject>
<imageobject> <imagedata format="SVG" fileref="XKBproto-2.svg"/>
</imageobject>
</mediaobject>
<para>
With the result that a <emphasis>
curve</emphasis>
of <emphasis>
0</emphasis>
causes the distance moved to increase linearly from <emphasis>
action_delta</emphasis>
to <mediaobject>
<imageobject> <imagedata format="SVG" fileref="XKBproto-3.svg"/>
</imageobject>
</mediaobject>
, and the minimum legal <emphasis>
curve</emphasis>
of -<emphasis>
1000</emphasis>
causes all events after the first move at <emphasis>
max_accel</emphasis>
. A negative <emphasis>
curve</emphasis>
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 <emphasis>
steps_to_max</emphasis>
.
</para>
</sect2>
<sect2 id='Absolute_Pointer_Motion'>
<title>Absolute Pointer Motion</title>
<para>
If an <emphasis>
SA_MovePtr</emphasis>
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.
</para>
</sect2>
</sect1>
<sect1 id='The_AccessXKeys_Control'>
<title>The AccessXKeys Control</title>
<para>
If <emphasis>
AccessXKeys</emphasis>
is enabled many controls can also be turned on or off from the keyboard by
entering the following standard key sequences:
</para>
<itemizedlist>
<listitem>
<para>Holding down a shift key by itself for eight seconds toggles the
<emphasis>
SlowKeys</emphasis>
control.
</para>
</listitem>
<listitem>
<para>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 <emphasis>
StickyKeys</emphasis>
control.
</para>
</listitem>
<listitem>
<para>Simultaneously operating two or more modifier keys deactivates the
<emphasis>
StickyKeys</emphasis>
control.
</para>
</listitem>
</itemizedlist>
<para>
Some of these key sequences optionally generate audible feedback of the change
in state, as described in <link linkend='The_AccessXFeedback_Control'>The
AccessXFeedback Control</link>, or cause <emphasis>
XkbAccessXNotify</emphasis>
events as described in <link linkend='Events'>Events</link>.
</para>
</sect1>
<sect1 id='The_AccessXTimeout_Control'>
<title>The AccessXTimeout Control</title>
<para>
In environments where computers are shared, features such as <emphasis>
SlowKeys</emphasis>
present a problem: if <emphasis>
SlowKeys</emphasis>
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 <emphasis>
AccessXTimeout</emphasis>
control to automatically change the value of any global controls or AccessX
options if the keyboard is idle for a specified period of time.
</para>
<para>
The AccessXTimeout control has a number of parameters which affect the duration
of the timeout and the features changed when the timeout expires.
</para>
<para>
The <emphasis>
AccessX Timeout</emphasis>
field specifies the number of seconds the keyboard must be idle before the
global controls and AccessX options are modified. The <emphasis>
AccessX Options Mask</emphasis>
field specifies which values in the <emphasis>
AccessX Options</emphasis>
field are to be changed, and the <emphasis>
AccessX Options Values</emphasis>
field specifies the new values for those options. The <emphasis>
AccessX Controls Mask</emphasis>
field specifies which controls are to be changed in the global set of
<emphasis>
enabled controls</emphasis>
, and the <emphasis>
AccessX Controls Values</emphasis>
field specifies the new values for those controls.
</para>
</sect1>
<sect1 id='The_AccessXFeedback_Control'>
<title>The AccessXFeedback Control</title>
<para>
If <emphasis>
AccessXFeedback</emphasis>
is enabled, special beep-codes indicate changes in keyboard controls (or some
key events when <emphasis>
SlowKeys</emphasis>
or <emphasis>
StickyKeys</emphasis>
are active). Many beep codes sound as multiple tones, but XKB reports a single
<emphasis>
XkbBellNotify</emphasis>
event for the entire sequence of tones.
</para>
<para>
All feedback tones are governed by the <emphasis>
AudibleBell</emphasis>
control. Individual feedback tones can be explicitly enabled or disabled using
the <emphasis>
accessX options mask</emphasis>
or set to deactivate after an idle period using the <emphasis>
accessX timeout options mask</emphasis>
. XKB defines the following feedback tones:
</para>
<informaltable frame='none'>
<tgroup cols='4'>
<colspec align="left" colsep="0"/>
<colspec align="left" colsep="0"/>
<colspec align="left" colsep="0"/>
<colspec align="left" colsep="0"/>
<thead>
<row rowsep='1'>
<entry>Feedback Name</entry>
<entry>Bell Name</entry>
<entry>Default Sound</entry>
<entry>Indicates</entry>
</row>
</thead>
<tbody>
<row rowsep='0'>
<entry>FeatureFB</entry>
<entry>AX_FeatureOn</entry>
<entry>rising tone</entry>
<entry>Keyboard control enabled</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_FeatureOff</entry>
<entry>falling tone</entry>
<entry>Keyboard control disabled</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_FeatureChange</entry>
<entry>two tones</entry>
<entry>Several controls changed state</entry>
</row>
<row rowsep='0'>
<entry>IndicatorFB</entry>
<entry>AX_IndicatorOn</entry>
<entry>high tone</entry>
<entry>Indicator Lit</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_IndicatorOff</entry>
<entry>low tone</entry>
<entry>Indicator Extinguished</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_IndicatorChange</entry>
<entry>two high tones</entry>
<entry>Several indicators changed state</entry>
</row>
<row rowsep='0'>
<entry>SlowWarnFB</entry>
<entry>AX_SlowKeysWarning</entry>
<entry>three high tones</entry>
<entry>Shift key held for four seconds</entry>
</row>
<row rowsep='0'>
<entry>SKPressFB</entry>
<entry>AX_SlowKeyPress</entry>
<entry>single tone</entry>
<entry>Key press while <emphasis>
SlowKeys</emphasis>
are on</entry>
</row>
<row rowsep='0'>
<entry>SKReleaseFB</entry>
<entry>AX_SlowKeyRelease</entry>
<entry>single tone</entry>
<entry>Key release while <emphasis>
SlowKeys</emphasis>
are on</entry>
</row>
<row rowsep='0'>
<entry>SKAcceptFB</entry>
<entry>AX_SlowKeyAccept</entry>
<entry>single tone</entry>
<entry>Key event accepted by <emphasis>
SlowKeys</emphasis>
</entry>
</row>
<row rowsep='0'>
<entry>SKRejectFB</entry>
<entry>AX_SlowKeyReject</entry>
<entry>low tone</entry>
<entry>Key event rejected by <emphasis>
SlowKeys</emphasis>
</entry>
</row>
<row rowsep='0'>
<entry>StickyKeysFB</entry>
<entry>AX_StickyLatch</entry>
<entry>low tone then high tone</entry>
<entry>Modifier latched by <emphasis>
StickyKeys</emphasis>
</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_StickyLock</entry>
<entry>high tone</entry>
<entry>Modifier locked by <emphasis>
StickyKeys</emphasis>
</entry>
</row>
<row rowsep='0'>
<entry> </entry>
<entry>AX_StickyUnlock</entry>
<entry>low tone</entry>
<entry>Modifier unlocked by <emphasis>
StickyKeys</emphasis>
</entry>
</row>
<row rowsep='0'>
<entry>BKRejectFB</entry>
<entry>AX_BounceKeysReject</entry>
<entry>low tone</entry>
<entry>Key event rejected by <emphasis>
BounceKeys</emphasis>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
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.
</para>
<para>
If the physical keyboard bell is not very capable, attempts to simulate a
continuous tone with multiple bells can sound horrible. Set the <emphasis>
DumbBellFB</emphasis>
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
<emphasis>
DumbBellFB</emphasis>
option is set are implementation specific.
</para>
</sect1>
<sect1 id='The_Overlay1_and_Overlay2_Controls'>
<title>The Overlay1 and Overlay2 Controls</title>
<para>
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.
</para>
<para>
XKB includes direct support for two keyboard overlays, using the <emphasis>
Overlay1</emphasis>
and <emphasis>
Overlay2</emphasis>
controls. When <emphasis>
Overlay1</emphasis>
is enabled, all of the keys that are members of the first keyboard overlay
generate an alternate keycode. When <emphasis>
Overlay2</emphasis>
is enabled, all of the keys that are members of the second keyboard overlay
generate an alternate keycode.
</para>
<para>
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 <emphasis>
KB_Overlay1</emphasis>
or <emphasis>
KB_Overlay2</emphasis>
key behaviors, as described in <link linkend='Key_Behavior'>
Key Behavior</link>.
</para>
</sect1>
<sect1 id='Boolean_Controls_and_The_EnabledControls_Control'>
<title>"Boolean" Controls and The EnabledControls Control</title>
<para>
All of the controls described above, along with the <emphasis>
AudibleBell</emphasis>
control (described in <link linkend='Disabling_Server_Generated_Bells'>Disabling
Server Generated Bells</link>) and the <emphasis>
IgnoreGroupLock</emphasis>
control (described in <link linkend='Server_Internal_Modifiers_and_Ignore_Locks_Behavior'>Server
Internal Modifiers and Ignore Locks Behavior</link>) comprise the <emphasis>
boolean controls</emphasis>
. 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 <emphasis>
EnabledControls</emphasis>
control.
</para>
<para>
The following <emphasis>
non-boolean</emphasis>
controls are always active and cannot be changed using the <emphasis>
EnabledControls</emphasis>
control or specified in any context that accepts only boolean controls:
<emphasis>
GroupsWrap</emphasis>
(<link linkend='Computing_Effective_Modifier_and_Group'>Computing Effective Modifier and
Group</link>), <emphasis>
EnabledControls</emphasis>
, <emphasis>
InternalMods</emphasis>
(<link linkend='Server_Internal_Modifiers_and_Ignore_Locks_Behavior'>Server Internal Modifiers and
Ignore Locks Behavior</link>), and <emphasis>
IgnoreLockMods</emphasis>
(<link linkend='Server_Internal_Modifiers_and_Ignore_Locks_Behavior'>Server Internal Modifiers and
Ignore Locks Behavior</link>) and <emphasis>
PerKeyRepeat</emphasis>
(<link linkend='The_RepeatKeys_Control'>The RepeatKeys Control</link>)
</para>
</sect1>
<sect1 id='Automatic_Reset_of_Boolean_Controls'>
<title>Automatic Reset of Boolean Controls</title>
<para>
The <emphasis>
auto-reset controls</emphasis>
are a per-client value which consist of two masks that can contain any of the
boolean controls (see <link linkend='Boolean_Controls_and_The_EnabledControls_Control'>"Boolean"
Controls and The EnabledControls Control</link>). Whenever the client exits
for any reason, any boolean controls specified in the <emphasis>
auto-reset mask</emphasis>
are set to the corresponding value from the <emphasis>
auto-reset values</emphasis>
mask. This makes it possible for clients to "clean up after themselves"
automatically, even if abnormally terminated.
</para>
<para>
For example, a client that replace the keyboard bell with some other audible
cue might want to turn off the <emphasis>
AudibleBell</emphasis>
control (<link linkend='Disabling_Server_Generated_Bells'>Disabling Server
Generated Bells</link>) to prevent the server from also generating a sound and
thus avoid cacophony. If the client were to exit without resetting the
<emphasis>
AudibleBell </emphasis>
control, the user would be left without any feedback at all. Setting <emphasis>
AudibleBell</emphasis>
in both the auto-reset mask and auto-reset values guarantees that the audible
bell will be turned back on when the client exits.
</para>
</sect1>
</chapter>
|