diff options
| -rw-r--r-- | share/man/man4/wscons.4 | 264 | ||||
| -rw-r--r-- | share/man/man4/wsdisplay.4 | 118 | ||||
| -rw-r--r-- | share/man/man4/wskbd.4 | 102 | ||||
| -rw-r--r-- | share/man/man4/wsmouse.4 | 55 | ||||
| -rw-r--r-- | share/man/man4/wsmux.4 | 95 |
5 files changed, 634 insertions, 0 deletions
diff --git a/share/man/man4/wscons.4 b/share/man/man4/wscons.4 new file mode 100644 index 00000000000..efa4734dfd9 --- /dev/null +++ b/share/man/man4/wscons.4 @@ -0,0 +1,264 @@ +.\" $NetBSD: wscons.4,v 1.11 2000/04/13 11:14:42 is Exp $ +.\" +.\" Copyright (c) 1999 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" 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. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. 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 July 26, 1998 +.Dt WSCONS 4 +.Os +.Sh NAME +.Nm wscons +.Nd console access +.Sh SYNOPSIS +.Cd options WSEMUL_SUN +.Cd options WSEMUL_VT100 +.Cd options WSEMUL_NO_DUMB +.Cd options \&"WSEMUL_DEFAULT=\e"xxx\e"" +.Cd options WS_KERNEL_FG=WSCOL_XXX +.Cd options WS_KERNEL_BG=WSCOL_XXX +.Cd options WSDISPLAY_COMPAT_PCVT +.Cd options WSDISPLAY_COMPAT_SYSCONS +.Cd options WSDISPLAY_COMPAT_USL +.Cd options WSDISPLAY_COMPAT_RAWKBD + +.Cd "wsdisplay* at ..." +.Cd "wskbd* at ... mux N" +.Cd "wsmouse* at ... mux N" + +.Cd pseudo-device wsmux N +.Pp +.Sh DESCRIPTION +The +.Nm +driver provides support for machine independent access to the console. +.Pp +.Nm +is made of a number of cooperating modules, in particular +.Bl -bullet +.It +hardware support for display adapters, keyboards and mice, see +.Xr wsdisplay 4 , +.Xr wskbd 4 , and +.Xr wsmouse 4 +.It +input event multiplexor, see +.Xr wsmux 4 +.It +terminal emulation modules (see below), and +.It +compatibility options to support control operations and other low-level +behaviour of existing terminal drivers (see below) +.El +.Pp +.Em Terminal emulations: +.Nm +does not define an own set of terminal control sequences and special keyboard +codes in terms of +.Xr termcap 5 . +Instead a +.Dq terminal emulation +is assigned to each virtual screen when the screen is created (see +.Xr wsconscfg 8 ). +Different terminal emulations can be active at the same time on one display. +The following choices are available: +.Bl -tag -width xxxxxx +.It dumb +This minimal terminal support is available unless the kernel option +.Cd options WSEMUL_NO_DUMB +was specified at build time. No control sequences are supported besides +the ASCII control characters. The cursor is not addressable. Only ASCII +keyboard codes will be delivered, cursor and functions keys do not work. +.It sun +The +.Dq sun +console emulation is available if +.Cd options WSEMUL_SUN +was specified at kernel build time. It supports the control sequences of +.Tn SUN +machine consoles and delivers its keyboard codes for function and +keypad keys (as far as present on the actually used keyboard). +This emulation is sufficient for full-screen applications. +.It vt100 +is available with the kernel compile option +.Cd options WSEMUL_VT100 . +It provides the most commonly used functions of +.Tn DEC VT100 +terminals with some extensions introduced by the +.Tn DEC VT220 +and +.Tn DEC VT320 +models. The features of the original +.Tn VT100 +which are not or not completely implemented are: +.Bl -bullet +.It +.Tn VT52 +support, 132-column-mode, smooth scroll, light background, keyboard +autorepeat control, external printer support, keyboard locking, +newline/linefeed switching: Escape sequences related +to these features are ignored or answered with standard replies. +(DECANM, DECCOLM, DECSCLM, DECSCNM, DECARM, DECPFF, DECPEX, KAM, LNM) +.It +Function keys are not reprogrammable and fonts can not be downloaded. +DECUDK and DECDLD sequences will be ignored. +.It +Neither C1 control set characters will be recognized nor will 8-bit keyboard +codes be delivered. +.It +The +.Dq DEC supplemental graphic +font is approximated by the ISO-latin-1 font, though there are +subtle differences. +.It +The actual rendering quality depends on the underlying graphics hardware +driver. Characters might be missing in the available fonts and be +substituted by more or less fitting replacements. +.Pp +Depending on the keyboard used, not all function keys might be available. +.El +.Pp +In addition to the plain +.Tn VT100 +functions are supported: +.Bl -bullet +.It +ANSI colors +.It +Some +.Tn VT220 +-like presentation state settings and -reports (DECRSPS), especially +tabulator settings. +.El +.Pp +In most applications, +.Nm +will work sufficiently as a +.Tn VT220 +emulator. +.El +.Pp +The +.Va WSEMUL_DEFAULT +kernel option allows to select one of the described terminal options +as default choice. The default gets into effect in kernel startup, i.e. +for the operating system console or additional screens allocated +through the +.Va WSDISPLAY_DEFAULTSCREENS +option (see +.Xr wsdisplay 4 +), or if no emulation type was passed to the +.Xr wsconscfg 8 +utility. +.Pp +.Em Compatibility options: +these options allow to run X servers or other programs using low-level +console driver functions which were written specifically for other +console drivers to run on +.Nx +systems. The options are in particular: +.Bl -tag -width xxxxxxxx +.It Cd WSDISPLAY_COMPAT_USL +Support the protocol for switches between multiple virtual screens on +one display as used by most PC-UNIX variants. +.It Cd WSDISPLAY_COMPAT_RAWKBD +Allows to get raw XT keyboard scancodes from PC keyboards as needed +by i386 X servers. +.It Cd WSDISPLAY_COMPAT_PCVT +Emulates enough of the +.Nx +/ i386 +.Dq pcvt +driver to make X servers work. +.It Cd WSDISPLAY_COMPAT_SYSCONS +Emulates enough of the i386 FreeBSD +.Dq syscons +driver to make X servers work. Useful with FreeBSD binary emulation. +.El +.Pp +Linux/i386 X servers do usually run if the first two options are +enabled together with the +.Nx +Linux binary emulation. +.Pp +(To have programs looking for device special files of other console drivers +find the +.Nm +driver entry points, symlinks are a helpful measure.) +.Pp +.Em Other options: +.Bl -tag -width xxxxxxxx +.It Cd options WS_KERNEL_FG=WSCOL_XXX , +.It Cd options WS_KERNEL_BG=WSCOL_XXX , +.It Cd options \&WS_KERNEL_COLATTR="(WSATTR_XXX | WSATTR_YYY)" +and +.It Cd options \&WS_KERNEL_MONOATTR="(WSATTR_XXX | WSATTR_YYY)" +allow to make console output originating from the kernel appear differently +than output from user level programs (via +.Pa /dev/console +or the specific tty +device like +.Pa /dev/ttyE0 +). +.Dq WS_KERNEL_FG +and +.Dq WS_KERNEL_BG +set the foreground / background used on color displays. The +.Dq WSCOL_XXX +arguments are colors as defined in +.Pa /usr/include/wscons/wsdisplayvar.h . +.Dq WS_KERNEL_COLATTR +and +.Dq WS_KERNEL_MONOATTR +are additional attribute flags used on color or monochrome displays, +respectively. +The arguments are defined in the same header file. Whether the attributes +are supported or not depends on the actually used graphics adapter. +These options are ignored by the +.Dq dumb +terminal emulation. +.It Cd options WSCOMPAT_USL_SYNCTIMEOUT=nnn +The virtual screen switching protocol enabled by +.Dq WSDISPLAY_COMPAT_USL +uses a somewhat complex handshake protocol to pass control to user programs +as X servers controlling a virtual screen. To avoid a non-responsive +application to lock the whole console system a screen switch will be rolled +back if the user application does not respond to a screen switch request +within some time. This option allows to set this timeout (in seconds), +the default value is 5 seconds. +.El +.Sh SEE ALSO +.Xr wsdisplay 4 , +.Xr wskbd 4 , +.Xr wsmouse 4 , +.Xr wsmux 4 , +.Xr wsconscfg 8 , +.Xr wsconsctl 8 , +.Xr wsfontload 8 diff --git a/share/man/man4/wsdisplay.4 b/share/man/man4/wsdisplay.4 new file mode 100644 index 00000000000..70717de6a8d --- /dev/null +++ b/share/man/man4/wsdisplay.4 @@ -0,0 +1,118 @@ +.\" $NetBSD: wsdisplay.4,v 1.5 2000/05/13 15:22:19 mycroft Exp $ +.Dd March 20, 1999 +.Os +.Dt WSDISPLAY 4 +.Sh NAME +.Nm wsdisplay +.Nd generic display device support in wscons +.Sh SYNOPSIS +.Cd wsdisplay* at ega? console ? +(EGA display on ISA) +.Cd wsdisplay* at vga? console ? +(VGA display on ISA or PCI) +.Cd wsdisplay* at pcdisplay? console ? +(generic PC (ISA) display) +.Cd wsdisplay* at tga? console ? +(DEC TGA display, alpha only) +.Cd wsdisplay* at pfb? console ? +(PCI framebuffer, bebox only) +.Cd wsdisplay0 at ofb? console ? +(Open Firmware framebuffer, macppc only) +.Cd wsdisplay* at nextdisplay? console ? +(NeXT display) +.Cd wsdisplay0 at smg0 +(VAXstation small monochrome display) +.Cd options WSDISPLAY_DEFAULTSCREENS=N +.Sh DESCRIPTION +The +.Nm +driver is an abstraction layer for display devices within the +.Xr wscons 4 +framework. It attaches to the hardware specific display device +driver and and makes it available as text terminal or graphics +interface. +.Pp +A display device can have the ability to display characters on it +(without help of an X server), either directly by hardware or through +software putting pixel data into the display memory. +Such displays are called +.Dq emulating , +the +.Nm +driver will connect a terminal emulation module and provide a +tty-like software interface. In contrary, non-emulating displays can only +be used by special programs like X servers. +.Pp +The +.Em console +locator in the configuration line refers to the device's use as output +part of the operating system console. A device specification containing +a positive value here will only match if the device is in use as system +console. (The console device selection in early system startup is not +influenced.) This way, the console device can be connected to a known +wsdisplay device instance. (Naturally, only +.Dq emulating +display devices are usable as console.) +.Pp +The logical unit of an independent contents displayed on a display +(sometimes referred to as +.Dq virtual terminal +) is called a +.Dq screen +here. If the underlying device driver supports it, multiple screens can +be used on one display. (As of this writing, only the +.Xr vga 4 +and the +.Tn VAX +.Dq smg +display drivers provide this ability.) +Screens have different minor device numbers and separate tty instances. +One screen posesses the +.Dq focus , +this means it is displayed on the display and its tty device will get +the keyboard input. (In some cases - if no screen is set up or if a screen +was just deleted - it is possible that no focus is present at all.) +The focus can be switched by either special keyboard input (typically +CTL-ALT-Fn) or an ioctl command issued by a user program. +Screens are set up or deleted through the +.Pa /dev/ttyEcfg +control decice (preferrably using the +.Xr wsconscfg 8 +utility). Alternatively, the compile-time option +.Cd WSDISPLAY_DEFAULTSCREENS=N +will set up N screens of the display driver's default type and using +the system's default terminal emulator at autoconfiguration time. +.Sh FILES +.Bl -item +.It +.Pa /dev/ttyE* +Terminal devices (per screen). +.It +.Pa /dev/ttyEcfg +Control device. +.It +.Pa /usr/include/dev/wscons/wsconsio.h +.El +.Sh BUGS +The +.Nm +code currently limits the number of screens on one display to 8. +.Pp +The terms +.Dq wscons +and +.Dq wsdisplay +are not cleanly distinguished in the code and in manual pages. +.Pp +.Dq non-emulating +display devices are not tested. +.Sh SEE ALSO +.Xr wscons 4 , +.Xr wsconscfg 8 , +.Xr wsconsctl 8 , +.Xr wsfontload 8 , +.Xr ega 4 , +.Xr vga 4 , +.Xr pcdisplay 4 , +.Xr tty 4 + diff --git a/share/man/man4/wskbd.4 b/share/man/man4/wskbd.4 new file mode 100644 index 00000000000..934710a06eb --- /dev/null +++ b/share/man/man4/wskbd.4 @@ -0,0 +1,102 @@ +.\" $NetBSD: wskbd.4,v 1.5 2000/03/20 11:51:59 pk Exp $ +.Dd March 20, 1999 +.Os +.Dt WSKBD 4 +.Sh NAME +.Nm wskbd +.Nd generic keyboard support in wscons +.Sh SYNOPSIS +.Cd "wskbd* at pckbd? console ? mux 1" +(standard PC keyboard) +.Cd "wskbd* at ukbd? console ? mux 1" +(USB keyboard) +.Cd "wskbd* at lkkbd? console ? mux 1" +(DEC LK200/400 serial keyboard) +.Cd "wskbd0 at akbd? console ? mux 1" +(Apple ADB keyboard) +.Cd "wskbd0 at nextkbd? console ? mux 1" +(NeXT keyboard) +.Cd "wskbd* at vrkiu? console ? mux 1" +(NEC VR4000 series HPC keyboard) +.Cd "wskbd* at skbd? console ? mux 1" +(keyboard of misc hpcmips handheld devices) +.Sh DESCRIPTION +The +.Nm +driver handles common tasks for keyboards within the +.Xr wscons 4 +framework. It is attached to the hardware specific keyboard drivers and +provides their connection to +.Dq wsdisplay +devices and a character device interface. +.Pp +The common keyboard support consists of: +.Bl -bullet +.It +Mapping from keycodes (defined by the specific keyboard driver) to +keysyms (hardware independent, defined in +.Pa /usr/include/dev/wscons/wsksymdef.h +). +.It +Handling of +.Dq compose +sequences. Characters commonly not present as separate key on keyboards +can be generated after either a special +.Dq compose +key is pressed or a +.Dq dead accent +character is used. +.It +Certain translations, like turning an +.Dq ALT +modifier into an +.Dq ESC +prefix. +.It +Automatic key repetition ( +.Dq typematic +). +.It +Parameter handling for +.Dq keyboard bells . +.It +Generation of +.Dq keyboard events +for use by X servers. +.El +.Pp +The +.Nm +driver provides a number of ioctl functions to control key maps +and other parameters. These functions are accessible though the +associated +.Dq wsdisplay +device as well. A complete list is in +.Pa /usr/include/dev/wscons/wsconsio.h . +The +.Xr wsconsctl 8 +utility allows to access key maps and other variables. +.Pp +The +.Em console +locator in the configuration line refers to the device's use as input +part of the operating system console. A device specification containing +a positive value here will only match if the device is in use as system +console. (The console device selection in early system startup is not +influenced.) This way, the console device can be connected to a known +wskbd device instance. +.Sh FILES +.Bl -item +.It +.Pa /dev/wskbd* +.It +.Pa /usr/include/dev/wscons/wsksymdef.h +.It +.Pa /usr/include/dev/wscons/wsconsio.h . +.El +.Sh SEE ALSO +.Xr wscons 4 , +.Xr wsconsctl 8 , +.Xr wsmux 4 , +.Xr pckbd 4 , +.Xr ukbd 4 diff --git a/share/man/man4/wsmouse.4 b/share/man/man4/wsmouse.4 new file mode 100644 index 00000000000..6c380c9b35a --- /dev/null +++ b/share/man/man4/wsmouse.4 @@ -0,0 +1,55 @@ +.\" $NetBSD: wsmouse.4,v 1.3 1999/12/06 14:52:08 augustss Exp $ +.Dd March 20, 1999 +.Os +.Dt WSMOUSE 4 +.Sh NAME +.Nm wsmouse +.Nd generic mouse support in wscons +.Sh SYNOPSIS +.Cd "wsmouse* at pms? mux 0" +(PS/2 mouse) +.Cd "wsmouse* at pmsi? mux 0" +( +.Dq Intellimouse +-compatible wheel mouse with PS/2 interface) +.Cd "wsmouse* at ums? mux 0" +(USB mouse) +.Cd "wsmouse* at lms? mux 0" +(Logitech bus mouse, i386 only) +.Cd "wsmouse* at mms? mux 0" +(Microsoft InPort mouse, i386 only) +.Cd "wsmouse0 at ams? mux 0" +(Apple ADB mouse) +.Sh DESCRIPTION +The +.Nm +driver is an abstraction layer for mice within the +.Xr wscons 4 +framework. It is attached to the hardware specific keyboard drivers and +provides a character device interface. For use with X servers, +.Dq mouse events +can be generated. +.Pp +The +.Nm +driver provides a number of ioctl functions to control +various parameters. A complete list is in +.Pa /usr/include/dev/wscons/wsconsio.h . +The +.Xr wsconsctl 8 +utility gives access to these variables. +.Sh FILES +.Bl -item +.It +.Pa /dev/wsmouse* +.It +.Pa /usr/include/dev/wscons/wsconsio.h . +.El +.Sh SEE ALSO +.Xr wscons 4 , +.Xr wsconsctl 8 , +.Xr wsmux 4 , +.Xr pms 4 , +.Xr lms 4 , +.Xr mms 4 , +.Xr ums 4 diff --git a/share/man/man4/wsmux.4 b/share/man/man4/wsmux.4 new file mode 100644 index 00000000000..15e975a373a --- /dev/null +++ b/share/man/man4/wsmux.4 @@ -0,0 +1,95 @@ +.\" $NetBSD: wsmux.4,v 1.2 1999/11/03 22:01:40 castor Exp $ +.\" +.\" Copyright (c) 1999 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" 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. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. 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 July 26, 1999 +.Dt WSMUX 4 +.Os +.Sh NAME +.Nm wsmux +.Nd console keyboard/mouse multiplexor for wscons +.Sh SYNOPSIS +.Cd "wskbd* at ... mux N" +.Cd "wsmouse* at ... mux N" + +.Cd pseudo-device wsmux N +.Pp +.Sh DESCRIPTION +The +.Nm +is a pseudo-device driver that allows several +.Xr wscons 4 +input devices to have their events multiplexed into one stream. +.Pp +The typical usage for this device is to have two multiplexors, one +for mouse events and one for keyboard events. All +.Xr wsmouse 4 +devices should direct their events to the mouse mux (normally 0) +and all keyboard devices, except the console, should direct their +events to the keyboard mux (normally 1). A device will +send its events to the mux indicated by the +.Va mux +locator. If none is given the device will not use a multiplexor. +The keyboard multiplexor should be connected to the display, using +the +.Xr wsconscfg 8 +command. It will then receive all keystrokes from all keyboards +and, furthermore, keyboards can be dynamically attached and detached without +further user interaction. +In a similar way, the window system will open the mouse multiplexor +and receive all mouse events; mice can also be dynamically attached +and detached. +.Pp +It is also possible to inject events into a multiplexor from a +user program. This is used by the +.Xr moused 8 +daemon to take data from a mouse connected to a serial port and +make it appear on the standard mouse mux. +.Pp +.Sh FILES +.Bl -item +.It +.Pa /dev/wsmouse +.It +.Pa /dev/wskbd +.It +.Pa /usr/include/dev/wscons/wsconsio.h . +.El +.Sh SEE ALSO +.Xr moused 8 , +.Xr wscons 4 , +.Xr wsdisplay 4 , +.Xr wskbd 4 , +.Xr wsmouse 4 , +.Xr wsconscfg 8 , +.Xr wsconsctl 8 , +.Xr wsfontload 8 |