# HG changeset patch
# User Karoly Lorentey <lorentey@elte.hu>
# Date 1130497937 0
# Node ID 513453e09ec7656c1853da33799fcfe91ae4a5f0
# Parent  732c5740ca8f6f6ec057172f64066c363c375537
Doc update.

* src/keyboard.c (syms_of_keyboard): Update docs of
  local-function-key-map and function-key-map.


git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-430

diff -r 732c5740ca8f -r 513453e09ec7 src/keyboard.c
--- a/src/keyboard.c	Sun Oct 23 22:47:29 2005 +0000
+++ b/src/keyboard.c	Fri Oct 28 11:12:17 2005 +0000
@@ -11578,24 +11578,25 @@
 terminals at any point in a key sequence.
 
 The `read-key-sequence' function replaces any subsequence bound by
-`function-key-map' with its binding.  More precisely, when the active
-keymaps have no binding for the current key sequence but
-`function-key-map' binds a suffix of the sequence to a vector or string,
-`read-key-sequence' replaces the matching suffix with its binding, and
-continues with the new sequence.
-
-The events that come from bindings in `function-key-map' are not
-themselves looked up in `function-key-map'.
-
-For example, suppose `function-key-map' binds `ESC O P' to [f1].
+`local-function-key-map' with its binding.  More precisely, when the
+active keymaps have no binding for the current key sequence but
+`local-function-key-map' binds a suffix of the sequence to a vector or
+string, `read-key-sequence' replaces the matching suffix with its
+binding, and continues with the new sequence.
+
+The events that come from bindings in `local-function-key-map' are not
+themselves looked up in `local-function-key-map'.
+
+For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
 Typing `ESC O P' to `read-key-sequence' would return [f1].  Typing
-`C-x ESC O P' would return [?\\C-x f1].  If [f1] were a prefix
-key, typing `ESC O P x' would return [f1 x].
-
-`function-key-map' has a separate binding for each display device.
-See Info node `(elisp)Multiple displays'.  If you need to define a
-binding on all display devices, change `global-function-key-map'
-instead.
+`C-x ESC O P' would return [?\\C-x f1].  If [f1] were a prefix key,
+typing `ESC O P x' would return [f1 x].
+
+`local-function-key-map' has a separate binding for each display
+device.  See Info node `(elisp)Multiple displays'.  If you need to
+define a binding on all display devices, change `function-key-map'
+instead.  Initially, `local-function-key-map' is an empty keymap that
+has `function-key-map' as its parent on all display devices.
 
 Note that the currently selected frame has very little to do with
 which binding of this variable is active at any given moment.  If you
@@ -11605,7 +11606,9 @@
   DEFVAR_LISP ("function-key-map", &Vfunction_key_map,
                doc: /* The parent keymap of all `local-function-key-map' instances.
 Function key definitions that apply to all display devices should go
-here.  */);
+here.  If a mapping is defined in both the current
+`local-function-key-map' binding and this variable, then the local
+definition will take precendence.  */);
   Vfunction_key_map = Fmake_sparse_keymap (Qnil);
                     
   DEFVAR_KBOARD ("local-key-translation-map", Vlocal_key_translation_map,