xref: /netbsd-src/usr.sbin/wsconscfg/wsconscfg.8 (revision 1ffa7b76c40339c17a0fb2a09fac93f287cfc046)
1.\"	$NetBSD: wsconscfg.8,v 1.14 2003/02/25 10:36:22 wiz 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 January 12, 1999
28.Os
29.Dt WSCONSCFG 8
30.Sh NAME
31.Nm wsconscfg
32.Nd configure virtual terminals on a wscons display
33.Sh SYNOPSIS
34.Nm
35.Op Fl f Ar ctldev
36.Op Fl t Ar type
37.Op Fl e Ar emul
38.Ar index
39.Nm
40.Op Fl f Ar ctldev
41.Fl d
42.Op Fl F
43.Ar index
44.Nm
45.Op Fl f Ar ctldev
46.Fl k | m
47.Op Fl d
48.Op Ar index
49.Sh DESCRIPTION
50The
51.Nm
52tool allows to create and delete virtual terminals on display devices
53controlled by the wscons terminal framework if the underlying display hardware
54driver supports multiple screens. Further it controls the assignment of
55keyboards to displays.
56The
57.Ar index
58argument specifies which virtual terminal is to be configured; the allowed
59numbers are from 0 to an implementation-specified value (currently 7, allowing
60for 8 virtual terminals on a display).
61In keyboard configuration mode, it specifies the
62.Xr wskbd 4
63device to attach or detach.
64Without further option arguments, a virtual terminal is created with
65implementation specific properties and a default terminal emulation variant
66selected at kernel compile time.
67.Pp
68The options are:
69.Bl -tag -width xxxxxxxxx
70.It Fl f Ar ctldev
71Specify the control device of the wscons display to operate on.
72Default is
73.Pa /dev/ttyEcfg .
74.It Fl d
75Delete the specified terminal. A terminal opened by a program will not be
76deleted unless the
77.Fl F
78option is applied. Terminals used by the operating system console or a
79graphics program (X server) cannot be deleted. With the
80.Fl k
81flag, the keyboard specified by
82.Ar index
83will be detached from the wscons display.
84With the
85.Fl m
86flag, the multiplexor specified by
87.Ar index
88will be detached from the wscons display.
89.It Fl F
90Force deleting of a terminal even if it is in use by a user space program.
91.It Fl k
92Do keyboard related operations instead of virtual screen configuration.
93Without other flags, a keyboard will be attached to the display device. The
94.Ar index
95argument can be omitted, in this case the first free keyboard will be used.
96.It Fl m
97Do multiplexor related operations instead of virtual screen configuration.
98Without other flags, a multiplexor will be attached to the display device.
99.It Fl t Ar type
100Specify a screen type to use. Screen types refer to display format, colour
101depth and other low-level display properties. Valid
102.Ar type
103arguments are defined by the underlying display device driver.
104.It Fl e Ar emul
105Specify the terminal emulation to use for the virtual terminal. The set of
106available terminal emulations is determined at kernel compile time. See
107.Xr wscons 4
108for details.
109.El
110.Pp
111Typically, the
112.Nm
113utility will be invoked in system startup by the
114.Pa /etc/rc.d/wscons
115script, controlled by the
116.Pa /etc/wscons.conf
117configuration file.
118.Sh FILES
119.Pa /etc/wscons.conf
120.Sh EXAMPLES
121.Dl wsconscfg -t 80x50 -e vt100 1
122.Pp
123Configure screen 1 (i.e. the second), it will get the type
124.Ql 80x50
125and use the VT100 terminal emulation. (Note:
126.Ql 80x50
127is a screen type offered by the
128.Xr vga 4
129display driver. In this particular case, an 8\(mu8-font must be loaded
130before to make the screen useful. See
131.Xr wsfontload 8 . )
132.Pp
133.Dl wsconscfg -k
134.Pp
135Connect the first unconnected keyboard to the display.
136.Sh SEE ALSO
137.Xr wscons 4 ,
138.Xr wskbd 4 ,
139.Xr wsconsctl 8 ,
140.Xr wsfontload 8
141.Sh BUGS
142There should be an easy way to get a list of the screen types available
143on a display, and of the emulations supported by the kernel.
144