From 7961355ba1c0cd521372496c507a31a51b41ddf2 Mon Sep 17 00:00:00 2001
From: Gokul Soumya
Date: Wed, 24 Nov 2021 12:17:41 +0530
Subject: Change cursor shape on mode change

Fixes #323. Due to terminal limitations we can only
change the shape of the primary cursor.
---
 book/src/configuration.md | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

(limited to 'book/src')

diff --git a/book/src/configuration.md b/book/src/configuration.md
index 2ed48d51..a40a8959 100644
--- a/book/src/configuration.md
+++ b/book/src/configuration.md
@@ -5,9 +5,26 @@ To override global configuration parameters, create a `config.toml` file located
 * Linux and Mac: `~/.config/helix/config.toml`
 * Windows: `%AppData%\helix\config.toml`
 
+Example config:
+
+```toml
+theme = "onedark"
+
+[editor]
+line-number = "relative"
+mouse = false
+
+[editor.cursor-shape]
+normal = "underline"
+insert = "block"
+
+[editor.file-picker]
+hidden = false
+```
+
 ## Editor
 
-`[editor]` section of the config.
+### `[editor]` Section
 
 | Key | Description | Default |
 |--|--|---------|
@@ -24,7 +41,28 @@ To override global configuration parameters, create a `config.toml` file located
 | `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
 | `auto-info` | Whether to display infoboxes | `true` |
 
-`[editor.filepicker]` section of the config. Sets options for file picker and global search. All but the last key listed in the default file-picker configuration below are IgnoreOptions: whether hidden files and files listed within ignore files are ignored by (not visible in) the helix file picker and global search. There is also one other key, `max-depth` available, which is not defined by default.
+### `[editor.cursor-shape]` Section
+
+Defines the shape of cursor in each mode. Note that due to limitations
+of the terminal environment, only the primary cursor can change shape.
+
+| Key      | Description                                | Default     |
+| ---      | -----------                                | --------    |
+| `normal` | Cursor shape in [normal mode][normal mode] | `block`     |
+| `insert` | Cursor shape in [insert mode][insert mode] | `bar`       |
+| `select` | Cursor shape in [select mode][select mode] | `underline` |
+
+[normal mode]: ./keymap.md#normal-mode
+[insert mode]: ./keymap.md#insert-mode
+[select mode]: ./keymap.md#select--extend-mode
+
+### `[editor.filepicker]` Section
+
+Sets options for file picker and global search. All but the last key listed in
+the default file-picker configuration below are IgnoreOptions: whether hidden
+files and files listed within ignore files are ignored by (not visible in) the
+helix file picker and global search. There is also one other key, `max-depth`
+available, which is not defined by default.
 
 | Key | Description | Default |
 |--|--|---------|
-- 
cgit v1.2.3-70-g09d2