You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-31Lines changed: 33 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ vim.ahk is the setting file for [AutoHotkey](http://www.autohotkey.com/)(Autohot
7
7
vim.exe is a standalone application made from vim.ahk (available in [the releases page](https://github.com/rcmdnk/vim_ahk/releases)).
8
8
9
9
This is vim emulation for Windows.
10
-
If you are interesting in same settings for Mac,
10
+
If you are interested in the same settings for Mac,
11
11
try Vim emulation for [Karabiner - Software for macOS](https://pqrs.org/osx/karabiner/): [Karabiner-Elements complex_modifications rules by rcmdnk](https://rcmdnk.com/KE-complex_modifications/).
12
12
13
13
## Installation
@@ -37,7 +37,7 @@ Unzip the zip file, and place the extracted vim_ahk folder where you like,
37
37
then launch **vim_ahk.exe**.
38
38
39
39
:memo: place **vim_ahk_icons** folder in the same folder with **vim_ahk.exe**,
40
-
otherwise the tray menu icon feature does not work.
40
+
otherwise, the tray menu icon feature does not work.
41
41
42
42
### Build executable from the source
43
43
@@ -66,7 +66,7 @@ The default setting enables vim-mode for the following applications:
66
66
* OneNote
67
67
* Applications using ahk_exe ApplicationFrameHost.exe
68
68
69
-
You can change them from the rightclick menu of task tray icon
69
+
You can change them from the right-click menu of the task tray icon
70
70
(find `VimMenu`-`Settings` in the list),
71
71
or launch the setting window by `Ctrl-Alt-Shift-v`.
Caret width can be changed only on the specific applications: Wordpad, Word, or OneNote.
167
+
Caret width can be changed only on specific applications: Wordpad, Word, or OneNote.
168
168
On Notepad or Explorer, the caret width is kept but does not change.
169
169
170
-
For the most of other applications, the caret width is kept as original width.
170
+
For most other applications, the caret width is kept as the original width.
171
171
172
172
When this option is enabled, the current window briefly loses focus when the mode is changed.
173
173
174
174
## GUI Option Setting Window
175
175
176
-
You can change these options from the rightclick menu of task tray icon
176
+
You can change these options from the right-click menu of the task tray icon
177
177
(find `VimMenu`-`Settings` in the list),
178
178
or launch the setting window by `Ctrl-Alt-Shift-v`.
179
179
@@ -185,7 +185,7 @@ Here, you can add applications, change the mode change key,
185
185
or change the verbose level.
186
186
187
187
If you push `Reset`, default settings will be shown in the window.
188
-
These settings will be enabled only if you push `OK` button.
188
+
These settings will be enabled only if you push the `OK` button.
189
189
190
190
These **default settings** are overwritten by
191
191
your `VimXXX` options in your script described above.
@@ -207,13 +207,13 @@ Here are the main modes.
207
207
|Mode|Description|
208
208
|:---|:----------|
209
209
|Insert mode|Original Windows state|
210
-
|Normal mode|As in vim, a cursor is moved by hjkl, w, etc... and some vimlike commands are available.|
211
-
|Visual mode|There are three visual modes: Character-wise, Line-wise, and Block-wise. Block-wise visual mode is valid only for applications which support block-wise selection (such TeraPad).|
212
-
|Command mode|Can be used for saving file/quitting.|
210
+
|Normal mode|As in vim, a cursor is moved by `hjkl`, `w`, etc... and some vim-like commands are available.|
211
+
|Visual mode|There are three visual modes: Character-wise, Line-wise, and Block-wise. Block-wise visual mode is valid only for applications that support block-wise selection (such TeraPad).|
212
+
|Command mode|Can be used for saving the file/quitting.|
213
213
214
214
The initial state is the insert mode, then `ESC` or `Ctrl-[` brings you to the normal mode.
215
215
216
-
In the normal mode, `i` is the key to be back to the insert mode.
216
+
In the normal mode, `i` is the key to being back to the insert mode.
217
217
218
218
`v`, `V` and `Ctrl-v` are the key to
219
219
the Character-wise, the Line-wise, and the Block-wise
@@ -236,8 +236,8 @@ Ctrl-[ switches off IME and enters the normal mode even if IME is on.
236
236
Long press ESC (Ctrl-[) will send these original keys, if `VimLongEscNormal` (`VimLongCtrlBracketNormal` is not enabled (0).
237
237
238
238
If `VimLongEscNormal` (`VimLongCtrlBracketNormal`) is enabled,
239
-
single press will send original keys
240
-
and long press will change the mode to the normal mode.
239
+
a single press will send original keys
240
+
and a long press will change the mode to the normal mode.
241
241
242
242
If using a custom two-letter hotkey to enter the normal mode, the two letters must be different.
243
243
@@ -247,7 +247,7 @@ If using a custom two-letter hotkey to enter the normal mode, the two letters mu
247
247
248
248
|Key/Commands|Function|
249
249
|:----------:|:-------|
250
-
|i/I/a/A/o/O| Enter the insert mode at under the cursor/start of the line/next to the cursor/end of the line/next line/previous line.|
250
+
|i/I/a/A/o/O| Enter the insert mode under the cursor/start of the line/next to the cursor/end of the line/next line/previous line.|
251
251
|v/V/Ctrl-v|Enter the visual mode of Character-wise/Line-wise/Block-wise.|
252
252
|:|Enter the command line mode|
253
253
@@ -260,7 +260,7 @@ If using a custom two-letter hotkey to enter the normal mode, the two letters mu
260
260
|Ctrl-a/Ctrl-e| Move to the start/end of the line (emacs like).|
261
261
|^| Move to the starting non-whitespace character of the line.|
262
262
|w/W| Move to the beginning of the next word.|
263
-
|e/E| Move to the end of the next word. (Actually, move to the beggining of the next next word and move a one character left.)|
263
+
|e/E| Move to the end of the word. (Actually, move to the beginning of the next word and move one character left.)|
264
264
|b/B| Move to the beginning of the previous word.|
265
265
|Ctrl-u/Ctrl-d| Go Up/Down 10 line.|
266
266
|Ctrl-b/Ctrl-f| PageUp/PageDown.|
@@ -285,6 +285,7 @@ In addition, `Repeat` is also available for some commands.
285
285
|C| Cut from here to the end of the line and enter the insert mode.|
286
286
|x/X| Delete a character under/before the cursor (not registered in the clipboard).|
287
287
|p/P| Paste to the next/current place. If copy/cut was done with the line-wise visual mode, it pastes to the next/current line. Some commands (such yy/dd) also force to paste as line-wise.|
288
+
|yiw/diw/ciw| Copy/cut/change current word.|
288
289
289
290
y/d/c+Move Command can be used, too.
290
291
* e.g.) `yw` -> copy next one word.
@@ -297,7 +298,7 @@ y/d/c+Move Command can be used, too.
297
298
|u/Ctrl-r| Undo/Redo.|
298
299
|r/R| Replace one character/multiple characters.|
299
300
|J| Combine two lines.|
300
-
|.| It is fixed to do: `Replace a following word with a clipboard` (useful to use with a search).|
301
+
|.| It is fixed to do: `Replace the following word with a clipboard` (useful to use with a search).|
301
302
|~| Change case.|
302
303
|/| Start search (search box will be opened)|
303
304
|n/N| Search next/previous (Some applications support only next search)|
@@ -309,27 +310,28 @@ y/d/c+Move Command can be used, too.
309
310
|Key/Commands|Function|
310
311
|:----------:|:-------|
311
312
|ESC/Ctrl-[| Enter the normal mode.|
312
-
|Move command| Most of move commands in the normal mode are available.|
313
+
|Move command| Most move commands in the normal mode are available.|
313
314
|y/d/x/c| Copy/Cut/Cut/Cut and insert (`d`=`x`)|
314
-
|Y/D/X/C| Move to the end of line, then Copy/Cut/Cut/Cut and the insert mode (`D`=`X`)|
315
+
|Y/D/X/C| Move to the end of the line, then Copy/Cut/Cut/Cut and the insert mode (`D`=`X`)|
316
+
|iw| Select the current word.|
315
317
|*| Search the selected word.|
316
318
317
319
## Available commands in the command mode
318
320
319
321
|Key/Commands|Function|
320
322
|:----------:|:-------|
321
-
|ESC/Ctrl-[| Enter the the normal mode.|
323
+
|ESC/Ctrl-[| Enter the normal mode.|
322
324
|w + RETURN| Save |
323
325
|w + SPACE | Save as |
324
326
|w + q| Save and Quit |
325
327
|q | Quit |
326
328
|h | Open help of the application|
327
329
328
-
## Applicationspecific settings
330
+
## Application-specific settings
329
331
330
332
### Q-dir
331
333
332
-
The keybinds refer to [ranger](https://github.com/ranger/ranger) which is a console file manager with VI key bindings
334
+
Refer [ranger](https://github.com/ranger/ranger) which is a console file manager with VI key bindings.
333
335
334
336
#### Available commands in the normal mode
335
337
@@ -343,7 +345,7 @@ The keybinds refer to [ranger](https://github.com/ranger/ranger) which is a cons
343
345
344
346
Tests are run by executing `tests/run_vimahk_tests.ahk`. A notepad and vim window is opened, and vim_ahk is started.
345
347
346
-
The testing system used is a series of test cases in `tests/testcases.txt` representing key strokes to send to vim_ahk. These are sent to the open vim and notepad windows, and the resulting text is compared.
348
+
The testing system used is a series of test cases in `tests/testcases.txt` representing keystrokes to send to vim_ahk. These are sent to the open vim and notepad windows, and the resulting text is compared.
347
349
348
350
The tests can be very flakey, so should be used as a guide and to execute code paths to check for errors. Tests should be run with a default ini.
0 commit comments