*easymotion.txt* Version 3.0 ______ __ ___ __ _ / ____/____ ________ __/ |/ /____ / /_(_)____ ____ / __/ / __ `/ ___/ / / / /|_/ // __ \/ __/ // __ \/ __ \ / /___ / /_/ (__ ) /_/ / / / // /_/ / /_/ // /_/ / / / / /_____/ \__,_/____/\__, /_/ /_/ \____/\__/_/ \____/_/ /_/ /____/ - Vim motions on speed! ============================================================================== CONTENTS *easymotion-contents* Introduction ....................... |easymotion-introduction| Usage .............................. |easymotion-usage| Default mappings ................ |easymotion-default-mappings| More mappings ................... |easymotion-more-mappings| Requirements ....................... |easymotion-requirements| Configuration ...................... |easymotion-configuration| EasyMotion_keys ................. |EasyMotion_keys| EasyMotion_do_shade ............. |EasyMotion_do_shade| EasyMotion_do_mapping ........... |EasyMotion_do_mapping| EasyMotion_grouping ............. |EasyMotion_grouping| EasyMotion_smartcase ............ |EasyMotion_smartcase| EasyMotion_smartsign ............ |EasyMotion_smartsign| EasyMotion_use_migemo ........... |EasyMotion_use_migemo| EasyMotion_use_upper ........... |EasyMotion_use_upper| EasyMotion_enter_jump_first ..... |EasyMotion_enter_jump_first| EasyMotion_prompt ............... |EasyMotion_prompt| EasyMotion_highlight ............ |EasyMotion_highlight| EasyMotion_add_search_history ... |EasyMotion_add_search_history| EasyMotion_off_screen_search .... |EasyMotion_off_screen_search| EasyMotion_disable_two_key_combo. |EasyMotion_disable_two_key_combo| EasyMotion_verbose .............. |EasyMotion_verbose| Custom highlighting ............. |easymotion-custom-hl| Custom mappings ................. |easymotion-custom-mappings| Leader key .................. |easymotion-leader-key| Custom keys ................. |easymotion-custom-keys| License ............................ |easymotion-license| Known bugs ......................... |easymotion-known-bugs| Contributing ....................... |easymotion-contributing| Credits ............................ |easymotion-credits| ============================================================================== Introduction *easymotion* *easymotion-introduction* EasyMotion provides a much simpler way to use some motions in vim. It takes the out of w or f{char} by highlighting all possible choices and allowing you to press one key to jump directly to the target. When one of the available motions is triggered, all visible text preceding or following the cursor is faded, and motion targets are highlighted. ============================================================================== Usage *easymotion-usage* EasyMotion is triggered by one of the provided mappings (see |easymotion-default-mappings| for details). Example: > Lorem ipsum dolor sit amet. Type w to trigger the word motion |w|. See |easymotion-leader-key| for details about the leader key. When the motion is triggered, the text is updated (no braces are actually added, the text is highlighted in red by default): > Lorem {a}psum {b}olor {c}it {d}met. Press "c" to jump to the beginning of the word "sit": > Lorem ipsum dolor sit amet. Similarly, if you're looking for an "o", you can use the |f| motion. Type fo, and all "o" characters are highlighted: > L{a}rem ipsum d{b}l{c}r sit amet. Press "b" to jump to the second "o": > Lorem ipsum dolor sit amet. And that's it! ------------------------------------------------------------------------------ Default mappings *easymotion-default-mappings* The default configuration defines the following mappings in normal, visual and operator-pending mode if |g:EasyMotion_do_mapping| is on: Note: The default leader has been changed to to avoid conflicts with other plugins you may have installed Default Mapping | Details ---------------------|---------------------------------------------- f{char} | Find {char} to the right. See |f|. F{char} | Find {char} to the left. See |F|. t{char} | Till before the {char} to the right. See |t|. T{char} | Till after the {char} to the left. See |T|. w | Beginning of word forward. See |w|. W | Beginning of WORD forward. See |W|. b | Beginning of word backward. See |b|. B | Beginning of WORD backward. See |B|. e | End of word forward. See |e|. E | End of WORD forward. See |E|. ge | End of word backward. See |ge|. gE | End of WORD backward. See |gE|. j | Line downward. See |j|. k | Line upward. See |k|. n | Jump to latest "/" or "?" forward. See |n|. N | Jump to latest "/" or "?" backward. See |N|. s | Find(Search) {char} forward and backward. | See |f| and |F|. See |easymotion-leader-key| and |mapleader| for details about the leader key. See |easymotion-custom-mappings| for customizing the default mappings. EasyMotion table *easymotion-plug-table* Mapping Table | Default ---------------------|---------------------------------------------- (easymotion-f) | f{char} (easymotion-F) | F{char} (easymotion-t) | t{char} (easymotion-T) | T{char} (easymotion-w) | w (easymotion-W) | W (easymotion-b) | b (easymotion-B) | B (easymotion-e) | e (easymotion-E) | E (easymotion-ge)| ge (easymotion-gE)| gE (easymotion-j) | j (easymotion-k) | k (easymotion-n) | n (easymotion-N) | N (easymotion-s) | s More Mapping Table | (No assignment by default) ----------------------------------|--------------------------------- (easymotion-bd-f) | See |(easymotion-s)| (easymotion-bd-t) | See |(easymotion-bd-t)| (easymotion-bd-w) | See |(easymotion-bd-w)| (easymotion-bd-W) | See |(easymotion-bd-W)| (easymotion-bd-e) | See |(easymotion-bd-e)| (easymotion-bd-E) | See |(easymotion-bd-E)| (easymotion-bd-jk) | See |(easymotion-bd-jk)| (easymotion-bd-n) | See |(easymotion-bd-n)| (easymotion-jumptoanywhere) | See |(easymotion-jumptoanywhere)| (easymotion-repeat) | See |(easymotion-repeat)| (easymotion-next) | See |(easymotion-next)| (easymotion-prev) | See |(easymotion-prev)| (easymotion-sol-j) | See |(easymotion-sol-j)| (easymotion-sol-k) | See |(easymotion-sol-k)| (easymotion-eol-j) | See |(easymotion-eol-j)| (easymotion-eol-k) | See |(easymotion-eol-k)| (easymotion-iskeyword-w) | See |(easymotion-iskeyword-w)| (easymotion-iskeyword-b) | See |(easymotion-iskeyword-b)| (easymotion-iskeyword-bd-w) | See |(easymotion-iskeyword-bd-w)| (easymotion-iskeyword-e) | See |(easymotion-iskeyword-e)| (easymotion-iskeyword-ge) | See |(easymotion-iskeyword-ge)| (easymotion-iskeyword-bd-e) | See |(easymotion-iskeyword-bd-e)| (easymotion-vim-n) | See |(easymotion-vim-n)| (easymotion-vim-N) | See |(easymotion-vim-N)| | Within Line Motion | See |easymotion-within-line| ----------------------------------|--------------------------------- (easymotion-sl) | See |(easymotion-sl)| (easymotion-fl) | See |(easymotion-fl)| (easymotion-Fl) | See |(easymotion-Fl)| (easymotion-bd-fl) | See |(easymotion-sl)| (easymotion-tl) | See |(easymotion-tl)| (easymotion-Tl) | See |(easymotion-Tl)| (easymotion-bd-tl) | See |(easymotion-bd-tl)| (easymotion-wl) | See |(easymotion-wl)| (easymotion-bl) | See |(easymotion-bl)| (easymotion-bd-wl) | See |(easymotion-bd-wl)| (easymotion-el) | See |(easymotion-el)| (easymotion-gel) | See |(easymotion-gel)| (easymotion-bd-el) | See |(easymotion-bd-el)| (easymotion-lineforward) | See |(easymotion-lineforward)| (easymotion-linebackward) | See |(easymotion-linebackward)| (easymotion-lineanywhere) | See |(easymotion-lineanywhere)| | Multi Input Find Motion | See |easymotion-multi-input| ----------------------------------|--------------------------------- (easymotion-s2) | See |(easymotion-s2)| (easymotion-f2) | See |(easymotion-f2)| (easymotion-F2) | See |(easymotion-F2)| (easymotion-bd-f2) | See |(easymotion-s2)| (easymotion-t2) | See |(easymotion-t2)| (easymotion-T2) | See |(easymotion-T2)| (easymotion-bd-t2) | See |(easymotion-bd-t2)| | (easymotion-sl2) | See |(easymotion-sl2)| (easymotion-fl2) | See |(easymotion-fl2)| (easymotion-Fl2) | See |(easymotion-Fl2)| (easymotion-tl2) | See |(easymotion-tl2)| (easymotion-Tl2) | See |(easymotion-Tl2)| | (easymotion-sn) | See |(easymotion-sn)| (easymotion-fn) | See |(easymotion-fn)| (easymotion-Fn) | See |(easymotion-Fn)| (easymotion-bd-fn) | See |(easymotion-sn)| (easymotion-tn) | See |(easymotion-tn)| (easymotion-Tn) | See |(easymotion-Tn)| (easymotion-bd-tn) | See |(easymotion-bd-tn)| | (easymotion-sln) | See |(easymotion-sln)| (easymotion-fln) | See |(easymotion-fln)| (easymotion-Fln) | See |(easymotion-Fln)| (easymotion-bd-fln) | See |(easymotion-sln)| (easymotion-tln) | See |(easymotion-tln)| (easymotion-Tln) | See |(easymotion-Tln)| (easymotion-bd-tln) | See |(easymotion-bd-tln)| Over Window Motion | (No assignment by default) ----------------------------------|--------------------------------- (easymotion-overwin-f) | See |(easymotion-overwin-f)| (easymotion-overwin-f2) | See |(easymotion-overwin-f2)| (easymotion-overwin-line) | See |(easymotion-overwin-line)| (easymotion-overwin-w) | See |(easymotion-overwin-w)| ------------------------------------------------------------------------------ More mappings *easymotion-more-mappings* These mappings are not mapped by Default. Bidirection ~ Note: bd is short for bidirectional (easymotion-s) *(easymotion-s)* *(easymotion-bd-f)* Find {char} to bidirection(forward and backward at the same time.) See |f| & |F|. (easymotion-bd-t) *(easymotion-bd-t)* Till before & after the {char}. See |t| & |T|. (easymotion-bd-w) *(easymotion-bd-w)* Beginning of word forward and backward. See |w| & |b|. (easymotion-bd-W) *(easymotion-bd-W)* Beginning of WORD forward and backward. See |W| & |B|. (easymotion-bd-e) *(easymotion-bd-e)* End of word forward and backward. See |e| & |ge|. (easymotion-bd-E) *(easymotion-bd-E)* End of WORD forward and backward. See |e| & |ge|. (easymotion-bd-jk) *(easymotion-bd-jk)* Line downward and upward. See |j| & |k|. (easymotion-bd-n) *(easymotion-bd-n)* Jump to latest "/" or "?" forward. See |n| & |N|. *easymotion-overwin-motions* Overwin Motions~ Overwin motions supports moving cursor across/over |window|. Since it doesn't make sense that moving cursor to other window while |Visual| or |Operator-pending| mode, overwin motions only provides mappings for |Normal| mode. Please use |nmap| to use overwin motions. overwin motions only supports bi-directional motions. (easymotion-overwin-f){char} *n_(easymotion-overwin-f)* Like |(easymotion-s)| or |(easymotion-bd-f)|, but supports moving cursor to other window. > nmap f (easymotion-overwin-f) xmap f (easymotion-bd-f) omap f (easymotion-bd-f) < (easymotion-overwin-f2){char}{char} *n_(easymotion-overwin-f2)* Like |(easymotion-s2)| or |(easymotion-bd-f2)|, but supports moving cursor to other window. > nmap s (easymotion-overwin-f2) xmap s (easymotion-bd-f2) omap s (easymotion-bd-f2) < (easymotion-overwin-line) *n_(easymotion-overwin-line)* Like |(easymotion-bd-jk)| but supports moving cursor to other window. > nmap L (easymotion-overwin-line) xmap L (easymotion-bd-jk) omap L (easymotion-bd-jk) < (easymotion-overwin-w) *n_(easymotion-overwin-w)* Like |(easymotion-bd-w)| but supports moving cursor to other window. > nmap w (easymotion-overwin-w) xmap w (easymotion-bd-w) omap w (easymotion-bd-w) < For overwin n-character find motions~ *easymotion-do-not-support-overwin-n-char-motions* Overwin n-character find motions is equivalent to *(easymotion-overwin-sn)* (doesn't exist. It's like |(easymotion-sn)| but supports moving cursor to other window). EasyMotion itself doesn't support this mapping, but with |incsearch.vim|[1] and incsearch-easymotion.vim[2], you can get equivalent mappings. incsearch.vim is more compatible with Vim's default search and it works with EasyMotion. [1] https://github.com/haya14busa/incsearch.vim [2] https://github.com/haya14busa/incsearch-easymotion.vim > " You can use other keymappings like instead of if you want to " use these mappings as default search and somtimes want to move cursor with " EasyMotion. function! s:incsearch_config(...) abort return incsearch#util#deepextend(deepcopy({ \ 'modules': [incsearch#config#easymotion#module({'overwin': 1)], \ 'keymap': { \ "\": '(easymotion)' \ }, \ 'is_expr': 0 \ }), get(a:, 1, {})) endfunction noremap / incsearch#go(incsearch_config()) noremap ? incsearch#go(incsearch_config({'command': '?'})) noremap g/ incsearch#go(incsearch_config({'is_stay': 1})) < *easymotion-overwin-limitation* Since archtecture of overwin motions is different from other easymotion motions, there are some limitations. 1. Highlight for target is always EasyMotionTarget (|EasyMotion_highlight|) even for two key targets. Jump To Anywhere ~ (easymotion-jumptoanywhere) *(easymotion-jumptoanywhere)* JumpToAnywhere motion! Default: Beginning and End of word, Camelcase, after '_', and after '#'. You can modify this motion behavior by vimrc |g:EasyMotion_re_anywhere|: *g:EasyMotion_re_anywhere* > let g:EasyMotion_re_anywhere = '\v' . \ '(<.|^$)' . '|' . \ '(.>|^$)' . '|' . \ '(\l)\zs(\u)' . '|' . \ '(_\zs.)' . '|' . \ '(#\zs.)' < Modified example: > let g:EasyMotion_re_anywhere = '\v' . \ '(<.|^)' . '|' . \ '(<.|.$)' . '|' . \ '(\l)\zs(\u)' . '|' . < Repeat ~ (easymotion-repeat) *(easymotion-repeat)* Repeat last motion! Repeat last motion type including input target character. Nothing will happen when previous motion doesn't exist. Last Find Motion~ With a Find motion (e.g. |(easymotion-s)| ), type `` without input characters to invoke the last find motion. This does not repeat the motion type (e.g. other word motion, (easymotion-j) etc...) only input characters. (easymotion-next) *(easymotion-next)* (easymotion-prev) *(easymotion-prev)* Jump to next/previous match. This is the only motion that can move to off-screen locations. With set |'wrapscan'| enabled, this motion will also wrap around the end of the file. During this motion, matched text is highlighted. If you don't want highlighting, set |g:EasyMotion_move_highlight| to 0. Example: > nmap ; (easymotion-next) nmap , (easymotion-prev) < This feature is inspired by and based on vim-sneak. vim-sneak can be downloaded here: https://github.com/justinmk/vim-sneak EasyMotion dot repeat~ *easymotion-dotrepeat* *easymotion-textobject* This feature requires tpope/vim-repeat https://github.com/tpope/vim-repeat All motions support '.' repeat. Example: > " vimrc: omap z (easymotion-t) let g:EasyMotion_keys='hklyuiopnm,qwertzxcvbasdgjf;' < Text sample: > {cursor}Lorem ipsum dolor sit ame*t*, consectetur adipisicing eli*t*, sed do eiusmod tempor < type `dzt` and type first target marker(in this case, `h`) > {cursor}*t*, consectetur adipisicing eli*t,* sed do eiusmod tempor < from here type '`.`' and you get: > *t,* sed do eiusmod tempor < JK Motion ~ *easymotion-jk-motion* JK motion option *(easymotion-j)* *(easymotion-k)* *g:EasyMotion_startofline* The default behavior of the |j| and |k| is to move your cursor to the start of the line. Set this option to 0 to force the cursor to stay in the same column If you want to use both movements as separate mappings, set |'g:EasyMotion_startofline'| to 0 and map |(easymotion-sol-j)| & |(easymotion-sol-k)| to the start of line mapping: > let g:EasyMotion_startofline = 0 # keep cursor colum JK motion map J (easymotion-sol-j) map K (easymotion-sol-k) < Default: 1 Start of Line JK motion *(easymotion-sol-j)* *(easymotion-sol-k)* *(easymotion-sol-bd-jk)* Start of line J/K motion Example: > map J (easymotion-sol-j) map K (easymotion-sol-k) < End of Line JK motion *(easymotion-eol-j)* *(easymotion-eol-k)* *(easymotion-eol-bd-jk)* End of line J/K motion Example: > map J (easymotion-eol-j) map K (easymotion-eol-K) < iskeyword compatible word motions *(easymotion-iskeyword-w)* *(easymotion-iskeyword-b)* *(easymotion-iskeyword-bd-w)* *(easymotion-iskeyword-e)* *(easymotion-iskeyword-ge)* *(easymotion-iskeyword-bd-e)* Default word motions which EasyMotion provide is not completely compatible with |iskeyword| options. But if you make default word motion completely compatible with it, there will be so many targets that they maybe annoy you, so provide |iskeyword| compatible word motions with another || mappings. Example: > map w (easymotion-iskeyword-w) map b (easymotion-iskeyword-b) < NOTE: Within line motions are compatible with |iskeyword| by default. Search motion respect previous direction (easymotion-vim-n) *(easymotion-vim-n)* (easymotion-vim-N) *(easymotion-vim-N)* This is vim compatible |n| & |N| easymotion. Unlike |(easymotion-n)| and |(easymotion-N)| 's direction is always forward or backward, these motions consider previous search direction. Within line motion ~ *easymotion-within-line* (easymotion-sl) *(easymotion-sl)* *(easymotion-bd-fl)* This function is same as |(easymotion-s)|, except the range is limited to the current cursor line. (easymotion-fl) *(easymotion-fl)* This function is same as |(easymotion-f)|, except the range is limited to the current cursor line. (easymotion-Fl) *(easymotion-Fl)* This function is same as |(easymotion-F)|, except the range is limited to the current cursor line. (easymotion-tl) *(easymotion-tl)* This function is same as |(easymotion-t)|, except the range is limited to the current cursor line. (easymotion-Tl) *(easymotion-Tl)* This function is same as |(easymotion-T)|, except the range is limited to the current cursor line. (easymotion-bd-tl) *(easymotion-bd-tl)* This function is same as |(easymotion-bd-t)|, except the range is limited to the current cursor line. (easymotion-wl) *(easymotion-wl)* This function is same as |(easymotion-iskeyword-w)|, except the range is limited to the current cursor line. (easymotion-bl) *(easymotion-bl)* This function is same as |(easymotion-iskeyword-b)|, except the range is limited to the current cursor line. (easymotion-bd-wl) *(easymotion-bd-wl)* This function is same as |(easymotion-iskeyword-bd-w)|, except the range is limited to the current cursor line. (easymotion-el) *(easymotion-el)* This function is same as |(easymotion-iskeyword-e)|, except the range is limited to the current cursor line. (easymotion-gel) *(easymotion-gel)* This function is same as |(easymotion-iskeyword-ge)|, except the range is limited to the current cursor line. (easymotion-bd-el) *(easymotion-bd-el)* This function is same as |(easymotion-iskeyword-bd-e)|, except the range is limited to the current cursor line. (easymotion-lineforward) *(easymotion-lineforward)* This function is similar to |(easymotion-jumptoanywhere)|, except the range is limited to the current cursor line in the forward direction. (easymotion-linebackward) *(easymotion-linebackward)* This function is similar to |(easymotion-jumptoanywhere)|, except the range is limited to the current cursor line in the backward direction. (easymotion-lineanywhere) *(easymotion-lineanywhere)* This function is same as |(easymotion-jumptoanywhere)|, but limited to within the current cursor line. You can customize the behavior of this function in your vimrc. |g:EasyMotion_re_line_anywhere|: *g:EasyMotion_re_line_anywhere* Default: > let g:EasyMotion_re_line_anywhere = '\v' . \ '(<.|^$)' . '|' . \ '(.>|^$)' . '|' . \ '(\l)\zs(\u)' . '|' . \ '(_\zs.)' . '|' . \ '(#\zs.)' < Modified example: > let g:EasyMotion_re_line_anywhere = '\v' . \ '(<.|^)' . '|' . \ '(>.|.$)' . '|' . \ '(\l)\zs(\u)' . '|' . Multi Input Find Motion!~ All Find motions (s,f,F,t,T,sl,fl,Fl,tl,Tl, see below) support this feature! (|l| means within line motion) *easymotion-multi-input* *easymotion-two-key* *easymotion-{find}n* *(easymotion-{find}n)* *(easymotion-{find}2)* *(easymotion-s2)* *(easymotion-f2)* *(easymotion-F2)* *(easymotion-t2)* *(easymotion-T2)* *(easymotion-bd-f2)* *(easymotion-bd-t2)* *(easymotion-sl2)* *(easymotion-fl2)* *(easymotion-Fl2)* *(easymotion-tl2)* *(easymotion-Tl2)* *(easymotion-bd-fl2)* *(easymotion-bd-tl2)* *(easymotion-sn)* *(easymotion-fn)* *(easymotion-Fn)* *(easymotion-tn)* *(easymotion-Tn)* *