~eugenenuke/ubuntu/wily/console-setup/fix-for-1565542

« back to all changes in this revision

Viewing changes to man/keyboard.5.txt

  • Committer: Package Import Robot
  • Author(s): Mathieu Trudel-Lapierre, Steve Langasek, Mathieu Trudel-Lapierre
  • Date: 2015-02-27 16:36:52 UTC
  • mfrom: (3.2.59 sid)
  • Revision ID: package-import@ubuntu.com-20150227163652-9sxmh6sbwqseysa0
Tags: 1.108ubuntu1
[ Steve Langasek ]
* Merge from Debian unstable, remaining changes: (LP: #1426721)
  - Don't gzip font or ACM files in /etc/console-setup/.  The space saving
    is negligible, and it's more efficient not to need to uncompress them
    at boot time.
  - Include pc105.tree for ubiquity.
  - Move boot tasks to a combination of two udev rules and a single
    Upstart job, ensuring that they're run at points when we are able to
    satisfy the constraints on the relevant ioctls.
  - Stop running debconf-updatepo on clean.
  - Set keymap and font in the initramfs if possible and sensible.
  - Add an apport hook.
  - Use keymapper to generate decision trees for a restricted subset of
    the pc105 model.
  - Depend on kbd (>= 1.15-1ubuntu3) for a valuable loadkeys improvement.
  - Include support for translated keyboard names.
  - Depend on debconf instead of pre-depending, because pre-depends have
    no effect on config scripts.
  - debian/vtrgb, debian/vtrgb.vga,
    debian/console-setup-linux.setvtrgb.upstart, debian/rules,
    debian/console-setup-linux.postinst: use Ubuntu's virtual terminal color
    scheme by default, with a VGA color scheme available as an alternative.
  - Make setupcon explicitly exit 0, so that postinsts don't fail in the
    event that loadkeys can't find a console.
  - Update for new layouts and variants for Montenegro and Serbia, and
    migrate configuration files from the old layouts.
  - Generate a locale locally for translating keyboard names in
    kbdnames-maker.
  - Don't copy keyboard-configuration questions to /target in OEM mode.
    oem-config will ask them later, and copying these confuses it.
  - Change the default font from Fixed to VGA for Lat15; while it's not
    entirely complete, it looks better and is largely good enough.
  - If the detect-keyboard debconf plugin is available
    (cdebconf-newt-detect-keys in the installer), then offer to use it to
    detect the keyboard layout.
  - Fix default keyboard selection for language/country combinations
    lacking a proper combined locale.
  - Drop the layout/variant priority to high on fresh installs.
  - Set default for Dutch to us(intl), not just us.
  - Set default layout for Vietnam to 'us'.
  - Set default variant for French to oss.
  - Set default layout for Simplified Chinese to 'cn'.
  - Don't use the default keyboard variant if the layout is overridden by
    preseeding.
  - If keyboard-configuration/layoutcode is preseeded but not marked as
    seen, then set the default layout but don't lower the layout question
    priority or preseed console-setup/ask_detect.
  - Use the default keyboard model if an existing configuration file sets
    XKBMODEL="".
  - Go back to always asking layout before variant.
  - Fix keyboard layout detection to set the layout properly.
  - Reset keyboard-configuration/toggle to the default if it's set to "No
    toggling" and you select a non-Latin layout.
  - Automatically save the font and keymap to /etc in
    /etc/init.d/console-setup if it isn't being run from init. Similarly,
    ensure that the font and keymap are saved to /etc during initial
    installation.
  - Replace usplash detection code with Plymouth detection code.
  - Load the new keyboard configuration immediately when running
    'dpkg-reconfigure keyboard-configuration' in an installed system.
  - Don't fail to configure keyboard-configuration if setxkbmap fails to
    talk to the X display.
  - Tolerate absence of setupcon in keyboard-configuration.postinst.
  - Drop the simplified keyboard-configuration/xkb-keymap question.
  - Fix command injection in ckbcomp.
  - debian/console-setup.console-font.upstart: Add Upstart job that sets up
    console font when plymouth-splash is starting.
  - Override description of the ch layout from "German (Switzerland)" to
    just "Switzerland".
  - Map ppc64el/* to XKBMODEL=pc105.
* Dropped changes, included in Debian:
  - "Do not configure keyboard; keep kernel keymap" model option,
    preseedable by keyboard-configuration/modelcode=SKIP: this is now
    supported upstream with either "unknown" or an empty string as the
    model.
  - Run kbd_mode on each tty in ACTIVE_CONSOLES rather than on the current
    tty, since the current tty might belong to X and changing X's tty out
    of raw mode is a very bad idea.
  - Include Terminus font in the compiled packages.  Do not depend, but
    conflict/provide/replace console-terminus.  New upstream version of
    the Terminus font (4.32).
  - Explicitly build-depend on liblocale-gettext-perl for kbdnames-maker,
    and likewise have keyboard-configuration depend on
    liblocale-gettext-perl.
  - Weaken test for whether /usr is mounted; testing for /usr/share is
    sufficient, and fixes operation in d-i.
  - Make keyboard-configuration replace old console-setup/console-setup-mini
    versions as well as conflicting with them.
  - Set default layout for Kurdish to tr(ku).
* Dropped changes, no longer needed:
  - Cope with systems installed with console-setup-udeb (<< 1.53) (which
    predates Ubuntu 12.04 and Debian wheezy).
  - Drop ancient handling of an empty codeset in the config file.
  - Drop vtrgb upgrade handling from natty
  - Drop upstart job transition from lucid
* setupcon: Map XKBMODEL=SKIP to '' for compatibility with existing
  configs.
* debian/rules: revert hard-coding of a list of "debconf-selectable"
  layouts for the udebs, since we don't use this debconf question in Ubuntu
  and all layouts are selectable.
* setupcon: revert ridiculous upstream twiddling of keymap cache filenames:
  - the variables are taken from a config file which, if changed,
    invalidates the cache.
  - there is only ever one keyboard map per system.
  - the system should not have to resolve filenames to find the keymap cache
    on boot.
* Move vtrgb handling to console-setup-linux package, since this is clearly
  Linux-specific.
* Add missing console-setup-linux.prerm to remove /etc/vtrgb alternatives
* Keyboard/kbdcompiler: fix bug in filtering of unsupported variants that
  breaks generation of the pc105.tree for d-i keyboard detection.
* debian/keyboard-configuration.postinst: udpkg is not part of an installed
  Debian system; don't fail to configure if it's absent and the script is
  called outside of an installer context.
* Don't make debian/copyright a symlink to COPYRIGHT, this is disallowed
  by the Ubuntu archive installer.

[ Mathieu Trudel-Lapierre ]
* debian/keyboard-configuration.config: fix typo in model check for SKIP;
  even when looking up the layout/variant, we need to check for the model
  as XKBMODEL, since $model doesn't exist.
* debian/preprocessor: revert the removal of keyboard names (for size) of
  console-setup-udeb: we do need those, since we don't use the simplified
  xkb-keymap template from Debian just yet: this way we can still show
  country/language names when selecting a keyboard, layout or variant.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
KEYBOARD(5)               Console-setup User's Manual              KEYBOARD(5)
 
2
 
 
3
 
 
4
 
 
5
NAME
 
6
       keyboard - keyboard configuration file
 
7
 
 
8
DESCRIPTION
 
9
       The  keyboard file describes the properties of the keyboard. It is read
 
10
       by setupcon(1) in order to configure the keyboard on the  console.   In
 
11
       Debian   systems   the   default   keyboard   layout  is  described  in
 
12
       /etc/default/keyboard and it is shared between X and the console.
 
13
 
 
14
       The specification of the keyboard layout in the keyboard file is  based
 
15
       on  the  XKB  options  XkbModel,  XkbLayout, XkbVariant and XkbOptions.
 
16
       Unfortunately, there is little documentation how to use them.  Descrip-
 
17
       tion  of all possible values for these options can be found in the file
 
18
       xorg.lst.
 
19
 
 
20
       You might want to read "The XKB Configuration Guide" by Kamil Toman and
 
21
       Ivan U. Pascal:
 
22
 
 
23
              http://www.xfree86.org/current/XKB-Config.html
 
24
 
 
25
       Other possible readings are:
 
26
 
 
27
              http://pascal.tsu.ru/en/xkb/
 
28
              http://www.charvolant.org/~doug/xkb/
 
29
 
 
30
       The complete XKB-specification can be found on
 
31
 
 
32
              http://xfree86.org/current/XKBproto.pdf
 
33
 
 
34
       The file keyboard consists of variable settings in POSIX format:
 
35
 
 
36
              VARIABLE=VALUE
 
37
 
 
38
       Only  one assignment is allowed per line.  Comments (starting with '#')
 
39
       are also allowed.
 
40
 
 
41
 
 
42
OPTIONS
 
43
       The following variables can be set.
 
44
 
 
45
 
 
46
       XKBMODEL
 
47
              Specifies the XKB keyboard model name.  Default: pc105 for  most
 
48
              platforms.
 
49
 
 
50
 
 
51
       XKBLAYOUT
 
52
              Specifies  the  XKB  keyboard  layout  name. This is usually the
 
53
              country or language type of the keyboard. Default: us  for  most
 
54
              platforms
 
55
 
 
56
 
 
57
       XKBVARIANT
 
58
              Specifies the XKB keyboard variant components. These can be used
 
59
              to further specify the keyboard  layout  details.  Default:  not
 
60
              set.
 
61
 
 
62
 
 
63
       XKBOPTIONS
 
64
              Specifies  the  XKB keyboard option components.  Options usually
 
65
              relate to the behavior of the special keys (<Shift>,  <Control>,
 
66
              <Alt>, <CapsLock>, etc.)  Default: not set.
 
67
 
 
68
 
 
69
       BACKSPACE
 
70
              Determines  the behavior of <BackSpace> and <Delete> keys on the
 
71
              console.  Allowed values: bs, del and guess.  In most cases  you
 
72
              can  specify guess here, in which case the current terminal set-
 
73
              tings and the kernel of your operating system will  be  used  to
 
74
              determine  the  correct value.  Value bs specifies VT100-confor-
 
75
              mant behavior: <BackSpace>  will  generate  ^H  (ASCII  BS)  and
 
76
              <Delete>  will  generate  ^?   (ASCII DEL).  Value del specifies
 
77
              VT220-conformant behavior: <BackSpace> will generate ^?   (ASCII
 
78
              DEL) and <Delete> will generate a special function sequence.
 
79
 
 
80
 
 
81
       KMAP   Usually this variable will be unset but if you don't want to use
 
82
              a XKB layout on the console,  you  can  specify  an  alternative
 
83
              keymap here.  Specify a file that is suitable as input for load-
 
84
              keys(1) on Linux or for kbdcontrol(1) on FreeBSD.
 
85
 
 
86
 
 
87
FILES
 
88
       The standard  location  of  the  keyboard  file  is  /usr/local/etc/de-
 
89
       fault/keyboard.  Description of all available keyboard models, layouts,
 
90
       variants     and     options     is     available      in      /usr/lo-
 
91
       cal/share/X11/xkb/rules/xorg.lst.       In      most      cases,     in
 
92
       /usr/share/keymaps/ or /usr/share/syscons/keymaps/ you will find sever-
 
93
       al keymaps that can be used with the variable KMAP.
 
94
 
 
95
 
 
96
NOTES
 
97
       In Debian systems, changes in /etc/default/keyboard do not become imme-
 
98
       diately visible to X.  You should either reboot the system, or use
 
99
 
 
100
           udevadm trigger --subsystem-match=input --action=change
 
101
 
 
102
 
 
103
BUGS
 
104
       When a triple-layout is used, i.e. a layout with three XKB groups, then
 
105
       the  group  toggling  happens in the following way: Group1 -> Group2 ->
 
106
       Group1 -> Group3.
 
107
 
 
108
       On FreeBSD triple- and quadruple-layouts are not  supported  (only  the
 
109
       first and the second layout are taken into account).
 
110
 
 
111
       The option grp:shifts_toggle is not supported.
 
112
 
 
113
 
 
114
EXAMPLES
 
115
       The following configuration will give you the standard US QWERTY layout
 
116
       (us).  The key <Menu> will act as  a  compose  key  (compose:menu)  and
 
117
       <CapsLock> will act as third control key (ctrl:nocaps).
 
118
 
 
119
           XKBLAYOUT=us
 
120
           XKBVARIANT=
 
121
           XKBOPTIONS=compose:menu,ctrl:nocaps
 
122
 
 
123
       In  the  following  configuration the right <Alt> key (grp:toggle) will
 
124
       toggle between US QWERTY layout (us) and Greek (gr) layout.  The option
 
125
       grp_led:scroll  is  ignored on the console but in X in means to use the
 
126
       ScrollLock keyboard led as indicator for  the  current  layout  (US  or
 
127
       Greek).
 
128
 
 
129
           XKBLAYOUT=us,gr
 
130
           XKBVARIANT=
 
131
           XKBOPTIONS=grp:toggle,grp_led:scroll
 
132
 
 
133
       In  the  following  configuration the <Control>+<Shift> key combination
 
134
       will toggle (grp:ctrl_shift_toggle) between French keyboard (fr)  with-
 
135
       out dead keys (nodeadkeys) and British (gb) "Dvorak" (dvorak) keyboard.
 
136
       The right <Win> key will be a compose-key (compose:rwin) and the  right
 
137
       <Alt> key will function as AltGr (lv3:lalt_switch).
 
138
 
 
139
           XKBLAYOUT=fr,gb
 
140
           XKBVARIANT=nodeadkeys,dvorak
 
141
           XKBOPTIONS=grp:ctrl_shift_toggle,compose:rwin,lv3:ralt_switch
 
142
 
 
143
 
 
144
SEE ALSO
 
145
       setupcon(1), ckbcomp(1), console-setup(5), loadkeys(1), kbdcontrol(1)
 
146
 
 
147
 
 
148
 
 
149
console-setup                     2011-03-17                       KEYBOARD(5)