xref: /freebsd/usr.sbin/kbdmap/kbdmap.1 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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.Dd July 3, 2002
25.Dt KBDMAP 1
26.Os
27.Sh NAME
28.Nm kbdmap ,
29.Nm vidfont
30.Nd front end for syscons and vt
31.Sh SYNOPSIS
32.Nm
33.Op Fl K
34.Op Fl V
35.Op Fl d | default
36.Op Fl h | help
37.Op Fl l | lang Ar language
38.Op Fl p | print
39.Op Fl r | restore
40.Op Fl s | show
41.Op Fl v | verbose
42.Sh DESCRIPTION
43The
44.Nm
45utility allows easy setting of available keymaps.
46The
47.Nm vidfont
48command allows the setting of fonts.
49Both examine a database for the keymaps and fonts.
50Descriptions are in English by default, but may also be
51in other languages.
52These programs are interactive and expect to run
53in a terminal to get required input (e.g., a keymap selection)
54from the user.
55.Pp
56It is strongly recommended to not choose
57.Tn MSDOS
58codepage keymaps
59or fonts.
60Use the
61.Tn ISO
62standard version if available!
63.Tn X11
64does not
65support
66.Tn MSDOS
67codepage.
68.Pp
69The following options are available:
70.Bl -tag -width indent
71.It Fl K
72Run as command
73.Nm .
74.It Fl V
75Run as command
76.Nm vidfont .
77.It Fl d , default
78Use default language.
79Ignore
80.Ev LANG
81environment variable.
82.It Fl h , help
83Print options and exit.
84.It Fl l , lang Ar language
85Use
86.Ar language
87for description and menu.
88.It Fl p , print
89Print description of available keymaps or fonts
90to stdout and exit.
91.It Fl r , restore
92Load default font from
93.Pa /etc/rc.conf .
94.It Fl s , show
95Show currently supported languages and exit.
96.It Fl v , verbose
97More warnings.
98.El
99.Sh ENVIRONMENT
100.Bl -tag -width LANG -compact
101.It Ev LANG
102preferred language
103.El
104.Sh FILES
105.Bl -tag -width ".Pa /usr/share/syscons/keymaps/INDEX.keymaps" -compact
106.It Pa /usr/share/syscons/keymaps/INDEX.keymaps
107.It Pa /usr/share/vt/keymaps/INDEX.keymaps
108database for keymaps
109.It Pa /usr/share/syscons/fonts/INDEX.fonts
110.It Pa /usr/share/vt/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 syscons 4 ,
124.Xr vt 4 ,
125.Xr kbdmap 5 ,
126.Xr rc.conf 5
127.Sh HISTORY
128The
129.Nm
130and
131.Nm vidfont
132commands appeared in
133.Fx 2.1 .
134.Sh AUTHORS
135.An -nosplit
136.An Wolfram Schneider Aq Mt wosch@FreeBSD.org
137wrote the original Perl version.
138The current version was rewritten in C by
139.An Jonathan Belson Aq Mt 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