xref: /netbsd-src/share/man/man5/wscons.conf.5 (revision 220b5c059a84c51ea44107ea8951a57ffaecdc8c)
1.\"	$NetBSD: wscons.conf.5,v 1.7 2001/09/11 01:01:59 wiz 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 September 2, 2000
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 -compact
51.It Sy screen      idx scr emul
52Add and configure virtual console number
53.Sy idx
54using a screen type of
55.Sy scr
56(e.g. 80x25) and a
57.Sy emul
58terminal emulation (e.g. vt100). See
59.Xr wsconscfg 8
60for further parameter description.
61.Pp
62.It Sy font        name width height enc file
63Used to load a font via
64.Xr wsfontload 8 .
65.Sy name
66gives a font name that can be used later,
67.Sy width
68can be used to specify the width of a font character in pixel,
69.Sy height
70is the same, just for the font characters' height.
71.Sy enc
72is used to declare the font's encoding, see the description on
73.Xr wsfontload 8 's
74.Fl e
75option for more detail.
76.Sy file
77gives the absolute path to the font file.
78See
79.Xr wsfontload 8
80for more information.
81.Pp
82.It Sy keyboard    <wsconscfg -k args>
83The given argument(s) are handed off to
84.Dq Li "wsconscfg -k"
85for attaching and configuration of keyboards. See
86.Xr wsconscfg 8
87for more information.
88.Pp
89.It Sy encoding    <wsconsctl -w encoding=arg>
90Set the keyboard map to the given language code. The map
91must be supported by the keyboard driver in use and must be
92compiled into the kernel. See the keyboard driver's manpage (eg.
93.Xr pckbd 4 ,
94.Xr ukbd 4 )
95for details.
96.Pp
97.It Sy mapfile
98Passes the contents of a file containing a keyboard map line by line to
99.Dq wsconsctl -w map+=
100See
101.Xr wsconsctl 8
102for details.
103.Pp
104.It Sy mux         <wsconscfg -m args>
105Used to attach and configure keyboard/mouse multiplexors. See
106.Xr wsconscfg 8
107for more information.
108.Pp
109.El
110Command arguments can be specified as
111.Dq -
112which makes default values come into effect as described in the
113documentation of the utilities.
114.Sh FILES
115.Bl -tag -width /etc/wscons.conf -compact
116.It Pa /etc/wscons.conf
117.El
118.Sh SEE ALSO
119.Xr wscons 4 ,
120.Xr wsconscfg 8 ,
121.Xr wsfontload 8
122