[PATCH 4/4] add documentation for keymap, setkey, and setnumpad commands

[Luc Van Rompaey]

Update the GNU GRUB manual  with  entries  that  document  the  keymap,
setkey, and setnumpad commands, under the list of general commands.
---
 docs/grub.texi | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 150 insertions(+)

diff --git a/docs/grub.texi b/docs/grub.texi
index b9f41a7..8bd5efe 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -3660,13 +3660,57 @@ All options are the same as in the @command{menuentry} 
command
 Commands usable anywhere in the menu and in the command-line.
 
 @menu
+* keymap::                      Load a keyboard layout
 * serial::                      Set up a serial device
+* setkey::                      Change the keyboard map
+* setnumpad::                   Change the numeric keypad behavior
 * terminal_input::              Manage input terminals
 * terminal_output::             Manage output terminals
 * terminfo::                    Define terminal type
 @end menu
 
 
address@hidden keymap
address@hidden keymap
+
address@hidden Command keymap LAYOUT
+Load a keyboard layout.
+
+If @var{LAYOUT} is just the identifier of a keyboard layout, then GRUB will
+look for file @file{$prefix/layouts/@var{LAYOUT}.gkb}.
+Alternatively, @var{LAYOUT} may be the full path to a GRUB keyboard layout 
file.
+
+This command will have no effect unless and until you use the
address@hidden command to activate either the @samp{at_keyboard}
+input terminal:
+
address@hidden
+terminal_input at_keyboard
address@hidden example
+
+or the @samp{usb_keyboard} input terminal:
+
address@hidden
+terminal_input usb_keyboard
address@hidden example
+
address@hidden @asis
address@hidden Creating a GRUB keyboard layout file:
+
+To generate a GRUB keyboard layout file, you can use the 
@command{grub-mklayout}
+command-line utility, which takes a Linux console keyboard layout description
+as input, and converts it to a format that GRUB can understand.
+
+For instance, if you use the @samp{dvorak} keyboard layout, then the following
+command will create the @file{dvorak.gkb} file for use with GRUB:
+
address@hidden
+ckbcomp dvorak | grub-mklayout -o dvorak.gkb
address@hidden example
address@hidden table
address@hidden deffn
+
+
 @node serial
 @subsection serial
 
@@ -3689,6 +3733,112 @@ See also @ref{Serial terminal}.
 @end deffn
 
 
address@hidden setkey
address@hidden setkey
+
address@hidden Command setkey [[TO_KEY] FROM_KEY]
+Change the keyboard map.
+
+With no arguments, reset the keyboard map to its default U.S. layout.
+
+When only the @var{FROM_KEY} argument is given, or when @var{TO_KEY} is equal 
to
address@hidden, the mapping entry for the specified key will be cleared.
+Keep in mind that @var{FROM_KEY} identifies the position of the key under the 
default
+U.S. layout.
+
+With two unequal arguments, the key @var{FROM_KEY} will be mapped to 
@var{TO_KEY}.
+In effect, the @var{FROM_KEY} argument identifies the position of the key 
under the
+default U.S. layout, and @var{TO_KEY} specifies how the key should behave 
under your
+local keyboard layout.
+
+A key must be:
address@hidden @bullet
address@hidden
+a lowercase letter;
address@hidden
+an uppercase letter;
address@hidden
+a decimal digit;
address@hidden
+a function key---i.e., @kbd{F1} through @kbd{F12};
address@hidden itemize
+
+or one of the following:
+
address@hidden
+  ampersand    barx         delete       less         question
+  asterisk     braceleft    dollar       minus        quote
+  at           braceright   doublequote  numbersign   semicolon
+  backslash    bracketleft  enter        parenleft    slash
+  backslashx   bracketright equal        parenright   space
+  backquote    caret        escape       percent      tab
+  backspace    colon        exclam       period       tilde
+  bar          comma        greater      plus         underscore
address@hidden verbatim
+
+This command is only available on PC BIOS systems. It will have no effect 
unless
+and until you use the @command{terminal_input} command to activate the 
@samp{nuconsole}
+input terminal:
+
address@hidden
+terminal_input nuconsole
address@hidden example
+
+Differences with the @command{setkey} command under GRUB Legacy:
+
address@hidden @bullet
address@hidden
+This @command{setkey} command does not support the modifier keys---i.e., 
@kbd{shift},
address@hidden, @kbd{alt}, @kbd{capslock}.
+
address@hidden
+This @command{setkey} command supports all twelve function keys.
+
address@hidden
+Depending on your keyboard layout, there may be an extra key between the 
@key{Left Shift}
+key and the row of letter keys to its right. This extra key will output a 
backslash (i.e.,
address@hidden) or, when shifted, a vertical bar (i.e., @kbd{|}), by default.
+
+This @command{setkey} command will not affect this extra key when you remap the
address@hidden or @kbd{bar} keys. You can instead remap the key separately, 
using the
address@hidden or @kbd{barx} values for the @var{FROM_KEY} argument.
+
+For instance, under the Belgian keyboard layout, this key will output a 
@kbd{<} or, when
+shifted, a @kbd{>} character. The following GRUB commands will, then, 
appropriately remap
+the key:
+
address@hidden
+setkey less    backslashx
+setkey greater barx
address@hidden example
address@hidden itemize
address@hidden deffn
+
+
address@hidden setnumpad
address@hidden setnumpad
+
address@hidden Command setnumpad address@hidden|@option{--noforce}]
+Change the behavior of the numeric keypad.
+
+With @option{--force}, make the keys on the numeric keypad emit the numeric
+characters on their keycaps, irrespective of the @key{NumLock} and @key{Shift}
+key states.
+
+With @option{--noforce}, or if no option is given, restore default behavior
+of the keys on the numeric keypad, which depends on the @key{NumLock} and
address@hidden states.
+
+This command is only available on PC BIOS systems. It will have no effect 
unless
+and until you use the @command{terminal_input} command to activate the 
@samp{nuconsole}
+input terminal:
+
address@hidden
+terminal_input nuconsole
address@hidden example
address@hidden deffn
+
+
 @node terminal_input
 @subsection terminal_input
 
-- 
2.1.4