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 $
32 .\" $DragonFly: src/usr.sbin/moused/moused.8,v 1.5 2006/04/17 18:01:38 swildner Exp $
39 .Nd pass mouse data to the console driver
45 .Op Fl r Ar resolution
47 .Op Fl a Ar X Ns Op , Ns Ar Y
53 .Op Fl 3 Op Fl E Ar timeout
63 utility and the console driver work together to support
64 mouse operation in the text console and user programs.
65 They virtualize the mouse and provide user programs with mouse data
66 in the standard format
70 The mouse daemon listens to the specified port for mouse data,
71 interprets and then passes it via ioctls to the console driver.
73 reports translation movement, button press/release
74 events and movement of the roller or the wheel if available.
75 The roller/wheel movement is reported as ``Z'' axis movement.
77 The console driver will display the mouse pointer on the screen
78 and provide cut and paste functions if the mouse pointer is enabled
79 in the virtual console via
83 is opened by the user program, the console driver also passes the mouse
84 data to the device so that the user program will see it.
86 If the mouse daemon receives the signal
88 it will reopen the mouse port and reinitialize itself.
90 the mouse is attached/detached while the system is suspended.
92 The following options are available:
93 .Bl -tag -width indent
95 Emulate the third (middle) button for 2-button mice.
97 by pressing the left and right physical buttons simultaneously.
99 Set double click speed as the maximum interval in msec between button clicks.
100 Without this option, the default value of 500 msec will be assumed.
101 This option will have effect only on the cut and paste operations
102 in the text mode console.
103 The user program which is reading mouse data
106 will not be affected.
108 Lower DTR on the serial port.
109 This option is valid only if
111 is selected as the protocol type.
112 The DTR line may need to be dropped for a 3-button mouse
117 When the third button emulation is enabled
123 msec at most before deciding whether two buttons are being pressed
125 The default timeout is 100 msec.
127 Set the report rate (reports/sec) of the device if supported.
129 Write the process id of the
131 utility in the specified file.
132 Without this option, the process id will be stored in
133 .Pa /var/run/moused.pid .
135 Do not start the Plug and Play COM device enumeration procedure
136 when identifying the serial mouse.
137 If this option is given together with the
141 utility will not be able to print useful information for the serial mouse.
143 Lower RTS on the serial port.
144 This option is valid only if
146 is selected as the protocol type by the
149 It is often used with the
152 Both RTS and DTR lines may need to be dropped for
153 a 3-button mouse to operate in the
157 Select the baudrate for the serial port (1200 to 9600).
158 Not all serial mice support this option.
159 .It Fl a Ar X Ns Op , Ns Ar Y
160 Accelerate or decelerate the mouse input.
161 This is a linear acceleration only.
162 Values less than 1.0 slow down movement, values greater than 1.0 speed it
164 Specifying only one value sets the acceleration for both axes.
166 Some mice report middle button down events
167 as if the left and right buttons are being pressed.
168 This option handles this.
170 Enable debugging messages.
172 Do not become a daemon and instead run as a foreground process.
173 Useful for testing and debugging.
175 Print specified information and quit. Available pieces of
178 .Bl -tag -compact -width modelxxx
180 Port (device file) name, i.e.\&
186 Interface type: serial, bus, inport or ps/2.
189 It is one of the types listed under the
193 if the driver supports the
195 data format standard.
199 utility may not always be able to identify the model.
201 All of the above items. Print port, interface, type and model in this order
207 utility cannot determine the requested information, it prints ``unknown''
210 Assign the physical button
212 to the logical button
214 You may specify as many instances of this option as you like.
215 More than one physical button may be assigned to a logical button at the
217 In this case the logical button will be down,
218 if either of the assigned physical buttons is held down.
219 Do not put space around `='.
223 to communicate with the mouse.
224 .It Fl r Ar resolution
225 Set the resolution of the device; in Dots Per Inch, or
231 This option may not be supported by all the device.
233 Select a baudrate of 9600 for the serial line.
234 Not all serial mice support this option.
236 Specify the protocol type of the mouse attached to the port.
237 You may explicitly specify a type listed below, or use
241 utility automatically select an appropriate protocol for the given
243 If you entirely omit this option in the command line,
246 Under normal circumstances,
247 you need to use this option only if the
249 utility is not able to detect the protocol automatically
251 .Sx "Configuring Mouse Daemon" ) .
253 Note that if a protocol type is specified with this option, the
255 option above is implied and Plug and Play COM device enumeration
256 procedure will be disabled.
258 Also note that if your mouse is attached to the PS/2 mouse port, you should
263 regardless of the brand and model of the mouse. Likewise, if your
264 mouse is attached to the bus mouse port, choose
268 Serial mouse protocols will not work with these mice.
270 For the USB mouse, the protocol must be
272 No other protocol will work with the USB mouse.
274 Valid types for this option are
277 For the serial mouse:
278 .Bl -tag -compact -width mousesystemsxxx
280 Microsoft serial mouse protocol. Most 2-button serial mice use this protocol.
282 Microsoft IntelliMouse protocol. Genius NetMouse,
285 Logitech MouseMan+ and FirstMouse+ use this protocol too.
286 Other mice with a roller/wheel may be compatible with this protocol.
288 MouseSystems 5-byte protocol. 3-button mice may use this protocol.
290 MM Series mouse protocol.
292 Logitech mouse protocol. Note that this is for old Logitech models.
296 should be specified for newer models.
298 Logitech MouseMan and TrackMan protocol. Some 3-button mice may be compatible
299 with this protocol. Note that MouseMan+ and FirstMouse+ use
301 protocol rather than this one.
303 ALPS GlidePoint protocol.
305 Kensington ThinkingMouse protocol.
307 Hitachi tablet protocol.
308 .It Ar x10mouseremote
311 Genius Kidspad and Easypad protocol.
313 Interlink VersaPad protocol.
316 For the bus and InPort mouse:
317 .Bl -tag -compact -width mousesystemsxxx
319 This is the only protocol type available for
320 the bus and InPort mouse and should be specified for any bus mice
321 and InPort mice, regardless of the brand.
325 .Bl -tag -compact -width mousesystemsxxx
327 This is the only protocol type available for the PS/2 mouse
328 and should be specified for any PS/2 mice, regardless of the brand.
333 is the only protocol type available for the USB mouse
334 and should be specified for any USB mice, regardless of the brand.
336 Make the physical button
338 act as the wheel mode button.
339 While this button is pressed, X and Y axis movement is reported to be zero
340 and the Y axis movement is mapped to Z axis.
341 You may further map the Z axis movement to virtual buttons by the
345 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
349 .Bl -tag -compact -width x__
352 X or Y axis movement will be reported when the Z axis movement is detected.
354 Report down events for the virtual buttons
358 respectively when negative and positive Z axis movement
360 There do not need to be physical buttons
364 Note that mapping to logical buttons is carried out after mapping
365 from the Z axis movement to the virtual buttons is done.
367 Report down events for the virtual buttons
371 respectively when negative and positive Z axis movement
374 This is useful for the mouse with two wheels of which
375 the second wheel is used to generate horizontal scroll action,
376 and for the mouse which has a knob or a stick which can detect
377 the horizontal force applied by the user.
379 The motion of the second wheel will be mapped to the buttons
381 for the negative direction, and
383 for the positive direction.
388 actually exist in this mouse, their actions will not be detected.
390 Note that horizontal movement or second roller/wheel movement may not
392 because there appears to be no accepted standard as to how it is encoded.
394 Note also that some mice think left is the negative horizontal direction;
395 others may think otherwise.
396 Moreover, there are some mice whose two wheels are both mounted vertically,
397 and the direction of the second vertical wheel does not match the
401 .Ss Configuring Mouse Daemon
402 The first thing you need to know is the interface type
403 of the mouse you are going to use.
404 It can be determined by looking at the connector of the mouse.
405 The serial mouse has a D-Sub female 9- or 25-pin connector.
406 The bus and InPort mice have either a D-Sub male 9-pin connector
407 or a round DIN 9-pin connector.
408 The PS/2 mouse is equipped with a small, round DIN 6-pin connector.
409 Some mice come with adapters with which the connector can
410 be converted to another. If you are to use such an adapter,
411 remember the connector at the very end of the mouse/adapter pair is
413 The USB mouse has a flat rectangular connector.
415 The next thing to decide is a port to use for the given interface.
416 For the bus, InPort and PS/2 mice, there is little choice:
417 the bus and InPort mice always use
419 and the PS/2 mouse is always at
421 There may be more than one serial port to which the serial
422 mouse can be attached. Many people often assign the first, built-in
426 You can attach multiple USB mice to your system or to your USB hub.
427 They are accessible as
428 .Pa /dev/ums0 , /dev/ums1 ,
431 You may want to create a symbolic link
433 pointing to the real port to which the mouse is connected, so that you
434 can easily distinguish which is your ``mouse'' port later.
436 The next step is to guess the appropriate protocol type for the mouse.
439 utility may be able to automatically determine the protocol type.
444 option and see what it says. If the command can identify
445 the protocol type, no further investigation is necessary on your part.
446 You may start the daemon without explicitly specifying a protocol type
450 The command may print
452 if the mouse driver supports this protocol type.
460 option do not necessarily match the product name of the pointing device
461 in question, but they may give the name of the device with which it is
466 option yields nothing, you need to specify a protocol type to the
471 You have to make a guess and try.
472 There is rule of thumb:
474 .Bl -enum -compact -width 1.X
476 The bus and InPort mice always use
478 protocol regardless of the brand of the mouse.
482 protocol should always be specified for the PS/2 mouse
483 regardless of the brand of the mouse.
487 protocol for the USB mouse.
489 Most 2-button serial mice support the
493 3-button serial mice may work with the
496 If it does not, it may work with the
499 the third (middle) button will not function.
500 3-button serial mice may also work with the
502 protocol under which the third button may function as expected.
504 3-button serial mice may have a small switch to choose between ``MS''
505 and ``PC'', or ``2'' and ``3''.
506 ``MS'' or ``2'' usually mean the
509 ``PC'' or ``3'' will choose the
513 If the mouse has a roller or a wheel, it may be compatible with the
518 To test if the selected protocol type is correct for the given mouse,
519 enable the mouse pointer in the current virtual console,
523 start the mouse daemon in the foreground mode,
525 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
527 and see if the mouse pointer travels correctly
528 according to the mouse movement.
529 Then try cut & paste features by
530 clicking the left, right and middle buttons.
534 As many instances of the mouse daemon as the number of mice attached to
535 the system may be run simultaneously; one
536 instance for each mouse.
537 This is useful if the user wants to use the built-in PS/2 pointing device
538 of a laptop computer while on the road, but wants to use a serial
539 mouse when s/he attaches the system to the docking station in the office.
540 Run two mouse daemons and tell the application program
542 .Tn "X\ Window System" )
545 then the application program will always see mouse data from either mouse.
546 When the serial mouse is not attached, the corresponding mouse daemon
547 will not detect any movement or button state change and the application
548 program will only see mouse data coming from the daemon for the
550 In contrast when both mice are attached and both of them
551 are moved at the same time in this configuration,
552 the mouse pointer will travel across the screen just as if movement of
553 the mice is combined all together.
555 .Bl -tag -width /dev/consolectl -compact
556 .It Pa /dev/consolectl
557 device to control the console
559 bus and InPort mouse driver
563 virtualized mouse driver
568 .It Pa /var/run/moused.pid
569 process id of the currently running
572 .It Pa /var/run/MouseRemote
573 UNIX-domain stream socket for X10 MouseRemote events
576 .Dl moused -p /dev/cuaa0 -i type
580 utility determine the protocol type of the mouse at the serial port
582 If successful, the command will print the type, otherwise it will say
585 .Dl moused -p /dev/cuaa0
590 utility is able to identify the protocol type of the mouse at the specified
591 port automatically, you can start the daemon without the
593 option and enable the mouse pointer in the text console as above.
595 .Dl moused -p /dev/mouse -t microsoft
598 Start the mouse daemon on the serial port
602 is explicitly specified by the
606 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
608 Assign the physical button 3 (right button) to the logical button 1
609 (logical left) and the physical button 1 (left) to the logical
610 button 3 (logical right).
611 This will effectively swap the left and right buttons.
613 .Dl moused -p /dev/mouse -t intellimouse -z 4
615 Report negative Z axis (roller) movement as the button 4 pressed
616 and positive Z axis movement as the button 5 pressed.
618 Many pad devices behave as if the first (left) button were pressed if
619 the user `taps' the surface of the pad.
620 In contrast, some ALPS GlidePoint and Interlink VersaPad models
621 treat the tapping action
622 as fourth button events.
623 Use the option ``-m 1=4'' for these models
624 to obtain the same effect as the other pad devices.
626 Cut and paste functions in the virtual console assume that there
627 are three buttons on the mouse.
628 The logical button 1 (logical left) selects a region of text in the
629 console and copies it to the cut buffer.
630 The logical button 3 (logical right) extends the selected region.
631 The logical button 2 (logical middle) pastes the selected text
632 at the text cursor position.
633 If the mouse has only two buttons, the middle, `paste' button
635 To obtain the paste function, use the
637 option to emulate the middle button, or use the
639 option to assign the physical right button to the logical middle button:
653 utility partially supports
654 .Dq Plug and Play External COM Device Specification
655 in order to support PnP serial mice.
656 However, due to various degrees of conformance to the specification by
657 existing serial mice, it does not strictly follow the version 1.0 of the
659 Even with this less strict approach,
660 it may not always determine an appropriate protocol type
661 for the given serial mouse.
665 utility first appeared in
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 .
projects / dragonfly.git / blob