aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/fish_mode_prompt.txt
diff options
context:
space:
mode:
authorGravatar Fabian Homborg <FHomborg@gmail.com>2016-06-21 19:06:44 +0200
committerGravatar Fabian Homborg <FHomborg@gmail.com>2016-06-26 11:36:31 +0200
commita3e9e179eb51476f3c700e485268db45d367f408 (patch)
tree000afaf6866d686ff4fadd4d00558ce12df430b9 /doc_src/fish_mode_prompt.txt
parent0f3b4d2bd8e28281c876226b4e9c5e8f02c62872 (diff)
Document fish_mode_prompt
Diffstat (limited to 'doc_src/fish_mode_prompt.txt')
-rw-r--r--doc_src/fish_mode_prompt.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc_src/fish_mode_prompt.txt b/doc_src/fish_mode_prompt.txt
new file mode 100644
index 00000000..b35d4ce4
--- /dev/null
+++ b/doc_src/fish_mode_prompt.txt
@@ -0,0 +1,11 @@
+\section fish_mode_prompt fish_mode_prompt - define the appearance of the mode indicator
+
+\subsection fish_mode_prompt-synopsis Synopsis
+
+fish_mode_prompt 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.
+
+Multiple lines are not supported in `fish_mode_prompt`.