aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/options.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/options.txt')
-rw-r--r--runtime/doc/options.txt14
1 files changed, 8 insertions, 6 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 4326f770d4..81dbe7548b 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6022,14 +6022,16 @@ A jump table for the options with a short description can be found at |Q_op|.
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"
- or "r" for left and right button respectively, modifiers
- pressed: string which contains "s" if shift modifier was
- pressed, "c" for control, "a" for alt and "m" for meta.
+ 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 and
+ instead, but one should not rely on presence of spaces or
specific order of modifiers: use |stridx()| to test whether some
- modifier is present.
+ 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.
< - Where to truncate line if too long. Default is at the start.
No width fields allowed.
= - Separation point between left and right aligned items.