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 September 11, 2000
  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 ASCII
  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 ASCII
  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.
 169 .It lshift
 170 Act as left shift key.
 171 .It rshift
 172 Act as right shift key.
 173 .It clock
 174 Act as caps lock key.
 175 .It nlock
 176 Act as num lock key.
 177 .It slock
 178 Act as scroll lock key.
 179 .It lalt|alt
 180 Act as left alt key.
 181 .It btab
 182 Act as backwards tab.
 183 .It lctrl|ctrl
 184 Act as left control key.
 185 .It rctrl
 186 Act as right control key.
 187 .It ralt
 188 Act as right alt (altgr) key.
 189 .It alock
 190 Act as alt lock key.
 191 .It ashift
 192 Act as alt shift key.
 193 .It meta
 194 Act as meta key.
 195 .It lshifta|shifta
 196 Act as left shift key / alt lock.
 197 .It rshifta
 198 Act as right shift key / alt lock.
 199 .It lctrla|ctrla
 200 Act as left ctrl key / alt lock.
 201 .It rctrla
 202 Act as right ctrl key / alt lock.
 203 .It lalta|alta
 204 Act as left alt key / alt lock.
 205 .It ralta
 206 Act as right alt key / alt lock.
 207 .It nscr
 208 Act as switch to next screen.
 209 .It pscr
 210 Act as switch to previous screen.
 211 .It scr Ns Ar N
 212 Switch to screen
 213 .Ar N ,
 214 where
 215 .Ar N
 216 is a decimal number.
 217 .It boot
 218 Reboot the machine.
 219 .It halt
 220 Halt the machine.
 221 .It pdwn
 222 Halt the machine
 223 and attempt to power it down.
 224 .It debug
 225 Call the debugger.
 226 .It susp
 227 Use APM to suspend power.
 228 .It saver
 229 Activate screen saver
 230 by toggling between splash/text screen.
 231 .It panic
 232 Panic the system.
 233 The
 234 .Xr sysctl 8
 235 variable
 236 .Va machdep.enable_panic_key
 237 must be set to 1 to enable this feature.
 238 .It paste
 239 Act as mouse buffer paste.
 240 .El
 241 .Pp
 242 Finally,
 243 to complete the description of a key,
 244 a flag which describes
 245 the effect of caps lock and num lock
 246 on that key is given.
 247 The flag can be
 248 .Ql C
 249 to indicate that caps lock affects the key,
 250 .Ql N
 251 to indicate that num lock affects the key,
 252 .Ql B
 253 to indicate that both
 254 caps lock and num lock affects the key,
 255 or
 256 .Ql O
 257 to indicate that neither affects the key.
 258 .Pp
 259 An accent key works
 260 by modifying the behavior
 261 of the next key pressed.
 262 The description of an accent begins
 263 with one of the accent names
 264 given above.
 265 This is followed
 266 by the symbol for the accent,
 267 given in single quotes or
 268 as a decimal or hexadecimal
 269 .Tn ASCII
 270 value.
 271 This symbol will be produced
 272 if the accent key is pressed and
 273 then the space key is pressed.
 274 .Pp
 275 The description of the accent key
 276 continues with a list showing
 277 how it modifies various symbols,
 278 by giving pairs made up of the normal symbol and
 279 the modified symbol
 280 enclosed in parentheses.
 281 Both symbols in a pair can be given
 282 in either single quotes or
 283 as decimal or
 284 hexadecimal
 285 .Tn ASCII
 286 values.
 287 .Pp
 288 For example,
 289 consider the following extract from a
 290 .Nm :
 291 .Bd -literal -offset indent
 292   041   dgra   172    nop    nop    '|'    '|'    nop    nop     O
 293   dgra  '`'  ( 'a' 224 ) ( 'A' 192 ) ( 'e' 232 ) ( 'E' 200 )
 294              ( 'i' 236 ) ( 'I' 204 ) ( 'o' 242 ) ( 'O' 210 )
 295              ( 'u' 249 ) ( 'U' 217 )
 296 .Ed
 297 This extract
 298 configures the backtick key on a UK keyboard
 299 to act as a grave accent key.
 300 Pressing backtick followed by space
 301 produces a backtick, and
 302 pressing a backtick followed by a vowel
 303 produces the ISO-8859-1 symbol
 304 for that vowel with a grave accent.
 305 .Sh FILES
 306 .Bl -tag -width /usr/share/syscons/keymaps/* -compact
 307 .It Pa /usr/share/syscons/keymaps/*
 308 standard keyboard map files
 309 .El
 310 .Sh SEE ALSO
 311 .Xr kbdcontrol 1 ,
 312 .Xr kbdmap 1 ,
 313 .Xr keyboard 4 ,
 314 .Xr syscons 4 ,
 315 .Xr ascii 7
 316 .Sh HISTORY
 317 This manual page first appeared in
 318 .Fx 4.2 .