xref: /netbsd/share/man/man5/wscons.conf.5 (revision 6550d01e)
1.\"	$NetBSD: wscons.conf.5,v 1.20 2009/03/11 19:38:08 joerg Exp $
2.\"
3.\" Copyright (c) 2000-2008 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Hubert Feyrer <hubert@feyrer.de>.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd November 22, 2008
31.Dt WSCONS.CONF 5
32.Os
33.Sh NAME
34.Nm wscons.conf
35.Nd workstation console config file
36.Sh SYNOPSIS
37.Nm
38.Sh DESCRIPTION
39The
40.Nm
41file defines parameters regarding to the workstation console (wscons).
42The file consists of lines starting with a keyword, and one or more arguments.
43Empty lines and lines starting with a hash
44.Pq Dq \&#
45are ignored.
46.Pp
47This configuration file is used by the
48.Pa /etc/rc.d/wscons
49script which parses
50.Pa /etc/wscons.conf
51and runs
52.Xr wsconscfg 8 ,
53.Xr wsconsctl 8 ,
54and/or
55.Xr wsfontload 8
56as configured.
57See
58.Xr rc.conf 5
59for details on enabling the rc.d script.
60.Pp
61The following keywords and arguments are recognized:
62.Bl -tag -width keyboard
63.It Sy font Ar name Ar width Ar height Ar enc Ar file
64Used to load a font via
65.Xr wsfontload 8 .
66.Ar name
67gives a font name that can be used later,
68.Ar width
69can be used to specify the width of a font character in pixel,
70.Ar height
71is the same, just for the font characters' height.
72.Ar enc
73is used to declare the font's encoding, see the description on
74.Xr wsfontload 8 Ns 's
75.Fl e
76option for more detail.
77.Ar file
78gives the absolute path to the font file.
79See
80.Xr wsfontload 8
81for more information.
82.
83.It Sy screen Ar idx Ar scr Ar emul
84Add and configure virtual console number
85.Ar idx
86using a screen type of
87.Ar scr
88(e.g. 80x25) and a
89.Ar emul
90terminal emulation (e.g. vt100). See
91.Xr wsconscfg 8
92for further parameter description.
93.
94.It Sy keyboard Ar kbd
95Attach and configure keyboard
96.Ar kbd
97using
98.Dq Li "wsconscfg -k" .
99If
100.Ar kbd
101is
102.Sq Li -
103or
104.Sq Li auto ,
105the first free keyboard will be used.
106See
107.Xr wsconscfg 8
108for more information.
109.
110.It Sy encoding Ar enc
111Set the keyboard map to the given language code
112.Ar enc ,
113using
114.Dq Li "wsconsctl -w encoding=enc" .
115The map must be supported by the keyboard driver in use and must be
116compiled into the kernel.
117See the keyboard driver's manpage (e.g.,
118.Xr pckbd 4 ,
119.Xr ukbd 4 )
120for details.
121.
122.It Sy mapfile Ar file
123Parses the contents of
124.Ar file ,
125which contains a keyboard map per line, and calls
126.Dq Li "wsconsctl -w map+="
127for each line.
128See
129.Xr wsconsctl 8
130for details.
131.
132.It Sy mux Ar idx
133Used to attach and configure keyboard/mouse multiplexors, using
134.Dq Li "wsconscfg -m idx" .
135See
136.Xr wsconscfg 8
137for more information.
138.
139.It Sy setvar Ar dev Ar var Ar val
140Set arbitrary wscons variable
141.Ar var
142to value
143.Ar val
144for specified control device
145.Ar dev .
146Can be used for direct modification of
147.Xr wscons 4
148variables, when no other keywords are suitable.
149See
150.Xr wsconsctl 8
151for more information.
152.El
153.Pp
154Command arguments can be specified as
155.Dq -
156which makes default values come into effect as described in the
157documentation of the utilities.
158.Sh FILES
159.Bl -tag -width /etc/wscons.conf -compact
160.It Pa /etc/wscons.conf
161.El
162.Sh SEE ALSO
163.Xr wscons 4 ,
164.Xr wsconscfg 8 ,
165.Xr wsconsctl 8 ,
166.Xr wsfontload 8
167