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