From eaa0fdaeba2db6259ed43950a9dec09b5fddc3e9 Mon Sep 17 00:00:00 2001
From: Nick Tzaperas <nick@nijotz.com>
Date: Wed, 28 Jun 2017 17:09:54 -0700
Subject: [PATCH] fish_bind_mode variable documentation

---
 doc_src/fish_mode_prompt.txt | 32 +++++++++++++++++++++++++++++---
 1 file changed, 29 insertions(+), 3 deletions(-)

diff --git a/doc_src/fish_mode_prompt.txt b/doc_src/fish_mode_prompt.txt
index b35d4ce4a..ee242369c 100644
--- a/doc_src/fish_mode_prompt.txt
+++ b/doc_src/fish_mode_prompt.txt
@@ -2,10 +2,36 @@
 
 \subsection fish_mode_prompt-synopsis Synopsis
 
-fish_mode_prompt will output the mode indicator for use in vi-mode.
+The fish_mode_prompt function will output the mode indicator for use in vi-mode.
 
 \subsection fish_mode_prompt-description Description
 
-The output of `fish_mode_prompt` will be displayed in the mode indicator position to the left of the regular prompt.
+The default `fish_mode_prompt` function will output indicators about the current Vi editor mode displayed to the left of the regular prompt. Define your own function to customize the appearance of the mode indicator. You can also define an empty `fish_mode_prompt` function to remove the Vi mode indicators. The `$fish_bind_mode variable` can be used to determine the current mode. It
+will be one of `default`, `insert`, `replace_one`, or `visual`.
 
-Multiple lines are not supported in `fish_mode_prompt`.
+\subsection block-example Example
+
+\fish
+function fish_mode_prompt
+  switch $fish_bind_mode
+    case default
+      set_color --bold red
+      echo 'N'
+    case insert
+      set_color --bold green
+      echo 'I'
+    case replace_one
+      set_color --bold green
+      echo 'R'
+    case visual
+      set_color --bold brmagenta
+      echo 'V'
+    case '*'
+      set_color --bold red
+      echo '?'
+  end
+  set_color normal
+end
+\endfish
+
+Outputting multiple lines is not supported in `fish_mode_prompt`.