summaryrefslogtreecommitdiff
path: root/xkbset.man
blob: 5d252b5b557a88d57f7a5520a2803baaa6ef8440 (plain)
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
.\" Copyright (c) 2000, 2002 Stephen Montgomery-Smith
.\" All rights reserved.
.\" 
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of Stephen Montgomery-Smith nor the names of his 
.\"    contributors may be used to endorse or promote products derived from 
.\"    this software without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE STEPHEN MONTGOMERY-SMITH AND CONTRIBUTORS 
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL STEPHEN MONTGOMERY-SMITH OR 
.\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
.\" OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
.\" POSSIBILITY OF SUCH DAMAGE.
.\" 
.TH XKBSET 1 __xorgversion__
.SH NAME
xkbset - user preference utility for XKB extensions for X
.SH SYNOPSIS
.B xkbset 
h | \fIoptions\fP | exp \fIexpire-options\fP | q [exp] | w [exp]

where \fIoptions\fP are any or all of:

[-]{bell | b}

[-]{repeatkeys \fIper-key_repeat> | r <per_key_repeat\fP}

perkeyrepeat \fIper-key_repeat\fP

[-]{repeatkeys | r} [rate \fIrepeat-delay> [<repeat_interval\fP]]

[-]{mousekeys | m} [\fImk-dflt_btn\fP]

[-]{mousekeysaccel | ma} [\fImk-delay> <mk_interval> <mk_time_to_max\fP 
\fImk-max_speed> <mk_curve\fP]

[-]{accessx | a}

[-]{sticky | st} [[-]twokey | [-]latchlock]...

[-]{slowkeys | sl} [\fIslow-keys_delay\fP]

[-]{bouncekeys | bo} [\fIdebounce-delay\fP]

[-]{feedback | f} [[-]dumbbell | [-]led | [-]feature | [-]slowwarn | 
[-]slowpress | [-]slowaccept | [-]slowreject | [-]slowrelease | 
[-]bouncereject | [-]stickybeep]...

[-]{overlay1 | ov1}

[-]{overlay2 | ov2}

groupswrap {redirect | clamp | wrap} [\fIgroups-wrap\fP]

[-]ignoregrouplock

nullify [[-]shift | [-]lock | [-]control | [-]mod1 | [-]mod2 | [-]mod3 | [-]mod4 | 
[-]mod5]...

ignorelock [[-]shift | [-]lock | [-]control | [-]mod1 | [-]mod2 | [-]mod3 | 
[-]mod4 | [-]mod5]...


and where \fIexpire-options\fP are any or all of:

\fIax-timeout\fP

[-|=]{bell | b}

[-|=]{repeatkeys | r}

[-|=]{mousekeys | m}

[-|=]{mousekeysaccel | ma}

[-|=]{accessx | a}

[-|=]{sticky | st} [[-|=]twokey | [-|=]latchlock]...

[-|=]{slowkeys | sl}

[-|=]{bouncekeys | bo}

[-|=]{feedback | f} [[-|=]dumbbell | [-|=]led | [-|=]feature | [-|=]slowwarn | 
[-|=]slowpress | [-|=]slowaccept | [-|=]slowreject | [-|=]slowrelease | 
[-|=]bouncereject | [-|=]stickybeep]...

[-|=]{overlay1 | ov1}

[-|=]{overlay2 | ov2}

[-|=]ignoregrouplock


.SH DESCRIPTION
This program can be used to set various options available in the XKB
extensions.  This includes such things as 
.B mousekeys
where one can use the numeric pad keys to move the mouse;
.B stickykeys
where modifiers like control and shift will lock until the
next key press (good for one finger typing);
.B slowkeys
where the keys will not work unless they are pressed for a certain
amount of time; and
.B bouncekeys
in which if a key is pressed more than once rapidly, only one key
press will be registered.
.SH OPTIONS
.\-------------------- b
.PP
.TP 8
.B b
The \fBb\fP option controls whether the bell is switched on or off.
.\-------------------- h
.PP
.TP 8
.B h
The \fBh\fP option (or no options) will type a rather helpful usage
message - definitely more informative than this unfinished man page.
.\-------------------- perkeyrepeat
.TP 8
.B perkeyrepeat \fIhex-mask\fP
With this option, \fIhex-mask\fP is a sequence of 64 hex digits,
representing 32 bytes.  These bytes represent which keys will autorepeat,
and which will not.  The 8n+kth key will autorepeat if the kth bit
of the nth byte is set.  See also the \fBr\fP or the \fBrepeatkey\fP
option.
.\-------------------- r
.TP 8
.B repeatkeys|r [\fIkey-code\fP | \fBrate\fP \fIdelay\fP [\fIinterval\fP] ]
The \fBr\fP or \fBrepeatkey\fP  option can be used to control the
autorepeat feature.  By itself, it can switch the autorepeat on
or off.  Followed by a single number, it can be used
to switch autorepeat on or off for that particular keycode (see also the
\fBperkeyrepeat\fP option).  Followed by \fBrate\fP, it can be used
to set the time in milliseconds after the key is pressed before autorepeat
will start, and optionally the time in milliseconds between the key
repeats.
.SH BUGS
In some earlier versions of X, some of the features do not work
properly.  For example, 
mousekeys acceleration.  Also, the
.B perkeyrepeat
option (or
.B repeatkey
followed by a key code) did not work.  These are due to bugs in the
XKB extensions.  These bugs are fixed in more recent versions of X.

Also the man page is woefully incomplete.
.SH "SEE ALSO"
xset(1)
.SH AUTHOR
Stephen Montgomery-Smith, University of Missouri