further readme and doc
parent
d23fd5166d
commit
ff1101d790
49
README.md
49
README.md
|
@ -8,16 +8,51 @@ necessary to search for different keywords without overriding previous searches;
|
||||||
that is, I wanted to be able to continue adding more words to a search without
|
that is, I wanted to be able to continue adding more words to a search without
|
||||||
having to keep track of which words I've already searched for.
|
having to keep track of which words I've already searched for.
|
||||||
|
|
||||||
Functionality includes:
|
["x]& Highlights the <cword> under the cursor
|
||||||
|
into register x.
|
||||||
|
|
||||||
* ```["x]&```: Add the <cword> under the cursor into highlight registry ```x```.
|
["x]y& Sets the search register to the contents of
|
||||||
* ```["x]d&```: Remove <cword> under the cursor from highlight registry ```x```.
|
register x.
|
||||||
* ```["x]c&```: Clear all words from highlight registry ```x```.
|
|
||||||
|
|
||||||
Additionally, overrides the following:
|
["x]d& Removes the <cword> from register x.
|
||||||
|
|
||||||
* ```["x]*```: Searches for the next <cword> and appends word into registry ```x```.
|
["x]c& Emptys register x. No patterns previously
|
||||||
* ```["x]#```: Searches for the previous <cword> and appends word into registry ```x```.
|
belonging inside this register will be
|
||||||
|
highlighted.
|
||||||
|
|
||||||
|
["x]* Highlights the <cword> under the cursor
|
||||||
|
into register x. Moves to the next
|
||||||
|
occurrence of the <cword>.
|
||||||
|
|
||||||
|
["x]# Highlights the <cword> under the cursor
|
||||||
|
into register x. Moves to the previous
|
||||||
|
occurrence of the <cword>.
|
||||||
|
|
||||||
|
["x]g& Highlights the <cword> under the cursor, but
|
||||||
|
without forcing any highlighted occurrences
|
||||||
|
to be a word. That is, if the selected
|
||||||
|
<cword> is a substring of any text in the
|
||||||
|
current buffer, the substring will also be
|
||||||
|
highlighted.
|
||||||
|
|
||||||
|
["x]g* Works like ["x]g& but also moves to the next
|
||||||
|
occurrence of the pattern.
|
||||||
|
|
||||||
|
["x]g# Works like ["x]g& but also moves to the
|
||||||
|
previous occurrence of the pattern.
|
||||||
|
|
||||||
|
v_["x]& Note the v indicates visual mode. Works like
|
||||||
|
g&, but with the visually selected region.
|
||||||
|
|
||||||
|
v_["x]* Note the v indicates visual mode. Works like
|
||||||
|
g*, but with the visually selected region.
|
||||||
|
|
||||||
|
v_["x]# Note the v indicates visual mode. Works like
|
||||||
|
g#, but with the visually selected region.
|
||||||
|
|
||||||
|
v_["x]d& Note the v indicates visual mode. Removes
|
||||||
|
the visually selected region from register
|
||||||
|
x.
|
||||||
|
|
||||||
Variables
|
Variables
|
||||||
---------
|
---------
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
CONTENTS *highlight-contents*
|
CONTENTS *highlight-contents*
|
||||||
|
|
||||||
1. Usage .................................................. |highlight-usage|
|
1. Usage .................................................. |highlight-usage|
|
||||||
|
2. Variables .......................................... |highlight-variables|
|
||||||
|
|
||||||
============================================================================
|
============================================================================
|
||||||
Section 1: Usage *highlight-usage*
|
Section 1: Usage *highlight-usage*
|
||||||
|
@ -54,4 +55,12 @@ v_["x]d& Note the v indicates visual mode. Removes
|
||||||
the visually selected region from register
|
the visually selected region from register
|
||||||
x.
|
x.
|
||||||
|
|
||||||
|
============================================================================
|
||||||
|
Section 2: Variables *highlight-variables*
|
||||||
|
|
||||||
|
g:highlight_register_default_color
|
||||||
|
|
||||||
|
Default color used when initializing an unused register.
|
||||||
|
|
||||||
|
|
||||||
vim:tw=78:ts=8:ft=help:norl:
|
vim:tw=78:ts=8:ft=help:norl:
|
||||||
|
|
1
doc/tags
1
doc/tags
|
@ -1,3 +1,4 @@
|
||||||
highlight-contents highlight.txt /*highlight-contents*
|
highlight-contents highlight.txt /*highlight-contents*
|
||||||
highlight-usage highlight.txt /*highlight-usage*
|
highlight-usage highlight.txt /*highlight-usage*
|
||||||
|
highlight-variables highlight.txt /*highlight-variables*
|
||||||
highlight.txt highlight.txt /*highlight.txt*
|
highlight.txt highlight.txt /*highlight.txt*
|
||||||
|
|
Loading…
Reference in New Issue