usr.sbin/kbdcontrol/kbdcontrol.1

   1 .\"
   2 .\" kbdcontrol - a utility for manipulating the syscons keyboard driver section
   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 .\"     @(#)kbdcontrol.1
  14 .\" $FreeBSD$
  15 .\"
  16 .Dd May 27, 2001
  17 .Dt KBDCONTROL 1
  18 .Os
  19 .Sh NAME
  20 .Nm kbdcontrol
  21 .Nd keyboard control and configuration utility
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl dFKix
  25 .Oo
  26 .Fl b
  27 .Ar duration . Ns Ar pitch | Ar belltype
  28 .Oc
  29 .Oo
  30 .Fl r
  31 .Ar delay . Ns Ar repeat | Ar speed
  32 .Oc
  33 .Op Fl l Ar keymap_file
  34 .Op Fl f Ar # Ar string
  35 .Op Fl k Ar keyboard_device
  36 .Op Fl L Ar keymap_file
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 command is used to set various keyboard related options for the
  41 .Xr syscons 4
  42 console driver and the keyboard drivers,
  43 such as key map, keyboard repeat and delay rates, bell
  44 characteristics etc.
  45 .Pp
  46 Keyboard options may be automatically configured at system boot time by
  47 setting variables in
  48 .Pa /etc/rc.conf .
  49 See
  50 .Sx Boot Time Configuration
  51 below.
  52 .Pp
  53 The following command line options are supported:
  54 .Bl -tag -width indent
  55 .It Fl b Xo
  56 .Ar duration . Ns Ar pitch | Ar belltype
  57 .Xc
  58 Set the bell duration in milliseconds and pitch in hertz.
  59 If a
  60 .Ar belltype
  61 argument is specified, it may be one of
  62 .Cm normal
  63 which sets sound parameters back to normal values,
  64 .Cm off
  65 which disables the bell entirely, or
  66 .Cm visual
  67 which sets the bell to visual mode, i.e. flashes the screen instead.
  68 If
  69 .Ar belltype
  70 is preceded by the word
  71 .Cm quiet. ,
  72 the bell will not be rung when the ringing process is in the background vty.
  73 .It Fl r Xo
  74 .Ar delay . Ns Ar repeat | Ar speed
  75 .Xc
  76 Set keyboard
  77 .Ar delay
  78 (250, 500, 750, 1000)
  79 and
  80 .Ar repeat
  81 (34, 38, 42, 46, 50, 55, 59, 63, 68, 76, 84, 92, 100, 110, 118, 126,
  82 136, 152, 168, 184, 200, 220, 236, 252, 272, 304, 336, 368, 400, 440,
  83 472, 504)
  84 rates, or if a
  85 .Ar speed
  86 argument is specified, it may be one of
  87 .Cm slow
  88 (1000.504),
  89 .Cm fast
  90 (250.34)
  91 or
  92 .Cm normal
  93 (500.126).
  94 .It Fl l Ar keymap_file
  95 Install keyboard map file from
  96 .Ar keymap_file .
  97 You may load the keyboard map file from a menu-driven command,
  98 .Xr kbdmap 1 .
  99 .It Fl d
 100 Dump the current keyboard map onto stdout.
 101 The output may be redirected to a file and can be loaded
 102 back to the kernel later by the
 103 .Fl l
 104 option above.
 105 .It Fl f Ar # Ar string
 106 Set function key number
 107 .Ar #
 108 to send
 109 .Ar string .
 110 Refer to the man page for the keyboard driver
 111 (e.g.\&
 112 .Xr atkbd 4 )
 113 for available function keys and their numbers.
 114 .It Fl F
 115 Set function keys back to the standard definitions.
 116 .It Fl x
 117 Use hexadecimal numbers in keyboard map dump.
 118 .It Fl i
 119 Print brief information about the keyboard.
 120 .It Fl K
 121 Disconnect the keyboard from the console.
 122 You need to use the
 123 .Fl k
 124 option below to associate a keyboard with the console again.
 125 .It Fl k Ar keyboard_device
 126 Use the specified device as the console keyboard.
 127 When using this option, the standard input of the
 128 .Nm
 129 process should be redirected from
 130 .Pa /dev/console
 131 if you are not working on the system console
 132 (see the
 133 .Sx EXAMPLES
 134 section).
 135 .It Fl L Ar keymap_file
 136 Load keyboard map file from
 137 .Ar keymap_file
 138 and write the
 139 .Ft "struct keymap"
 140 compiled from it to stdout.
 141 This option is primarily intended for programmers and is probably
 142 of little use under normal circumstances.
 143 .El
 144 .Sh ENVIRONMENT
 145 The environment variable
 146 .Ev KEYMAP_PATH
 147 can hold an alternative path to the keyboard map files.
 148 .Sh KEYBOARD CONFIGURATION
 149 .Ss Boot Time Configuration
 150 You may set variables in
 151 .Pa /etc/rc.conf
 152 or
 153 .Pa /etc/rc.conf.local
 154 in order to configure the keyboard at boot time.
 155 The following is the list of relevant variables.
 156 .Pp
 157 .Bl -tag -width foo_bar_var -compact
 158 .It Ar keymap
 159 Specifies a keyboard map file for the
 160 .Fl l
 161 option.
 162 .It Ar keyrate
 163 Sets the keyboard repeat rate for the
 164 .Fl r
 165 option.
 166 .It Ar keychange
 167 Lists function key strings for the
 168 .Fl f
 169 option.
 170 .El
 171 .Pp
 172 See
 173 .Xr rc.conf 5
 174 for details.
 175 .Ss Driver Configuration
 176 The keyboard device driver may let you change default configuration
 177 options, such as the default keyboard map, so that you do not need to set up
 178 the options at boot time.
 179 See keyboard driver manuals
 180 (e.g.\&
 181 .Xr atkbd 4 ,
 182 .Xr ukbd 4 )
 183 for details.
 184 .Sh FILES
 185 .Bl -tag -width /usr/share/syscons/keymaps/foo_bar -compact
 186 .It Pa /usr/share/syscons/keymaps/*
 187 keyboard map files
 188 .El
 189 .Sh EXAMPLES
 190 The following command will load the keyboard map file
 191 .Pa /usr/share/syscons/keymaps/ru.koi8-r.kbd .
 192 .Pp
 193 .Dl kbdcontrol -l /usr/share/syscons/keymaps/ru.koi8-r.kbd
 194 .Pp
 195 So long as the keyboard map file resides in
 196 .Pa /usr/share/syscons/keymaps ,
 197 you may abbreviate the file name as
 198 .Pa ru.koi8-r .
 199 .Pp
 200 .Dl kbdcontrol -l ru.koi8-r
 201 .Pp
 202 The following command will make the function key 10 emit "telnet myhost".
 203 .Pp
 204 .Dl kbdcontrol -f 10 \&"telnet myhost\&"
 205 .Pp
 206 In order to get the visual effect for bell, but prevent the screen
 207 from flushing if the bell is to ring in the background screen,
 208 run the following command.
 209 .Pp
 210 .Dl kbdcontrol -b quiet.visual
 211 .Pp
 212 To change the default console keyboard to the another keyboard,
 213 for example the first USB keyboard (see
 214 .Xr ukbd 4 ) ,
 215 use the following commands.
 216 .Pp
 217 .Dl kbdcontrol -k /dev/kbd1 < /dev/console
 218 .Pp
 219 To switch back to the default keyboard, use this command.
 220 .Pp
 221 .Dl kbdcontrol -k /dev/kbd0
 222 .Sh BUGS
 223 Report when found.
 224 .Sh SEE ALSO
 225 .Xr kbdmap 1 ,
 226 .Xr vidcontrol 1 ,
 227 .Xr atkbd 4 ,
 228 .Xr keyboard 4 ,
 229 .Xr screen 4 ,
 230 .Xr syscons 4 ,
 231 .Xr ukbd 4 ,
 232 .Xr kbdmap 5 ,
 233 .Xr rc.conf 5
 234 .Sh AUTHORS
 235 .An S\(/oren Schmidt Aq sos@FreeBSD.org