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
46 .Op Fl VH Op Fl U Ar distance
47 .Op Fl a Ar X Ns Op , Ns Ar Y
54 .Op Fl 3 Op Fl E Ar timeout
55 .Op Fl T Ar distance Ns Op , Ns Ar time Ns Op , Ns Ar after
65 utility and the console driver work together to support
66 mouse operation in the text console and user programs.
67 They virtualize the mouse and provide user programs with mouse data
68 in the standard format
72 The mouse daemon listens to the specified port for mouse data,
73 interprets and then passes it via ioctls to the console driver.
75 reports translation movement, button press/release
76 events and movement of the roller or the wheel if available.
77 The roller/wheel movement is reported as
81 The console driver will display the mouse pointer on the screen
82 and provide cut and paste functions if the mouse pointer is enabled
83 in the virtual console via
87 is opened by the user program, the console driver also passes the mouse
88 data to the device so that the user program will see it.
90 If the mouse daemon receives the signal
92 it will reopen the mouse port and reinitialize itself.
94 the mouse is attached/detached while the system is suspended.
96 If the mouse daemon receives the signal
98 it will stop passing mouse events.
101 again will resume passing mouse events.
102 Useful if your typing on a laptop is
103 interrupted by accidentally touching the mouse pad.
105 The following options are available:
106 .Bl -tag -width indent
108 Emulate the third (middle) button for 2-button mice.
110 by pressing the left and right physical buttons simultaneously.
111 .It Fl C Ar threshold
112 Set double click speed as the maximum interval in msec between button clicks.
113 Without this option, the default value of 500 msec will be assumed.
114 This option will have effect only on the cut and paste operations
115 in the text mode console.
116 The user program which is reading mouse data
119 will not be affected.
121 Lower DTR on the serial port.
122 This option is valid only if
124 is selected as the protocol type.
125 The DTR line may need to be dropped for a 3-button mouse
130 When the third button emulation is enabled
136 msec at most before deciding whether two buttons are being pressed
138 The default timeout is 100 msec.
140 Set the report rate (reports/sec) of the device if supported.
143 .Dq Horizontal Virtual Scrolling .
144 With this option set, holding the middle mouse
145 button down will cause motion to be interpreted as
146 horizontal scrolling.
149 option to set the distance the mouse must move before the scrolling mode is
151 This option may be used with or without the
155 Write the process id of the
157 utility in the specified file.
158 Without this option, the process id will be stored in
159 .Pa /var/run/moused.pid .
161 Do not start the Plug and Play COM device enumeration procedure
162 when identifying the serial mouse.
163 If this option is given together with the
167 utility will not be able to print useful information for the serial mouse.
169 Lower RTS on the serial port.
170 This option is valid only if
172 is selected as the protocol type by the
175 It is often used with the
178 Both RTS and DTR lines may need to be dropped for
179 a 3-button mouse to operate in the
183 Select the baudrate for the serial port (1200 to 9600).
184 Not all serial mice support this option.
185 .It Fl T Ar distance Ns Op , Ns Ar time Ns Op , Ns Ar after
187 Use this option if mouse pointer slowly wanders when mouse is not moved.
190 (for example 4) pixels (X+Y) in
192 msec (default 500) are ignored, except during
194 msec (default 4000) since last real mouse movement.
197 .Dq Virtual Scrolling .
198 With this option set, holding the middle mouse
199 button down will cause motion to be interpreted as scrolling.
202 option to set the distance the mouse must move before the scrolling mode is
206 .Dq Virtual Scrolling
209 option can be used to set the
211 (in pixels) that the mouse must move before the scrolling
216 .It Fl a Ar X Ns Op , Ns Ar Y
217 Accelerate or decelerate the mouse input.
218 This is a linear acceleration only.
219 Values less than 1.0 slow down movement, values greater than 1.0 speed it
221 Specifying only one value sets the acceleration for both axes.
223 Some mice report middle button down events
224 as if the left and right buttons are being pressed.
225 This option handles this.
227 Enable debugging messages.
229 Do not become a daemon and instead run as a foreground process.
230 Useful for testing and debugging.
232 Print specified information and quit.
236 .Bl -tag -compact -width modelxxx
238 Port (device file) name, i.e.\&
244 Interface type: serial, bus, inport or ps/2.
247 It is one of the types listed under the
251 if the driver supports the
253 data format standard.
258 utility may not always be able to identify the model.
260 All of the above items.
261 Print port, interface, type and model in this order
267 utility cannot determine the requested information, it prints
272 Specifies at which level
274 should operate the mouse driver.
279 for more information on this.
281 Assign the physical button
283 to the logical button
285 You may specify as many instances of this option as you like.
286 More than one physical button may be assigned to a logical button at the
288 In this case the logical button will be down,
289 if either of the assigned physical buttons is held down.
290 Do not put space around
295 to communicate with the mouse.
296 .It Fl r Ar resolution
297 Set the resolution of the device; in Dots Per Inch, or
303 This option may not be supported by all the device.
305 Select a baudrate of 9600 for the serial line.
306 Not all serial mice support this option.
308 Specify the protocol type of the mouse attached to the port.
309 You may explicitly specify a type listed below, or use
313 utility automatically select an appropriate protocol for the given
315 If you entirely omit this option in the command line,
318 Under normal circumstances,
319 you need to use this option only if the
321 utility is not able to detect the protocol automatically
323 .Sx "Configuring Mouse Daemon" ) .
325 Note that if a protocol type is specified with this option, the
327 option above is implied and Plug and Play COM device enumeration
328 procedure will be disabled.
330 Also note that if your mouse is attached to the PS/2 mouse port, you should
335 regardless of the brand and model of the mouse.
337 mouse is attached to the bus mouse port, choose
341 Serial mouse protocols will not work with these mice.
343 For the USB mouse, the protocol must be
345 No other protocol will work with the USB mouse.
347 Valid types for this option are
350 For the serial mouse:
351 .Bl -tag -compact -width mousesystemsxxx
353 Microsoft serial mouse protocol.
354 Most 2-button serial mice use this protocol.
356 Microsoft IntelliMouse protocol.
360 Logitech MouseMan+ and FirstMouse+ use this protocol too.
361 Other mice with a roller/wheel may be compatible with this protocol.
363 MouseSystems 5-byte protocol.
364 3-button mice may use this protocol.
366 MM Series mouse protocol.
368 Logitech mouse protocol.
369 Note that this is for old Logitech models.
373 should be specified for newer models.
375 Logitech MouseMan and TrackMan protocol.
376 Some 3-button mice may be compatible
378 Note that MouseMan+ and FirstMouse+ use
380 protocol rather than this one.
382 ALPS GlidePoint protocol.
384 Kensington ThinkingMouse protocol.
386 Hitachi tablet protocol.
387 .It Ar x10mouseremote
390 Genius Kidspad and Easypad protocol.
392 Interlink VersaPad protocol.
395 GTCO Digipad protocol.
397 For the bus and InPort mouse:
398 .Bl -tag -compact -width mousesystemsxxx
400 This is the only protocol type available for
401 the bus and InPort mouse and should be specified for any bus mice
402 and InPort mice, regardless of the brand.
406 .Bl -tag -compact -width mousesystemsxxx
408 This is the only protocol type available for the PS/2 mouse
409 and should be specified for any PS/2 mice, regardless of the brand.
414 is the only protocol type available for the USB mouse
415 and should be specified for any USB mice, regardless of the brand.
417 Make the physical button
419 act as the wheel mode button.
420 While this button is pressed, X and Y axis movement is reported to be zero
421 and the Y axis movement is mapped to Z axis.
422 You may further map the Z axis movement to virtual buttons by the
426 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
430 .Bl -tag -compact -width x__
433 X or Y axis movement will be reported when the Z axis movement is detected.
435 Report down events for the virtual buttons
439 respectively when negative and positive Z axis movement
441 There do not need to be physical buttons
445 Note that mapping to logical buttons is carried out after mapping
446 from the Z axis movement to the virtual buttons is done.
448 Report down events for the virtual buttons
452 respectively when negative and positive Z axis movement
455 This is useful for the mouse with two wheels of which
456 the second wheel is used to generate horizontal scroll action,
457 and for the mouse which has a knob or a stick which can detect
458 the horizontal force applied by the user.
460 The motion of the second wheel will be mapped to the buttons
462 for the negative direction, and
464 for the positive direction.
469 actually exist in this mouse, their actions will not be detected.
471 Note that horizontal movement or second roller/wheel movement may not
473 because there appears to be no accepted standard as to how it is encoded.
475 Note also that some mice think left is the negative horizontal direction;
476 others may think otherwise.
477 Moreover, there are some mice whose two wheels are both mounted vertically,
478 and the direction of the second vertical wheel does not match the
482 .Ss Configuring Mouse Daemon
483 The first thing you need to know is the interface type
484 of the mouse you are going to use.
485 It can be determined by looking at the connector of the mouse.
486 The serial mouse has a D-Sub female 9- or 25-pin connector.
487 The bus and InPort mice have either a D-Sub male 9-pin connector
488 or a round DIN 9-pin connector.
489 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
490 Some mice come with adapters with which the connector can
491 be converted to another.
492 If you are to use such an adapter,
493 remember the connector at the very end of the mouse/adapter pair is
495 The USB mouse has a flat rectangular connector.
497 The next thing to decide is a port to use for the given interface.
498 For the bus, InPort and PS/2 mice, there is little choice:
499 the bus and InPort mice always use
501 and the PS/2 mouse is always at
503 There may be more than one serial port to which the serial
504 mouse can be attached.
505 Many people often assign the first, built-in
509 You can attach multiple USB mice to your system or to your USB hub.
510 They are accessible as
511 .Pa /dev/ums0 , /dev/ums1 ,
514 You may want to create a symbolic link
516 pointing to the real port to which the mouse is connected, so that you
517 can easily distinguish which is your
521 The next step is to guess the appropriate protocol type for the mouse.
524 utility may be able to automatically determine the protocol type.
529 option and see what it says.
530 If the command can identify
531 the protocol type, no further investigation is necessary on your part.
532 You may start the daemon without explicitly specifying a protocol type
536 The command may print
538 if the mouse driver supports this protocol type.
546 option do not necessarily match the product name of the pointing device
547 in question, but they may give the name of the device with which it is
552 option yields nothing, you need to specify a protocol type to the
557 You have to make a guess and try.
558 There is rule of thumb:
560 .Bl -enum -compact -width 1.X
562 The bus and InPort mice always use
564 protocol regardless of the brand of the mouse.
568 protocol should always be specified for the PS/2 mouse
569 regardless of the brand of the mouse.
573 protocol for the USB mouse.
575 Most 2-button serial mice support the
579 3-button serial mice may work with the
582 If it does not, it may work with the
585 the third (middle) button will not function.
586 3-button serial mice may also work with the
588 protocol under which the third button may function as expected.
590 3-button serial mice may have a small switch to choose between
611 If the mouse has a roller or a wheel, it may be compatible with the
616 To test if the selected protocol type is correct for the given mouse,
617 enable the mouse pointer in the current virtual console,
619 .Dl "vidcontrol -m on"
621 start the mouse daemon in the foreground mode,
623 .Dl "moused -f -p <selected_port> -t <selected_protocol>"
625 and see if the mouse pointer travels correctly
626 according to the mouse movement.
627 Then try cut & paste features by
628 clicking the left, right and middle buttons.
632 As many instances of the mouse daemon as the number of mice attached to
633 the system may be run simultaneously; one
634 instance for each mouse.
635 This is useful if the user wants to use the built-in PS/2 pointing device
636 of a laptop computer while on the road, but wants to use a serial
637 mouse when s/he attaches the system to the docking station in the office.
638 Run two mouse daemons and tell the application program
640 .Tn "X\ Window System" )
643 then the application program will always see mouse data from either mouse.
644 When the serial mouse is not attached, the corresponding mouse daemon
645 will not detect any movement or button state change and the application
646 program will only see mouse data coming from the daemon for the
648 In contrast when both mice are attached and both of them
649 are moved at the same time in this configuration,
650 the mouse pointer will travel across the screen just as if movement of
651 the mice is combined all together.
653 .Bl -tag -width /dev/consolectl -compact
654 .It Pa /dev/consolectl
655 device to control the console
657 bus and InPort mouse driver
661 virtualized mouse driver
666 .It Pa /var/run/moused.pid
667 process id of the currently running
670 .It Pa /var/run/MouseRemote
671 UNIX-domain stream socket for X10 MouseRemote events
674 .Dl "moused -p /dev/cuad0 -i type"
678 utility determine the protocol type of the mouse at the serial port
680 If successful, the command will print the type, otherwise it will say
682 .Bd -literal -offset indent
689 utility is able to identify the protocol type of the mouse at the specified
690 port automatically, you can start the daemon without the
692 option and enable the mouse pointer in the text console as above.
693 .Bd -literal -offset indent
694 moused -p /dev/mouse -t microsoft
698 Start the mouse daemon on the serial port
702 is explicitly specified by the
706 .Dl "moused -p /dev/mouse -m 1=3 -m 3=1"
708 Assign the physical button 3 (right button) to the logical button 1
709 (logical left) and the physical button 1 (left) to the logical
710 button 3 (logical right).
711 This will effectively swap the left and right buttons.
713 .Dl "moused -p /dev/mouse -t intellimouse -z 4"
715 Report negative Z axis movement (i.e., mouse wheel) as the button 4 pressed
716 and positive Z axis movement (i.e., mouse wheel) as the button 5 pressed.
720 .Dl "ALL ALL = NOPASSWD: /usr/bin/killall -USR1 moused"
723 .Pa /usr/local/etc/sudoers
726 .Dl "killall -USR1 moused"
728 to a key in your window manager, you can suspend mouse events on your laptop if
729 you keep brushing over the mouse pad while typing.
731 Many pad devices behave as if the first (left) button were pressed if
734 the surface of the pad.
735 In contrast, some ALPS GlidePoint and Interlink VersaPad models
736 treat the tapping action
737 as fourth button events.
741 to obtain the same effect as the other pad devices.
743 Cut and paste functions in the virtual console assume that there
744 are three buttons on the mouse.
745 The logical button 1 (logical left) selects a region of text in the
746 console and copies it to the cut buffer.
747 The logical button 3 (logical right) extends the selected region.
748 The logical button 2 (logical middle) pastes the selected text
749 at the text cursor position.
750 If the mouse has only two buttons, the middle, `paste' button
752 To obtain the paste function, use the
754 option to emulate the middle button, or use the
756 option to assign the physical right button to the logical middle button:
770 utility partially supports
771 .Dq Plug and Play External COM Device Specification
772 in order to support PnP serial mice.
773 However, due to various degrees of conformance to the specification by
774 existing serial mice, it does not strictly follow the version 1.0 of the
776 Even with this less strict approach,
777 it may not always determine an appropriate protocol type
778 for the given serial mouse.
782 utility first appeared in
788 utility was written by
789 .An Michael Smith Aq msmith@FreeBSD.org .
790 This manual page was written by
791 .An Mike Pritchard Aq mpp@FreeBSD.org .
792 The command and manual page have since been updated by
793 .An Kazutaka Yokota Aq yokota@FreeBSD.org .