2 .\" kbdcontrol - a utility for manipulating the syscons keyboard driver section
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
14 .\" $FreeBSD: src/usr.sbin/kbdcontrol/kbdcontrol.1,v 1.18.2.9 2001/08/16 15:56:00 ru Exp $
15 .\" $DragonFly: src/usr.sbin/kbdcontrol/kbdcontrol.1,v 1.4 2006/02/17 19:40:16 swildner Exp $
17 .Dd September 12, 2009
22 .Nd keyboard control and configuration utility
30 .Ar duration . Ns Ar pitch | Ar belltype
34 .Ar delay . Ns Ar repeat | Ar speed
36 .Op Fl l Ar keymap_file
37 .Op Fl f Ar # Ar string
39 .Op Fl k Ar keyboard_device
40 .Op Fl L Ar keymap_file
44 command is used to set various keyboard related options for the
46 console driver and the keyboard drivers,
47 such as key map, keyboard repeat and delay rates, bell
50 Keyboard options may be automatically configured at system boot time by
54 .Sx Boot Time Configuration
57 The following command line options are supported:
58 .Bl -tag -width indent
60 Detach the keyboard, specified by the keyboard device name, from the keyboard
62 When using this option, the standard input of the
64 process should be redirected from the keyboard multiplexer keyboard device
65 (if the keyboard multiplexer is not the active keyboard) or
67 (if the keyboard multiplexer is the active keyboard and
68 you are not working on the system console).
70 Attach the keyboard, specified by the keyboard device name, to the keyboard
72 When using this option, the standard input of the
74 process should be redirected from the keyboard multiplexer keyboard device
75 (if the keyboard multiplexer is not the active keyboard) or
77 (if the keyboard multiplexer is the active keyboard and
78 you are not working on the system console).
80 .Ar duration . Ns Ar pitch | Ar belltype
82 Set the bell duration in milliseconds and pitch in hertz.
85 argument is specified, it may be one of
87 which sets sound parameters back to normal values,
89 which disables the bell entirely, or
91 which sets the bell to visual mode, i.e., flashes the screen instead.
94 is preceded by the word
96 the bell will not be rung when the ringing process is in the background vty.
99 bell, when chosen, applies to all vtys; other bell types
100 can be set individually for each vty.
102 .Ar delay . Ns Ar repeat | Ar speed
106 (250, 500, 750, 1000)
109 (34, 38, 42, 46, 50, 55, 59, 63, 68, 76, 84, 92, 100, 110, 118, 126,
110 136, 152, 168, 184, 200, 220, 236, 252, 272, 304, 336, 368, 400, 440,
114 argument is specified, it may be one of
122 .It Fl l Ar keymap_file
123 Install keyboard map file from
125 You may load the keyboard map file from a menu-driven command,
127 The format of keyboard map files is documented in the
131 Dump the current keyboard map onto stdout.
132 The output may be redirected to a file and can be loaded
133 back to the kernel later by the
136 .It Fl f Ar # Ar string
137 Set function key number
141 Refer to the man page for the keyboard driver
144 for available function keys and their numbers.
146 Set function keys back to the standard definitions.
148 Use hexadecimal numbers in keyboard map dump.
150 Set history buffer size to
154 Print brief information about the keyboard.
156 Disconnect the keyboard from the console.
159 option below to associate a keyboard with the console again.
160 .It Fl k Ar keyboard_device
161 Use the specified device as the console keyboard.
162 When using this option, the standard input of the
164 process should be redirected from
166 if you are not working on the system console
170 .It Fl L Ar keymap_file
171 Load keyboard map file from
175 compiled from it to stdout.
176 This option is primarily intended for programmers and is probably
177 of little use under normal circumstances.
180 The environment variable
182 can hold an alternative path to the keyboard map files.
183 .Sh KEYBOARD CONFIGURATION
184 .Ss Boot Time Configuration
185 You may set variables in
188 .Pa /etc/rc.conf.local
189 in order to configure the keyboard at boot time.
190 The following is the list of relevant variables.
192 .Bl -tag -width foo_bar_var -compact
194 Specifies a keyboard map file for the
198 Sets the keyboard repeat rate for the
202 Lists function key strings for the
210 .Ss Driver Configuration
211 The keyboard device driver may let you change default configuration
212 options, such as the default keyboard map, so that you do not need to set up
213 the options at boot time.
214 See keyboard driver manuals
220 .Bl -tag -width /usr/share/syscons/keymaps/foo_bar -compact
221 .It Pa /usr/share/syscons/keymaps/*
225 The following command will load the keyboard map file
226 .Pa /usr/share/syscons/keymaps/ru.koi8-r.kbd .
228 .Dl kbdcontrol -l /usr/share/syscons/keymaps/ru.koi8-r.kbd
230 So long as the keyboard map file resides in
231 .Pa /usr/share/syscons/keymaps ,
232 you may abbreviate the file name as
235 .Dl kbdcontrol -l ru.koi8-r
237 The following command will make the function key 10 emit "telnet myhost".
239 .Dl kbdcontrol -f 10 \&"telnet myhost\&"
241 In order to get the visual effect for bell, but prevent the screen
242 from flushing if the bell is to ring in the background screen,
243 run the following command.
245 .Dl kbdcontrol -b quiet.visual
247 To change the default console keyboard to another keyboard,
248 for example the first USB keyboard (see
250 use the following commands.
252 .Dl kbdcontrol -k /dev/kbd1 < /dev/console
254 To switch back to the default keyboard, use this command.
256 .Dl kbdcontrol -k /dev/kbd0
269 .An S\(/oren Schmidt Aq sos@FreeBSD.org