1.\" $NetBSD: wsconscfg.8,v 1.20 2009/03/09 19:24:33 joerg Exp $ 2.\" 3.\" Copyright (c) 1999 4.\" Matthias Drochner. 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.Dd June 24, 2006 28.Dt WSCONSCFG 8 29.Os 30.Sh NAME 31.Nm wsconscfg 32.Nd configure and switch between virtual terminals on a wscons display 33.Sh SYNOPSIS 34.Nm 35.Op Fl e Ar emul 36.Op Fl f Ar ctldev 37.Op Fl t Ar type 38.Ar index 39.Nm 40.Fl d 41.Op Fl F 42.Op Fl f Ar ctldev 43.Ar index 44.Nm 45.Fl g 46.Op Fl f Ar ctldev 47.Nm 48.Fl k | m 49.Op Fl d 50.Op Fl f Ar ctldev 51.Op Ar index 52.Nm 53.Fl s 54.Op Fl f Ar ctldev 55.Ar index 56.Sh DESCRIPTION 57The 58.Nm 59tool allows to create, delete and switch between virtual terminals 60on display devices controlled by the wscons terminal framework if 61the underlying display hardware driver supports multiple screens. 62Further it controls the assignment of keyboards to displays. 63The 64.Ar index 65argument specifies which virtual terminal is to be configured; the 66allowed numbers are from 0 to an implementation-specified value 67(currently 7, allowing for 8 virtual terminals on a display). 68In keyboard configuration mode, it specifies the 69.Xr wskbd 4 70device to attach or detach. 71Without further option arguments, a virtual terminal is created 72with implementation specific properties and a default terminal 73emulation variant selected at kernel compile time. 74.Pp 75The options are: 76.Bl -tag -width xxxxxxxxx 77.It Fl d 78Delete the specified terminal. 79A terminal opened by a program will not be deleted unless the 80.Fl F 81option is applied. 82Terminals used by the operating system console or a graphics program 83(X server) cannot be deleted. 84With the 85.Fl k 86flag, the keyboard specified by 87.Ar index 88will be detached from the wscons display. 89With the 90.Fl m 91flag, the multiplexor specified by 92.Ar index 93will be detached from the wscons display. 94.It Fl e Ar emul 95Specify the terminal emulation to use for the virtual terminal. 96The set of available terminal emulations is determined at kernel 97compile time. 98See 99.Xr wscons 4 100for details. 101.It Fl F 102Force deleting of a terminal even if it is in use by a user space 103program. 104.It Fl f Ar ctldev 105Specify the control device of the wscons display to operate on. 106Default is 107.Pa /dev/ttyEcfg . 108.It Fl g 109Print the index of the current virtual terminal. 110.It Fl k 111Do keyboard related operations instead of virtual screen configuration. 112Without other flags, a keyboard will be attached to the display 113device. 114The 115.Ar index 116argument can be omitted, in this case the first free keyboard will 117be used. 118.It Fl m 119Do multiplexor related operations instead of virtual screen 120configuration. 121Without other flags, a multiplexor will be attached to the display 122device. 123.It Fl s 124Switch to the specified virtual terminal. 125.It Fl t Ar type 126Specify a screen type to use. 127Screen types refer to display format, colour depth and other 128low-level display properties. 129Valid 130.Ar type 131arguments are defined by the underlying display device driver. 132.El 133.Pp 134Typically, the 135.Nm 136utility will be invoked in system startup by the 137.Pa /etc/rc.d/wscons 138script, controlled by the 139.Pa /etc/wscons.conf 140configuration file. 141.Sh FILES 142.Pa /etc/wscons.conf 143.Sh EXAMPLES 144.Dl wsconscfg -t 80x50 -e vt100 1 145.Pp 146Configure screen 1 (i.e., the second), it will get the type 147.Ql 80x50 148and use the VT100 terminal emulation. 149(Note: 150.Ql 80x50 151is a screen type offered by the 152.Xr vga 4 153display driver. 154In this particular case, an 8\(mu8-font must be loaded before to 155make the screen useful. 156See 157.Xr wsfontload 8 . ) 158.Pp 159.Dl wsconscfg -k 160.Pp 161Connect the first unconnected keyboard to the display. 162.Pp 163.Dl wsconscfg 3 164.Pp 165Create screen 3. 166.Pp 167.Dl wsconscfg -d 3 168.Pp 169Delete screen 3. 170.Pp 171.Dl wsconscfg -s 2 172.Pp 173Switch to screen 2. 174.Sh SEE ALSO 175.Xr wscons 4 , 176.Xr wskbd 4 , 177.Xr wsconsctl 8 , 178.Xr wsfontload 8 179.Sh BUGS 180There should be an easy way to get a list of the screen types 181available on a display, and of the emulations supported by the 182kernel. 183