NetBSD/usr.sbin/wsmoused/wsmoused.8

.\" $NetBSD: wsmoused.8,v 1.8 2003/01/19 21:25:43 atatat Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Julio Merino.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"/
.Dd June 26, 2002
.Dt WSMOUSED 8
.Os
.Sh NAME
.Nm wsmoused
.Nd mouse console daemon
.Sh SYNOPSIS
.Nm
.Op Fl d Ar device
.Op Fl f Ar fifo
.Op Fl ln
.Op Fl X Ar number
.Op Fl x Ar number
.Op Fl y Ar number
.Sh DESCRIPTION
The
.Nm
daemon provides mouse support in console, allowing copying and pasting
text. The left mouse button is used to select text when held and you
use the right button to paste it in the active console.
.Pp
Supported options are as follows:
.Bl -tag -width XXXnumberX
.It Fl d Ar device
specifies which driver to use as the mouse device. It defaults to
.Pa /dev/wsmouse .
.It Fl f Ar fifo
is used to specify an optional fifo where to redirect all mouse events
(even if they have been processed). By default, no fifo is used.
.It Fl l
swaps mouse buttons, specially useful for left handed users.
.It Fl n
do not fork in the background (for debugging purposes).
.It Fl X Ar number
tells
.Nm
which virtual console holds the X server (if any). The argument
specifies the console number (the same found in
.Pa /dev/ttyE? ,
where the ? appears).
.Nm
will stop processing events when entering this console and will
continue its job when you return to any other terminal.
.It Fl x Ar number
x slowdown. This positive integer specifies how many events in the x
direction should be ignored before changing the current column. It
defaults to 0.
.It Fl y Ar number
y slowdown. This positive integer specifies how many events in the y
direction should be ignored before changing the current row. It
defaults to 3.
.El
.Sh FILES
.Bl -tag -width /dev/wsdisplayXXX -compact
.It Pa /dev/ttyE[0-n]
tty devices
.It Pa /dev/ttyEstat
wsdisplay status notification device
.It Pa /dev/wsmouse0
mouse control device
.El
.Sh EXAMPLES
The following are just a few examples of
.Nm
and its functionality.
.Pp
.Dl wsmoused -X 4
.Pp
Starts the mouse dameon, telling it that ttyE4 holds a X server.
.Pp
.Dl wsmoused -d /dev/wsmouse1 -f /tmp/mousefifo
.Pp
Uses
.Pa /dev/wsmouse1
device as the mouse and
.Pa /tmp/mousefifo
as the fifo where all mouse data is redirected.
.Sh SECURITY CONSIDERATIONS
Be ABSOLUTELY sure that
.Pa /dev/ttyE*
devices have restrictive permissions as the mouse uses some functions
that could allow terminal snooping if improperly set.
.Sh NOTES
The mouse cursor is only visible for a short time. It will disappear
when you stop moving it to avoid console corruption if there is any
output while it is visible.
.Pp
.Cd options WSDISPLAY_CHARFUNCS
is needed in your kernel configuration file in
order to get mouse console support.
.Pp
When you return from the X screen to another terminal there is a small
time delay until the mouse works again. The delay is needed to allow X
to close the mouse device properly.
.Pp
It's needed that you change the getty program which runs in the first
virtual terminal to use
.Pa /dev/ttyE0
instead of
.Pa /dev/console .
If you do not change this, you may have problems.
You need to edit
.Pa /etc/ttys
and
.Pa /etc/wscons.conf
to make this change.
.Sh SEE ALSO
.Xr wscons 4 ,
.Xr wsdisplay 4 ,
.Xr wsmouse 4 ,
.Xr ttys 5 ,
.Xr wscons.conf 5 ,
.Xr moused 8
.Sh HISTORY
The
.Nm
command first appeared in
.Nx 2.0 .