2 .\" Mike Pritchard <mpp@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by Mike Pritchard.
15 .\" 4. Neither the name of the author nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nd pass mouse data to the console driver
44 .Op Fl r Ar resolution
60 and the console driver work together to support
61 mouse operation in the text console and user programs.
62 They virtualize the mouse and provide user programs with mouse data
63 in the standard format
64 .Pq see Xr sysmouse 4 .
66 The mouse daemon listens to the specified port for mouse data,
67 interprets and then passes it via ioctls to the console driver.
69 reports translation movement, button press/release
70 events and movement of the roller or the wheel if available.
71 The roller/wheel movement is reported as ``Z'' axis movement.
73 The console driver will display the mouse pointer on the screen
74 and provide cut and paste functions if the mouse pointer is enabled
75 in the virtual console via
79 is opened by the user program, the console driver also passes the mouse
80 data to the device so that the user program will see it.
82 If the mouse daemon receives the signal
84 it will reopen the mouse port and reinitializes itself. Useful if
85 the mouse is attached/detached while the system is suspended.
87 The following options are available:
88 .Bl -tag -width indent
90 Emulate the third (middle) button for 2-button mice. It is emulated
91 by pressing the left and right physical buttons simultaneously.
93 Set double click speed as the maximum interval in msec between button clicks.
94 Without this option, the default value of 500 msec will be assumed.
95 This option will have effect only on the cut and paste operations
96 in the text mode console. The user program which is reading mouse data
101 Lower DTR on the serial port.
102 This option is valid only if
104 is selected as the protocol type.
105 The DTR line may need to be dropped for a 3-button mouse
110 Set the report rate (reports/sec) of the device if supported.
112 Write the process id of the
114 daemon in the specified file.
115 Without this option, the process id will be stored in
116 .Pa /var/run/moused.pid .
118 Do not start the Plug and Play COM device enumeration procedure
119 when identifying the serial mouse.
120 If this option is given together with the
124 command won't be able to print useful information for the serial mouse.
126 Lower RTS on the serial port.
127 This option is valid only if
129 is selected as the protocol type by the
131 option below. It is often used with the
133 option above. Both RTS and DTR lines may need to be dropped for
134 a 3-button mouse to operate in the
138 Select the baudrate for the serial port (1200 to 9600).
139 Not all serial mice support this option.
141 Some mice report middle button down events
142 as if the left and right buttons are pressed. This option handles this.
144 Enable debugging messages.
146 Do not become a daemon and instead run as a foreground process.
147 Useful for testing and debugging.
149 Print specified information and quit. Available pieces of
152 .Bl -tag -compact -width modelxxx
154 Port (device file) name, i.e.
160 Interface type: serial, bus, inport or ps/2.
162 Protocol type. It is one of the types listed under the
166 if the driver supports the
168 data format standard.
172 command may not always be able to identify the model.
174 All of the above items. Print port, interface, type and model in this order
180 command cannot determine the requested information, it prints ``unknown''
183 Assign the physical button
185 to the logical button
187 You may specify as many instances of this option as you like.
188 More than one physical button may be assigned to a logical button at the
189 same time. In this case the logical button will be down,
190 if either of the assigned physical buttons is held down.
191 Do not put space around `='.
195 to communicate with the mouse.
196 .It Fl r Ar resolution
197 Set the resolution of the device; in Dots Per Inch, or
203 This option may not be supported by all the device.
205 Select a baudrate of 9600 for the serial line.
206 Not all serial mice support this option.
208 Specify the protocol type of the mouse attached to the port.
209 You may explicitly specify a type listed below, or use
213 command to automatically select an appropriate protocol for the given
215 If you entirely ommit this options in the command line,
218 Under normal circumstances,
219 you need to use this option only if the
221 command is not able to detect the protocol automatically
222 .Pq see the Sx Configuring Mouse Daemon .
224 Note that if a protocol type is specified with this option, the
226 option above is implied and Plug and Play COM device enumeration
227 procedure will be disabled.
229 Also note that if your mouse is attached to the PS/2 mouse port, you should
234 regardless of the brand and model of the mouse. Likewise, if your
235 mouse is attached to the bus mouse port, choose
239 Serial mouse protocols will not work with these mice.
241 For the USB mouse, the protocol must be
243 No other protocol will work with the USB mouse.
245 Valid types for this option are
248 For the serial mouse:
249 .Bl -tag -compact -width mousesystemsxxx
251 Microsoft serial mouse protocol. Most 2-button serial mice use this protocol.
253 Microsoft IntelliMouse protocol. Genius NetMouse, ASCII Mie Mouse,
254 Logitech MouseMan+ and FirstMouse+ use this protocol too.
255 Other mice with a roller/wheel may be compatible with this protocol.
257 MouseSystems 5-byte protocol. 3-button mice may use this protocol.
259 MM Series mouse protocol.
261 Logitech mouse protocol. Note that this is for old Logitech models.
265 should be specified for newer models.
267 Logitech MouseMan and TrackMan protocol. Some 3-button mice may be compatible
268 with this protocol. Note that MouseMan+ and FirstMouse+ use
270 protocol rather than this one.
272 ALPS GlidePoint protocol.
274 Kensington ThinkingMouse protocol.
276 Hitachi tablet protocol.
277 .It Ar x10mouseremote
280 Genius Kidspad and Easypad protocol.
282 Interlink VersaPad protocol.
285 For the bus and InPort mouse:
286 .Bl -tag -compact -width mousesystemsxxx
288 This is the only protocol type available for
289 the bus and InPort mouse and should be specified for any bus mice
290 and InPort mice, regardless of the brand.
294 .Bl -tag -compact -width mousesystemsxxx
296 This is the only protocol type available for the PS/2 mouse
297 and should be specified for any PS/2 mice, regardless of the brand.
302 is the only protocol type available for the USB mouse
303 and should be specified for any USB mice, regardless of the brand.
305 Make the physical button
307 act as the wheel mode button.
308 While this button is pressed, X and Y axis movement is reported to be zero
309 and the Y axis movement is mapped to Z axis.
310 You may further map the Z axis movement to virtual buttons by the
314 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
318 .Bl -tag -compact -width x__
321 X or Y axis movement will be reported when the Z axis movement is detected.
323 Report the virtual buttons
327 down events respectively when negative and positive Z axis movement
328 is detected. There doesn't need to be physical buttons
332 Note that mapping to logical buttons is carried out after mapping
333 from the Z axis movement to the virtual buttons is done.
336 .Ss Configuring Mouse Daemon
337 The first thing you need to know is the interface type
338 of the mouse you are going to use.
339 It can be determined by looking at the connector of the mouse.
340 The serial mouse has a D-Sub female 9- or 25-pin connector.
341 The bus and InPort mice have either a D-Sub male 9-pin connector
342 or a round DIN 9-pin connector.
343 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
344 Some mice come with adapters with which the connector can
345 be converted to another. If you are to use such an adapter,
346 remember the connector at the very end of the mouse/adapter pair is
348 The USB mouse has a flat rectangular connector.
350 The next thing to decide is a port to use for the given interface.
351 For the bus, InPort and PS/2 mice, there is little choice:
352 the bus and InPort mice always use
354 and the PS/2 mouse is always at
356 There may be more than one serial port to which the serial
357 mouse can be attached. Many people often assign the first, built-in
361 You can attach multiple USB mice to your system or to your USB hub.
362 They are accessible as
363 .Pa /dev/ums0, /dev/ums1,
366 You may want to create a symbolic link
368 pointing to the real port to which the mouse is connected, so that you
369 can easily distinguish which is your ``mouse'' port later.
371 The next step is to guess the appropriate protocol type for the mouse.
374 command may be able to automatically determine the protocol type.
379 option and see what it says. If the command can identify
380 the protocol type, no further investigation is necessary on your part.
381 You may start the daemon without explicitly specifying a protocol type
384 The command may print
386 if the mouse driver supports this protocol type.
394 option do not necessarily match the product name of the pointing device
395 in question, but they may give the name of the device with which it is
400 option yields nothing, you need to specify a protocol type to the
404 option. You have to make a guess and try.
405 There is rule of thumb:
407 .Bl -tag -compact -width 1.X
409 The bus and InPort mice always use
411 protocol regardless of the brand of the mouse.
415 protocol should always be specified for the PS/2 mouse
416 regardless of the brand of the mouse.
420 protocol for the USB mouse.
422 Most 2-button serial mice support the
426 3-button serial mice may work with the
428 protocol. If it doesn't, it may work with the
431 the third (middle) button won't function.
432 3-button serial mice may also work with the
434 protocol under which the third button may function as expected.
436 3-button serial mice may have a small switch to choose between ``MS''
437 and ``PC'', or ``2'' and ``3''.
438 ``MS'' or ``2'' usually mean the
441 ``PC'' or ``3'' will choose the
445 If the mouse has a roller or a wheel, it may be compatible with the
450 To test if the selected protocol type is correct for the given mouse,
451 enable the mouse pointer in the current virtual console,
455 start the mouse daemon in the foreground mode,
457 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
459 and see if the mouse pointer travels correctly
460 according to the mouse movement. Then try cut & paste features by
461 clicking the left, right and middle buttons. Type ^C to stop
464 As many instances of the mouse daemon as the number of mice attached to
465 the system may be run simultaneously; one
466 instance for each mouse.
467 This is useful if the user wants to use the built-in PS/2 pointing device
468 of a laptop computer while on the road, but wants to use a serial
469 mouse when s/he attaches the system to the docking station in the office.
470 Run two mouse daemons and tell the application program
471 .Pq such as the X Window System
474 then the application program will always see mouse data from either mice.
475 When the serial mouse is not attached, the corresponding mouse daemon
476 won't detect any movement or button state change and the application
477 program will only see mouse data coming from the daemon for the
478 PS/2 mouse. In contrast when both mice are attached and both of them
479 are moved at the same time in this configuration,
480 the mouse pointer will travel across the screen just as if movement of
481 the mice is combined all together.
483 .Bl -tag -width /dev/consolectl -compact
484 .It Pa /dev/consolectl
485 device to control the console
487 bus and InPort mouse driver
491 virtualized mouse driver
496 .It Pa /var/run/moused.pid
497 process id of the currently running
500 .It Pa /var/run/MouseRemote
501 UNIX-domain stream socket for X10 MouseRemote events
505 .Dl moused -p /dev/cuaa0 -i type
509 command determine the protocol type of the mouse at the serial port
511 If successful, the command will print the type, otherwise it will say
514 .Dl moused -p /dev/cuaa0
519 command is able to identify the protocol type of the mouse at the specified
520 port automatically, you can start the daemon without the
522 option and enable the mouse pointer in the text console as above.
524 .Dl moused -p /dev/mouse -t microsoft
527 Start the mouse daemon on the serial port
531 is explicitly specified by the
535 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
537 Assign the physical button 3 (right button) to the logical button 1
538 (logical left) and the physical button 1 (left) to the logical
539 button 3 (logical right).
540 This will effectively swap the left and right buttons.
542 .Dl moused -p /dev/mouse -t intellimouse -z 4
544 Report negative Z axis (roller) movement as the button 4 pressed
545 and positive Z axis movement as the button 5 pressed.
549 command does not currently work with the alternative console driver
552 Many pad devices behave as if the first (left) button were pressed if
553 the user `taps' the surface of the pad.
554 In contrast, some ALPS GlidePoint and Interlink VersaPad models
555 treat the tapping action
556 as fourth button events. Use the option ``-m 1=4'' for these models
557 to obtain the same effect as the other pad devices.
559 Cut and paste functions in the virtual console assume that there
560 are three buttons on the mouse.
561 The logical button 1 (logical left) selects a region of text in the
562 console and copies it to the cut buffer.
563 The logical button 3 (logical right) extends the selected region.
564 The logical button 2 (logical middle) pastes the selected text
565 at the text cursor position.
566 If the mouse has only two buttons, the middle, `paste' button
568 To obtain the paste function, use the
570 option to emulate the middle button, or use the
572 option to assign the physical right button to the logical middle button:
587 command partially supports
588 .Dq Plug and Play External COM Device Specification
589 in order to support PnP serial mice.
590 However, due to various degrees of conformance to the specification by
591 existing serial mice, it does not strictly follow the version 1.0 of the
592 standard. Even with this less strict approach,
593 it may not always determine an appropriate protocol type
594 for the given serial mouse.
598 command was written by
599 .An Michael Smith Aq msmith@FreeBSD.org .
600 This manual page was written by
601 .An Mike Pritchard Aq mpp@FreeBSD.org .
602 The command and manual page have since been updated by
603 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
607 command first appeared in
projects / FreeBSD / FreeBSD.git / blob