1.\" $OpenBSD: wsmoused.8,v 1.16 2007/05/31 19:20:30 jmc Exp $ 2.\" 3.\" Copyright (c) 2001 Jean-Baptiste Marchand 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.Dd $Mdocdate: May 31 2007 $ 28.Dt WSMOUSED 8 i386 29.Os 30.Sh NAME 31.Nm wsmoused 32.Nd wsmouse daemon 33.Sh SYNOPSIS 34.Nm wsmoused 35.Op Fl 2dfi 36.Op Fl C Ar thresh 37.Op Fl I Ar file 38.Oo 39.Fl M 40.Ar N Ns = Ns Ar M 41.Oc 42.Op Fl p Ar device 43.Op Fl t Ar type 44.Sh DESCRIPTION 45.Nm 46listens for mouse events on the specified 47.Ar device 48and communicates them to the 49.Xr wscons 4 50driver through the 51.Pa /dev/ttyCcfg 52interface. 53Its purpose is to provide copy/paste functionality on the PC console. 54.Pp 55By default, the left mouse button is used to select text 56(in the familiar click-and-drag fashion); 57the right button is used to extend the selection; 58and the middle button pastes. 59This behavior can be modified through the use of 60.Fl M , 61e.g.\& 62.Li -M 2=3 63maps the right mouse button to paste. 64.Pp 65The options are as follows: 66.Bl -tag -width "-p device" 67.It Fl 2 68Indicate that the mouse has two buttons. 69In that case, the right button pastes. 70.It Fl C Ar thresh 71Set double click speed as the maximum interval in msec between button clicks. 72If omitted, the default value of 500 msec will be assumed. 73This option will have effect only on the cut and paste operations 74in the text mode console. 75.It Fl d 76Enable debugging messages. 77.It Fl f 78Do not become a daemon and instead run as a foreground process. 79Useful for testing and debugging. 80.It Fl I Ar file 81Write the process ID of 82.Nm 83to the specified 84.Ar file . 85If omitted, the process ID will be stored in 86.Pa /var/run/wsmoused.pid . 87.It Fl i 88Print the type and the protocol of the mouse and exit. 89.It Fl M Ar N Ns = Ns Ar M 90Assign the physical button 91.Ar M 92to the logical button 93.Ar N . 94You may specify as many instances of this option as you like. 95More than one 96physical button may be assigned to a logical button at the same time. 97In this case the logical button will be down, if either of the assigned 98physical buttons is held down. 99Do not put space around 100.Ql = . 101.It Fl p Ar device 102Use 103.Ar device 104to communicate with the mouse. 105If this option is not present, the device opened is 106.Pa /dev/wsmouse 107(the multiplexer device that receives all mouse events from all wsmouse 108compatible mice on the system). 109For a serial mouse, you have to explicitly specify the serial port, i.e.\& 110.Ar device 111must be one of 112.Pa /dev/cua0[0-3] . 113.It Fl t Ar type 114This option only applies to serial mice. 115It specifies the protocol used by the serial mice. 116You may explicitly specify a type listed below or use 117.Em auto 118to let 119.Nm 120automatically select an appropriate protocol for the given mouse, if the 121serial mouse respects the PnP COM specification. 122.Pp 123If this option is not specified, 124.Em auto 125is assumed. 126Under normal circumstances, you need to use this option only if 127the mouse is not PnP compatible. 128.Pp 129Valid protocol types for this option are the following: 130.Bl -tag -width thinkingmouse 131.It Ar microsoft 132Microsoft serial mouse protocol. 133Most 2-button serial mice use this protocol. 134.It Ar intellimouse 135Microsoft IntelliMouse protocol. 136Genius NetMouse, ASCII Mie Mouse, Logitech MouseMan+, and FirstMouse+ 137use this protocol as well. 138Other mice with a roller/wheel may be compatible with this protocol. 139.It Ar mousesystems 140MouseSystems 5-byte protocol. 1413-button mice may use this protocol. 142.It Ar mmseries 143MM Series mouse protocol. 144.It Ar logitech 145Logitech mouse protocol. 146Note that this is for old Logitech models. 147.Ar mouseman 148or 149.Ar intellimouse 150should be specified for newer models. 151.It Ar mouseman 152Logitech MouseMan and TrackMan protocol. 153Some 3-button mice may be compatible with this protocol. 154Note that MouseMan+ and FirstMouse+ use 155.Ar intellimouse 156protocol rather than this one. 157.It Ar glidepoint 158ALPS GlidePoint protocol. 159.It Ar thinkingmouse 160Kensington ThinkingMouse protocol. 161.It Ar mmhitab 162Hitachi tablet protocol. 163.El 164.El 165.Pp 166.Nm 167will happily coexist with the X Window System, provided that the mouse 168device is supported by 169.Xr wsmouse 4 . 170Serial mice do not have a 171.Xr wsmouse 4 172compatible driver, so 173.Nm 174has to be killed before starting the X Window System. 175.Sh SEE ALSO 176.Xr wscons 4 , 177.Xr wsmouse 4 178.Sh HISTORY 179The 180.Nm 181daemon is a slightly modified version of the moused daemon from the 182.Fx 183project, written by 184.An Michael Smith Aq msmith@FreeBSD.org . 185Both inherit code from the XFree Project. 186