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