usr.sbin/kbdcontrol/kbdmap.5

   1 .\" Copyright (c) 2000
   2 .\"     David Malone
   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 ``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 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 .\"
  27 .Dd January 29, 2008
  28 .Dt KBDMAP 5
  29 .Os
  30 .Sh NAME
  31 .Nm kbdmap
  32 .Nd keyboard map file format for kbdcontrol
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Sh DESCRIPTION
  36 A
  37 .Nm
  38 file describes how the keys on a keyboard should behave.
  39 These files can be loaded
  40 using
  41 .Xr kbdcontrol 1 ,
  42 or
  43 .Xr kbdmap 1
  44 can be used to select one of the default
  45 .Nm
  46 files interactively.
  47 A
  48 .Nm
  49 file can be specified in
  50 .Xr rc.conf 5 ,
  51 to be loaded
  52 at boot time.
  53 The current keymap may also be printed using
  54 .Xr kbdcontrol 1 .
  55 .Pp
  56 Each line in the file
  57 can describe a key or an accent.
  58 A
  59 .Ql #
  60 character begins a comment,
  61 which extends to the end of the line.
  62 .Pp
  63 The description of a key
  64 begins with the scancode for that key.
  65 Then the effect of the key
  66 under combinations of
  67 shift,
  68 control
  69 and alt
  70 are listed in the following order:
  71 no modifier,
  72 shift,
  73 control,
  74 control and shift,
  75 alt,
  76 alt and shift,
  77 alt and control,
  78 alt and control and shift.
  79 The action of the key
  80 under each modifier can be:
  81 .Bl -tag -width Ar
  82 .It ' Ns Ar symbol Ns No '
  83 The symbol the key should produce,
  84 in single quotes.
  85 .It Ar decnum
  86 The
  87 .Tn Unicode
  88 value to produce
  89 as a decimal number
  90 (see
  91 .Xr ascii 7 ) .
  92 For example, 32 for space.
  93 .It 0x Ns Ar hexnum
  94 The
  95 .Tn Unicode
  96 value to produce
  97 as a hexadecimal number.
  98 For example, 0x20 for space.
  99 .It Ar ctrlname
 100 One of the standard names
 101 for the
 102 .Tn ASCII
 103 control characters:
 104 nul,
 105 soh,
 106 stx,
 107 etx,
 108 eot,
 109 enq,
 110 ack,
 111 bel,
 112 bs,
 113 ht,
 114 nl,
 115 vt,
 116 np,
 117 cr,
 118 so,
 119 si,
 120 dle,
 121 dc1,
 122 dc2,
 123 dc3,
 124 dc4,
 125 nak,
 126 syn,
 127 etb,
 128 can,
 129 em,
 130 sub,
 131 esc,
 132 fs,
 133 gs,
 134 rs,
 135 ns,
 136 us,
 137 sp,
 138 del.
 139 .It Ar accentname
 140 By giving one of the accent names,
 141 the next key pressed will produce
 142 an accented character
 143 in accordance with that accent.
 144 See the description of accents below.
 145 The accent names are:
 146 dgra,
 147 dacu,
 148 dcir,
 149 dtil,
 150 dmac,
 151 dbre,
 152 ddot,
 153 duml,
 154 ddia,
 155 dsla,
 156 drin,
 157 dced,
 158 dapo,
 159 ddac,
 160 dogo,
 161 dcar.
 162 .It fkey Ns Ar N
 163 Act as the
 164 .Ar N Ns No th
 165 function key,
 166 where
 167 .Ar N
 168 is a decimal number in the range from 1 to 96.
 169 Refer to the
 170 .Xr atkbd 4
 171 manual page for a list of predefined function keys.
 172 You can use the
 173 .Fl f
 174 option of the
 175 .Xr kbdcontrol 1
 176 utility to assign arbitrary strings to function keys.
 177 .It lshift
 178 Act as left shift key.
 179 .It rshift
 180 Act as right shift key.
 181 .It clock
 182 Act as caps lock key.
 183 .It nlock
 184 Act as num lock key.
 185 .It slock
 186 Act as scroll lock key.
 187 .It lalt|alt
 188 Act as left alt key.
 189 .It btab
 190 Act as backwards tab.
 191 .It lctrl|ctrl
 192 Act as left control key.
 193 .It rctrl
 194 Act as right control key.
 195 .It ralt
 196 Act as right alt (altgr) key.
 197 .It alock
 198 Act as alt lock key.
 199 .It ashift
 200 Act as alt shift key.
 201 .It meta
 202 Act as meta key.
 203 .It lshifta|shifta
 204 Act as left shift key / alt lock.
 205 .It rshifta
 206 Act as right shift key / alt lock.
 207 .It lctrla|ctrla
 208 Act as left ctrl key / alt lock.
 209 .It rctrla
 210 Act as right ctrl key / alt lock.
 211 .It lalta|alta
 212 Act as left alt key / alt lock.
 213 .It ralta
 214 Act as right alt key / alt lock.
 215 .It nscr
 216 Act as switch to next screen.
 217 .It pscr
 218 Act as switch to previous screen.
 219 .It scr Ns Ar N
 220 Switch to screen
 221 .Ar N ,
 222 where
 223 .Ar N
 224 is a decimal number.
 225 .It boot
 226 Reboot the machine.
 227 .It halt
 228 Halt the machine.
 229 .It pdwn
 230 Halt the machine
 231 and attempt to power it down.
 232 .It debug
 233 Call the debugger.
 234 .It susp
 235 Use APM to suspend power.
 236 .It saver
 237 Activate screen saver
 238 by toggling between splash/text screen.
 239 .It panic
 240 Panic the system.
 241 The
 242 .Xr sysctl 8
 243 variable
 244 .Va machdep.enable_panic_key
 245 must be set to 1 to enable this feature.
 246 .It paste
 247 Act as mouse buffer paste.
 248 .El
 249 .Pp
 250 Finally,
 251 to complete the description of a key,
 252 a flag which describes
 253 the effect of caps lock and num lock
 254 on that key is given.
 255 The flag can be
 256 .Ql C
 257 to indicate that caps lock affects the key,
 258 .Ql N
 259 to indicate that num lock affects the key,
 260 .Ql B
 261 to indicate that both
 262 caps lock and num lock affects the key,
 263 or
 264 .Ql O
 265 to indicate that neither affects the key.
 266 .Pp
 267 An accent key works
 268 by modifying the behavior
 269 of the next key pressed.
 270 The description of an accent begins
 271 with one of the accent names
 272 given above.
 273 This is followed
 274 by the symbol for the accent,
 275 given in single quotes or
 276 as a decimal or hexadecimal
 277 .Tn Unicode
 278 value.
 279 This symbol will be produced
 280 if the accent key is pressed and
 281 then the space key is pressed.
 282 .Pp
 283 The description of the accent key
 284 continues with a list showing
 285 how it modifies various symbols,
 286 by giving pairs made up of the normal symbol and
 287 the modified symbol
 288 enclosed in parentheses.
 289 Both symbols in a pair can be given
 290 in either single quotes or
 291 as decimal or
 292 hexadecimal
 293 .Tn Unicode
 294 values.
 295 .Pp
 296 For example,
 297 consider the following extract from a
 298 .Nm :
 299 .Bd -literal -offset indent
 300   041   dgra   172    nop    nop    '|'    '|'    nop    nop     O
 301   dgra  '`'  ( 'a' 224 ) ( 'A' 192 ) ( 'e' 232 ) ( 'E' 200 )
 302              ( 'i' 236 ) ( 'I' 204 ) ( 'o' 242 ) ( 'O' 210 )
 303              ( 'u' 249 ) ( 'U' 217 )
 304 .Ed
 305 This extract
 306 configures the backtick key on a UK keyboard
 307 to act as a grave accent key.
 308 Pressing backtick followed by space
 309 produces a backtick, and
 310 pressing a backtick followed by a vowel
 311 produces the ISO-8859-1 symbol
 312 for that vowel with a grave accent.
 313 .Sh FILES
 314 .Bl -tag -width /usr/share/syscons/keymaps/* -compact
 315 .It Pa /usr/share/syscons/keymaps/*
 316 standard keyboard map files
 317 .El
 318 .Sh SEE ALSO
 319 .Xr kbdcontrol 1 ,
 320 .Xr kbdmap 1 ,
 321 .Xr keyboard 4 ,
 322 .Xr syscons 4 ,
 323 .Xr ascii 7
 324 .Sh HISTORY
 325 This manual page first appeared in
 326 .Fx 4.2 .