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.27.2.11 2003/04/28 08:34:04 brueffer Exp $
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 utility 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
69 The mouse daemon listens to the specified port for mouse data,
70 interprets and then passes it via ioctls to the console driver.
72 reports translation movement, button press/release
73 events and movement of the roller or the wheel if available.
74 The roller/wheel movement is reported as ``Z'' axis movement.
76 The console driver will display the mouse pointer on the screen
77 and provide cut and paste functions if the mouse pointer is enabled
78 in the virtual console via
82 is opened by the user program, the console driver also passes the mouse
83 data to the device so that the user program will see it.
85 If the mouse daemon receives the signal
87 it will reopen the mouse port and reinitialize itself.
89 the mouse is attached/detached while the system is suspended.
91 The following options are available:
92 .Bl -tag -width indent
94 Emulate the third (middle) button for 2-button mice.
96 by pressing the left and right physical buttons simultaneously.
98 Set double click speed as the maximum interval in msec between button clicks.
99 Without this option, the default value of 500 msec will be assumed.
100 This option will have effect only on the cut and paste operations
101 in the text mode console.
102 The user program which is reading mouse data
105 will not be affected.
107 Lower DTR on the serial port.
108 This option is valid only if
110 is selected as the protocol type.
111 The DTR line may need to be dropped for a 3-button mouse
116 When the third button emulation is enabled
122 msec at most before deciding whether two buttons are being pressed
124 The default timeout is 100 msec.
126 Set the report rate (reports/sec) of the device if supported.
128 Write the process id of the
130 utility in the specified file.
131 Without this option, the process id will be stored in
132 .Pa /var/run/moused.pid .
134 Do not start the Plug and Play COM device enumeration procedure
135 when identifying the serial mouse.
136 If this option is given together with the
140 utility will not be able to print useful information for the serial mouse.
142 Lower RTS on the serial port.
143 This option is valid only if
145 is selected as the protocol type by the
148 It is often used with the
151 Both RTS and DTR lines may need to be dropped for
152 a 3-button mouse to operate in the
156 Select the baudrate for the serial port (1200 to 9600).
157 Not all serial mice support this option.
158 .It Fl a Ar X Ns Op , Ns Ar Y
159 Accelerate or decelerate the mouse input.
160 This is a linear acceleration only.
161 Values less than 1.0 slow down movement, values greater than 1.0 speed it
163 Specifying only one value sets the acceleration for both axes.
165 Some mice report middle button down events
166 as if the left and right buttons are being pressed.
167 This option handles this.
169 Enable debugging messages.
171 Do not become a daemon and instead run as a foreground process.
172 Useful for testing and debugging.
174 Print specified information and quit. Available pieces of
177 .Bl -tag -compact -width modelxxx
179 Port (device file) name, i.e.\&
185 Interface type: serial, bus, inport or ps/2.
188 It is one of the types listed under the
192 if the driver supports the
194 data format standard.
198 utility may not always be able to identify the model.
200 All of the above items. Print port, interface, type and model in this order
206 utility cannot determine the requested information, it prints ``unknown''
209 Assign the physical button
211 to the logical button
213 You may specify as many instances of this option as you like.
214 More than one physical button may be assigned to a logical button at the
216 In this case the logical button will be down,
217 if either of the assigned physical buttons is held down.
218 Do not put space around `='.
222 to communicate with the mouse.
223 .It Fl r Ar resolution
224 Set the resolution of the device; in Dots Per Inch, or
230 This option may not be supported by all the device.
232 Select a baudrate of 9600 for the serial line.
233 Not all serial mice support this option.
235 Specify the protocol type of the mouse attached to the port.
236 You may explicitly specify a type listed below, or use
240 utility automatically select an appropriate protocol for the given
242 If you entirely omit this option in the command line,
245 Under normal circumstances,
246 you need to use this option only if the
248 utility is not able to detect the protocol automatically
250 .Sx "Configuring Mouse Daemon" ) .
252 Note that if a protocol type is specified with this option, the
254 option above is implied and Plug and Play COM device enumeration
255 procedure will be disabled.
257 Also note that if your mouse is attached to the PS/2 mouse port, you should
262 regardless of the brand and model of the mouse. Likewise, if your
263 mouse is attached to the bus mouse port, choose
267 Serial mouse protocols will not work with these mice.
269 For the USB mouse, the protocol must be
271 No other protocol will work with the USB mouse.
273 Valid types for this option are
276 For the serial mouse:
277 .Bl -tag -compact -width mousesystemsxxx
279 Microsoft serial mouse protocol. Most 2-button serial mice use this protocol.
281 Microsoft IntelliMouse protocol. Genius NetMouse,
284 Logitech MouseMan+ and FirstMouse+ use this protocol too.
285 Other mice with a roller/wheel may be compatible with this protocol.
287 MouseSystems 5-byte protocol. 3-button mice may use this protocol.
289 MM Series mouse protocol.
291 Logitech mouse protocol. Note that this is for old Logitech models.
295 should be specified for newer models.
297 Logitech MouseMan and TrackMan protocol. Some 3-button mice may be compatible
298 with this protocol. Note that MouseMan+ and FirstMouse+ use
300 protocol rather than this one.
302 ALPS GlidePoint protocol.
304 Kensington ThinkingMouse protocol.
306 Hitachi tablet protocol.
307 .It Ar x10mouseremote
310 Genius Kidspad and Easypad protocol.
312 Interlink VersaPad protocol.
315 For the bus and InPort mouse:
316 .Bl -tag -compact -width mousesystemsxxx
318 This is the only protocol type available for
319 the bus and InPort mouse and should be specified for any bus mice
320 and InPort mice, regardless of the brand.
324 .Bl -tag -compact -width mousesystemsxxx
326 This is the only protocol type available for the PS/2 mouse
327 and should be specified for any PS/2 mice, regardless of the brand.
332 is the only protocol type available for the USB mouse
333 and should be specified for any USB mice, regardless of the brand.
335 Make the physical button
337 act as the wheel mode button.
338 While this button is pressed, X and Y axis movement is reported to be zero
339 and the Y axis movement is mapped to Z axis.
340 You may further map the Z axis movement to virtual buttons by the
344 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
348 .Bl -tag -compact -width x__
351 X or Y axis movement will be reported when the Z axis movement is detected.
353 Report down events for the virtual buttons
357 respectively when negative and positive Z axis movement
359 There do not need to be physical buttons
363 Note that mapping to logical buttons is carried out after mapping
364 from the Z axis movement to the virtual buttons is done.
366 Report down events for the virtual buttons
370 respectively when negative and positive Z axis movement
373 This is useful for the mouse with two wheels of which
374 the second wheel is used to generate horizontal scroll action,
375 and for the mouse which has a knob or a stick which can detect
376 the horizontal force applied by the user.
378 The motion of the second wheel will be mapped to the buttons
380 for the negative direction, and
382 for the positive direction.
387 actually exist in this mouse, their actions will not be detected.
389 Note that horizontal movement or second roller/wheel movement may not
391 because there appears to be no accepted standard as to how it is encoded.
393 Note also that some mice think left is the negative horizontal direction;
394 others may think otherwise.
395 Moreover, there are some mice whose two wheels are both mounted vertically,
396 and the direction of the second vertical wheel does not match the
400 .Ss Configuring Mouse Daemon
401 The first thing you need to know is the interface type
402 of the mouse you are going to use.
403 It can be determined by looking at the connector of the mouse.
404 The serial mouse has a D-Sub female 9- or 25-pin connector.
405 The bus and InPort mice have either a D-Sub male 9-pin connector
406 or a round DIN 9-pin connector.
407 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
408 Some mice come with adapters with which the connector can
409 be converted to another. If you are to use such an adapter,
410 remember the connector at the very end of the mouse/adapter pair is
412 The USB mouse has a flat rectangular connector.
414 The next thing to decide is a port to use for the given interface.
415 For the bus, InPort and PS/2 mice, there is little choice:
416 the bus and InPort mice always use
418 and the PS/2 mouse is always at
420 There may be more than one serial port to which the serial
421 mouse can be attached. Many people often assign the first, built-in
425 You can attach multiple USB mice to your system or to your USB hub.
426 They are accessible as
427 .Pa /dev/ums0 , /dev/ums1 ,
430 You may want to create a symbolic link
432 pointing to the real port to which the mouse is connected, so that you
433 can easily distinguish which is your ``mouse'' port later.
435 The next step is to guess the appropriate protocol type for the mouse.
438 utility may be able to automatically determine the protocol type.
443 option and see what it says. If the command can identify
444 the protocol type, no further investigation is necessary on your part.
445 You may start the daemon without explicitly specifying a protocol type
449 The command may print
451 if the mouse driver supports this protocol type.
459 option do not necessarily match the product name of the pointing device
460 in question, but they may give the name of the device with which it is
465 option yields nothing, you need to specify a protocol type to the
470 You have to make a guess and try.
471 There is rule of thumb:
473 .Bl -enum -compact -width 1.X
475 The bus and InPort mice always use
477 protocol regardless of the brand of the mouse.
481 protocol should always be specified for the PS/2 mouse
482 regardless of the brand of the mouse.
486 protocol for the USB mouse.
488 Most 2-button serial mice support the
492 3-button serial mice may work with the
495 If it does not, it may work with the
498 the third (middle) button will not function.
499 3-button serial mice may also work with the
501 protocol under which the third button may function as expected.
503 3-button serial mice may have a small switch to choose between ``MS''
504 and ``PC'', or ``2'' and ``3''.
505 ``MS'' or ``2'' usually mean the
508 ``PC'' or ``3'' will choose the
512 If the mouse has a roller or a wheel, it may be compatible with the
517 To test if the selected protocol type is correct for the given mouse,
518 enable the mouse pointer in the current virtual console,
522 start the mouse daemon in the foreground mode,
524 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
526 and see if the mouse pointer travels correctly
527 according to the mouse movement.
528 Then try cut & paste features by
529 clicking the left, right and middle buttons.
533 As many instances of the mouse daemon as the number of mice attached to
534 the system may be run simultaneously; one
535 instance for each mouse.
536 This is useful if the user wants to use the built-in PS/2 pointing device
537 of a laptop computer while on the road, but wants to use a serial
538 mouse when s/he attaches the system to the docking station in the office.
539 Run two mouse daemons and tell the application program
541 .Tn "X\ Window System" )
544 then the application program will always see mouse data from either mouse.
545 When the serial mouse is not attached, the corresponding mouse daemon
546 will not detect any movement or button state change and the application
547 program will only see mouse data coming from the daemon for the
549 In contrast when both mice are attached and both of them
550 are moved at the same time in this configuration,
551 the mouse pointer will travel across the screen just as if movement of
552 the mice is combined all together.
554 .Bl -tag -width /dev/consolectl -compact
555 .It Pa /dev/consolectl
556 device to control the console
558 bus and InPort mouse driver
562 virtualized mouse driver
567 .It Pa /var/run/moused.pid
568 process id of the currently running
571 .It Pa /var/run/MouseRemote
572 UNIX-domain stream socket for X10 MouseRemote events
575 .Dl moused -p /dev/cuaa0 -i type
579 utility determine the protocol type of the mouse at the serial port
581 If successful, the command will print the type, otherwise it will say
584 .Dl moused -p /dev/cuaa0
589 utility is able to identify the protocol type of the mouse at the specified
590 port automatically, you can start the daemon without the
592 option and enable the mouse pointer in the text console as above.
594 .Dl moused -p /dev/mouse -t microsoft
597 Start the mouse daemon on the serial port
601 is explicitly specified by the
605 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
607 Assign the physical button 3 (right button) to the logical button 1
608 (logical left) and the physical button 1 (left) to the logical
609 button 3 (logical right).
610 This will effectively swap the left and right buttons.
612 .Dl moused -p /dev/mouse -t intellimouse -z 4
614 Report negative Z axis (roller) movement as the button 4 pressed
615 and positive Z axis movement as the button 5 pressed.
619 utility does not currently work with the alternative console driver
622 Many pad devices behave as if the first (left) button were pressed if
623 the user `taps' the surface of the pad.
624 In contrast, some ALPS GlidePoint and Interlink VersaPad models
625 treat the tapping action
626 as fourth button events.
627 Use the option ``-m 1=4'' for these models
628 to obtain the same effect as the other pad devices.
630 Cut and paste functions in the virtual console assume that there
631 are three buttons on the mouse.
632 The logical button 1 (logical left) selects a region of text in the
633 console and copies it to the cut buffer.
634 The logical button 3 (logical right) extends the selected region.
635 The logical button 2 (logical middle) pastes the selected text
636 at the text cursor position.
637 If the mouse has only two buttons, the middle, `paste' button
639 To obtain the paste function, use the
641 option to emulate the middle button, or use the
643 option to assign the physical right button to the logical middle button:
658 utility partially supports
659 .Dq Plug and Play External COM Device Specification
660 in order to support PnP serial mice.
661 However, due to various degrees of conformance to the specification by
662 existing serial mice, it does not strictly follow the version 1.0 of the
664 Even with this less strict approach,
665 it may not always determine an appropriate protocol type
666 for the given serial mouse.
671 utility was written by
672 .An Michael Smith Aq msmith@FreeBSD.org .
673 This manual page was written by
674 .An Mike Pritchard Aq mpp@FreeBSD.org .
675 The command and manual page have since been updated by
676 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
680 utility first appeared in
nant's projects / dragonfly.git / blob