aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2017-04-01 13:08:42 +0200
committerJustin M. Keyes <justinkz@gmail.com>2017-04-01 23:14:05 +0200
commitc2826a7830ddba66261afdf45fcf4d0043506342 (patch)
treed979ef9ee3169e1c0e1c8909390dd9f2502a7ed8 /runtime
parent54bab0019b3638f213608757b523062195be156b (diff)
downloadrneovim-c2826a7830ddba66261afdf45fcf4d0043506342.tar.gz
rneovim-c2826a7830ddba66261afdf45fcf4d0043506342.tar.bz2
rneovim-c2826a7830ddba66261afdf45fcf4d0043506342.zip
'guicursor': Empty means "block cursor in all modes".
Also: update default 'guicursor' to match the documentation.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/msgpack_rpc.txt24
-rw-r--r--runtime/doc/options.txt27
-rw-r--r--runtime/doc/vim_diff.txt1
3 files changed, 23 insertions, 29 deletions
diff --git a/runtime/doc/msgpack_rpc.txt b/runtime/doc/msgpack_rpc.txt
index 02086e24fd..3f3c41f566 100644
--- a/runtime/doc/msgpack_rpc.txt
+++ b/runtime/doc/msgpack_rpc.txt
@@ -250,23 +250,21 @@ connect to another with different type codes.
==============================================================================
6. Remote UIs *rpc-remote-ui*
-Nvim allows Graphical user interfaces to be implemented by separate processes
-communicating with Nvim over the RPC API. Currently the ui model conists of a
-terminal-like grid with one single, monospace font size, with a few elements
-that could be drawn separately from the grid (for the momemnt only the popup
-menu)
-
-After connecting to a nvim instance (typically a spawned, embedded instance)
-use the |nvim_ui_attach|(width, height, options) API method to tell nvim that your
-program wants to draw the nvim screen on a grid with "width" times
-"height" cells. "options" should be a dictionary with the following (all
-optional) keys:
- `rgb`: Controls what color format to use.
+GUIs can be implemented as external processes communicating with Nvim over the
+RPC API. Currently the UI model consists of a terminal-like grid with one
+single, monospace font size. Some elements (UI "widgets") can be drawn
+separately from the grid.
+
+After connecting to Nvim (usually a spawned, embedded instance) use the
+|nvim_ui_attach| API method to tell Nvim that your program wants to draw the
+Nvim screen on a grid of width × height cells. `options` must be
+a dictionary with these (optional) keys:
+ `rgb` Controls what color format to use.
Set to true (default) to use 24-bit rgb
colors.
Set to false to use terminal color codes (at
most 256 different colors).
- `popupmenu_external`: Instead of drawing the completion popupmenu on
+ `popupmenu_external` Instead of drawing the completion popupmenu on
the grid, Nvim will send higher-level events to
the ui and let it draw the popupmenu.
Defaults to false.
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 4c827d0749..394e38f6e5 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -2790,22 +2790,17 @@ A jump table for the options with a short description can be found at |Q_op|.
i-ci:ver25-Cursor/lCursor,
r-cr:hor20-Cursor/lCursor,
sm:block-Cursor
- -blinkwait175-blinkoff150-blinkon175",
- for Windows console:
- "n-v-c:block,o:hor50,i-ci:hor15,
- r-cr:hor30,sm:block")
- global
- {only available when compiled with GUI enabled, and
- for Windows console}
- This option tells Vim what the cursor should look like in different
- modes. It fully works in the GUI. In a Windows console, only
- the height of the cursor can be changed. This can be done by
- specifying a block cursor, or a percentage for a vertical or
- horizontal cursor.
- For a console, shape is taken into account and color as well if
- 'termguicolors' is set. 't_SI' and 't_EI' are deprecated in neovim.
-
- The option is a comma separated list of parts. Each part consist of a
+ -blinkwait175-blinkoff150-blinkon175")
+ global
+ Configures the cursor style for each mode. Works in the GUI and some
+ terminals. Empty means "non-blinking block cursor in all modes": >
+ :set guicursor=
+<
+ With tmux you might need this in ~/.tmux.conf (see terminal-overrides
+ in the tmux(1) manual page): >
+ set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
+<
+ The option is a comma separated list of parts. Each part consists of a
mode-list and an argument-list:
mode-list:argument-list,mode-list:argument-list,..
The mode-list is a dash separated list of these modes:
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 41c0c41c80..bd43028806 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -113,6 +113,7 @@ Some `CTRL-SHIFT-...` key chords are distinguished from `CTRL-...` variants
Options:
'cpoptions' flags: |cpo-_|
+ 'guicursor' works in the terminal
'inccommand' shows interactive results for |:substitute|-like commands
'statusline' supports unlimited alignment sections
'tabline' %@Func@foo%X can call any function on mouse-click