xref: /netbsd/usr.sbin/wsmoused/wsmoused.8 (revision c4a72b64)
1.\" $NetBSD: wsmoused.8,v 1.6 2002/10/25 21:02:45 wiz Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Julio Merino.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Neither the name of The NetBSD Foundation nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"/
30.Dd June 26, 2002
31.Dt WSMOUSED 8
32.Os
33.Sh NAME
34.Nm wsmoused
35.Nd mouse console daemon
36.Sh SYNOPSIS
37.Nm
38.Op Fl d Ar device
39.Op Fl f Ar fifo
40.Op Fl n
41.Op Fl X Ar number
42.Op Fl x Ar number
43.Op Fl y Ar number
44.Sh DESCRIPTION
45The
46.Nm
47daemon provides mouse support in console, allowing copying and pasting
48text. The left mouse button is used to select text when held and you
49use the right button to paste it in the active console.
50.Pp
51Supported options are as follows:
52.Bl -tag -width XXXnumberX
53.It Fl d Ar device
54specifies which driver to use as the mouse device. It defaults to
55.Pa /dev/wsmouse .
56.It Fl f Ar fifo
57is used to specify an optional fifo where to redirect all mouse events
58(even if they have been processed). By default, no fifo is used.
59.It Fl n
60do not fork in the background (for debugging purposes).
61.It Fl X Ar number
62tells
63.Nm
64which virtual console holds the X server (if any). The argument
65specifies the console number (the same found in
66.Pa /dev/ttyE? ,
67where the ? appears).
68.Nm
69will stop processing events when entering this console and will
70continue its job when you return to any other terminal.
71.It Fl x Ar number
72x slowdown. This positive integer specifies how many events in the x
73direction should be ignored before changing the current column. It
74defaults to 0.
75.It Fl y Ar number
76y slowdown. This positive integer specifies how many events in the y
77direction should be ignored before changing the current row. It
78defaults to 3.
79.El
80.Sh FILES
81.Bl -tag -width /dev/wsdisplayXXX -compact
82.It Pa /dev/ttyE[0-n]
83tty devices
84.It Pa /dev/ttyEstat
85wsdisplay status notification device
86.It Pa /dev/wsmouse0
87mouse control device
88.El
89.Sh EXAMPLES
90The following are just a few examples of
91.Nm
92and its functionality.
93.Pp
94.Dl wsmoused -X 4
95.Pp
96Starts the mouse dameon, telling it that ttyE4 holds a X server.
97.Pp
98.Dl wsmoused -d /dev/wsmouse1 -f /tmp/mousefifo
99.Pp
100Uses
101.Pa /dev/wsmouse1
102device as the mouse and
103.Pa /tmp/mousefifo
104as the fifo where all mouse data is redirected.
105.Sh SECURITY CONSIDERATIONS
106Be ABSOLUTELY sure that
107.Pa /dev/ttyE*
108devices have restrictive permissions as the mouse uses some functions
109that could allow terminal snooping if improperly set.
110.Sh NOTES
111The mouse cursor is only visible for a short time. It will disappear
112when you stop moving it to avoid console corruption if there is any
113output while it is visible.
114.Pp
115.Cd options WSDISPLAY_CHARFUNCS
116is needed in your kernel configuration file in
117order to get mouse console support.
118.Pp
119When you return from the X screen to another terminal there is a small
120time delay until the mouse works again. The delay is needed to allow X
121to close the mouse device properly.
122.Pp
123It's needed that you change the getty program which runs in the first
124virtual terminal to use
125.Pa /dev/ttyE0
126instead of
127.Pa /dev/console .
128If you do not change this, you may have problems.
129You need to edit
130.Pa /etc/ttys
131and
132.Pa /etc/wscons.conf
133to make this change.
134.Sh SEE ALSO
135.Xr wscons 4 ,
136.Xr wsdisplay 4 ,
137.Xr wsmouse 4 ,
138.Xr ttys 5 ,
139.Xr wscons.conf 5 ,
140.Xr moused 8
141.Sh HISTORY
142The
143.Nm
144command first appeared in
145.Nx 1.7 .
146