Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / moused / moused.8
1 .\" Copyright (c) 1996
2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
18 .\"
30 .\"
31 .\" $FreeBSD: src/usr.sbin/moused/moused.8,v 2003/04/28 08:34:04 brueffer Exp $
32 .\" $DragonFly: src/usr.sbin/moused/moused.8,v 1.4 2006/02/17 19:40:18 swildner Exp $
33 .\"
34 .Dd April 1, 2000
35 .Dt MOUSED 8
36 .Os
37 .Sh NAME
38 .Nm moused
39 .Nd pass mouse data to the console driver
41 .Nm
42 .Op Fl DPRacdfs
43 .Op Fl I Ar file
44 .Op Fl F Ar rate
45 .Op Fl r Ar resolution
46 .Op Fl S Ar baudrate
47 .Op Fl a Ar X Ns Op , Ns Ar Y
48 .Op Fl C Ar threshold
49 .Op Fl m Ar N=M
50 .Op Fl w Ar N
51 .Op Fl z Ar target
52 .Op Fl t Ar mousetype
53 .Op Fl 3 Op Fl E Ar timeout
54 .Fl p Ar port
55 .Pp
56 .Nm
57 .Op Fl Pd
58 .Fl p Ar port
59 .Fl i Ar info
61 The
62 .Nm
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
67 (see
68 .Xr sysmouse 4 ) .
69 .Pp
70 The mouse daemon listens to the specified port for mouse data,
71 interprets and then passes it via ioctls to the console driver.
72 The mouse daemon
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.
76 .Pp
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
80 .Xr vidcontrol 1 .
81 If
82 .Xr sysmouse 4
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.
85 .Pp
86 If the mouse daemon receives the signal
87 .Dv SIGHUP ,
88 it will reopen the mouse port and reinitialize itself.
89 Useful if
90 the mouse is attached/detached while the system is suspended.
91 .Pp
92 The following options are available:
93 .Bl -tag -width indent
94 .It Fl 3
95 Emulate the third (middle) button for 2-button mice.
96 It is emulated
97 by pressing the left and right physical buttons simultaneously.
98 .It Fl C Ar threshold
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
104 via
105 .Xr sysmouse 4
106 will not be affected.
107 .It Fl D
108 Lower DTR on the serial port.
109 This option is valid only if
110 .Ar mousesystems
111 is selected as the protocol type.
112 The DTR line may need to be dropped for a 3-button mouse
113 to operate in the
114 .Ar mousesystems
115 mode.
116 .It Fl E Ar timeout
117 When the third button emulation is enabled
118 (see above),
119 the
120 .Nm
121 utility waits
122 .Ar timeout
123 msec at most before deciding whether two buttons are being pressed
124 simultaneously.
125 The default timeout is 100 msec.
126 .It Fl F Ar rate
127 Set the report rate (reports/sec) of the device if supported.
128 .It Fl I Ar file
129 Write the process id of the
130 .Nm
131 utility in the specified file.
132 Without this option, the process id will be stored in
133 .Pa /var/run/moused.pid .
134 .It Fl P
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
138 .Fl i
139 option, the
140 .Nm
141 utility will not be able to print useful information for the serial mouse.
142 .It Fl R
143 Lower RTS on the serial port.
144 This option is valid only if
145 .Ar mousesystems
146 is selected as the protocol type by the
147 .Fl t
148 option below.
149 It is often used with the
150 .Fl D
151 option above.
152 Both RTS and DTR lines may need to be dropped for
153 a 3-button mouse to operate in the
154 .Ar mousesystems
155 mode.
156 .It Fl S Ar baudrate
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
163 up.
164 Specifying only one value sets the acceleration for both axes.
165 .It Fl c
166 Some mice report middle button down events
167 as if the left and right buttons are being pressed.
168 This option handles this.
169 .It Fl d
170 Enable debugging messages.
171 .It Fl f
172 Do not become a daemon and instead run as a foreground process.
173 Useful for testing and debugging.
174 .It Fl i Ar info
175 Print specified information and quit.  Available pieces of
176 information are:
177 .Pp
178 .Bl -tag -compact -width modelxxx
179 .It Ar port
180 Port (device file) name, i.e.\&
181 .Pa /dev/cuaa0 ,
182 .Pa /dev/mse0
183 and
184 .Pa /dev/psm0 .
185 .It Ar if
186 Interface type: serial, bus, inport or ps/2.
187 .It Ar type
188 Protocol type.
189 It is one of the types listed under the
190 .Fl t
191 option below or
192 .Ar sysmouse
193 if the driver supports the
194 .Ar sysmouse
195 data format standard.
196 .It Ar model
197 Mouse model.  The
198 .Nm
199 utility may not always be able to identify the model.
200 .It Ar all
201 All of the above items.  Print port, interface, type and model in this order
202 in one line.
203 .El
204 .Pp
205 If the
206 .Nm
207 utility cannot determine the requested information, it prints ``unknown''
208 or ``generic''.
209 .It Fl m Ar N=M
210 Assign the physical button
211 .Ar M
212 to the logical button
213 .Ar N .
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
216 same time.
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 `='.
220 .It Fl p Ar port
221 Use
222 .Ar port
223 to communicate with the mouse.
224 .It Fl r Ar resolution
225 Set the resolution of the device; in Dots Per Inch, or
226 .Ar low ,
227 .Ar medium-low ,
228 .Ar medium-high
229 or
230 .Ar high .
231 This option may not be supported by all the device.
232 .It Fl s
233 Select a baudrate of 9600 for the serial line.
234 Not all serial mice support this option.
235 .It Fl t Ar type
236 Specify the protocol type of the mouse attached to the port.
237 You may explicitly specify a type listed below, or use
238 .Ar auto
239 to let the
240 .Nm
241 utility automatically select an appropriate protocol for the given
242 mouse.
243 If you entirely omit this option in the command line,
244 .Fl t Ar auto
245 is assumed.
246 Under normal circumstances,
247 you need to use this option only if the
248 .Nm
249 utility is not able to detect the protocol automatically
250 (see
251 .Sx "Configuring Mouse Daemon" ) .
252 .Pp
253 Note that if a protocol type is specified with this option, the
254 .Fl P
255 option above is implied and Plug and Play COM device enumeration
256 procedure will be disabled.
257 .Pp
258 Also note that if your mouse is attached to the PS/2 mouse port, you should
259 always choose
260 .Ar auto
261 or
262 .Ar ps/2 ,
263 regardless of the brand and model of the mouse.  Likewise, if your
264 mouse is attached to the bus mouse port, choose
265 .Ar auto
266 or
267 .Ar busmouse .
268 Serial mouse protocols will not work with these mice.
269 .Pp
270 For the USB mouse, the protocol must be
271 .Ar auto .
272 No other protocol will work with the USB mouse.
273 .Pp
274 Valid types for this option are
275 listed below.
276 .Pp
277 For the serial mouse:
278 .Bl -tag -compact -width mousesystemsxxx
279 .It Ar microsoft
280 Microsoft serial mouse protocol.  Most 2-button serial mice use this protocol.
281 .It Ar intellimouse
282 Microsoft IntelliMouse protocol.  Genius NetMouse,
283 .Tn ASCII
284 Mie Mouse,
285 Logitech MouseMan+ and FirstMouse+ use this protocol too.
286 Other mice with a roller/wheel may be compatible with this protocol.
287 .It Ar mousesystems
288 MouseSystems 5-byte protocol.  3-button mice may use this protocol.
289 .It Ar mmseries
290 MM Series mouse protocol.
291 .It Ar logitech
292 Logitech mouse protocol.  Note that this is for old Logitech models.
293 .Ar mouseman
294 or
295 .Ar intellimouse
296 should be specified for newer models.
297 .It Ar mouseman
298 Logitech MouseMan and TrackMan protocol.  Some 3-button mice may be compatible
299 with this protocol.  Note that MouseMan+ and FirstMouse+ use
300 .Ar intellimouse
301 protocol rather than this one.
302 .It Ar glidepoint
303 ALPS GlidePoint protocol.
304 .It Ar thinkingmouse
305 Kensington ThinkingMouse protocol.
306 .It Ar mmhitab
307 Hitachi tablet protocol.
308 .It Ar x10mouseremote
309 X10 MouseRemote.
310 .It Ar kidspad
311 Genius Kidspad and Easypad protocol.
312 .It Ar versapad
313 Interlink VersaPad protocol.
314 .El
315 .Pp
316 For the bus and InPort mouse:
317 .Bl -tag -compact -width mousesystemsxxx
318 .It Ar busmouse
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.
322 .El
323 .Pp
324 For the PS/2 mouse:
325 .Bl -tag -compact -width mousesystemsxxx
326 .It Ar ps/2
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.
329 .El
330 .Pp
331 For the USB mouse,
332 .Ar auto
333 is the only protocol type available for the USB mouse
334 and should be specified for any USB mice, regardless of the brand.
335 .It Fl w Ar N
336 Make the physical button
337 .Ar N
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
342 .Fl z
343 option below.
344 .It Fl z Ar target
345 Map Z axis (roller/wheel) movement to another axis or to virtual buttons.
346 Valid
347 .Ar target
348 maybe:
349 .Bl -tag -compact -width x__
350 .It Ar x
351 .It Ar y
352 X or Y axis movement will be reported when the Z axis movement is detected.
353 .It Ar N
354 Report down events for the virtual buttons
355 .Ar N
356 and
357 .Ar N+1
358 respectively when negative and positive Z axis movement
359 is detected.
360 There do not need to be physical buttons
361 .Ar N
362 and
363 .Ar N+1 .
364 Note that mapping to logical buttons is carried out after mapping
365 from the Z axis movement to the virtual buttons is done.
366 .It Ar N1 N2
367 Report down events for the virtual buttons
368 .Ar N1
369 and
370 .Ar N2
371 respectively when negative and positive Z axis movement
372 is detected.
373 .It Ar N1 N2 N3 N4
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.
378 .Pp
379 The motion of the second wheel will be mapped to the buttons
380 .Ar N3 ,
381 for the negative direction, and
382 .Ar N4 ,
383 for the positive direction.
384 If the buttons
385 .Ar N3
386 and
387 .Ar N4
388 actually exist in this mouse, their actions will not be detected.
389 .Pp
390 Note that horizontal movement or second roller/wheel movement may not
391 always be detected,
392 because there appears to be no accepted standard as to how it is encoded.
393 .Pp
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
398 first one.
399 .El
400 .El
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
412 what matters.
413 The USB mouse has a flat rectangular connector.
414 .Pp
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
418 .Pa /dev/mse0 ,
419 and the PS/2 mouse is always at
420 .Pa /dev/psm0 .
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
423 serial port
424 .Pa /dev/cuaa0
425 to the mouse.
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 ,
429 and so on.
430 .Pa
431 You may want to create a symbolic link
432 .Pa /dev/mouse
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.
435 .Pp
436 The next step is to guess the appropriate protocol type for the mouse.
437 The
438 .Nm
439 utility may be able to automatically determine the protocol type.
440 Run the
441 .Nm
442 utility with the
443 .Fl i
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
447 (see
448 .Sx EXAMPLES ) .
449 .Pp
450 The command may print
451 .Ar sysmouse
452 if the mouse driver supports this protocol type.
453 .Pp
454 Note that the
455 .Dv type
456 and
457 .Dv model
458 printed by the
459 .Fl i
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
462 compatible.
463 .Pp
464 If the
465 .Fl i
466 option yields nothing, you need to specify a protocol type to the
467 .Nm
468 utility by the
469 .Fl t
470 option.
471 You have to make a guess and try.
472 There is rule of thumb:
473 .Pp
474 .Bl -enum -compact -width 1.X
475 .It
476 The bus and InPort mice always use
477 .Ar busmouse
478 protocol regardless of the brand of the mouse.
479 .It
480 The
481 .Ar ps/2
482 protocol should always be specified for the PS/2 mouse
483 regardless of the brand of the mouse.
484 .It
485 You must specify the
486 .Ar auto
487 protocol for the USB mouse.
488 .It
489 Most 2-button serial mice support the
490 .Ar microsoft
491 protocol.
492 .It
493 3-button serial mice may work with the
494 .Ar mousesystems
495 protocol.
496 If it does not, it may work with the
497 .Ar microsoft
498 protocol although
499 the third (middle) button will not function.
500 3-button serial mice may also work with the
501 .Ar mouseman
502 protocol under which the third button may function as expected.
503 .It
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
507 .Ar microsoft
508 protocol.
509 ``PC'' or ``3'' will choose the
510 .Ar mousesystems
511 protocol.
512 .It
513 If the mouse has a roller or a wheel, it may be compatible with the
514 .Ar intellimouse
515 protocol.
516 .El
517 .Pp
518 To test if the selected protocol type is correct for the given mouse,
519 enable the mouse pointer in the current virtual console,
520 .Pp
521 .Dl vidcontrol -m on
522 .Pp
523 start the mouse daemon in the foreground mode,
524 .Pp
525 .Dl moused -f -p Ar _selected_port_ -t Ar _selected_protocol_
526 .Pp
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.
531 Type ^C to stop
532 the command.
533 .Ss Multiple Mice
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
541 (such as the
542 .Tn "X\ Window System" )
543 to use
544 .Xr sysmouse ,
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
549 PS/2 mouse.
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.
554 .Sh FILES
555 .Bl -tag -width /dev/consolectl -compact
556 .It Pa /dev/consolectl
557 device to control the console
558 .It Pa /dev/mse%d
559 bus and InPort mouse driver
560 .It Pa /dev/psm%d
561 PS/2 mouse driver
562 .It Pa /dev/sysmouse
563 virtualized mouse driver
564 .It Pa /dev/ttyv%d
565 virtual consoles
566 .It Pa /dev/ums%d
567 USB mouse driver
568 .It Pa /var/run/moused.pid
569 process id of the currently running
570 .Nm
571 utility
572 .It Pa /var/run/MouseRemote
573 UNIX-domain stream socket for X10 MouseRemote events
574 .El
576 .Dl moused -p /dev/cuaa0 -i type
577 .Pp
578 Let the
579 .Nm
580 utility determine the protocol type of the mouse at the serial port
581 .Pa /dev/cuaa0 .
582 If successful, the command will print the type, otherwise it will say
583 ``unknown''.
584 .Pp
585 .Dl moused -p /dev/cuaa0
586 .Dl vidcontrol -m on
587 .Pp
588 If the
589 .Nm
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
592 .Fl t
593 option and enable the mouse pointer in the text console as above.
594 .Pp
595 .Dl moused -p /dev/mouse -t microsoft
596 .Dl vidcontrol -m on
597 .Pp
598 Start the mouse daemon on the serial port
599 .Pa /dev/mouse .
600 The protocol type
601 .Ar microsoft
602 is explicitly specified by the
603 .Fl t
604 option.
605 .Pp
606 .Dl moused -p /dev/mouse -m 1=3 -m 3=1
607 .Pp
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.
612 .Pp
613 .Dl moused -p /dev/mouse -t intellimouse -z 4
614 .Pp
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.
625 .Pp
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
634 is not available.
635 To obtain the paste function, use the
636 .Fl 3
637 option to emulate the middle button, or use the
638 .Fl m
639 option to assign the physical right button to the logical middle button:
640 ``-m 2=3''.
641 .Sh SEE ALSO
642 .Xr kill 1 ,
643 .Xr vidcontrol 1 ,
644 .Xr keyboard 4 ,
645 .Xr mse 4 ,
646 .Xr psm 4 ,
647 .Xr screen 4 ,
648 .Xr sysmouse 4 ,
649 .Xr ums 4
651 The
652 .Nm
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
658 standard.
659 Even with this less strict approach,
660 it may not always determine an appropriate protocol type
661 for the given serial mouse.
663 The
664 .Nm
665 utility first appeared in
666 .Fx 2.2 .
668 .An -nosplit
669 The
670 .Nm
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 .