From 3ae360ddb38dd49e9392aad7a70f0f31a30849ee Mon Sep 17 00:00:00 2001 From: Bjorn Winckler Date: Thu, 2 Oct 2008 22:53:17 +0200 Subject: [PATCH] Add help on "modifier key as Esc" --- runtime/doc/gui_mac.txt | 26 ++++++++++++++++++++++++++ runtime/doc/tags | 25 ++++++++++++++++++++++++- 2 files changed, 50 insertions(+), 1 deletion(-) diff --git a/runtime/doc/gui_mac.txt b/runtime/doc/gui_mac.txt index 3c864bca..9b310475 100644 --- a/runtime/doc/gui_mac.txt +++ b/runtime/doc/gui_mac.txt @@ -242,6 +242,8 @@ Here is a list of relevant dictionary entries: KEY VALUE ~ MMCellWidthMultiplier width of a normal glyph in em units [float] MMDialogsTrackPwd open/save dialogs track the Vim pwd [bool] +MMFakeEscTimeout timeout for modifier to count as Esc [float] +MMFakeEscOnKeyDown send Esc when modifier is pressed [bool] MMLoginShellArgument login shell parameter [string] MMLoginShellCommand which shell to use to launch Vim [string] MMNoFontSubstitution disable automatic font substitution [bool] @@ -283,6 +285,30 @@ user default MMLoginShellArgument (e.g. to "-l"). Finally, if the "bash" shell is used, then "-l" is automatically added as an argument. To override this behaviour set MMLoginShellArgument to "--". + *macvim-esc* +MacVim can treat a modifier key as Esc in order to avoid having to reach for +the Esc key all the time. The actual modifier key to treat as Esc can be +selected in the preferences (only the left modifier key is affected on +keyboards which have a left and a right modifier key). This is most useful if +Caps Lock has also been remapped to the chosen modifier since it is then +possible to use Caps Lock (which is very easy to reach) to go to normal mode +instead of using Esc (which is somewhat harder to reach). Caps Lock can be +remapped in the "Keyboard & Mouse" System Preference by clicking on the +"Modifier Keys..." button. + +This feature works by swapping the modifier key release event for an Esc key +press event, so the Esc is only sent when the modifier is released. Also, if +the modifier is not released quickly enough no Esc event is sent. This way it +is possible to keep using the modifier key as a modifier (by holding the key +down and pressing another key) as well as using it as Esc (by quickly pressing +the key). It is possible to make MacVim send Esc when the modifier is pressed +(which makes the key feel more responsive) by setting the MMFakeEscOnKeyDown +user default, but then that modifier key can only be used as Esc. The timeout +can also be change by setting the MMFakeEscTimeout user default to the desired +timeout in seconds (e.g. if you want to be able to press the modifier more +slowly but still having it count as Esc, then you could increase the timeout +to 1.0). + ============================================================================== 4. Special colors *macvim-colors* diff --git a/runtime/doc/tags b/runtime/doc/tags index 9758e63d..d8962860 100644 --- a/runtime/doc/tags +++ b/runtime/doc/tags @@ -3012,6 +3012,12 @@ $VIMRUNTIME starting.txt /*$VIMRUNTIME* map.txt /** map.txt /** gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** change.txt /** motion.txt /** change.txt /** @@ -3048,6 +3054,10 @@ $VIMRUNTIME starting.txt /*$VIMRUNTIME* visual.txt /** map.txt /** gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** + gui_mac.txt /** term.txt /** change.txt /** term.txt /** @@ -3180,6 +3190,10 @@ ATTENTION usr_11.txt /*ATTENTION* Abbreviations map.txt /*Abbreviations* Actions.plist gui_mac.txt /*Actions.plist* Aleph options.txt /*Aleph* +Alt-Down gui_mac.txt /*Alt-Down* +Alt-Left gui_mac.txt /*Alt-Left* +Alt-Right gui_mac.txt /*Alt-Right* +Alt-Up gui_mac.txt /*Alt-Up* Amiga os_amiga.txt /*Amiga* Arabic arabic.txt /*Arabic* Atari os_mint.txt /*Atari* @@ -3325,6 +3339,12 @@ CTRL-] tagsrch.txt /*CTRL-]* CTRL-^ editing.txt /*CTRL-^* CTRL-{char} intro.txt /*CTRL-{char}* Chinese mbyte.txt /*Chinese* +Cmd-. gui_mac.txt /*Cmd-.* +Cmd-Down gui_mac.txt /*Cmd-Down* +Cmd-Left gui_mac.txt /*Cmd-Left* +Cmd-Right gui_mac.txt /*Cmd-Right* +Cmd-Up gui_mac.txt /*Cmd-Up* +Cmd-` gui_mac.txt /*Cmd-`* Cmd-event autocmd.txt /*Cmd-event* Cmdline cmdline.txt /*Cmdline* Cmdline-mode cmdline.txt /*Cmdline-mode* @@ -4579,6 +4599,7 @@ after-directory options.txt /*after-directory* aleph options.txt /*aleph* alt intro.txt /*alt* alt-input debugger.txt /*alt-input* +alt-movement gui_mac.txt /*alt-movement* alternate-file editing.txt /*alternate-file* amiga-window starting.txt /*amiga-window* anonymous-function eval.txt /*anonymous-function* @@ -4842,6 +4863,7 @@ clearmatches() eval.txt /*clearmatches()* client-server remote.txt /*client-server* clientserver remote.txt /*clientserver* clipboard gui.txt /*clipboard* +cmd-movement gui_mac.txt /*cmd-movement* cmdarg-variable eval.txt /*cmdarg-variable* cmdbang-variable eval.txt /*cmdbang-variable* cmdline-arguments vi_diff.txt /*cmdline-arguments* @@ -6340,17 +6362,18 @@ macvim-dialogs gui_mac.txt /*macvim-dialogs* macvim-differences gui_mac.txt /*macvim-differences* macvim-drag-n-drop gui_mac.txt /*macvim-drag-n-drop* macvim-encoding gui_mac.txt /*macvim-encoding* +macvim-esc gui_mac.txt /*macvim-esc* macvim-find gui_mac.txt /*macvim-find* macvim-hints gui_mac.txt /*macvim-hints* macvim-important gui_mac.txt /*macvim-important* macvim-login-shell gui_mac.txt /*macvim-login-shell* macvim-menus gui_mac.txt /*macvim-menus* -macvim-movement gui_mac.txt /*macvim-movement* macvim-options gui_mac.txt /*macvim-options* macvim-preferences gui_mac.txt /*macvim-preferences* macvim-prefs gui_mac.txt /*macvim-prefs* macvim-services gui_mac.txt /*macvim-services* macvim-shift-movement gui_mac.txt /*macvim-shift-movement* +macvim-shortcuts gui_mac.txt /*macvim-shortcuts* macvim-start gui_mac.txt /*macvim-start* macvim-todo gui_mac.txt /*macvim-todo* macvim-toolbar gui_mac.txt /*macvim-toolbar* -- 2.11.4.GIT