mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-04-23 15:55:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Reword help

Browse Source
This commit is contained in:
ZyX
2015-12-20 18:38:07 +03:00
parent 3f314d40be
commit 1a356e6439
1 changed files with 25 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
runtime/doc/options.txt
View File

@@ -6012,26 +6012,36 @@ A jump table for the options with a short description can be found at |Q_op|.
alignment of a section. Must be followed by %) somewhere.
) - End of item group. No width fields allowed.
T N For 'tabline': start of tab page N label. Use %T or %X to end
the label. This information is used for mouse clicks.
the label. Clicking this label with left mouse button switches
to the specified tab page.
X N For 'tabline': start of close tab N label. Use %X or %T to end
the label, e.g.: %3Xclose%X. Use %999X for a "close current
tab" mark. This information is used for mouse clicks.
tab" label. Clicking this label with left mouse button closes
specified tab page.
@ N For 'tabline': start of execute function label. Use %X or %T to
end the label, e.g.: %10@SwitchBuffer@foo.c%X. This information
is used for mouse clicks: in the example when clicking once
end the label, e.g.: %10@SwitchBuffer@foo.c%X. Clicking this
label runs specified function: in the example when clicking once
using left mouse button on "foo.c" "SwitchBuffer(10, 1, 'l',
' ')" expression will be run. Function receives the
following arguments in order: minwid field value, number of
mouse clicks (to detect double clicks), mouse button used: "l",
"r" or "m" for left, right or middle button respectively,
modifiers pressed: string which contains "s" if shift modifier
was pressed, "c" for control, "a" for alt and "m" for meta.
Currently if modifier is not pressed string contains space
instead, but one should not rely on presence of spaces or
specific order of modifiers: use |stridx()| to test whether some
modifier is present. One should also not rely on third argument
being only "l", "r" or "m": any other string value may be
expected for other mouse buttons.
following arguments in order:
1. minwid field value or zero if no N was specified
2. number of mouse clicks to detect multiple clicks
3. mouse button used: "l", "r" or "m" for left, right or middle
button respectively; one should not rely on third argument
being only "l", "r" or "m": any other non-empty string value
that contains only ASCII lower case letters may be expected
for other mouse buttons
4. modifiers pressed: string which contains "s" if shift
modifier was pressed, "c" for control, "a" for alt and "m"
for meta; currently if modifier is not pressed string
contains space instead, but one should not rely on presence
of spaces or specific order of modifiers: use |stridx()| to
test whether some modifier is present; string is guaranteed
to contain only ASCII letters and spaces, one letter per
modifier; "?" modifier may also be present, but its presence
is a bug that denotes that new mouse button recognition was
added without modifying code that reacts on mouse clicks on
this label.
< - Where to truncate line if too long. Default is at the start.
No width fields allowed.
= - Separation point between left and right aligned items.