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
31 .\" $FreeBSD: src/usr.sbin/moused/moused.8,v 1.47 2004/10/11 07:57:08 philip Exp $
32 .\" $DragonFly: src/usr.sbin/moused/moused.8,v 1.9 2008/02/08 10:17:40 matthias Exp $
39 .Nd pass mouse data to the console driver
45 .Op Fl r Ar resolution
47 .Op Fl V Op Fl U Ar distance
48 .Op Fl a Ar X Ns Op , Ns Ar Y
55 .Op Fl 3 Op Fl E Ar timeout
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 ``Z'' axis movement.
79 The console driver will display the mouse pointer on the screen
80 and provide cut and paste functions if the mouse pointer is enabled
81 in the virtual console via
85 is opened by the user program, the console driver also passes the mouse
86 data to the device so that the user program will see it.
88 If the mouse daemon receives the signal
90 it will reopen the mouse port and reinitialize itself.
92 the mouse is attached/detached while the system is suspended.
94 The following options are available:
95 .Bl -tag -width indent
97 Emulate the third (middle) button for 2-button mice.
99 by pressing the left and right physical buttons simultaneously.
100 .It Fl C Ar threshold
101 Set double click speed as the maximum interval in msec between button clicks.
102 Without this option, the default value of 500 msec will be assumed.
103 This option will have effect only on the cut and paste operations
104 in the text mode console.
105 The user program which is reading mouse data
108 will not be affected.
110 Lower DTR on the serial port.
111 This option is valid only if
113 is selected as the protocol type.
114 The DTR line may need to be dropped for a 3-button mouse
119 When the third button emulation is enabled
125 msec at most before deciding whether two buttons are being pressed
127 The default timeout is 100 msec.
129 Set the report rate (reports/sec) of the device if supported.
131 Write the process id of the
133 utility in the specified file.
134 Without this option, the process id will be stored in
135 .Pa /var/run/moused.pid .
137 Do not start the Plug and Play COM device enumeration procedure
138 when identifying the serial mouse.
139 If this option is given together with the
143 utility will not be able to print useful information for the serial mouse.
145 Lower RTS on the serial port.
146 This option is valid only if
148 is selected as the protocol type by the
151 It is often used with the
154 Both RTS and DTR lines may need to be dropped for
155 a 3-button mouse to operate in the
159 Select the baudrate for the serial port (1200 to 9600).
160 Not all serial mice support this option.
163 .Dq Virtual Scrolling .
164 With this option set, holding the middle mouse
165 button down will cause motion to be interpreted as scrolling. Use the
167 option to set the distance the mouse must move before the scrolling mode is
169 .It Fl a Ar X Ns Op , Ns Ar Y
170 Accelerate or decelerate the mouse input.
171 This is a linear acceleration only.
172 Values less than 1.0 slow down movement, values greater than 1.0 speed it
174 Specifying only one value sets the acceleration for both axes.
176 Some mice report middle button down events
177 as if the left and right buttons are being pressed.
178 This option handles this.
180 Enable debugging messages.
182 Do not become a daemon and instead run as a foreground process.
183 Useful for testing and debugging.
185 Print specified information and quit.
189 .Bl -tag -compact -width modelxxx
191 Port (device file) name, i.e.\&
197 Interface type: serial, bus, inport or ps/2.
200 It is one of the types listed under the
204 if the driver supports the
206 data format standard.
211 utility may not always be able to identify the model.
213 All of the above items.
214 Print port, interface, type and model in this order
220 utility cannot determine the requested information, it prints ``unknown''
223 Specifies at which level
225 should operate the mouse driver.
230 for more information on this.
232 Assign the physical button
234 to the logical button
236 You may specify as many instances of this option as you like.
237 More than one physical button may be assigned to a logical button at the
239 In this case the logical button will be down,
240 if either of the assigned physical buttons is held down.
241 Do not put space around `='.
245 to communicate with the mouse.
246 .It Fl r Ar resolution
247 Set the resolution of the device; in Dots Per Inch, or
253 This option may not be supported by all the device.
255 Select a baudrate of 9600 for the serial line.
256 Not all serial mice support this option.
258 Specify the protocol type of the mouse attached to the port.
259 You may explicitly specify a type listed below, or use
263 utility automatically select an appropriate protocol for the given
265 If you entirely omit this option in the command line,
268 Under normal circumstances,
269 you need to use this option only if the
271 utility is not able to detect the protocol automatically
273 .Sx "Configuring Mouse Daemon" ) .
275 Note that if a protocol type is specified with this option, the
277 option above is implied and Plug and Play COM device enumeration
278 procedure will be disabled.
280 Also note that if your mouse is attached to the PS/2 mouse port, you should
285 regardless of the brand and model of the mouse.
287 mouse is attached to the bus mouse port, choose
291 Serial mouse protocols will not work with these mice.
293 For the USB mouse, the protocol must be
295 No other protocol will work with the USB mouse.
297 Valid types for this option are
300 For the serial mouse:
301 .Bl -tag -compact -width mousesystemsxxx
303 Microsoft serial mouse protocol.
304 Most 2-button serial mice use this protocol.
306 Microsoft IntelliMouse protocol.
310 Logitech MouseMan+ and FirstMouse+ use this protocol too.
311 Other mice with a roller/wheel may be compatible with this protocol.
313 MouseSystems 5-byte protocol.
314 3-button mice may use this protocol.
316 MM Series mouse protocol.
318 Logitech mouse protocol.
319 Note that this is for old Logitech models.
323 should be specified for newer models.
325 Logitech MouseMan and TrackMan protocol.
326 Some 3-button mice may be compatible
328 Note that MouseMan+ and FirstMouse+ use
330 protocol rather than this one.
332 ALPS GlidePoint protocol.
334 Kensington ThinkingMouse protocol.
336 Hitachi tablet protocol.
337 .It Ar x10mouseremote
340 Genius Kidspad and Easypad protocol.
342 Interlink VersaPad protocol.
345 For the bus and InPort mouse:
346 .Bl -tag -compact -width mousesystemsxxx
348 This is the only protocol type available for
349 the bus and InPort mouse and should be specified for any bus mice
350 and InPort mice, regardless of the brand.
354 .Bl -tag -compact -width mousesystemsxxx
356 This is the only protocol type available for the PS/2 mouse
357 and should be specified for any PS/2 mice, regardless of the brand.
362 is the only protocol type available for the USB mouse
363 and should be specified for any USB mice, regardless of the brand.
365 Make the physical button
367 act as the wheel mode button.
368 While this button is pressed, X and Y axis movement is reported to be zero
369 and the Y axis movement is mapped to Z axis.
370 You may further map the Z axis movement to virtual buttons by the
374 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
378 .Bl -tag -compact -width x__
381 X or Y axis movement will be reported when the Z axis movement is detected.
383 Report down events for the virtual buttons
387 respectively when negative and positive Z axis movement
389 There do not need to be physical buttons
393 Note that mapping to logical buttons is carried out after mapping
394 from the Z axis movement to the virtual buttons is done.
396 Report down events for the virtual buttons
400 respectively when negative and positive Z axis movement
403 This is useful for the mouse with two wheels of which
404 the second wheel is used to generate horizontal scroll action,
405 and for the mouse which has a knob or a stick which can detect
406 the horizontal force applied by the user.
408 The motion of the second wheel will be mapped to the buttons
410 for the negative direction, and
412 for the positive direction.
417 actually exist in this mouse, their actions will not be detected.
419 Note that horizontal movement or second roller/wheel movement may not
421 because there appears to be no accepted standard as to how it is encoded.
423 Note also that some mice think left is the negative horizontal direction;
424 others may think otherwise.
425 Moreover, there are some mice whose two wheels are both mounted vertically,
426 and the direction of the second vertical wheel does not match the
430 .Ss Configuring Mouse Daemon
431 The first thing you need to know is the interface type
432 of the mouse you are going to use.
433 It can be determined by looking at the connector of the mouse.
434 The serial mouse has a D-Sub female 9- or 25-pin connector.
435 The bus and InPort mice have either a D-Sub male 9-pin connector
436 or a round DIN 9-pin connector.
437 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
438 Some mice come with adapters with which the connector can
439 be converted to another.
440 If you are to use such an adapter,
441 remember the connector at the very end of the mouse/adapter pair is
443 The USB mouse has a flat rectangular connector.
445 The next thing to decide is a port to use for the given interface.
446 For the bus, InPort and PS/2 mice, there is little choice:
447 the bus and InPort mice always use
449 and the PS/2 mouse is always at
451 There may be more than one serial port to which the serial
452 mouse can be attached.
453 Many people often assign the first, built-in
457 You can attach multiple USB mice to your system or to your USB hub.
458 They are accessible as
459 .Pa /dev/ums0 , /dev/ums1 ,
462 You may want to create a symbolic link
464 pointing to the real port to which the mouse is connected, so that you
465 can easily distinguish which is your ``mouse'' port later.
467 The next step is to guess the appropriate protocol type for the mouse.
470 utility may be able to automatically determine the protocol type.
475 option and see what it says.
476 If the command can identify
477 the protocol type, no further investigation is necessary on your part.
478 You may start the daemon without explicitly specifying a protocol type
482 The command may print
484 if the mouse driver supports this protocol type.
492 option do not necessarily match the product name of the pointing device
493 in question, but they may give the name of the device with which it is
498 option yields nothing, you need to specify a protocol type to the
503 You have to make a guess and try.
504 There is rule of thumb:
506 .Bl -enum -compact -width 1.X
508 The bus and InPort mice always use
510 protocol regardless of the brand of the mouse.
514 protocol should always be specified for the PS/2 mouse
515 regardless of the brand of the mouse.
519 protocol for the USB mouse.
521 Most 2-button serial mice support the
525 3-button serial mice may work with the
528 If it does not, it may work with the
531 the third (middle) button will not function.
532 3-button serial mice may also work with the
534 protocol under which the third button may function as expected.
536 3-button serial mice may have a small switch to choose between ``MS''
537 and ``PC'', or ``2'' and ``3''.
538 ``MS'' or ``2'' usually mean the
541 ``PC'' or ``3'' will choose the
545 If the mouse has a roller or a wheel, it may be compatible with the
550 To test if the selected protocol type is correct for the given mouse,
551 enable the mouse pointer in the current virtual console,
555 start the mouse daemon in the foreground mode,
557 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
559 and see if the mouse pointer travels correctly
560 according to the mouse movement.
561 Then try cut & paste features by
562 clicking the left, right and middle buttons.
566 As many instances of the mouse daemon as the number of mice attached to
567 the system may be run simultaneously; one
568 instance for each mouse.
569 This is useful if the user wants to use the built-in PS/2 pointing device
570 of a laptop computer while on the road, but wants to use a serial
571 mouse when s/he attaches the system to the docking station in the office.
572 Run two mouse daemons and tell the application program
574 .Tn "X\ Window System" )
577 then the application program will always see mouse data from either mouse.
578 When the serial mouse is not attached, the corresponding mouse daemon
579 will not detect any movement or button state change and the application
580 program will only see mouse data coming from the daemon for the
582 In contrast when both mice are attached and both of them
583 are moved at the same time in this configuration,
584 the mouse pointer will travel across the screen just as if movement of
585 the mice is combined all together.
587 .Bl -tag -width /dev/consolectl -compact
588 .It Pa /dev/consolectl
589 device to control the console
591 bus and InPort mouse driver
595 virtualized mouse driver
600 .It Pa /var/run/moused.pid
601 process id of the currently running
604 .It Pa /var/run/MouseRemote
606 stream socket for X10 MouseRemote events
609 .Dl moused -p /dev/cuaa0 -i type
613 utility determine the protocol type of the mouse at the serial port
615 If successful, the command will print the type, otherwise it will say
618 .Dl moused -p /dev/cuaa0
623 utility is able to identify the protocol type of the mouse at the specified
624 port automatically, you can start the daemon without the
626 option and enable the mouse pointer in the text console as above.
628 .Dl moused -p /dev/mouse -t microsoft
631 Start the mouse daemon on the serial port
635 is explicitly specified by the
639 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
641 Assign the physical button 3 (right button) to the logical button 1
642 (logical left) and the physical button 1 (left) to the logical
643 button 3 (logical right).
644 This will effectively swap the left and right buttons.
646 .Dl moused -p /dev/mouse -t intellimouse -z 4
648 Report negative Z axis movement (i.e., mouse wheel) as the button 4 pressed
649 and positive Z axis movement (i.e., mouse wheel) as the button 5 pressed.
651 Many pad devices behave as if the first (left) button were pressed if
652 the user `taps' the surface of the pad.
653 In contrast, some ALPS GlidePoint and Interlink VersaPad models
654 treat the tapping action
655 as fourth button events.
656 Use the option ``-m 1=4'' for these models
657 to obtain the same effect as the other pad devices.
659 Cut and paste functions in the virtual console assume that there
660 are three buttons on the mouse.
661 The logical button 1 (logical left) selects a region of text in the
662 console and copies it to the cut buffer.
663 The logical button 3 (logical right) extends the selected region.
664 The logical button 2 (logical middle) pastes the selected text
665 at the text cursor position.
666 If the mouse has only two buttons, the middle, `paste' button
668 To obtain the paste function, use the
670 option to emulate the middle button, or use the
672 option to assign the physical right button to the logical middle button:
686 utility partially supports
687 .Dq Plug and Play External COM Device Specification
688 in order to support PnP serial mice.
689 However, due to various degrees of conformance to the specification by
690 existing serial mice, it does not strictly follow the version 1.0 of the
692 Even with this less strict approach,
693 it may not always determine an appropriate protocol type
694 for the given serial mouse.
698 utility first appeared in
704 utility was written by
705 .An Michael Smith Aq msmith@FreeBSD.org .
706 This manual page was written by
707 .An Mike Pritchard Aq mpp@FreeBSD.org .
708 The command and manual page have since been updated by
709 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
projects / dragonfly.git / blob