From 66c7672a0cda3fa95b49d5bb2b6a0d25b4631794 Mon Sep 17 00:00:00 2001
From: David Chen <weichen2000121@gmail.com>
Date: Tue, 7 Jan 2020 08:38:07 +0800
Subject: [PATCH] updated keybinding config docs

---
 docs/keybindings/Custom_Keybindings.md | 69 +++++++++++---------------
 pkg/gui/keybindings.go                 |  6 +--
 2 files changed, 32 insertions(+), 43 deletions(-)

diff --git a/docs/keybindings/Custom_Keybindings.md b/docs/keybindings/Custom_Keybindings.md
index 6c77f0c105b..698b87e65d0 100644
--- a/docs/keybindings/Custom_Keybindings.md
+++ b/docs/keybindings/Custom_Keybindings.md
@@ -1,6 +1,35 @@
 ## Possible keybindings
 | Put in        | You will get   |
 |---------------|----------------|
+| `<f1>`        | F1             |
+| `<f2>`        | F2             |
+| `<f3>`        | F3             |
+| `<f4>`        | F4             |
+| `<f5>`        | F5             |
+| `<f6>`        | F6             |
+| `<f7>`        | F7             |
+| `<f8>`        | F8             |
+| `<f9>`        | F9             |
+| `<f10>`       | F10            |
+| `<f11>`       | F11            |
+| `<f12>`       | F12            |
+| `<insert>`    | Insert         |
+| `<delete>`    | Delete         |
+| `<home>`      | Home           |
+| `<end>`       | End            |
+| `<pgup>`      | Pgup           |
+| `<pgdown>`    | Pgdn           |
+| `<up>`        | ArrowUp        |
+| `<down>`      | ArrowDown      |
+| `<left>`      | ArrowLeft      |
+| `<right>`     | ArrowRight     |
+| `<tab>`       | Tab            |
+| `<enter>`     | Enter          |
+| `<esc>`       | Esc            |
+| `<backspace>` | Backspace      |
+| `<c-space>`   | CtrlSpace      |
+| `<c-/>`       | CtrlSlash      |
+| `<space>`     | Space          |
 | `<c-a>`       | CtrlA          |
 | `<c-b>`       | CtrlB          |
 | `<c-c>`       | CtrlC          |
@@ -8,12 +37,9 @@
 | `<c-e>`       | CtrlE          |
 | `<c-f>`       | CtrlF          |
 | `<c-g>`       | CtrlG          |
-| `<c-h>`       | CtrlH          |
-| `<c-i>`       | CtrlI          |
 | `<c-j>`       | CtrlJ          |
 | `<c-k>`       | CtrlK          |
 | `<c-l>`       | CtrlL          |
-| `<c-m>`       | CtrlM          |
 | `<c-n>`       | CtrlN          |
 | `<c-o>`       | CtrlO          |
 | `<c-p>`       | CtrlP          |
@@ -27,44 +53,7 @@
 | `<c-x>`       | CtrlX          |
 | `<c-y>`       | CtrlY          |
 | `<c-z>`       | CtrlZ          |
-| `<c-~>`       | CtrlTilde      |
-| `<c-2>`       | Ctrl2          |
-| `<c-3>`       | Ctrl3          |
 | `<c-4>`       | Ctrl4          |
 | `<c-5>`       | Ctrl5          |
 | `<c-6>`       | Ctrl6          |
-| `<c-7>`       | Ctrl7          |
 | `<c-8>`       | Ctrl8          |
-| `<c-space>`   | CtrlSpace      |
-| `<c-\\>`      | CtrlBackslash  |
-| `<c-[>`       | CtrlLsqBracket |
-| `<c-]>`       | CtrlRsqBracket |
-| `<c-/>`       | CtrlSlash      |
-| `<c-_>`       | CtrlUnderscore |
-| `<backspace>` | Backspace      |
-| `<tab>`       | Tab            |
-| `<enter>`     | Enter          |
-| `<esc>`       | Esc            |
-| `<space>`     | Space          |
-| `<f1>`        | F1             |
-| `<f2>`        | F2             |
-| `<f3>`        | F3             |
-| `<f4>`        | F4             |
-| `<f5>`        | F5             |
-| `<f6>`        | F6             |
-| `<f7>`        | F7             |
-| `<f8>`        | F8             |
-| `<f9>`        | F9             |
-| `<f10>`       | F10            |
-| `<f11>`       | F11            |
-| `<f12>`       | F12            |
-| `<insert>`    | Insert         |
-| `<delete>`    | Delete         |
-| `<home>`      | Home           |
-| `<end>`       | End            |
-| `<pgup>`      | Pgup           |
-| `<pgdown>`    | Pgdn           |
-| `<up>`        | ArrowUp        |
-| `<down>`      | ArrowDown      |
-| `<left>`      | ArrowLeft      |
-| `<right>`     | ArrowRight     |
diff --git a/pkg/gui/keybindings.go b/pkg/gui/keybindings.go
index 649b69c595b..50cec5afdaa 100644
--- a/pkg/gui/keybindings.go
+++ b/pkg/gui/keybindings.go
@@ -52,7 +52,7 @@ var keyMapReversed = map[gocui.Key]string{
 	gocui.KeyEsc:        "esc",        // ctrl+[, ctrl+3
 	gocui.KeyBackspace:  "backspace",  // ctrl+h
 	gocui.KeyCtrlSpace:  "ctrl+space", // ctrl+~, ctrl+2
-	gocui.KeyCtrlSlash:  "ctrl+/",
+	gocui.KeyCtrlSlash:  "ctrl+/",     // ctrl+_
 	gocui.KeySpace:      "space",
 	gocui.KeyCtrlA:      "ctrl+a",
 	gocui.KeyCtrlB:      "ctrl+b",
@@ -77,8 +77,8 @@ var keyMapReversed = map[gocui.Key]string{
 	gocui.KeyCtrlX:      "ctrl+x",
 	gocui.KeyCtrlY:      "ctrl+y",
 	gocui.KeyCtrlZ:      "ctrl+z",
-	gocui.KeyCtrl4:      "ctrl+4",
-	gocui.KeyCtrl5:      "ctrl+5",
+	gocui.KeyCtrl4:      "ctrl+4", // ctrl+\
+	gocui.KeyCtrl5:      "ctrl+5", // ctrl+]
 	gocui.KeyCtrl6:      "ctrl+6",
 	gocui.KeyCtrl8:      "ctrl+8",
 }