xref: /freebsd/usr.sbin/kbdmap/kbdmap.1 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) March 1995 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.Dd July 7, 2024
28.Dt KBDMAP 1
29.Os
30.Sh NAME
31.Nm kbdmap ,
32.Nm vidfont
33.Nd system video console keyboard map/font dialog utilities
34.Sh SYNOPSIS
35.Nm
36.Op Fl K
37.Op Fl V
38.Op Fl d | default
39.Op Fl h | help
40.Op Fl l | lang Ar language
41.Op Fl p | print
42.Op Fl r | restore
43.Op Fl s | show
44.Op Fl v | verbose
45.Sh DESCRIPTION
46The
47.Nm
48utility allows easy setting of available keymaps.
49The
50.Nm vidfont
51command allows the setting of fonts.
52Both examine a database for the keymaps and fonts.
53Descriptions are in English by default, but may also be
54in other languages.
55These programs are interactive and expect to run
56in a terminal to get required input (e.g., a keymap selection)
57from the user.
58.Pp
59It is strongly recommended to not choose
60.Tn MSDOS
61codepage keymaps
62or fonts.
63Use the
64.Tn ISO
65standard version if available!
66.Tn X11
67does not
68support
69.Tn MSDOS
70codepage.
71.Pp
72The following options are available:
73.Bl -tag -width indent
74.It Fl K
75Run as command
76.Nm .
77.It Fl V
78Run as command
79.Nm vidfont .
80.It Fl d , default
81Use default language.
82Ignore
83.Ev LANG
84environment variable.
85.It Fl h , help
86Print options and exit.
87.It Fl l , lang Ar language
88Use
89.Ar language
90for description and menu.
91.It Fl p , print
92Print description of available keymaps or fonts
93to stdout and exit.
94.It Fl r , restore
95Load default font from
96.Pa /etc/rc.conf .
97.It Fl s , show
98Show currently supported languages and exit.
99.It Fl v , verbose
100More warnings.
101.El
102.Sh ENVIRONMENT
103.Bl -tag -width LANG -compact
104.It Ev LANG
105preferred language
106.El
107.Sh FILES
108.Bl -tag -width ".Pa /usr/share/syscons/keymaps/INDEX.keymaps" -compact
109.It Pa /usr/share/syscons/keymaps/INDEX.keymaps
110.It Pa /usr/share/vt/keymaps/INDEX.keymaps
111database for keymaps
112.It Pa /usr/share/syscons/fonts/INDEX.fonts
113.It Pa /usr/share/vt/fonts/INDEX.fonts
114database for fonts
115.It Pa /etc/rc.conf
116default font
117.It Pa /usr/local/share/locale/locale.alias
118describe common
119.Ev LANG
120values
121.El
122.Sh SEE ALSO
123.Xr dialog 1 ,
124.Xr kbdcontrol 1 ,
125.Xr vidcontrol 1 ,
126.Xr syscons 4 ,
127.Xr vt 4 ,
128.Xr kbdmap 5 ,
129.Xr rc.conf 5
130.Sh HISTORY
131The
132.Nm
133and
134.Nm vidfont
135commands appeared in
136.Fx 2.1 .
137.Sh AUTHORS
138.An -nosplit
139.An Wolfram Schneider Aq Mt wosch@FreeBSD.org
140wrote the original Perl version.
141The current version was rewritten in C by
142.An Jonathan Belson Aq Mt jon@witchspace.com
143for
144.Fx 5.0 .
145.Sh BUGS
146.\" .Nm kbdmap/vidfont
147.\" does not know which font is in use. E.g. if the current font
148.\" is iso-8859-1 and you chose lang 'ru' (for Russian)
149.\" you get funny latin1 characters and not russkij shrift.
150.\"
151The
152.Nm
153and
154.Nm vidfont
155utilities work only on a (virtual) console and not with
156.Tn X11 .
157