README

   1
   2                              UCW XKB 2.0
   3                              ===========
   4
   5
   6 UCW XKB is a little set of keyboard layouts for XFree86 4.3.x and Xorg. These
   7 maps offer new possibilities for the user. The main one is to type accented
   8 characters via LEVEL_3 shift - so with ANY change to the basic keyboard layout.
   9
  10 LEVEL_3 shift can be mapped to a key on user's choice (right Alt etc.), the
  11 original idea was to map it to CapsLock key (original CapsLock function can be
  12 obtained with Alt-CapsLock) which solves two problems at once: avoid the
  13 accidentaly CAPSlOCK PRESS (DO YOU KNOW WHAT i MEAN?) and how to type the
  14 accented characters without any modifications of the original US keymap.
  15
  16
  17 Usage:
  18 ------
  19
  20 These maps can be freely combined with the original XFree ones and both ways work:
  21
  22 setting on-the-fly via setxkbmap command  and default setting in Xorg.conf or
  23 XF86Config-4 config files.
  24
  25 Example 1:
  26
  27           $ setxkbmap -rules ucw -layout ucw,cz-type            \
  28                       -option "lv3:caps,grp:shift_sclk,grp_led:scroll"
  29
  30 creates a keymap with two groups changeable via Shift-ScrollLock: ucw(qwerty)
  31 and cz-type(qwertz). UCW keyboard is same as original US (just with L3 shift
  32 added), cz-type is a layout used by Czech typewriters. If the groups is changed
  33 to the second one, the ScrollLock LED will be turned on.
  34
  35 (on the fly means that you can change the layouts without the restart of X
  36 server, even the files in XKB directories changed. See the Installation chapter.)
  37
  38
  39 Example 2:
  40
  41 default setting in an X conf file:
  42
  43         Section "InputDevice"
  44                 Driver       "kbd"
  45                 Identifier   "Keyboard[0]"
  46                 Option       "Protocol" "Standard"
  47
  48                 Option       "XkbRules" "ucw"
  49                 Option       "XkbModel" "pc104"
  50                 Option       "XkbLayout"        "ucw,cz-prog"
  51                 Option       "XkbOptions"       "lv3:caps,grp:shift_sclk,grp_led:scroll"
  52         EndSection
  53
  54
  55 3) Installation
  56 ---------------
  57
  58 3.1) Debian (root)
  59
  60         dpkg -i ucw-xkb_2.0-1_all.deb
  61
  62 3.2) other distros (root)
  63
  64    Copy the content of directories compat/ and symbols/ to the
  65 corresponding directories in system xkb directory (/etc/X11/xkb or
  66 /usr/share/X11/xkb) and execute rules/setup.sh with appropriate arguments.
  67
  68 Then you can use new configuration possibilities as shown above in the examples.
  69 You can immediately run setxkbmap without any restart of X server.
  70
  71 Example:
  72
  73 Suppose you are using US and DE layouts now. You can copy UCW files to
  74 /etc/X11/xkb (as root) and immediately call:
  75
  76         setxkbmap -layout ucw,ucwde -option lv3:caps -option grp:shift_sclk
  77
  78 and get the same, but with L3 shift support. Now caps+a gives aacute,
  79 caps+shift+a gives Aacute etc. And because DE layout has initialized Right Alt
  80 as L3 Shift too, you can use both CapsLock or Right Alt.
  81
  82
  83
  84 5) Layout
  85 ---------
  86
  87    Layout possibilities:
  88
  89         ucw             - US keyboard
  90         ucwde           - DE keyboard
  91         cz-prog         - CZ for programmers
  92         cz-type         - CZ for typewriters
  93         sk-prog         - SK for programmers
  94         sk-type         - SK for typewriters
  95
  96    At all UCW layouts you can get the accented chars by pressing L3 Shift with
  97 the key of the base char (or a key near this one):
  98
  99         lv3 + S         => Š
 100         lv3 + e         => é
 101         lv3 + w         => ě
 102         lv3 + x         => ß
 103
 104 The second function of L3 Shift is used in "layouts for programmers": L3 Shift
 105 pressed with some key gives the original (US) char of that key instead of the
 106 accented char.
 107
 108         lv3 + ě         => 2
 109         lv3 + shift + ě => @
 110
 111
 112
 113
 114 6) Variants
 115 -----------
 116
 117    You can freely choose qwerty OR qwertz variant for every UCW layout: ucwde
 118 with qwerty, ucw with qwertz etc.
 119
 120
 121 7) Options
 122 ----------
 123
 124 7a) options to set a "change group" key
 125
 126   grp:shift_sclk        - Shift + ScrollLock (ucw)
 127   grp:sclk_toggle       - Scroll Lock (xfree)
 128
 129      .... a many others from XFree/Xorg distribution
 130
 131 7b) Level3 Shift
 132
 133   lv3:caps              - CapsLock (ucw)
 134
 135   lv3:switch            - pravý Control (xfree)
 136   lv3:menu_switch       - klávesa Menu (xfree)
 137   lv3:win_switch        - libovolná z "Win" kláves (xfree)
 138   lv3:lwin_switch       - levá "Win" klávesa (xfree)
 139   lv3:rwin_switch       - pravá "Win" klávesa (xfree)
 140   lv3:ralt_switch       - pravý Alt (xfree)
 141
 142 7c ) others
 143
 144    grp_led - turn on LED on the keyboard if the second group is choosen
 145
 146   grp_led:num           - NumLock
 147   grp_led:caps          - CapsLock
 148   grp_led:scroll        - ScrollLock
 149
 150
 151 --
 152 Milan Vancura <milan@ucw.cz> ; Fri Jan 19 11:43:45 CET 2007