Document terminal.cursor_shape (#34707)

Peter Tripp created 4 months ago

Release Notes:

- N/A

Change summary

docs/src/configuring-zed.md      | 48 ++++++++++++++++++++++++++++++++++
docs/src/visual-customization.md |  2 
2 files changed, 49 insertions(+), 1 deletion(-)

Detailed changes

docs/src/configuring-zed.md

@@ -2698,6 +2698,54 @@ List of `integer` column numbers
 }
 ```
 
+### Terminal: Cursor Shape
+
+- Description: Whether or not selecting text in the terminal will automatically copy to the system clipboard.
+- Setting: `cursor_shape`
+- Default: `null` (defaults to block)
+
+**Options**
+
+1. A block that surrounds the following character
+
+```json
+{
+  "terminal": {
+    "cursor_shape": "block"
+  }
+}
+```
+
+2. A vertical bar
+
+```json
+{
+  "terminal": {
+    "cursor_shape": "bar"
+  }
+}
+```
+
+3. An underline / underscore that runs along the following character
+
+```json
+{
+  "terminal": {
+    "cursor_shape": "underline"
+  }
+}
+```
+
+4. A box drawn around the following character
+
+```json
+{
+  "terminal": {
+    "cursor_shape": "hollow"
+  }
+}
+```
+
 ### Terminal: Keep Selection On Copy
 
 - Description: Whether or not to keep the selection in the terminal after copying text.

docs/src/visual-customization.md

@@ -448,7 +448,7 @@ See [Zed AI Documentation](./ai/overview.md) for additional non-visual AI settin
 
     // Set the cursor blinking behavior in the terminal (on, off, terminal_controlled)
     "blinking": "terminal_controlled",
-    // Default cursor shape for the terminal (block, bar, underline, hollow)
+    // Default cursor shape for the terminal cursor (block, bar, underline, hollow)
     "cursor_shape": "block",
 
     // Environment variables to add to terminal's process environment