| 1 |
.TH GPM-TYPES 7 "July 2000" |
| 2 |
.UC 4 |
| 3 |
.SH NAME |
| 4 |
gpm-types \- pointer types (mice, tablets, etc.) managed by gpm. |
| 5 |
.br |
| 6 |
The information below is extracted from the texinfo file, which is the |
| 7 |
preferred source of information. |
| 8 |
.SH DESCRIPTION |
| 9 |
This manpage |
| 10 |
describes the various pointer types currently available in gpm. If you |
| 11 |
look at the source code, you'll find that pointer-specific code is |
| 12 |
confined to `mice.c' (while it used to only include mouse decoders, |
| 13 |
gpm now supports tablets and touchscreens as well). |
| 14 |
|
| 15 |
.LP |
| 16 |
The mouse type is specified on command line with the `\-t' |
| 17 |
option. The option takes an argument, which represents the name of a |
| 18 |
mouse type. Each type can be associated to different names. For old |
| 19 |
mouse types, one name is the old selection-compatible name, and another |
| 20 |
is the XFree name. After version 1.18.1 of gpm, the number of |
| 21 |
synonyms was made arbitrary and the actual name being used is made |
| 22 |
available to the function responsible for mouse |
| 23 |
initialization. Therefore it is possible for a mouse decoder to behave |
| 24 |
slightly differently according to the name being used for the device (if |
| 25 |
this feature was already present, we wouldn't have for example ms+ |
| 26 |
and ms+lr as different mouse types). |
| 27 |
|
| 28 |
.LP |
| 29 |
The initialization procedure of each mouse type can also receive extra |
| 30 |
option, by means of the \-o command line option. Since |
| 31 |
interpretation of the option string is decoder-specific, the allowed |
| 32 |
options are described in association to each mouse type. When no |
| 33 |
description of option strings is provided, that means the option |
| 34 |
string is unused for that mouse type and specifying one generates an |
| 35 |
error. When the document refer to ``standard serial options'' it means |
| 36 |
that one of \-o dtr, \-o rts, \-o both can be specified to |
| 37 |
toggle the control lines of the serial port. |
| 38 |
|
| 39 |
.LP |
| 40 |
The following mouse type are corrently recognized: |
| 41 |
.TP |
| 42 |
bare Microsoft |
| 43 |
The Microsoft protocol, without any extension. It only reports |
| 44 |
two buttons. If your device has three, you should either try |
| 45 |
running the mman decoder or msc. In the latter case, |
| 46 |
you need to tell the mouse to talk msc protocol by |
| 47 |
toggling the DTR and RTS lines (with one of \-o drt, \-o |
| 48 |
rts or \-o both) or invoking `gpm \-t msc' while |
| 49 |
keeping the middle button pressed. Very annoying, indeed. |
| 50 |
This mouse decoder accepts standard serial options, although they |
| 51 |
should not be needed. |
| 52 |
.TP |
| 53 |
ms |
| 54 |
This is the original Microsoft protocol, with a middle-button |
| 55 |
extension. Some old two-button devices send some spurious |
| 56 |
packets which can be misunderstood as middle-button events. If |
| 57 |
this is your case, use the `bare' mouse type. Some new |
| 58 |
two-button devices are ``plug and play'', and they don't play |
| 59 |
fair at all; in this case try \-t pnp. Many (most) |
| 60 |
three-button devices that use the microsoft protocol fail to |
| 61 |
report some middle-button events during mouse motion. Since |
| 62 |
the protocol does not distinguish between the middle button |
| 63 |
going up and the middle button going down it would be liable |
| 64 |
to get out of step, so this decoder declares the middle button |
| 65 |
to be up whenever the mouse moves. This prevents dragging with |
| 66 |
the middle button, so you should probably use `\-t ms+lr' |
| 67 |
instead of this decoder, especially if you want to use X. |
| 68 |
This mouse decoder accepts standard serial options, although |
| 69 |
they should not be needed. |
| 70 |
.TP |
| 71 |
ms+ |
| 72 |
This is the same as `\-t ms' except that the middle button |
| 73 |
is not reset during mouse motion. So you can drag with the |
| 74 |
middle button. However, if your mouse exhibits the usual buggy |
| 75 |
behaviour the decoder is likely to get out of step with |
| 76 |
reality, thinking the middle button is up when it's down and |
| 77 |
vice versa. You should probably use `\-t ms+lr' instead |
| 78 |
of this decoder. This mouse decoder accepts standard serial |
| 79 |
options, although they should not be needed. |
| 80 |
.TP |
| 81 |
ms+lr |
| 82 |
This is the same as `\-t ms+' except that there is an |
| 83 |
additional facility to reset the state of the middle button by |
| 84 |
pressing the other two buttons together. Do this when the |
| 85 |
decoder gets into a confused state where it thinks the middle |
| 86 |
button is up when it's down and vice versa. (If you get sick |
| 87 |
of having to do this, please don't blame gpm; blame your buggy |
| 88 |
mouse! Note that most three-button mice that do the microsoft |
| 89 |
protocol can be made to do the MouseSystems protocol |
| 90 |
instead. The ``3 Button Serial Mouse mini-HOWTO'' has |
| 91 |
information about this.) This mouse decoder accepts standard |
| 92 |
serial options, although they should not be needed. |
| 93 |
|
| 94 |
.TP |
| 95 |
msc MouseSystems |
| 96 |
This is the standard protocol for three-button serial devices. |
| 97 |
Some of such devices only enter MouseSystem mode if the RTS, DTR |
| 98 |
or both lines are pushed low. Thus, you may try \-t msc |
| 99 |
associated with \-o rts, \-o dtr or \-o both. |
| 100 |
|
| 101 |
.TP |
| 102 |
mman Mouseman |
| 103 |
The protocol used by the new Logitech devices with three |
| 104 |
buttons. It is backward compatible with the Microsoft |
| 105 |
protocol, so if your mouse has three buttons and works with |
| 106 |
\-t ms or similar decoders you may try \-t mman instead |
| 107 |
to use the middle button. This mouse decoder accepts standard |
| 108 |
serial options, although they should not be needed. |
| 109 |
|
| 110 |
.TP |
| 111 |
sun |
| 112 |
The protocol used on Sparc computers and a few others. |
| 113 |
This mouse decoder accepts standard serial options, although |
| 114 |
they should not be needed. |
| 115 |
|
| 116 |
.TP |
| 117 |
mm MMSeries |
| 118 |
Title says it all. |
| 119 |
This mouse decoder accepts standard serial options, although |
| 120 |
they should not be needed. |
| 121 |
|
| 122 |
.TP |
| 123 |
logi Logitech |
| 124 |
This is the protocol used by old serial Logitech mice. |
| 125 |
|
| 126 |
.TP |
| 127 |
bm BusMouse |
| 128 |
Some bus devices use this protocol, including those produced |
| 129 |
by Logitech. |
| 130 |
|
| 131 |
.TP |
| 132 |
ps2 PS/2 |
| 133 |
The protocol used by most busmice. |
| 134 |
|
| 135 |
.TP |
| 136 |
ncr |
| 137 |
This `type' is able to decode the pointing pen found |
| 138 |
on some laptops (the NCR 3125 pen) |
| 139 |
|
| 140 |
.TP |
| 141 |
wacom |
| 142 |
The protocol used by the Wacom tablet. Since version 1.18.1 |
| 143 |
we have a new Wacom decoder, as the old one was not working |
| 144 |
with new tablets. This decoder was tested with Ultrapad, |
| 145 |
PenPartner, and Graphire tablets. |
| 146 |
Options: |
| 147 |
\-o relative (default) for relative mode, |
| 148 |
\-o absolute for absolute mode. |
| 149 |
|
| 150 |
.TP |
| 151 |
genitizer |
| 152 |
The \"Genitizer\" tablet, in relative mode. |
| 153 |
This mouse decoder accepts standard serial options, although |
| 154 |
they should not be needed. |
| 155 |
|
| 156 |
.TP |
| 157 |
logim |
| 158 |
Used to turn Logitech mice into Mouse-Systems-Compatible. |
| 159 |
Obviously, it only works with some of the Logitech mice. |
| 160 |
|
| 161 |
.TP |
| 162 |
pnp |
| 163 |
This decoder works with the new mice produces by our friend Bill, |
| 164 |
and maybe with the old ones as well. The Pnp protocol is |
| 165 |
hardwired at 1200 baud and is upset by normal initialization, so |
| 166 |
this is a \-t bare decoder with no initialization at all. |
| 167 |
This mouse decoder accepts standard serial options, although |
| 168 |
they should not be needed. |
| 169 |
|
| 170 |
.TP |
| 171 |
ms3 |
| 172 |
A decoder for the new serial IntelliMouse devices, the ones |
| 173 |
with three buttons and a protocol incompatible with older |
| 174 |
ones. The wheel is currently unused. |
| 175 |
|
| 176 |
.TP |
| 177 |
imps2 |
| 178 |
``IntelliMouse'' on the ps/2 port. This type can also be used for |
| 179 |
a generic 2-button ps/2 mouse too, since it will auto-detect the type. |
| 180 |
|
| 181 |
.TP |
| 182 |
netmouse |
| 183 |
Decodes the ``Genius NetMouse'' type of devices on the ps/2 |
| 184 |
port. For serial ``Netmouse'' devices, use the ``ms3'' decoder. |
| 185 |
|
| 186 |
|
| 187 |
.TP |
| 188 |
cal |
| 189 |
A decoder of the ``Calcomp UltraSlate device. |
| 190 |
|
| 191 |
.TP |
| 192 |
calr |
| 193 |
Same as above, but in relative mode. |
| 194 |
|
| 195 |
.TP |
| 196 |
twid |
| 197 |
Support for the twiddler keyboard. As of gpm-1.14 this decoder |
| 198 |
includes a char generator for the text console, but doesn't |
| 199 |
yet support X keycodes. If used with `\-R', `gpm' will anyway |
| 200 |
repeat mouse events to the X server. More information about twiddler |
| 201 |
support can be found in `README.twiddler', in the gpm |
| 202 |
distribution. |
| 203 |
|
| 204 |
.TP |
| 205 |
syn synaptics |
| 206 |
A decoder for the Synaptics TouchPad connected to the serial port. |
| 207 |
This mouse decoder accepts standard serial options, although |
| 208 |
they should not be needed. |
| 209 |
|
| 210 |
.TP |
| 211 |
synps2 synaptics_ps2 |
| 212 |
Same as above, but for the devices attached to the ps2 port. |
| 213 |
|
| 214 |
.TP |
| 215 |
brw |
| 216 |
A decoder for the Fellowes Browser, a device with 4 buttons |
| 217 |
and a wheel. |
| 218 |
This mouse decoder accepts standard serial options, although |
| 219 |
they should not be needed. |
| 220 |
|
| 221 |
.TP |
| 222 |
js Joystick |
| 223 |
This mouse type uses the joystick device to generate mouse |
| 224 |
events. It is only available if the header `linux/joystick.h' |
| 225 |
is found at compile time. The header (and the device as well) |
| 226 |
has been introduced only during 2.1 development, and is not |
| 227 |
present in version 2.0 of the kernel. |
| 228 |
|
| 229 |
.TP |
| 230 |
summa |
| 231 |
This is a decode for the Symmagraphics of Genius tablet, run in |
| 232 |
absolute mode. A repeater is associated to this decoder, so it |
| 233 |
can \-R summa can be used to generate X events even for other |
| 234 |
absolute-pointing devices, like touchscreens. To use the repeated |
| 235 |
data from X, you need a modified xf86Summa.o module. |
| 236 |
|
| 237 |
.TP |
| 238 |
mtouch |
| 239 |
A decoder for the MicroTouch touch screen. Please refer to the |
| 240 |
file `README.microtouch' in the source tree of gpm for |
| 241 |
further information. In the near future, anyways, I plan to fold |
| 242 |
back to this documentation the content of that file. |
| 243 |
|
| 244 |
.TP |
| 245 |
gunze |
| 246 |
A decoder for the gunze touch screen. Please refer to the |
| 247 |
file `README.gunze' in the source tree of gpm for |
| 248 |
further information. In the near future, anyways, I plan to fold |
| 249 |
back to this documentation the content of that file. The decoder |
| 250 |
accepts the following options: smooth=, debounce=. An |
| 251 |
higher smoothness results in slower motion as well; a smaller |
| 252 |
smoothness gives faster motion but, obviously, less smooth. |
| 253 |
The default smoothness is 9. The debounce time is express in |
| 254 |
milliseconds and is the minimum duration of an up-down event |
| 255 |
to be taken as a tap. Smaller bounces are ignored. |
| 256 |
|
| 257 |
.TP |
| 258 |
acecad |
| 259 |
The Acecad tablet in absolute mode. |
| 260 |
|
| 261 |
.TP |
| 262 |
wp wizardpad |
| 263 |
Genius WizardPad tablet |
| 264 |
|
| 265 |
|
| 266 |
|
| 267 |
.SH FILES |
| 268 |
.nf |
| 269 |
src/mice.c The source file for pointer decoders |
| 270 |
.fi |
| 271 |
|
| 272 |
.LP |
| 273 |
.SH SEE ALSO |
| 274 |
.nf |
| 275 |
\fB gpm(8) \fP The General Purpose Mouse server |
| 276 |
|
| 277 |
.fi |
| 278 |
The info file about `gpm', which gives more complete information and |
| 279 |
explains how to write a gpm client. |