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 a Ar X Ns Op , Ns Ar Y
52 .Op Fl 3 Op Fl E Ar timeout
62 and the console driver work together to support
63 mouse operation in the text console and user programs.
64 They virtualize the mouse and provide user programs with mouse data
65 in the standard format
66 .Pq see Xr sysmouse 4 .
68 The mouse daemon listens to the specified port for mouse data,
69 interprets and then passes it via ioctls to the console driver.
71 reports translation movement, button press/release
72 events and movement of the roller or the wheel if available.
73 The roller/wheel movement is reported as ``Z'' axis movement.
75 The console driver will display the mouse pointer on the screen
76 and provide cut and paste functions if the mouse pointer is enabled
77 in the virtual console via
81 is opened by the user program, the console driver also passes the mouse
82 data to the device so that the user program will see it.
84 If the mouse daemon receives the signal
86 it will reopen the mouse port and reinitializes itself.
88 the mouse is attached/detached while the system is suspended.
90 The following options are available:
91 .Bl -tag -width indent
93 Emulate the third (middle) button for 2-button mice.
95 by pressing the left and right physical buttons simultaneously.
97 Set double click speed as the maximum interval in msec between button clicks.
98 Without this option, the default value of 500 msec will be assumed.
99 This option will have effect only on the cut and paste operations
100 in the text mode console.
101 The user program which is reading mouse data
104 will not be affected.
106 Lower DTR on the serial port.
107 This option is valid only if
109 is selected as the protocol type.
110 The DTR line may need to be dropped for a 3-button mouse
115 When the third button emulation is enabled
121 msec at most before deciding whether two buttons are being pressed
123 The default timeout is 100 msec.
125 Set the report rate (reports/sec) of the device if supported.
127 Write the process id of the
129 daemon in the specified file.
130 Without this option, the process id will be stored in
131 .Pa /var/run/moused.pid .
133 Do not start the Plug and Play COM device enumeration procedure
134 when identifying the serial mouse.
135 If this option is given together with the
139 command will not be able to print useful information for the serial mouse.
141 Lower RTS on the serial port.
142 This option is valid only if
144 is selected as the protocol type by the
147 It is often used with the
150 Both RTS and DTR lines may need to be dropped for
151 a 3-button mouse to operate in the
155 Select the baudrate for the serial port (1200 to 9600).
156 Not all serial mice support this option.
157 .It Fl a Ar X Ns Op , Ns Ar Y
158 Accelerate or decelerate the mouse input.
159 This is a linear acceleration only.
160 Values less than 1.0 slow down movement, values greater than 1.0 speed it
162 Specifying only one value sets the acceleration for both axes.
164 Some mice report middle button down events
165 as if the left and right buttons are being pressed.
166 This option handles this.
168 Enable debugging messages.
170 Do not become a daemon and instead run as a foreground process.
171 Useful for testing and debugging.
173 Print specified information and quit. Available pieces of
176 .Bl -tag -compact -width modelxxx
178 Port (device file) name, i.e.
184 Interface type: serial, bus, inport or ps/2.
187 It is one of the types listed under the
191 if the driver supports the
193 data format standard.
197 command may not always be able to identify the model.
199 All of the above items. Print port, interface, type and model in this order
205 command cannot determine the requested information, it prints ``unknown''
208 Assign the physical button
210 to the logical button
212 You may specify as many instances of this option as you like.
213 More than one physical button may be assigned to a logical button at the
215 In this case the logical button will be down,
216 if either of the assigned physical buttons is held down.
217 Do not put space around `='.
221 to communicate with the mouse.
222 .It Fl r Ar resolution
223 Set the resolution of the device; in Dots Per Inch, or
229 This option may not be supported by all the device.
231 Select a baudrate of 9600 for the serial line.
232 Not all serial mice support this option.
234 Specify the protocol type of the mouse attached to the port.
235 You may explicitly specify a type listed below, or use
239 command to automatically select an appropriate protocol for the given
241 If you entirely ommit this options in the command line,
244 Under normal circumstances,
245 you need to use this option only if the
247 command is not able to detect the protocol automatically
248 .Pq see the Sx Configuring Mouse Daemon .
250 Note that if a protocol type is specified with this option, the
252 option above is implied and Plug and Play COM device enumeration
253 procedure will be disabled.
255 Also note that if your mouse is attached to the PS/2 mouse port, you should
260 regardless of the brand and model of the mouse. Likewise, if your
261 mouse is attached to the bus mouse port, choose
265 Serial mouse protocols will not work with these mice.
267 For the USB mouse, the protocol must be
269 No other protocol will work with the USB mouse.
271 Valid types for this option are
274 For the serial mouse:
275 .Bl -tag -compact -width mousesystemsxxx
277 Microsoft serial mouse protocol. Most 2-button serial mice use this protocol.
279 Microsoft IntelliMouse protocol. Genius NetMouse, ASCII Mie Mouse,
280 Logitech MouseMan+ and FirstMouse+ use this protocol too.
281 Other mice with a roller/wheel may be compatible with this protocol.
283 MouseSystems 5-byte protocol. 3-button mice may use this protocol.
285 MM Series mouse protocol.
287 Logitech mouse protocol. Note that this is for old Logitech models.
291 should be specified for newer models.
293 Logitech MouseMan and TrackMan protocol. Some 3-button mice may be compatible
294 with this protocol. Note that MouseMan+ and FirstMouse+ use
296 protocol rather than this one.
298 ALPS GlidePoint protocol.
300 Kensington ThinkingMouse protocol.
302 Hitachi tablet protocol.
303 .It Ar x10mouseremote
306 Genius Kidspad and Easypad protocol.
308 Interlink VersaPad protocol.
311 For the bus and InPort mouse:
312 .Bl -tag -compact -width mousesystemsxxx
314 This is the only protocol type available for
315 the bus and InPort mouse and should be specified for any bus mice
316 and InPort mice, regardless of the brand.
320 .Bl -tag -compact -width mousesystemsxxx
322 This is the only protocol type available for the PS/2 mouse
323 and should be specified for any PS/2 mice, regardless of the brand.
328 is the only protocol type available for the USB mouse
329 and should be specified for any USB mice, regardless of the brand.
331 Make the physical button
333 act as the wheel mode button.
334 While this button is pressed, X and Y axis movement is reported to be zero
335 and the Y axis movement is mapped to Z axis.
336 You may further map the Z axis movement to virtual buttons by the
340 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
344 .Bl -tag -compact -width x__
347 X or Y axis movement will be reported when the Z axis movement is detected.
349 Report down events for the virtual buttons
353 respectively when negative and positive Z axis movement
355 There do not need to be physical buttons
359 Note that mapping to logical buttons is carried out after mapping
360 from the Z axis movement to the virtual buttons is done.
362 Report down events for the virtual buttons
366 respectively when negative and positive Z axis movement
369 This is useful for the mouse with two wheels of which
370 the second wheel is used to generate horizontal scroll action,
371 and for the mouse which has a knob or a stick which can detect
372 the horizontal force applied by the user.
374 The motion of the second wheel will be mapped to the buttons
376 for the negative direction, and
378 for the positive direction.
383 actually exist in this mouse, their actions will not be detected.
385 Note that horizontal movement or second roller/wheel movement may not
387 because there appears to be no accepted standard as to how it is encoded.
389 Note also that some mice think left is the negative horizontal direction,
390 others may think otherwise.
391 Moreover, there are some mice whose two wheels are both mounted vertically,
392 and the direction of the second vertical wheel does not match the
396 .Ss Configuring Mouse Daemon
397 The first thing you need to know is the interface type
398 of the mouse you are going to use.
399 It can be determined by looking at the connector of the mouse.
400 The serial mouse has a D-Sub female 9- or 25-pin connector.
401 The bus and InPort mice have either a D-Sub male 9-pin connector
402 or a round DIN 9-pin connector.
403 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
404 Some mice come with adapters with which the connector can
405 be converted to another. If you are to use such an adapter,
406 remember the connector at the very end of the mouse/adapter pair is
408 The USB mouse has a flat rectangular connector.
410 The next thing to decide is a port to use for the given interface.
411 For the bus, InPort and PS/2 mice, there is little choice:
412 the bus and InPort mice always use
414 and the PS/2 mouse is always at
416 There may be more than one serial port to which the serial
417 mouse can be attached. Many people often assign the first, built-in
421 You can attach multiple USB mice to your system or to your USB hub.
422 They are accessible as
423 .Pa /dev/ums0 , /dev/ums1 ,
426 You may want to create a symbolic link
428 pointing to the real port to which the mouse is connected, so that you
429 can easily distinguish which is your ``mouse'' port later.
431 The next step is to guess the appropriate protocol type for the mouse.
434 command may be able to automatically determine the protocol type.
439 option and see what it says. If the command can identify
440 the protocol type, no further investigation is necessary on your part.
441 You may start the daemon without explicitly specifying a protocol type
442 .Pq see Sx EXAMPLES .
444 The command may print
446 if the mouse driver supports this protocol type.
454 option do not necessarily match the product name of the pointing device
455 in question, but they may give the name of the device with which it is
460 option yields nothing, you need to specify a protocol type to the
465 You have to make a guess and try.
466 There is rule of thumb:
468 .Bl -enum -compact -width 1.X
470 The bus and InPort mice always use
472 protocol regardless of the brand of the mouse.
476 protocol should always be specified for the PS/2 mouse
477 regardless of the brand of the mouse.
481 protocol for the USB mouse.
483 Most 2-button serial mice support the
487 3-button serial mice may work with the
490 If it does not, it may work with the
493 the third (middle) button will not function.
494 3-button serial mice may also work with the
496 protocol under which the third button may function as expected.
498 3-button serial mice may have a small switch to choose between ``MS''
499 and ``PC'', or ``2'' and ``3''.
500 ``MS'' or ``2'' usually mean the
503 ``PC'' or ``3'' will choose the
507 If the mouse has a roller or a wheel, it may be compatible with the
512 To test if the selected protocol type is correct for the given mouse,
513 enable the mouse pointer in the current virtual console,
517 start the mouse daemon in the foreground mode,
519 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
521 and see if the mouse pointer travels correctly
522 according to the mouse movement.
523 Then try cut & paste features by
524 clicking the left, right and middle buttons.
528 As many instances of the mouse daemon as the number of mice attached to
529 the system may be run simultaneously; one
530 instance for each mouse.
531 This is useful if the user wants to use the built-in PS/2 pointing device
532 of a laptop computer while on the road, but wants to use a serial
533 mouse when s/he attaches the system to the docking station in the office.
534 Run two mouse daemons and tell the application program
535 .Pq such as the X Window System
538 then the application program will always see mouse data from either mice.
539 When the serial mouse is not attached, the corresponding mouse daemon
540 will not detect any movement or button state change and the application
541 program will only see mouse data coming from the daemon for the
543 In contrast when both mice are attached and both of them
544 are moved at the same time in this configuration,
545 the mouse pointer will travel across the screen just as if movement of
546 the mice is combined all together.
548 .Bl -tag -width /dev/consolectl -compact
549 .It Pa /dev/consolectl
550 device to control the console
552 bus and InPort mouse driver
556 virtualized mouse driver
561 .It Pa /var/run/moused.pid
562 process id of the currently running
565 .It Pa /var/run/MouseRemote
566 UNIX-domain stream socket for X10 MouseRemote events
569 .Dl moused -p /dev/cuaa0 -i type
573 command determine the protocol type of the mouse at the serial port
575 If successful, the command will print the type, otherwise it will say
578 .Dl moused -p /dev/cuaa0
583 command is able to identify the protocol type of the mouse at the specified
584 port automatically, you can start the daemon without the
586 option and enable the mouse pointer in the text console as above.
588 .Dl moused -p /dev/mouse -t microsoft
591 Start the mouse daemon on the serial port
595 is explicitly specified by the
599 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
601 Assign the physical button 3 (right button) to the logical button 1
602 (logical left) and the physical button 1 (left) to the logical
603 button 3 (logical right).
604 This will effectively swap the left and right buttons.
606 .Dl moused -p /dev/mouse -t intellimouse -z 4
608 Report negative Z axis (roller) movement as the button 4 pressed
609 and positive Z axis movement as the button 5 pressed.
613 command does not currently work with the alternative console driver
616 Many pad devices behave as if the first (left) button were pressed if
617 the user `taps' the surface of the pad.
618 In contrast, some ALPS GlidePoint and Interlink VersaPad models
619 treat the tapping action
620 as fourth button events.
621 Use the option ``-m 1=4'' for these models
622 to obtain the same effect as the other pad devices.
624 Cut and paste functions in the virtual console assume that there
625 are three buttons on the mouse.
626 The logical button 1 (logical left) selects a region of text in the
627 console and copies it to the cut buffer.
628 The logical button 3 (logical right) extends the selected region.
629 The logical button 2 (logical middle) pastes the selected text
630 at the text cursor position.
631 If the mouse has only two buttons, the middle, `paste' button
633 To obtain the paste function, use the
635 option to emulate the middle button, or use the
637 option to assign the physical right button to the logical middle button:
652 command partially supports
653 .Dq Plug and Play External COM Device Specification
654 in order to support PnP serial mice.
655 However, due to various degrees of conformance to the specification by
656 existing serial mice, it does not strictly follow the version 1.0 of the
658 Even with this less strict approach,
659 it may not always determine an appropriate protocol type
660 for the given serial mouse.
665 command was written by
666 .An Michael Smith Aq msmith@FreeBSD.org .
667 This manual page was written by
668 .An Mike Pritchard Aq mpp@FreeBSD.org .
669 The command and manual page have since been updated by
670 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
674 command first appeared in
projects / FreeBSD / FreeBSD.git / blob