diff options
Diffstat (limited to 'runtime/doc/sign.txt')
| -rw-r--r-- | runtime/doc/sign.txt | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/runtime/doc/sign.txt b/runtime/doc/sign.txt index 895ee5ebef..641e193b5e 100644 --- a/runtime/doc/sign.txt +++ b/runtime/doc/sign.txt @@ -47,6 +47,8 @@ The color of the column is set with the SignColumn highlight group :highlight SignColumn guibg=darkgrey < +If 'cursorline' is enabled, then the CursorLineSign highlight group is used +|hl-CursorLineSign|. *sign-identifier* Each placed sign is identified by a number called the sign identifier. This identifier is used to jump to the sign or to remove the sign. The identifier @@ -156,6 +158,13 @@ See |sign_getdefined()| for the equivalent Vim script function. :sign list {name} Lists one defined sign and its attributes. + culhl={group} + Highlighting group used for the text item when the cursor is + on the same line as the sign and 'cursorline' is enabled. + + Example: > + :sign define MySign text=>> texthl=Search linehl=DiffText +< PLACING SIGNS *:sign-place* *E158* @@ -377,6 +386,9 @@ sign_define({list}) text text that is displayed when there is no icon or the GUI is not being used. texthl highlight group used for the text item + culhl highlight group used for the text item when + the cursor is on the same line as the sign and + 'cursorline' is enabled. numhl highlight group used for 'number' column at the associated line. Overrides |hl-LineNr|, |hl-CursorLineNr|. @@ -425,9 +437,13 @@ sign_getdefined([{name}]) *sign_getdefined()* or the GUI is not being used. texthl highlight group used for the text item; not present if not set. + culhl highlight group used for the text item when + the cursor is on the same line as the sign and + 'cursorline' is enabled; not present if not + set. numhl highlight group used for 'number' column at the associated line. Overrides |hl-LineNr|, - |hl-CursorLineNr|. + |hl-CursorLineNr|; not present if not set. Returns an empty List if there are no signs and when {name} is not found. |