1.\" $NetBSD: wsmux.4,v 1.17 2019/08/13 13:22:16 uwe 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.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 18.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25.\" POSSIBILITY OF SUCH DAMAGE. 26.\" 27.Dd August 13, 2019 28.Dt WSMUX 4 29.Os 30.Sh NAME 31.Nm wsmux 32.Nd console keyboard/mouse multiplexor for wscons 33.Sh SYNOPSIS 34.Cd "wskbd* at ... mux 1" 35.Cd "wsbell* at ... mux 1" 36.Cd "wsmouse* at ... mux 0" 37.Pp 38.Cd pseudo-device wsmux 39.Sh DESCRIPTION 40The 41.Nm 42is a pseudo-device driver that allows several 43.Xr wscons 4 44input devices to have their events multiplexed into one stream. 45.Pp 46The typical usage for this device is to have two multiplexors, one 47for mouse events and one for keyboard and bell events. 48All 49.Xr wsmouse 4 50devices should direct their events to the mouse mux (normally 0) 51and all keyboard devices, except the console, should direct their 52events to the keyboard mux (normally 1). 53A device will send its events to the mux indicated by the 54.Va mux 55locator. 56If none is given the device will not use a multiplexor. 57The keyboard multiplexor should be connected to the display, using 58the 59.Xr wsconscfg 8 60command. 61It will then receive all keystrokes from all keyboards 62and, furthermore, keyboards can be dynamically attached and detached without 63further user interaction. 64Additionally, bell events generated for the display will be directed to 65all attached 66.Xr wsbell 4 67devices. 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 72If a 73.Xr wskbd 4 , 74.Xr wsbell 4 , 75or 76.Xr wsmouse 4 77device is opened despite having a mux it will be detached from the mux. 78.Pp 79It is also possible to inject events into a multiplexor from a 80user program. 81.\" This is used by the 82.\" .Xr moused 8 83.\" daemon to take data from a mouse connected to a serial port and 84.\" make it appear on the standard mouse mux. 85.Sh FILES 86For each mux device, 87.Pa /dev/wsmux Ns Ar N 88there is a control device 89.Pa /dev/wsmuxctl Ns Ar N . 90The control device has a minor number 128 greater than the regular 91mux device. 92It can be used to control the mux even when it is open, 93e.g., by 94.Xr wsmuxctl 8 . 95.Pp 96.Bl -tag -width ".Pa /dev/wsmouse" -compact 97.It Pa /dev/wsmouse 98a.k.a. 99.Pa /dev/wsmux0 100.It Pa /dev/wskbd 101a.k.a. 102.Pa /dev/wsmux1 103.It Pa /usr/include/dev/wscons/wsconsio.h 104.El 105.Sh SEE ALSO 106.Xr wsbell 4 , 107.Xr wscons 4 , 108.Xr wsdisplay 4 , 109.Xr wskbd 4 , 110.Xr wsmouse 4 , 111.Xr moused 8 , 112.Xr wsconscfg 8 , 113.Xr wsconsctl 8 , 114.Xr wsmoused 8 , 115.Xr wsmuxctl 8 116.Sh CAVEATS 117If more than one type of keyboard is used, 118.Dv WSKBDIO_GTYPE 119will return the type of the first keyboard. 120