.Dd May 9, 2006
.Dt moused 8
.Os
.Sh NAME
.Nm moused
.Nd pass mouse data to the console driver
.Sh SYNOPSIS
.Nm 
.Op Fl d Ar device
.Op Fl m Ar module
.Op Fl 3 Op Fl E Ar timeout
.Op Fl V Op Fl U Ar threshold
.Op Fl a Ar acceleration
.Op Fl fvh
.Sh DESCRIPTIN
The
.Nm
utility and the console driver work together to support mouse operation in the
text console and user programs. They virtualize the mouse and provide user
programs with mouse data in a standard format (see
.Xr sysmouse 4 ) .

Multiple moused programs are able to run simultaneously. This allows you use multiple mice at the same time, and also allows you to hot plug mice.

If the mouse daemon receives the signal SIGHUP, it will do a soft restart. That
is, it will reopen the mouse device, reinitialize the mouse, and reread the
config file. This is useful for testing new options for your mice without
having to restart all of your mouse daemons.

The following options are available:
.Bl -tag -with indent

.It Fl b Ar device
Specify the 
.Ar device
to use for input (ie; /dev/ums0)
.It Fl m Ar module
Specify the mouse
.Ar module
to use (ie; synaptics). See the 
.Sx MODULES
section for what is supported.
.It Fl f
Run in foreground (do not detach)
.It Fl v
Increase verbosity level
.It Fl V
Enable "virtual scrolling"
.It Fl U Ar threshold
Specify the minimum movement before virtual scrolling is enabled. (in pixels)
.It Fl 3
Enable emulate 3 button
.It Fl E Ar timeout
Specify the
.Ar timeout
for emulate 3 button mode
.It Fl a Ar x[,y]
Specify 
.Ar x 
(and 
.Ar y
) acceleration factors. If only 
.Ar x
is supplied, its value is used for 
.Ar y aswell.
.It Fl h
Show help
.El

.Sh MODULES

The following modules are available:
.Bl -tag -with indent
.It generic
This module supports vanilla PS/2 mice. Use this if you have a ps/2 mouse that no other module supports.
.It synaptics
Support for Synaptics touchpads. This driver supports secondary input devices
such as pens and trackpoint mice that are often in tandem to the touchpad
itself.
.It sysmouse
"old" mouse support. Existing ums(4) and the old psm(4) use this.
.It command
text-based command input module for controllin the mouse via programs.
.Pp
Valid commands are:
.Pp
.Bl -tag -with indent
.It movex N
move the mouse N pixels right (negative means left)
.It movey N
 move the mouse N pixels down (negative means up)
.It click N 
signal a button click (mousedown and mouseup) for button N
.El
.It usb 
<NOT IMPLEMENTED> Use this if you do not have ums(4) loaded in your kernel. It
provides userland support for uhid(4) mice.
.El

.Sh CONFIGURATION FILE
You can specify certain options in a config file for any specific mouse. The format of the configuration file is the same as termcap(5). The general format is:

	mousetype:option1:option2:...:optionN

The following options are supported globally:
.Bl -tag -with indent
.It virtscroll
enable virtual scrolling
.It emulate3 
enable emulate 3 button
.It accel=N
enable acceleration factor N
.El

Driver modules will support other options aswell:
.Bl -tag -with indent
.It synaptics
.Bl -bullet
.It notouchpad 
disable input handlin from the touchpad.
.It scrollside=N
<NOT IMPLEMENTED> enable drag scrolling on side N. Valid values are top, left,
bottom, right.
.It scrollmargin[DIRECTION]=N
<NOT IMPLEMENTED> specify the scroll margin size for the direction [DIRECTION]
.El
.El

.Sh EXAMPLES

Use the first usb mouse.

	moused -d /dev/ums0 -m sysmouse

Use the synaptics module with virtual scrolling:

	moused -d /dev/psm0 -m synaptics -V

Disable the touchpad for synaptics and enable virtual scrolling

	synaptics:notouchpad:virtscroll

.Sh FILES
.Bl -tag -width ".Pa /etc/moused.conf" -compact
.It Pa /etc/moused.conf
The default configuration file
.El

.Sh BUGS
Probably.

.Sh AUTHOR
The moused utility and this manual page was written by 
.An Jordan Sissel Aq jls@csh.rit.edu .