share/man/man4/keyboard.4

   1 .\"
   2 .\" $FreeBSD: src/share/man/man4/keyboard.4,v 1.19.2.5 2001/08/17 13:08:38 ru Exp $
   3 .\"
   4 .Dd January 8, 1995
   5 .Dt KEYBOARD 4
   6 .Os
   7 .Sh NAME
   8 .Nm keyboard
   9 .Nd pc keyboard interface
  10 .Sh DESCRIPTION
  11 The PC keyboard is used as the console character input device.
  12 The keyboard
  13 is owned by the current virtual console.
  14 To switch between the virtual consoles use the sequence
  15 .Ar ALT+Fn ,
  16 which means hold down ALT and press one of the function keys.
  17 The
  18 virtual console with the same number as the function key is then
  19 selected as the current virtual console and given exclusive use of
  20 the keyboard and display.
  21 .Pp
  22 The console allows entering values that are not physically
  23 present on the keyboard via a special keysequence.
  24 To use this facility press and hold down ALT,
  25 then enter a decimal number from 0-255 via the numerical keypad, then
  26 release ALT.
  27 The entered value is then used as the ASCII value for one
  28 character.
  29 This way it is possible to enter any ASCII value, not present
  30 on the keyboard.
  31 The console driver also includes a history function.
  32 It is activated by
  33 pressing the scroll-lock key.
  34 This holds the display, and enables the cursor
  35 arrows for scrolling up and down through the last scrolled out lines.
  36 .Pp
  37 The keyboard is configurable to suit the individual user and the different
  38 national layout.
  39 .Pp
  40 The keys on the keyboard can have any of the following functions:
  41 .Pp
  42 .Bl -tag -width "Modifier Key" -compact
  43 .It "Normal key"
  44 Enter the ASCII value associated with the key.
  45 .It "Function key"
  46 Enter a string of ASCII values.
  47 .It "Switch Key"
  48 Switch virtual console.
  49 .It "Modifier Key"
  50 Change the meaning of another key.
  51 .El
  52 .Pp
  53 The keyboard is seen as a number of keys numbered from 1 to n. This
  54 number is often referred to as the "scancode" for a given key.
  55 The number
  56 of the key is transmitted as an 8 bit char with bit 7 as 0 when a key is
  57 pressed, and the number with bit 7 as 1 when released.
  58 This makes it
  59 possible to make the mapping of the keys fully configurable.
  60 .Pp
  61 The meaning of every key is programmable via the PIO_KEYMAP ioctl call, that
  62 takes a structure keymap_t as argument.
  63 The layout of this structure is as
  64 follows:
  65 .Pp
  66 .Bd -literal -offset indent
  67                 struct keymap {
  68                         u_short n_keys;
  69                         struct key_t {
  70                                 u_char map[NUM_STATES];
  71                                 u_char spcl;
  72                                 u_char flgs;
  73                         } key[NUM_KEYS];
  74                 };
  75 .Ed
  76 .Pp
  77 The field n_keys tells the system how many keydefinitions (scancodes)
  78 follows.
  79 Each scancode is then specified in the key_t substructure.
  80 .Pp
  81 Each scancode can be translated to any of 8 different values, depending
  82 on the shift, control, and alt state.
  83 These eight possibilities are
  84 represented by the map array, as shown below:
  85 .Bd -literal
  86                                                             alt
  87  scan                          cntrl          alt    alt   cntrl
  88  code     base   shift  cntrl  shift   alt   shift  cntrl  shift
  89  map[n]      0       1      2      3     4       5      6      7
  90  ----     ------------------------------------------------------
  91  0x1E      'a'     'A'   0x01   0x01    'a'    'A'   0x01   0x01
  92 .Ed
  93 .Pp
  94 This is the default mapping for the key labelled 'A' which normally has
  95 scancode 0x1E. The eight states are as shown, giving the 'A' key its
  96 normal behavior.
  97 The spcl field is used to give the key "special" treatment, and is
  98 interpreted as follows.
  99 Each bit corresponds to one of the states above.
 100 If the bit is 0 the
 101 key emits the number defined in the corresponding map[] entry.
 102 If the bit is 1 the key is "special". This means it does not emit
 103 anything; instead it changes the "state". That means it is a shift,
 104 control, alt, lock, switch-screen, function-key or no-op key.
 105 The bitmap is backwards ie. 7 for base, 6 for shift etc.
 106 .Pp
 107 The flgs field defines if the key should react on caps-lock (1),
 108 num-lock (2), both (3) or ignore both (0).
 109 .Pp
 110 The
 111 .Xr kbdcontrol 1
 112 utility is used to load such a description into/outof
 113 the kernel at runtime.
 114 This makes it possible to change the key
 115 assignments at runtime, or more important to get (GIO_KEYMAP ioctl)
 116 the exact key meanings from the kernel (fx. used by the X server).
 117 .Pp
 118 The function keys can be programmed using the SETFKEY ioctl call.
 119 .Pp
 120 This ioctl takes a argument of the type fkeyarg_t:
 121 .Bd -literal -offset indent
 122                 struct fkeyarg {
 123                         u_short keynum;
 124                         char    keydef[MAXFK];
 125                         char    flen;
 126                 };
 127 .Ed
 128 .Pp
 129 The field keynum defines which function key that is programmed.
 130 The array keydef should contain the new string to be used (MAXFK long),
 131 and the length should be entered in flen.
 132 .Pp
 133 The GETFKEY ioctl call works in a similar manner, except it returns
 134 the current setting of keynum.
 135 .Pp
 136 The function keys are numbered like this:
 137 .Bd -literal -offset indent
 138         F1-F12                  key 1 - 12
 139         Shift F1-F12            key 13 - 24
 140         Ctrl F1-F12             key 25 - 36
 141         Ctrl+shift F1-F12       key 37 - 48
 142
 143         Home                    key 49
 144         Up arrow                key 50
 145         Page Up                 key 51
 146         (keypad) -              key 52
 147         Left arrow              key 53
 148         (keypad) 5              key 54
 149         Right arrow             key 55
 150         (keypad) +              key 56
 151         End                     key 57
 152         Down arrow              key 58
 153         Page down               key 59
 154         Insert                  key 60
 155         Delete                  key 61
 156
 157         Right window            key 62
 158         Left window             key 63
 159         Menu                    key 64
 160 .Ed
 161 .Pp
 162 The
 163 .Xr kbdcontrol 1
 164 utility also allows changing these values at runtime.
 165 .Sh AUTHORS
 166 .An S\(/oren Schmidt Aq sos@FreeBSD.org