xref: /netbsd-src/share/man/man4/wsmux.4 (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1.\" $NetBSD: wsmux.4,v 1.4 2001/04/04 14:16:07 augustss Exp $
2.\"
3.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
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.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"        This product includes software developed by the NetBSD
17.\"        Foundation, Inc. and its contributors.
18.\" 4. Neither the name of The NetBSD Foundation nor the names of its
19.\"    contributors may be used to endorse or promote products derived
20.\"    from this software without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32.\" POSSIBILITY OF SUCH DAMAGE.
33.\"
34.Dd July 26, 1999
35.Dt WSMUX 4
36.Os
37.Sh NAME
38.Nm wsmux
39.Nd console keyboard/mouse multiplexor for wscons
40.Sh SYNOPSIS
41.Cd "wskbd*     at ... mux N"
42.Cd "wsmouse*   at ... mux N"
43
44.Cd pseudo-device  wsmux    N
45.Pp
46.Sh DESCRIPTION
47The
48.Nm
49is a pseudo-device driver that allows several
50.Xr wscons 4
51input devices to have their events multiplexed into one stream.
52.Pp
53The typical usage for this device is to have two multiplexors, one
54for mouse events and one for keyboard events.  All
55.Xr wsmouse 4
56devices should direct their events to the mouse mux (normally 0)
57and all keyboard devices, except the console, should direct their
58events to the keyboard mux (normally 1).  A device will
59send its events to the mux indicated by the
60.Va mux
61locator.  If none is given the device will not use a multiplexor.
62The keyboard multiplexor should be connected to the display, using
63the
64.Xr wsconscfg 8
65command.  It will then receive all keystrokes from all keyboards
66and, furthermore, keyboards can be dynamically attached and detached without
67further user interaction.
68In a similar way, the window system will open the mouse multiplexor
69and receive all mouse events; mice can also be dynamically attached
70and detached.
71.Pp
72It is also possible to inject events into a multiplexor from a
73user program.
74.\" This is used by the
75.\" .Xr moused 8
76.\" daemon to take data from a mouse connected to a serial port and
77.\" make it appear on the standard mouse mux.
78.Pp
79.Sh FILES
80.Bl -item
81.It
82.Pa /dev/wsmouse
83.It
84.Pa /dev/wskbd
85.It
86.Pa /usr/include/dev/wscons/wsconsio.h .
87.El
88.Sh SEE ALSO
89.\" .Xr moused 8 ,
90.Xr wscons 4 ,
91.Xr wsdisplay 4 ,
92.Xr wskbd 4 ,
93.Xr wsmouse 4 ,
94.Xr wsconscfg 8 ,
95.Xr wsconsctl 8 ,
96.Xr wsfontload 8
97