From: Frank Terbeck <ft@grml.org>
Date: Sun, 17 Mar 2013 18:50:23 +0000 (+0100)
Subject: grmlzshrc.t2t: Add customisation note about smkx and rmkx for keybindings
X-Git-Url: http://git.grml.org/?p=grml-etc-core.git;a=commitdiff_plain;h=edb13007bae9c7a8d02594b4043341980b021fed

grmlzshrc.t2t: Add customisation note about smkx and rmkx for keybindings

Signed-off-by: Frank Terbeck <ft@grml.org>
---

diff --git a/doc/grmlzshrc.t2t b/doc/grmlzshrc.t2t
index 7c75e50..a74e087 100644
--- a/doc/grmlzshrc.t2t
+++ b/doc/grmlzshrc.t2t
@@ -508,6 +508,23 @@ Display help on keybindings and zsh line editor. Press consecutively to page thr
 Brings a job, which got suspended with CTRL-z back to foreground.
 
 
+=== Customisation ===
+
+To customise keybindings, you can just use zsh's bindkey utility. However, if
+you plan to to use the `//zle-line-init//' or `//zle-line-finish//' hooks
+yourself, make sure you call the following functions in the respective hook:
+
+- **zle-line-init**: //zle-smkx//
+- **zle-line-finish**: //zle-rmkx//
+
+
+This is **required** so the keybindings set up by //grmlzshrc// work. The
+reason for this is to turn the terminal into the right mode while zsh's line
+editor (zle) is running. This enables us to query //terminfo// about escape
+sequences for special keys and thus simplify and generalise our keybinding
+section.
+
+
 == SHELL FUNCTIONS ==
 //grmlzshrc// comes with a wide array of defined shell functions to ease the
 user's life.