xref: /netbsd/share/man/man5/wscons.conf.5 (revision bf9ec67e)
1.\"	$NetBSD: wscons.conf.5,v 1.9 2002/04/26 00:06:53 lukem Exp $
2.\"
3.\" Copyright 2000, 2001 Hubert Feyrer <hubertf@netbsd.org>
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.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"      This product includes software developed by Hubert Feyrer
17.\"      for the NetBSD Project.
18.\" 4. The name of the author may not be used to endorse or promote products
19.\"    derived from this software without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.Dd April 26, 2002
33.Dt WSCONS.CONF 5
34.Os
35.Sh NAME
36.Nm wscons.conf
37.Nd workstation console config file
38.Sh SYNOPSIS
39.Nm
40.Sh DESCRIPTION
41The
42.Nm
43file defines parameters regarding to the workstation console (wscons).
44The file consists of lines starting with a keyword, and one or more arguments.
45Empty lines and lines starting with a hash
46.Pq Dq \&#
47are ignored.
48.Pp
49The following keywords and arguments are recognized:
50.Bl -tag -width keyboard
51.It Sy font Xo
52.Ar name Ar width Ar height
53.Ar enc Ar file
54.Xc
55Used to load a font via
56.Xr wsfontload 8 .
57.Ar name
58gives a font name that can be used later,
59.Ar width
60can be used to specify the width of a font character in pixel,
61.Ar height
62is the same, just for the font characters' height.
63.Ar enc
64is used to declare the font's encoding, see the description on
65.Xr wsfontload 8 's
66.Fl e
67option for more detail.
68.Ar file
69gives the absolute path to the font file.
70See
71.Xr wsfontload 8
72for more information.
73.
74.It Sy screen Ar idx Ar scr Ar emul
75Add and configure virtual console number
76.Ar idx
77using a screen type of
78.Ar scr
79(e.g. 80x25) and a
80.Ar emul
81terminal emulation (e.g. vt100). See
82.Xr wsconscfg 8
83for further parameter description.
84.
85.It Sy keyboard Ar kbd
86Attach and configure keyboard
87.Ar kbd
88using
89.Dq Li "wsconscfg -k" .
90If
91.Ar kbd
92is
93.Sq Li -
94or
95.Sq Li auto ,
96the first free keyboard will be used.
97See
98.Xr wsconscfg 8
99for more information.
100.
101.It Sy encoding Ar enc
102Set the keyboard map to the given language code
103.Ar enc ,
104using
105.Dq Li "wsconsctl -w encoding=enc" .
106The map must be supported by the keyboard driver in use and must be
107compiled into the kernel.
108See the keyboard driver's manpage (eg.
109.Xr pckbd 4 ,
110.Xr ukbd 4 )
111for details.
112.
113.It Sy mapfile Ar file
114Parses the contents of
115.Ar file ,
116which contains a keyboard map per line, and calls
117.Dq Li "wsconsctl -w map+="
118for each line.
119See
120.Xr wsconsctl 8
121for details.
122.
123.It Sy mux Ar idx
124Used to attach and configure keyboard/mouse multiplexors, using
125.Dq Li "wsconscfg -m idx" .
126See
127.Xr wsconscfg 8
128for more information.
129.
130.It Sy setvar Ar var Ns = Ns Ar val
131Set wscons variable
132.Ar var
133to
134.Ar val ,
135using
136.Dq Li "wsconsctl -w var=val" .
137See
138.Xr wsconsctl 8
139for more information.
140.El
141.Pp
142Command arguments can be specified as
143.Dq -
144which makes default values come into effect as described in the
145documentation of the utilities.
146.Sh FILES
147.Bl -tag -width /etc/wscons.conf -compact
148.It Pa /etc/wscons.conf
149.El
150.Sh SEE ALSO
151.Xr wscons 4 ,
152.Xr wsconscfg 8 ,
153.Xr wsfontload 8
154