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. Useful if
93 the mouse is attached/detached while the system is suspended.
95 If the mouse daemon receives the signal
97 it will stop passing mouse events. Sending the signal
99 again will resume passing mouse events. Useful if your typing on a laptop is
100 interrupted by accidentally touching the mouse pad.
102 The following options are available:
103 .Bl -tag -width indent
105 Emulate the third (middle) button for 2-button mice.
107 by pressing the left and right physical buttons simultaneously.
108 .It Fl C Ar threshold
109 Set double click speed as the maximum interval in msec between button clicks.
110 Without this option, the default value of 500 msec will be assumed.
111 This option will have effect only on the cut and paste operations
112 in the text mode console.
113 The user program which is reading mouse data
116 will not be affected.
118 Lower DTR on the serial port.
119 This option is valid only if
121 is selected as the protocol type.
122 The DTR line may need to be dropped for a 3-button mouse
127 When the third button emulation is enabled
133 msec at most before deciding whether two buttons are being pressed
135 The default timeout is 100 msec.
137 Set the report rate (reports/sec) of the device if supported.
140 .Dq Horizontal Virtual Scrolling .
141 With this option set, holding the middle mouse
142 button down will cause motion to be interpreted as
143 horizontal scrolling.
146 option to set the distance the mouse must move before the scrolling mode is
148 This option may be used with or without the
152 Write the process id of the
154 utility in the specified file.
155 Without this option, the process id will be stored in
156 .Pa /var/run/moused.pid .
158 Do not start the Plug and Play COM device enumeration procedure
159 when identifying the serial mouse.
160 If this option is given together with the
164 utility will not be able to print useful information for the serial mouse.
166 Lower RTS on the serial port.
167 This option is valid only if
169 is selected as the protocol type by the
172 It is often used with the
175 Both RTS and DTR lines may need to be dropped for
176 a 3-button mouse to operate in the
180 Select the baudrate for the serial port (1200 to 9600).
181 Not all serial mice support this option.
182 .It Fl T Ar distance Ns Op , Ns Ar time Ns Op , Ns Ar after
184 Use this option if mouse pointer slowly wanders when mouse is not moved.
187 (for example 4) pixels (X+Y) in
189 msec (default 500) are ignored, except during
191 msec (default 4000) since last real mouse movement.
194 .Dq Virtual Scrolling .
195 With this option set, holding the middle mouse
196 button down will cause motion to be interpreted as scrolling.
199 option to set the distance the mouse must move before the scrolling mode is
203 .Dq Virtual Scrolling
206 option can be used to set the
208 (in pixels) that the mouse must move before the scrolling
213 .It Fl a Ar X Ns Op , Ns Ar Y
214 Accelerate or decelerate the mouse input.
215 This is a linear acceleration only.
216 Values less than 1.0 slow down movement, values greater than 1.0 speed it
218 Specifying only one value sets the acceleration for both axes.
220 Some mice report middle button down events
221 as if the left and right buttons are being pressed.
222 This option handles this.
224 Enable debugging messages.
226 Do not become a daemon and instead run as a foreground process.
227 Useful for testing and debugging.
229 Print specified information and quit.
233 .Bl -tag -compact -width modelxxx
235 Port (device file) name, i.e.\&
241 Interface type: serial, bus, inport or ps/2.
244 It is one of the types listed under the
248 if the driver supports the
250 data format standard.
255 utility may not always be able to identify the model.
257 All of the above items.
258 Print port, interface, type and model in this order
264 utility cannot determine the requested information, it prints
269 Specifies at which level
271 should operate the mouse driver.
276 for more information on this.
278 Assign the physical button
280 to the logical button
282 You may specify as many instances of this option as you like.
283 More than one physical button may be assigned to a logical button at the
285 In this case the logical button will be down,
286 if either of the assigned physical buttons is held down.
287 Do not put space around
292 to communicate with the mouse.
293 .It Fl r Ar resolution
294 Set the resolution of the device; in Dots Per Inch, or
300 This option may not be supported by all the device.
302 Select a baudrate of 9600 for the serial line.
303 Not all serial mice support this option.
305 Specify the protocol type of the mouse attached to the port.
306 You may explicitly specify a type listed below, or use
310 utility automatically select an appropriate protocol for the given
312 If you entirely omit this option in the command line,
315 Under normal circumstances,
316 you need to use this option only if the
318 utility is not able to detect the protocol automatically
320 .Sx "Configuring Mouse Daemon" ) .
322 Note that if a protocol type is specified with this option, the
324 option above is implied and Plug and Play COM device enumeration
325 procedure will be disabled.
327 Also note that if your mouse is attached to the PS/2 mouse port, you should
332 regardless of the brand and model of the mouse.
334 mouse is attached to the bus mouse port, choose
338 Serial mouse protocols will not work with these mice.
340 For the USB mouse, the protocol must be
342 No other protocol will work with the USB mouse.
344 Valid types for this option are
347 For the serial mouse:
348 .Bl -tag -compact -width mousesystemsxxx
350 Microsoft serial mouse protocol.
351 Most 2-button serial mice use this protocol.
353 Microsoft IntelliMouse protocol.
357 Logitech MouseMan+ and FirstMouse+ use this protocol too.
358 Other mice with a roller/wheel may be compatible with this protocol.
360 MouseSystems 5-byte protocol.
361 3-button mice may use this protocol.
363 MM Series mouse protocol.
365 Logitech mouse protocol.
366 Note that this is for old Logitech models.
370 should be specified for newer models.
372 Logitech MouseMan and TrackMan protocol.
373 Some 3-button mice may be compatible
375 Note that MouseMan+ and FirstMouse+ use
377 protocol rather than this one.
379 ALPS GlidePoint protocol.
381 Kensington ThinkingMouse protocol.
383 Hitachi tablet protocol.
384 .It Ar x10mouseremote
387 Genius Kidspad and Easypad protocol.
389 Interlink VersaPad protocol.
392 GTCO Digipad protocol.
394 For the bus and InPort mouse:
395 .Bl -tag -compact -width mousesystemsxxx
397 This is the only protocol type available for
398 the bus and InPort mouse and should be specified for any bus mice
399 and InPort mice, regardless of the brand.
403 .Bl -tag -compact -width mousesystemsxxx
405 This is the only protocol type available for the PS/2 mouse
406 and should be specified for any PS/2 mice, regardless of the brand.
411 is the only protocol type available for the USB mouse
412 and should be specified for any USB mice, regardless of the brand.
414 Make the physical button
416 act as the wheel mode button.
417 While this button is pressed, X and Y axis movement is reported to be zero
418 and the Y axis movement is mapped to Z axis.
419 You may further map the Z axis movement to virtual buttons by the
423 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
427 .Bl -tag -compact -width x__
430 X or Y axis movement will be reported when the Z axis movement is detected.
432 Report down events for the virtual buttons
436 respectively when negative and positive Z axis movement
438 There do not need to be physical buttons
442 Note that mapping to logical buttons is carried out after mapping
443 from the Z axis movement to the virtual buttons is done.
445 Report down events for the virtual buttons
449 respectively when negative and positive Z axis movement
452 This is useful for the mouse with two wheels of which
453 the second wheel is used to generate horizontal scroll action,
454 and for the mouse which has a knob or a stick which can detect
455 the horizontal force applied by the user.
457 The motion of the second wheel will be mapped to the buttons
459 for the negative direction, and
461 for the positive direction.
466 actually exist in this mouse, their actions will not be detected.
468 Note that horizontal movement or second roller/wheel movement may not
470 because there appears to be no accepted standard as to how it is encoded.
472 Note also that some mice think left is the negative horizontal direction;
473 others may think otherwise.
474 Moreover, there are some mice whose two wheels are both mounted vertically,
475 and the direction of the second vertical wheel does not match the
479 .Ss Configuring Mouse Daemon
480 The first thing you need to know is the interface type
481 of the mouse you are going to use.
482 It can be determined by looking at the connector of the mouse.
483 The serial mouse has a D-Sub female 9- or 25-pin connector.
484 The bus and InPort mice have either a D-Sub male 9-pin connector
485 or a round DIN 9-pin connector.
486 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
487 Some mice come with adapters with which the connector can
488 be converted to another.
489 If you are to use such an adapter,
490 remember the connector at the very end of the mouse/adapter pair is
492 The USB mouse has a flat rectangular connector.
494 The next thing to decide is a port to use for the given interface.
495 For the bus, InPort and PS/2 mice, there is little choice:
496 the bus and InPort mice always use
498 and the PS/2 mouse is always at
500 There may be more than one serial port to which the serial
501 mouse can be attached.
502 Many people often assign the first, built-in
506 You can attach multiple USB mice to your system or to your USB hub.
507 They are accessible as
508 .Pa /dev/ums0 , /dev/ums1 ,
511 You may want to create a symbolic link
513 pointing to the real port to which the mouse is connected, so that you
514 can easily distinguish which is your
518 The next step is to guess the appropriate protocol type for the mouse.
521 utility may be able to automatically determine the protocol type.
526 option and see what it says.
527 If the command can identify
528 the protocol type, no further investigation is necessary on your part.
529 You may start the daemon without explicitly specifying a protocol type
533 The command may print
535 if the mouse driver supports this protocol type.
543 option do not necessarily match the product name of the pointing device
544 in question, but they may give the name of the device with which it is
549 option yields nothing, you need to specify a protocol type to the
554 You have to make a guess and try.
555 There is rule of thumb:
557 .Bl -enum -compact -width 1.X
559 The bus and InPort mice always use
561 protocol regardless of the brand of the mouse.
565 protocol should always be specified for the PS/2 mouse
566 regardless of the brand of the mouse.
570 protocol for the USB mouse.
572 Most 2-button serial mice support the
576 3-button serial mice may work with the
579 If it does not, it may work with the
582 the third (middle) button will not function.
583 3-button serial mice may also work with the
585 protocol under which the third button may function as expected.
587 3-button serial mice may have a small switch to choose between
608 If the mouse has a roller or a wheel, it may be compatible with the
613 To test if the selected protocol type is correct for the given mouse,
614 enable the mouse pointer in the current virtual console,
618 start the mouse daemon in the foreground mode,
620 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
622 and see if the mouse pointer travels correctly
623 according to the mouse movement.
624 Then try cut & paste features by
625 clicking the left, right and middle buttons.
629 As many instances of the mouse daemon as the number of mice attached to
630 the system may be run simultaneously; one
631 instance for each mouse.
632 This is useful if the user wants to use the built-in PS/2 pointing device
633 of a laptop computer while on the road, but wants to use a serial
634 mouse when s/he attaches the system to the docking station in the office.
635 Run two mouse daemons and tell the application program
637 .Tn "X\ Window System" )
640 then the application program will always see mouse data from either mouse.
641 When the serial mouse is not attached, the corresponding mouse daemon
642 will not detect any movement or button state change and the application
643 program will only see mouse data coming from the daemon for the
645 In contrast when both mice are attached and both of them
646 are moved at the same time in this configuration,
647 the mouse pointer will travel across the screen just as if movement of
648 the mice is combined all together.
650 .Bl -tag -width /dev/consolectl -compact
651 .It Pa /dev/consolectl
652 device to control the console
654 bus and InPort mouse driver
658 virtualized mouse driver
663 .It Pa /var/run/moused.pid
664 process id of the currently running
667 .It Pa /var/run/MouseRemote
668 UNIX-domain stream socket for X10 MouseRemote events
671 .Dl moused -p /dev/cuad0 -i type
675 utility determine the protocol type of the mouse at the serial port
677 If successful, the command will print the type, otherwise it will say
680 .Dl moused -p /dev/cuad0
685 utility is able to identify the protocol type of the mouse at the specified
686 port automatically, you can start the daemon without the
688 option and enable the mouse pointer in the text console as above.
690 .Dl moused -p /dev/mouse -t microsoft
693 Start the mouse daemon on the serial port
697 is explicitly specified by the
701 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
703 Assign the physical button 3 (right button) to the logical button 1
704 (logical left) and the physical button 1 (left) to the logical
705 button 3 (logical right).
706 This will effectively swap the left and right buttons.
708 .Dl moused -p /dev/mouse -t intellimouse -z 4
710 Report negative Z axis movement (i.e., mouse wheel) as the button 4 pressed
711 and positive Z axis movement (i.e., mouse wheel) as the button 5 pressed.
715 .Dl ALL ALL = NOPASSWD: /usr/bin/killall -USR1 moused
718 .Pa /usr/local/etc/sudoers
721 .Dl killall -USR1 moused
723 to a key in your window manager, you can suspend mouse events on your laptop if
724 you keep brushing over the mouse pad while typing.
728 utility does not currently work with the alternative console driver
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:
771 utility partially supports
772 .Dq Plug and Play External COM Device Specification
773 in order to support PnP serial mice.
774 However, due to various degrees of conformance to the specification by
775 existing serial mice, it does not strictly follow the version 1.0 of the
777 Even with this less strict approach,
778 it may not always determine an appropriate protocol type
779 for the given serial mouse.
783 utility first appeared in
789 utility was written by
790 .An Michael Smith Aq msmith@FreeBSD.org .
791 This manual page was written by
792 .An Mike Pritchard Aq mpp@FreeBSD.org .
793 The command and manual page have since been updated by
794 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
projects / FreeBSD / FreeBSD.git / blob