Debian Codegraph @

imwheel.1.html

raw
1 <HTML><HEAD><TITLE>Manpage of IMWheel</TITLE>
2 </HEAD><BODY>
3 <H1>IMWheel</H1>
4 Section: User Commands (1)<BR>Updated: September 8 2002<BR><A HREF="#index">Index</A>
5 <A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi">Return to Main Contents</A><HR>
6
7
8 <A NAME="lbAB">&nbsp;</A>
9 <H2>NAME</H2>
10
11 imwheel - a mouse wheel and stick interpreter for X Windows
12 <A NAME="lbAC">&nbsp;</A>
13 <H2>SYNOPSIS</H2>
14
15 <B>imwheel</B> [ <I>options</I> ]
16 <BR>
17
18 <A NAME="lbAD">&nbsp;</A>
19 <H2>DESCRIPTION</H2>
20
21 <I>IMWheel</I> is a universal mouse wheel and mouse stick translator for the X
22 Windows System. Using either a special version of gpm and it's /dev/gpmwheel
23 FIFO, or the support for a ZAxis on the mouse built into some servers, such as
24 XFree86. Utilizing the input from gpm or X Windows, imwheel translates mouse
25 wheel and mouse stick actions into keyboard events using the XTest extension to
26 X. Use <I>xdpyinfo</I> for information on the supported extensions in your X
27 server.
28 <P>
29
30 <A NAME="lbAE">&nbsp;</A>
31 <H2>COMMAND LINE OPTIONS</H2>
32
33 Available command line options are as follows:
34 <DL COMPACT>
35 <DT><B>-4, --flip-buttons</B><DD>
36 Flips the mouse buttons so that 4 is 5 and 5 is 4, reversing
37 the Up and Down actions. This would make 4 buttons somewhat useful!
38 This is the similar to using &quot;-b 54678&quot;, see the <B>-b</B> option.
39 See also <A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1+xmodmap">xmodmap</A>(1).
40 <DT><B>-b, --buttons</B> <I>button-spec</I><DD>
41 Remap buttons in <I>button-spec</I> to interpreted wheel/thumb input.
42 Also limits the button grab to the specified buttons when using the ZAxis method.
43 (see &quot;X WINDOWS ZAXIS METHOD&quot; below)
44 the <I>button-spec</I> may specify any of up to five buttons.
45 the <I>button-spec</I> is decoded in the following order for wheel input:
46 <DL COMPACT><DT><DD>
47 <DL COMPACT><DT><DD>
48 <PRE>
49
50 Index Interpreted As Button Number
51 <BR>
52 1 Wheel Up 4
53 <BR>
54 2 Wheel Down 5
55 <BR>
56 3 Wheel Left 6
57 <BR>
58 4 Wheel Right 7
59 <BR>
60 5 Thumb Button 1 8
61 <BR>
62 6 Thumb Button 2 9
63
64 </PRE>
65
66 </DL>
67
68 A <I>button-spec</I> of &quot;45&quot; will limit the grabbed buttons for only wheel up and down.
69 <BR>
70
71 A <I>button-spec</I> of &quot;67&quot; may be useful to use actual buttons 6 and 7 as wheel up
72 and down, and limit the grab to only those two buttons.
73 <BR>
74
75 A <I>button-spec</I> of &quot;0&quot; turns off any defined mapping, thus allowing for skips in
76 the <I>button-spec</I> for something that doesn't exist on your mouse.
77 <BR>
78
79 A <I>button-spec</I> of &quot;45006&quot; may be for normal wheel up/down and a thumb button 1, but
80 no horizontal wheel axis.
81 <BR>
82
83 The default <I>button-spec</I> is &quot;456789&quot;.
84 <BR>
85
86 See also <A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1+xmodmap">xmodmap</A>(1).
87 </DL>
88
89 <DT><B>-c, --config</B><DD>
90 Popup to configuration helper window imediately.
91 <BR>
92
93 See also <B>CONFIGURATION HELPER</B>
94 <DT><B>-D, --debug</B><DD>
95 Show all possible debug info while running. This spits out alot and I also
96 suggest using the <B>-d</B> option to prevent imwheel from detaching from the
97 controlling terminal.
98 <DT><B>-d, --detach</B><DD>
99 Actually this does the opposite of it's name, it prevents detachment from the
100 controlling terminal. (no daemon...) Control-C stops, etc...
101 <DT><B>-f, --focus</B><DD>
102 Forces the X event subwindow to be used instead of the original hack that would
103 replace the subwindow in the X event with a probed focus query (XGetInputFocus).
104 This should fix some compatability problems with some window managers, such as
105 window maker, and perhaps enlightenment. If nothing seems to be working right,
106 try toggling this on or off...
107 <DT><B>-g, --focus-events</B><DD>
108 Disable the use of focus events for button grabs. If your <B>@Excluded</B> windows
109 are not regrabbing the mouse buttons when exited, try toggling this on or off...
110 <DT><B>-h, --help</B><DD>
111 Short help on options plus version/author info.
112 <DT><B>-k, --kill</B><DD>
113 Attempts to kill old imwheel (useful only for <B>--wheel-fifo</B> method.)
114 Pidfile must be created for this to work (no <B>-p</B> or <B>--pid</B> option on
115 the previous imwheel invocation). Process IDs are
116 tested using /proc/${pid}/status Name: field ?= imwheel.
117 If /proc is not mounted then this fails everytime!
118 Otherwise, this ensures that the wrong process is not killed.
119 <DT><B>-p, --pid</B><DD>
120 Don't write a pid file for gpmwheel FIFO method. This is the only
121 method that uses the pid file. XGrab doesn't need it, so it just
122 issues a warning about starting multiple imwheels on the same
123 display. Some people really prefer this, especially when they are
124 not using a SUID root imwheel executable.
125 <DT><B>-q, --quit</B><DD>
126 Quit imwheel before entering event loop. Usful in killing an
127 imwheel running in gpmwheel FIFO mode after exiting XWindows,
128 if you're using pid files that is.
129 <BR>
130
131 Example: `imwheel -k -q' = kill and quit (option order doesn't matter)
132 <DT><B>-s, --sensitivity</B> <I>sum-min</I><DD>
133 (Stick mice, Wheel FIFO method only)
134 <BR>
135
136 like <B>-t</B> only this sets a minimum total amount of movment of the
137 stick or marble, before any action is taken. This works good
138 with the Marble type devices.
139 This should be a multiple of the threshhold as given by the <B>-t</B> option.
140 The default is 0, meaning that there is no sensitivity testing,
141 all input spawns an event.
142 See the <B>-t</B> option also.
143 (see &quot;STICK SENSITIVITY SETTINGS&quot; below)
144 <DT><B>-t, --threshhold</B> <I>minimum-pressure</I><DD>
145 Used with gpm only and then only with recognized stick mice.
146 stick mice send a pressure value ranging from 0(no pressure) to
147 7(hard push). This sets the minimum required pressure for
148 input to be registered. Setting it to zero will cause realtime sticking,
149 which is usually too much action for X to keep up. (max rate i saw was
150 100 events a second!). Once input is registered, it is summed up per axis,
151 and then it must equal or exceed the sensitivity setting to pass as an input.
152 See the <B>-s</B> option also, for sensitivity.
153 <BR>
154
155 The default is 2, to avoid slight presses on the 90-degree direction of the
156 intended while still getting to the intended direction. Setting this to 7 is
157 insane, because it requires the user to push as hard as possible everytime they
158 want something to happen! However it may not be so insane for people using
159 trackballs for input, as they may spin much faster per sample...
160 <BR>
161
162 (see &quot;STICK SENSITIVITY SETTINGS&quot; below)
163 <DT><B>-W, --wheel-fifo</B> <I>fifo</I><DD>
164 Use the gpm/jamd wheel fifo instead of XGrabMouse. See <B>GPM/JAMD WHEEL FIFO METHOD</B>
165 section. This method allows only one X display to be used. This is required
166 for the gpm method to work. This method only works with the imwheel version
167 of gpm and with jamd. To find out if you are running the imwheel version of gpm
168 use the following command and look for &quot;(imwheel)&quot; in the title:
169 <DL COMPACT><DT><DD>
170 <DL COMPACT><DT><DD>
171 <PRE>
172
173 gpm -v
174
175 </PRE>
176
177 </DL>
178
179 <I>fifo</I> names the named pipe (FIFO) created by gpm. It defaults to
180 &quot;/dev/gpmwheel&quot; (for <B>--wheel-fifo</B> only). The FIFO must exist before
181 running imwheel in this mode. using jamd requires you to name the correct fifo
182 because it doesn't use /dev/gpmwheel, but rather one of the /dev/jam_imwheel:0.0
183 named fifos created by jamd's imwheel module.
184 <BR>
185
186 <B>@Exclude</B> commands in the rc file are unused in this mode.
187 </DL>
188
189 <DT><B>-X, --display</B> <I>display</I><DD>
190 Use XServer at a specified <I>display</I> in standard X form.
191 Using this option is usful for multiple displays in the X Window ZAxis Method.
192 <DT><B>-x, --transpose</B><DD>
193 <P>
194 This swaps the X and Y axis of movement for stick input from a wheel-fifo.
195 </DL>
196 <P>
197
198 <A NAME="lbAF">&nbsp;</A>
199 <H2>X WINDOWS ZAXIS METHOD</H2>
200
201 This method is the only method that works with multiple X displays, using
202 multiple imwheels. Use multiple imwheels by either setting the DISPLAY
203 environment variable before running each imwheel, or use the <B>-X</B> or
204 <B>--display</B> options to specify a different display for each imwheel.
205 Running multiple imwheels on the same display is not recommended, but is
206 allowed, and may cause strange things to happen while using the stick or wheel.
207 <P>
208
209 Edit the XF86Config and add/edit the following lines in the
210 &quot;Pointer&quot;(XFree86 3.3) or
211 &quot;InputDevice&quot;(XFree86 4.x)
212 section:
213 <P>
214
215 1 axis (vertical wheel):
216 <DL COMPACT><DT><DD>
217 <PRE>
218 (XFree86 3.3)
219 <DL COMPACT><DT><DD>Buttons 5
220 ZAxisMapping 4 5
221 </DL>
222 (XFree86 4.x)
223 <DL COMPACT><DT><DD>Option &quot;Buttons&quot; &quot;5&quot;
224 Option &quot;ZAxisMapping&quot; &quot;4 5&quot;
225 </DL>
226 </PRE>
227
228 </DL>
229
230 <P>
231
232 2 axis (1 stick or 2 perpendicular wheels):
233 <DL COMPACT><DT><DD>
234 <PRE>
235 (XFree86 3.3)
236 <DL COMPACT><DT><DD>Buttons 7
237 ZAxisMapping 4 5 6 7
238 </DL>
239 (XFree86 4.x)
240 <DL COMPACT><DT><DD>Option &quot;Buttons&quot; &quot;7&quot;
241 Option &quot;ZAxisMapping&quot; &quot;4 5 6 7&quot;
242 </DL>
243 </PRE>
244
245 </DL>
246
247 <P>
248
249 The Buttons option may be greater than stated above if you have thumb
250 buttons, or other extras that qualify as buttons.
251 <P>
252
253 Make sure your Protocol is set to either &quot;IMPS/2&quot; for a PS/2 mouse
254 or for serial mice set it to &quot;IntelliMouse&quot; or &quot;Auto&quot;.
255 This is for IntelliMouse compatible mice, other protocols may be required for other mice.
256 Then while running X Windows run imwheel <I>without</I> the <B>--wheel-fifo</B>
257 or <B>-W</B> options.
258 <P>
259
260 <B>NOTE</B>
261
262 <BR>
263
264 The <B>@Exclude</B> command must be used for clients that either use the ZAxis
265 for themselves and have no keyboard translations to cause the same desired
266 effect. The <B>@Exclude</B> command must also be added for any client requiring
267 mouse and/or mouse button grabs and that don't specify specific buttons to
268 grab. These clients fail when they try to grab the mouse because the buttons 4
269 and 5 are already grabbed by imwheel. XV is an example of a client that
270 requires these types of grabs to succeed. KDE clients use the ZAxis for their
271 own purposes. The supplied imwheelrc included and exclusion for XV already.
272 See the IMWheelRC section for more information.
273 <P>
274
275 Also pid files are not used for this method. Thus the <B>-p</B> and <B>--pid</B>
276 options have no effect, and are ignored.
277 <P>
278
279 <A NAME="lbAG">&nbsp;</A>
280 <H2>GPM/JAMD WHEEL FIFO METHOD</H2>
281
282 This method is REQUIRED for any X Windows server without wheel
283 mouse support built in. This method will currently support mice as supported
284 through gpm or jamd.
285 <P>
286
287 In the Pointer section of your XF86Config (or the equivalent configuration file
288 for your X server) change your mouse Protocol to be &quot;MouseSystems&quot;
289 (or the equivelant...), also change the Device file that the mouse is read from
290 to &quot;/dev/gpmdata&quot;, then restart X Windows if it is running.
291 jamd will replicate to /dev/jam_ps2:0.0 or some other devices as well,
292 make sure to use the right X Mouse protocol in this case,
293 like the jamd_ps2 device is X mouse protocol PS/2,
294 and the jamd_imps2 device is X mouse protocol IMPS/2.
295 <P>
296
297 Before starting X Windows (re)start gpm with the <B>-W</B> option. Make sure
298 you are using a supported wheel or stick mouse as stated in the gpm man page.
299 <P>
300
301 After starting X Windows run imwheel as follows adding options as desired:
302 <P>
303
304 for gpm you can use the following option to imwheel
305 <P>
306
307 <B>--wheel-fifo</B>
308 <P>
309
310 jamd requires you specify the fifo name as one of the /dev/jamd_imwheel:0.0
311 named fifos. Run
312 <P>
313
314 <B>ls -al /dev/jam_imwheel*</B>
315 <P>
316
317 to see what is available.
318 In this example I would use
319 <P>
320
321 <B>-W /dev/jam_imwheel:0.0</B>
322 <P>
323
324 as the option to imwheel.
325 <P>
326
327 I usually add the <B>-k</B> option to kill off any old imwheel processes left
328 over, as imwheel doesn't exit with the server, but rather it will only die if a
329 wheel or stick action occurs when an X server is not connected, such as when X
330 is dead or the DISPLAY environment variable is setup wrong, or the <B>-X</B> or
331 <B>--display</B> variables connected imwheel to a now defunct X server.
332 <P>
333
334 gpm or jamd, and/or imwheel can be restarted at any time, imwheel can sense when
335 gpm of jamd is not there, and gpm nor jamd doesn't give a hoot about imwheel
336 being up or not.
337 <P>
338
339 <B>NOTE</B>
340
341 <BR>
342
343 The @Exclude command has no bearing in this method, it is ignored. No Focus
344 change events are received in this method. Thus KDE and other clients that
345 support X based wheel events through the ZAxis are not going to work except
346 through normal imwheel keypress translation of wheel and stick actions.
347 <BR>
348
349 XV will function fine, as will any client that grabs the mouse and/or mouse
350 buttons. This mode doesn't use any grabs to function.
351 <P>
352
353 <A NAME="lbAH">&nbsp;</A>
354 <H2>STICK SENSITIVITY SETTINGS</H2>
355
356 The <B>-s</B> and <B>-t</B> options specify a sensitivity and threshhold.
357 each movement of a stick, or trackball, must equal or exceed the threshhold to
358 be added to the respective axis sum. In other words if you puch the stick up
359 hard enough to exceed the threshhold then the Y axis sum would be increased by
360 however much you pressed up.
361 <P>
362
363 Next the summed X and Y axis movement is each compared to the sensitivity setting.
364 If the sensitivity setting is equalled or exceeded, then one imwheel event is spawned,
365 thus after pressing up for a bit, the Y sum exceeds the sensitivity and a wheel up
366 event is interpreted by imwheel into an action such as a PageUp key.
367 <P>
368
369 The sensitivity therefore must be greater than the threshhold for it to have any
370 bearing on the input. Pseudo code such as the following may explain:
371 <DL COMPACT><DT><DD>
372 <PRE>
373 if(input &gt;= threshhold)
374 <DL COMPACT><DT><DD>sum = sum + input
375 </DL>
376 if(sum &gt;= sensitivity) {
377 <DL COMPACT><DT><DD>do an imwheel action
378 sum = 0
379 </DL>
380 }
381 </PRE>
382
383 </DL>
384
385 <A NAME="lbAI">&nbsp;</A>
386 <H2>IMWHEELRC</H2>
387
388 IMWheel uses, optionally, two configuration files. One called /etc/X11/imwheelrc,
389 which is used for everybody. The other is $HOME/.imwheelrc, used only for one
390 user. One is supplied and should have been installed automatically in /etc
391 if not also in the installing users $HOME as well. All whitespace is ignored
392 in the files except for within the window names' double quotes.
393 <P>
394
395 The configuration file consists of window names and event translations and/or
396 imwheel commands that begin with an `@' (at) symbol. Each window name starts a
397 section that is it's configuration. The window names a priortized as first
398 come first served, so more generic matches should always occur later in the
399 configuration file.
400 <P>
401
402 Comments are started with a pound (#) and extend to the end of the line.
403 <P>
404
405 <A NAME="lbAJ">&nbsp;</A>
406 <H2>IMWHEELRC WINDOW SECTION HEADERS</H2>
407
408 Window name section headers are actually one of four things:
409 <P>
410
411 <PRE>
412 Window Title
413 Window Class Name
414 Window Resource Name
415 (null) which matches &quot;\(null\)&quot; in the imwheelrc
416 </PRE>
417
418 <P>
419
420 Most of these are probe-able using fvwm2's FvwmIdent module or the configurator
421 (see the <B>CONFIGURATION HELPER</B> section). Other window managers may have their
422 own method of identifying windows' attributes.
423 <BR>
424
425 Each window name is matched as a regex string. Thus any window is matched using
426 the regex pattern &quot;.*&quot; as a window name. This pattern should be the last
427 section in your configuration file, or it will override the other window
428 configurations in the file for matched wheel/stick actions.
429 <BR>
430
431 There is one special header noted as &quot;(null)&quot; which matches windows that have a
432 null string in the three attributes. This makes it possible to assign actions
433 to even Quake3, which has no info for it's window. Just make sure that you
434 realize that the keys used should not be keys that may conflict with other
435 key actions in the game or application you are aiming to make work!
436 The included imwheelrc file has a &quot;(null)&quot; section included to demonstrate, and
437 it should work with Quake3.
438 <BR>
439
440 Each window/class/resource name <I>must</I> be enclosed in double quotes (&quot;) on a line by
441 itself.
442 <P>
443
444 Inside each window section is any number of translation definitions or commands.
445 Each translation definition or command must be on a line by itself. The window section doesn't have to be terminated, as it is terminated by either starting
446 another window section or the end of the configuration file.
447 <P>
448
449 <A NAME="lbAK">&nbsp;</A>
450 <H2>IMWHEELRC TRANSLATION DEFINITIONS</H2>
451
452 Mouse wheel/stick translations each take up a line after a window section has
453 been started. Each argument is seperated by commas(,) whitespace is ignored.
454 KeySyms are used to specify the keyboard input and outputs. pipes (|) are used
455 to join multiple keys into one input/output.
456 The format is as follows:
457 <P>
458
459 <B>REQUIRED</B>
460
461 <BR>
462
463 The following arguments a required to make a minimum translation definition.
464 <DL COMPACT>
465 <DT><I>Key Modifiers Input</I><DD>
466 X KeySyms joined by pipes that indicate the required keys pressed when the
467 mouse action is made in order for this translation to be used. Alt, Meta,
468 Control, and Shift keys are typical modifiers, but are stated slightly different
469 than just `Shift' but rather `Shift_L' or `Shift_R', differentiating between
470 left and right shift keys. See the KeySyms section for more.
471 <P>
472 `<B>None</B>' is a special KeySym used by imwheel, it is used to indicate no
473 modifiers. A blank entry is also acceptable in this case, but less descriptive
474 of what is going on! If `<B>None</B>' is used then there can be no modifiers
475 in use during the wheel action. If the field is blank then <I>any</I> modifier
476 will match, so put these last in their window section.
477 <DT><I>Mouse Action Input</I><DD>
478 This is the input from the mouse wheel or stick. It is one of the following and
479 <I>only</I> one:
480 <P>
481 <PRE>
482 Up
483 Down
484 Left
485 Right
486 Thumb
487 </PRE>
488
489 <P>
490 These are self explanatory. If you have trouble use the configurator!
491 <DT><I>Key Action Output</I><DD>
492 Out KeySyms are placed here. See KeySyms section for more on all available
493 KeySyms. Join KeySyms using pipes. Output keys are pressed in order and
494 released, in reverse order, only after all have been pressed, likely making
495 them all combined as in `Control_L|C' which would be a `^C' (control-c)
496 keypress.
497 </DL>
498 <P>
499
500 <B>OPTIONAL</B>
501
502 <BR>
503
504 The following options are optional, but to use one you must fill in all the
505 preceding arguments.
506 <DL COMPACT>
507 <DT><I>Output Repetitions</I><DD>
508 How many times should the Output KeySyms be pressed in a row.
509 <P>
510 Default is 1.
511 <DT><I>Delay Before KeyUp Event</I><DD>
512 How long in microseconds until we release all the Output KeySyms in one Output
513 Repetition.
514 <P>
515 Default is 0.
516 <DT><I>Delay Before Next KeyPress Event</I><DD>
517 How long in microseconds until we press the next the Output KeySyms.
518 Ths delay occurs after the Output KeySyms are released.
519 <P>
520 Default is 0.
521 </DL>
522 <P>
523
524 <A NAME="lbAL">&nbsp;</A>
525 <H2>IMWHEELRC COMMANDS</H2>
526
527 Commands start with the `@' character. Commands are as follows:
528 <DL COMPACT>
529 <DT><B>@Exclude</B><DD>
530 Exclude this window from imwheel grabing mouse events. imwheel will ungrab
531 the mouse when these windows are entered and not regrab the mouse until focus
532 is changed to a non-excluded window. This allows the ZAxis button events to
533 pass through normally and mouse grabs to succeed.
534 <BR>
535
536 XV and KDE clients need this for the X Windows Method.
537 <BR>
538
539 This command has no effect in the GPM Method. The mouse isn't grabbed, nor are
540 ZAxis button events created by the server.
541 <DT><B>@Repeat</B><DD>
542 Repeat the mouse button to the window. This cause a mouse button to be generated
543 in the current window. It does not use XSendEvent so the mouse button presses
544 are indistiguishable from the real thing. This mode is not compatible with the
545 XGrabButtons method of imwheel, otherwise listed as the ZAxis Method in this manpage.
546 <BR>
547
548 Motions are mapped as follows:
549 <DL COMPACT><DT><DD>
550 <DL COMPACT><DT><DD>
551 <PRE>
552
553 Up is button 4
554 Down is button 5
555 Left is button 6
556 Right is button 7
557 Thumb1 is button 8
558 Thumb2 is button 9
559 </PRE>
560
561 </DL>
562
563 </DL>
564
565 <DT><B>@Priority</B>=<I>priority</I><DD>
566 Using this is allowed in each window/class/resource section.
567 Higher <I>priority</I> values take precedence over lower ones.
568 Equal priorities on sections make the imwheelrc file parsed from top to bottom
569 to find the first match.
570 Thus <B>@Priority</B> can be used to make the file search for matches out of order,
571 then you dont have to keep the entries in order if you so please.
572 the supplied imwheelrc file contains extensive comments and examples of the
573 <B>@Priority</B> function.
574 <BR>
575
576 The default <I>priority</I> for any new section is 0.
577 The last <B>@Priority</B> command in a section overrides all previous priorities
578 for that section. Thus each section has only one <I>priority</I> setting in the end.
579 Priorities are kept as an int, thus range from INT_MAX to INT_MIN.
580 (see /usr/include/limits.h for these values on your system)
581 </DL>
582 <P>
583
584 <A NAME="lbAM">&nbsp;</A>
585 <H2>CONFIGURATION HELPER</H2>
586
587 IMWheel contains a semi-hidden configuration helper which can be brought up
588 by rolling/sticking up and down a few times in the root window of the X server.
589 Inside this window you can find out possible window names to use in your
590 imwheelrc file. Press on the mini-screen capture to grab another window,
591 including the root window (whole screen).
592 <P>
593
594 Mouse wheel and stick actions can be grabbed along with
595 active modifier keys on the keyboard. The mouse wheel/stick action is displayed
596 and the X KeySyms are displayed beneath it. All this information can be
597 directly entered into an imwheelrc as desired.
598 <P>
599
600 IMWheel can be restarted to read in a changed imwheelrc file or the
601 configurator can be canceled causing imwheel to resume oprations without
602 reading the configuration file. To restart imwheel execs itself as called by
603 the user in the first place but adding the <B>-R</B> option to indicate to
604 itself that this is a restarted imwheel. The <B>-R</B> is not for use by the
605 user, as it bypasses some configuration of imwheel.
606 <P>
607
608 <A NAME="lbAN">&nbsp;</A>
609 <H2>KEYSYMS</H2>
610
611 The program expects combinations of keysyms to be used by using pipe(|)
612 characters to combine them together.
613 <P>
614
615 Example:
616 <DL COMPACT><DT><DD>
617 <PRE>
618 Alt_R|Shift_R
619
620 </PRE>
621
622 Means right alt <I>and</I> right shift together, not just either one or the
623 other! And not one after the other, they are both pressed at the same time
624 essentially.
625 </DL>
626
627 <P>
628
629 For FIFO users, it is possible to send a real mouse button event, using
630 the special <B>Button#</B> syntax. An imwheelrc keysym of Button1 would
631 send a real Mouse button 1 (left mouse button) event. Mouse4 is what you'd want
632 for a MouseWheelUp type event. Mouse5 is what you want to MouseWheelDown event.
633 Many applications will understand the meaning of mouse button 4 and 5, but most don't
634 go beyond that. So <I>Mouse6 and greater have no &quot;standardized&quot; meaning</I>. The Button# syntax
635 can be combined with regular keysyms, to send keys and mouse buttons at the same time.
636 <P>
637
638 Example:
639 <DL COMPACT><DT><DD>
640 <PRE>
641 Shift_L|Button4
642 - meaning left shift and wheel up.
643 Button5
644 - meaning wheel down.
645 </PRE>
646
647 </DL>
648
649 <P>
650
651 Other button to imwheel meaniful references:
652 <DL COMPACT><DT><DD>
653 <PRE>
654 KeySym IMWheel Input Real Mouse
655 ------ ------------- ----------
656 Button1 (none) Left Mouse Button
657 Button2 (none) Middle Mouse Button
658 Button3 (none) Right Mouse Button
659 Button4 Up Mouse Wheel Up
660 Button5 Down Mouse Wheel Down
661 Button6 Left Mouse Wheel Left
662 Button7 Right Mouse Wheel Right
663 Button8 Thumb1 Side Mouse Button 1 (left/up)
664 Button9 Thumb2 Side Mouse Button 2 (right/down)
665 </DL>
666
667 Common Modifier Keysym names used in X:
668 Shift_L Shift_R
669 Control_L Control_R
670 Alt_L Alt_R
671 </PRE>
672
673 <P>
674
675 These are probably not currently assigned any keys, unless you <I>xmodmap</I> them in:
676 <P>
677
678 <PRE>
679 Meta_L Meta_R (Actually, Sun keyboards have this...)
680 Super_L Super_R
681 Hyper_L Hyper_R
682 </PRE>
683
684 <P>
685
686 And here's some that you may use, and they are <I>somewhere</I> on your keyboard:Here's where they were on my keyboard, again, this is not universal.
687 Use the <I>xev</I> program to test your own keys on your keyboard!
688 <P>
689
690 <PRE>
691 Caps_Lock = The Caps Lock key!
692 (This still turns on and off caps lock!)
693 Num_Lock = The Num Lock key!
694 (This is not good to use...
695 for the same reasons as Caps_Lock)
696 Multi_key = The Scroll Lock key!
697 (Go figure!)
698 Mode_switch = Right Alt...for me anyways.
699 (This mean I cannot use Alt_R)
700 </PRE>
701
702 <P>
703 The windows keys may not be assigned any KeySyms, but they will have numbers.
704 <I>xmodmap</I> can be used to assign them to a real KeySym.
705 <P>
706
707 To find keysym names for any keys available see the
708 <B>/usr/include/X11/keysymdef.h</B> file, and for any define in that file
709 remove the &quot;XK_&quot; for the usable KeySym name in the configuration file.
710 The path to this file may differ for you.
711 <P>
712
713 Remember, there's always the configurator.
714 And <B>xev</B> will also help here too!
715 <P>
716
717 <A NAME="lbAO">&nbsp;</A>
718 <H2>WHEEL OR STICK AS MIDDLE BUTTON IN X</H2>
719
720 Configure the XF86Config without &quot;Emulate3Buttons&quot; and increase &quot;Buttons&quot; if it is 2
721 in the Ponter or InputDevice section. The wheel or stick will act as a real
722 middle button and the outer two buttons will act as separate buttons (1 and 3),
723 even when pressed together.
724 <P>
725
726 Of course if your wheel keeps clicking middle button while you're trying to use the
727 wheel you may want to activate the Emulate3Buttons option to disable the wheel button!
728 And donn't forget to reduce the Buttons argument to 2!
729 <P>
730
731 <A NAME="lbAP">&nbsp;</A>
732 <H2>LEFTY BUTTON MAPPING IN X WINDOWS</H2>
733
734 For those of you lefties out there using method #1, the non-gpm method this
735 command may help you get the buttons set up correctly in XWindows for both
736 left handed and imwheel use.
737 <P>
738
739 <DL COMPACT><DT><DD>
740 <PRE>
741 xmodmap -e &quot;pointer = 3 2 1 4 5&quot;
742 <I>or</I>
743 xmodmap -e &quot;pointer = 3 2 1 4 5 6 7&quot;
744 <I>etc...</I>
745 xmodmap -e &quot;pointer = 3 2 1 4 5 6 7 8 9&quot;
746
747 NOTE: most of these are NOT going to work, because of all the limits in X.
748 </PRE>
749
750 </DL>
751
752 <P>
753
754 add more numbers to the end of this line if you have more buttons!
755 <P>
756
757 <A NAME="lbAQ">&nbsp;</A>
758 <H2>BUGS</H2>
759
760 Of course...but most of the time it's just that you haven't read everything I've written here and in the files of the distribution itself. Even then, you may be giving up too easily. Keep trying, it's not that hard. I am always working on reducing strange behavior. This is still a beta, as indicated by the leading 0 in the version number.
761 <P>
762
763 <B>Real Bugs</B>
764
765 <P>
766
767 imwheel doesn't get along with itself on the same X display or using the same
768 gpmwheel FIFO. - This will always be your fault :-/
769 <P>
770
771 Stick mice are still a pain in the butt to use. - This is the manufacturer's fault.
772 Or X Windows fault, for not having a method to easily use such devices in all applications.
773 <P>
774
775 Keyboard focus isn't changed automatically to input keys into Window mouse is
776 over. This only occurs with Click-to-Focus type focus managment in window managers.
777 I use sloppy focus in fvwm2, which always works for me. - Whose fault <I>is</I> this?
778 (Switch focus modes and/or window managers, or try the <B>-f</B> option on imwheel)
779 <P>
780
781 Configuration file is not validated for correctness nicely...although it does
782 get preparsed before the main program starts, thus stopping you before you run
783 with an invalid configuration file. I just have never made a bad configuration
784 file, so I guess I'll have to try and do that to see what happens. Just don't
785 make any mistakes and you'll be fine. - This is my fault?! ;)
786 <P>
787
788 <A NAME="lbAR">&nbsp;</A>
789 <H2>HOMEPAGE</H2>
790
791 <PRE>
792 <A HREF="http://jonatkins.org/imwheel">http://jonatkins.org/imwheel</A>
793 </PRE>
794
795 <P>
796 <P>
797
798 <A NAME="lbAS">&nbsp;</A>
799 <H2>AUTHOR</H2>
800
801 Jonathan Atkins &lt;<A HREF="mailto:[email protected]">[email protected]</A>&gt;
802 <P>
803 <P>
804
805 <A NAME="lbAT">&nbsp;</A>
806 <H2>FILES</H2>
807
808 <PRE>
809 $HOME/.imwheelrc
810 The users configuration file.
811
812 /etc/X11/imwheelrc
813 The global location for the configuration
814 file, it is always loaded. Overided by
815 the users configuration file.
816
817 /dev/gpmwheel
818 The default wheel FIFO from gpm, if used.
819
820 /dev/jam_imwheel:0.0 (or other numbers...)
821 A wheel FIFO from jamd, if used, must be specified.
822 jamd allows more than on FIFO, and thus allows more than
823 one instance of imwheel to be running on the same computer
824 when running imwheel on multiple displays
825 using the Wheel FIFO method.
826
827 /tmp/imwheel.pid
828 The public area for imwheel's pid file.
829
830 /var/run/imwheel.pid
831 The private area for imwheel's pid file.
832 </PRE>
833
834 <P>
835 <P>
836
837 <A NAME="lbAU">&nbsp;</A>
838 <H2>SEE ALSO</H2>
839
840 <PRE>
841 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1+jamd">jamd</A>(1)</B>
842 Jon Atkins Mouse - a replacement/augmentation for/to gpm.
843 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1x+xwheel">xwheel</A>(1x)</B>
844 The new replacement for imwheel. Uses jamd instead of gpm or ZAxis.
845 (may not be available yet)
846 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1x+xdpyinfo">xdpyinfo</A>(1x)</B>
847 X Display information, including extensions.
848 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?8+gpm">gpm</A>(8)</B>
849 General Purpose Mouse, imwheel edition required.
850 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1x+FvwmIdent">FvwmIdent</A>(1x)</B>
851 FVWM2's Identify module, for probing windows.
852 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?7+regex">regex</A>(7)</B>
853 POSIX 1003.2 Regular Expressions.
854 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1x+xmodmap">xmodmap</A>(1x)</B>
855 Utility for modifying keymap &amp; button mappings in X.
856 <B><A HREF="http://jcatki.dhs.org/cgi-bin/man2html.cgi?1x+xev">xev</A>(1x)</B>
857 Print contents of X events.
858 <B>/usr/include/X11/keysymdef.h</B>
859 X11 KeySym definitions.
860 <B>/usr/include/limits.h</B>
861 INT_MIN and INT_MAX definitions.
862 </PRE>
863
864 <P>
865
866 <HR>
867 <A NAME="index">&nbsp;</A><H2>Index</H2>
868 <DL>
869 <DT><A HREF="#lbAB">NAME</A><DD>
870 <DT><A HREF="#lbAC">SYNOPSIS</A><DD>
871 <DT><A HREF="#lbAD">DESCRIPTION</A><DD>
872 <DT><A HREF="#lbAE">COMMAND LINE OPTIONS</A><DD>
873 <DT><A HREF="#lbAF">X WINDOWS ZAXIS METHOD</A><DD>
874 <DT><A HREF="#lbAG">GPM/JAMD WHEEL FIFO METHOD</A><DD>
875 <DT><A HREF="#lbAH">STICK SENSITIVITY SETTINGS</A><DD>
876 <DT><A HREF="#lbAI">IMWHEELRC</A><DD>
877 <DT><A HREF="#lbAJ">IMWHEELRC WINDOW SECTION HEADERS</A><DD>
878 <DT><A HREF="#lbAK">IMWHEELRC TRANSLATION DEFINITIONS</A><DD>
879 <DT><A HREF="#lbAL">IMWHEELRC COMMANDS</A><DD>
880 <DT><A HREF="#lbAM">CONFIGURATION HELPER</A><DD>
881 <DT><A HREF="#lbAN">KEYSYMS</A><DD>
882 <DT><A HREF="#lbAO">WHEEL OR STICK AS MIDDLE BUTTON IN X</A><DD>
883 <DT><A HREF="#lbAP">LEFTY BUTTON MAPPING IN X WINDOWS</A><DD>
884 <DT><A HREF="#lbAQ">BUGS</A><DD>
885 <DT><A HREF="#lbAR">HOMEPAGE</A><DD>
886 <DT><A HREF="#lbAS">AUTHOR</A><DD>
887 <DT><A HREF="#lbAT">FILES</A><DD>
888 <DT><A HREF="#lbAU">SEE ALSO</A><DD>
889 </DL>
890 </BODY>
891 </HTML>