Sweep-fix man page section order to match mdoc(7), part 5/5.
[dragonfly.git] / usr.sbin / kbdmap / kbdmap.1
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: src/usr.sbin/kbdmap/kbdmap.1,v 1.31 2002/12/04 14:45:48 ru Exp $
26 .\" $DragonFly: src/usr.sbin/kbdmap/kbdmap.1,v 1.4 2006/02/17 19:40:16 swildner Exp $
27 .Dd July 3, 2002
28 .Dt KBDMAP 1
29 .Os
30 .Sh NAME
31 .Nm kbdmap ,
32 .Nm vidfont
33 .Nd front end for syscons
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl K
37 .Op Fl V
38 .Op Fl d | Fl default
39 .Op Fl h | Fl help
40 .Op Fl l | Fl lang Ar language
41 .Op Fl p | Fl print
42 .Op Fl r | Fl restore
43 .Op Fl s | Fl show
44 .Op Fl v | Fl verbose
45 .Sh DESCRIPTION
46 The
47 .Nm
48 utility allows easy setting of available keymaps.
49 The
50 .Nm vidfont
51 command allows the setting of fonts.
52 Both examine a database for the keymaps and fonts.
53 Descriptions are in English by default, but may also be
54 in other languages.
55 These programs are interactive and expect to run
56 in a terminal to get required input (e.g., a keymap selection)
57 from the user.
58 .Pp
59 It is strongly recommended to not choose
60 .Tn MSDOS
61 codepage keymaps
62 or fonts.
63 Use the
64 .Tn ISO
65 standard version if available!
66 .Tn X11
67 does not
68 support
69 .Tn MSDOS
70 codepage.
71 .Pp
72 The following options are available:
73 .Bl -tag -width indent
74 .It Fl K
75 Run as command
76 .Nm .
77 .It Fl V
78 Run as command
79 .Nm vidfont .
80 .It Fl d , Fl default
81 Use default language.
82 Ignore
83 .Ev LANG
84 environment variable.
85 .It Fl h , Fl help
86 Print options and exit.
87 .It Fl l , Fl lang Ar language
88 Use
89 .Ar language
90 for description and menu
91 .It Fl p , Fl print
92 Print description  of available keymaps or fonts
93 to stdout and exit.
94 .It Fl r , Fl restore
95 Load default font from
96 .Pa /etc/rc.conf .
97 .It Fl s , Fl show
98 Show currently supported languages and exit.
99 .It Fl v , Fl verbose
100 More warnings.
101 .El
102 .Sh ENVIRONMENT
103 .Bl -tag -width LANG -compact
104 .It Ev LANG
105 preferred language
106 .El
107 .Sh FILES
108 .Bl -tag -width /usr/share/syscons/keymaps/INDEX.keymaps -compact
109 .It Pa /usr/share/syscons/keymaps/INDEX.keymaps
110 database for keymaps
111 .It Pa /usr/share/syscons/fonts/INDEX.fonts
112 database for fonts
113 .It Pa /etc/rc.conf
114 default font
115 .It Pa /usr/X11/lib/X11/locale/locale.alias
116 describe common
117 .Ev LANG
118 values
119 .El
120 .Sh SEE ALSO
121 .Xr dialog 1 ,
122 .Xr kbdcontrol 1 ,
123 .Xr vidcontrol 1 ,
124 .Xr kbdmap 5 ,
125 .Xr rc.conf 5
126 .Sh HISTORY
127 The
128 .Nm
129 and
130 .Nm vidfont
131 commands appeared in
132 .Fx 2.1 .
133 .Sh AUTHORS
134 .An -nosplit
135 .An Wolfram Schneider
136 .Aq wosch@FreeBSD.org
137 wrote the original Perl version.
138 The current version was rewritten in C by
139 .An Jonathan Belson
140 .Aq jon@witchspace.com
141 for
142 .Fx 5.0 .
143 .Sh BUGS
144 .\" .Nm kbdmap/vidfont
145 .\" does not know which font is in use. E.g. if the current font
146 .\" is iso-8859-1 and you chose lang 'ru' (for Russian)
147 .\" you get funny latin1 characters and not russkij shrift.
148 .\"
149 The
150 .Nm
151 and
152 .Nm vidfont
153 utilities work only on a (virtual) console and not with
154 .Tn X11 .