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