{ "content": [ { "type": "text", "text": "# keyboard (man)\n\n## NAME\n\nkeyboard - keyboard configuration file\n\n## DESCRIPTION\n\nThe keyboard file describes the properties of the keyboard. It is read by setupcon(1) in or‐\nder to configure the keyboard on the console. In Debian systems the default keyboard layout\nis described in /etc/default/keyboard and it is shared between X and the console.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **OPTIONS**\n- **FILES**\n- **NOTES**\n- **BUGS**\n- **EXAMPLES**\n- **SEE ALSO**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "keyboard", "section": "", "mode": "man", "summary": "keyboard - keyboard configuration file", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [ "The following configuration will give you the standard US QWERTY layout (us). The key ", "will act as a compose key (compose:menu) and will act as third control key", "(ctrl:nocaps).", "XKBLAYOUT=us", "XKBVARIANT=", "XKBOPTIONS=compose:menu,ctrl:nocaps", "In the following configuration the right key (grp:toggle) will toggle between US QWERTY", "layout (us) and Greek (gr) layout. The option grpled:scroll is ignored on the console but", "in X in means to use the ScrollLock keyboard led as indicator for the current layout (US or", "Greek).", "XKBLAYOUT=us,gr", "XKBVARIANT=", "XKBOPTIONS=grp:toggle,grpled:scroll", "In the following configuration the + key combination will toggle", "(grp:ctrlshifttoggle) between French keyboard (fr) without dead keys (nodeadkeys) and", "British (gb) “Dvorak” (dvorak) keyboard. The right key will be a compose-key (com‐‐", "pose:rwin) and the right key will function as AltGr (lv3:laltswitch).", "XKBLAYOUT=fr,gb", "XKBVARIANT=nodeadkeys,dvorak", "XKBOPTIONS=grp:ctrlshifttoggle,compose:rwin,lv3:raltswitch" ], "see_also": [ { "name": "setupcon", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/setupcon/1/json" }, { "name": "ckbcomp", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ckbcomp/1/json" }, { "name": "console-setup", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/console-setup/5/json" }, { "name": "loadkeys", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/loadkeys/1/json" }, { "name": "kbdcontrol", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/kbdcontrol/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 30, "subsections": [] }, { "name": "OPTIONS", "lines": 37, "subsections": [] }, { "name": "FILES", "lines": 7, "subsections": [] }, { "name": "NOTES", "lines": 8, "subsections": [] }, { "name": "BUGS", "lines": 9, "subsections": [] }, { "name": "EXAMPLES", "lines": 27, "subsections": [] }, { "name": "SEE ALSO", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "keyboard - keyboard configuration file\n", "subsections": [] }, "DESCRIPTION": { "content": "The keyboard file describes the properties of the keyboard. It is read by setupcon(1) in or‐\nder to configure the keyboard on the console. In Debian systems the default keyboard layout\nis described in /etc/default/keyboard and it is shared between X and the console.\n\nThe specification of the keyboard layout in the keyboard file is based on the XKB options\nXkbModel, XkbLayout, XkbVariant and XkbOptions. Unfortunately, there is little documentation\nhow to use them. Description of all possible values for these options can be found in the\nfile xorg.lst.\n\nYou might want to read “The XKB Configuration Guide” by Kamil Toman and Ivan U. Pascal:\n\nhttp://www.xfree86.org/current/XKB-Config.html\n\nOther possible readings are:\n\nhttps://wiki.archlinux.org/index.php/XKeyBoardextension\nhttp://pascal.tsu.ru/en/xkb/\nhttp://www.charvolant.org/~doug/xkb/\n\nThe complete XKB-specification can be found on\n\nhttp://xfree86.org/current/XKBproto.pdf\n\nThe file keyboard consists of variable settings in POSIX format:\n\nVARIABLE=VALUE\n\nOnly one assignment is allowed per line. Comments (starting with '#') are also allowed.\n\n", "subsections": [] }, "OPTIONS": { "content": "The following variables can be set.\n\n\nXKBMODEL\nSpecifies the XKB keyboard model name. Default: pc105 on most platforms.\n\n\nXKBLAYOUT\nSpecifies the XKB keyboard layout name. This is usually the country or language type\nof the keyboard. Default: us on most platforms\n\n\nXKBVARIANT\nSpecifies the XKB keyboard variant components. These can be used to further specify\nthe keyboard layout details. Default: not set.\n\n\nXKBOPTIONS\nSpecifies the XKB keyboard option components. Options usually relate to the behavior\nof the special keys (, , , , etc.) Default: not set.\n\n\nBACKSPACE\nDetermines the behavior of and keys on the console. Allowed val‐\nues: bs, del and guess. In most cases you can specify guess here, in which case the\ncurrent terminal settings and the kernel of your operating system will be used to de‐\ntermine the correct value. Value bs specifies VT100-conformant behavior: \nwill generate ^H (ASCII BS) and will generate ^? (ASCII DEL). Value del\nspecifies VT220-conformant behavior: will generate ^? (ASCII DEL) and\n will generate a special function sequence.\n\n\nKMAP Usually this variable will be unset but if you don't want to use a XKB layout on the\nconsole, you can specify an alternative keymap here. Specify a file that is suitable\nas input for loadkeys(1) on Linux or for kbdcontrol(1) on FreeBSD.\n\n", "subsections": [] }, "FILES": { "content": "The standard location of the keyboard file is /etc/default/keyboard. Description of all\navailable keyboard models, layouts, variants and options is available in\n/usr/share/X11/xkb/rules/xorg.lst. In most cases, in /usr/share/keymaps/ or\n/usr/share/syscons/keymaps/ you will find several keymaps that can be used with the variable\nKMAP.\n\n", "subsections": [] }, "NOTES": { "content": "In Debian systems, changes in /etc/default/keyboard do not become immediately visible to X.\nYou should either reboot the system, or use\n\nudevadm trigger --subsystem-match=input --action=change\n\nIn order to activate the changes on the console, run setupcon(1).\n\n", "subsections": [] }, "BUGS": { "content": "When a triple-layout is used on the console, i.e. a layout with three XKB groups, then the\ngroup toggling happens in the following way: Group1 -> Group2 -> Group1 -> Group3.\n\nOn FreeBSD triple- and quadruple-layouts are not supported on the console (only the first and\nthe second layout are taken into account).\n\nThe option grp:shiftstoggle is not supported on the console.\n\n", "subsections": [] }, "EXAMPLES": { "content": "The following configuration will give you the standard US QWERTY layout (us). The key \nwill act as a compose key (compose:menu) and will act as third control key\n(ctrl:nocaps).\n\nXKBLAYOUT=us\nXKBVARIANT=\nXKBOPTIONS=compose:menu,ctrl:nocaps\n\nIn the following configuration the right key (grp:toggle) will toggle between US QWERTY\nlayout (us) and Greek (gr) layout. The option grpled:scroll is ignored on the console but\nin X in means to use the ScrollLock keyboard led as indicator for the current layout (US or\nGreek).\n\nXKBLAYOUT=us,gr\nXKBVARIANT=\nXKBOPTIONS=grp:toggle,grpled:scroll\n\nIn the following configuration the + key combination will toggle\n(grp:ctrlshifttoggle) between French keyboard (fr) without dead keys (nodeadkeys) and\nBritish (gb) “Dvorak” (dvorak) keyboard. The right key will be a compose-key (com‐‐\npose:rwin) and the right key will function as AltGr (lv3:laltswitch).\n\nXKBLAYOUT=fr,gb\nXKBVARIANT=nodeadkeys,dvorak\nXKBOPTIONS=grp:ctrlshifttoggle,compose:rwin,lv3:raltswitch\n\n", "subsections": [] }, "SEE ALSO": { "content": "setupcon(1), ckbcomp(1), console-setup(5), loadkeys(1), kbdcontrol(1)\n\n\n\nconsole-setup 2011-03-17 KEYBOARD(5)", "subsections": [] } } } }