aboutsummaryrefslogtreecommitdiff
path: root/atom/packages/vim-mode/docs
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2015-09-28 12:39:59 -0500
committerBen Beltran <ben@nsovocal.com>2015-09-28 12:39:59 -0500
commit455f099b504ec07dd492ab31987ae05a6f6774c7 (patch)
tree22b0c7fd8e492733b97e661750a2d79c46da451d /atom/packages/vim-mode/docs
parent24c7594d62d8d7fbbcdb64b11ce4adc5d8e6991a (diff)
Adds atom packages
Diffstat (limited to 'atom/packages/vim-mode/docs')
-rw-r--r--atom/packages/vim-mode/docs/motions.md22
-rw-r--r--atom/packages/vim-mode/docs/operators.md10
-rw-r--r--atom/packages/vim-mode/docs/overview.md18
-rw-r--r--atom/packages/vim-mode/docs/scrolling.md2
4 files changed, 48 insertions, 4 deletions
diff --git a/atom/packages/vim-mode/docs/motions.md b/atom/packages/vim-mode/docs/motions.md
index 77442e6..ab77fdd 100644
--- a/atom/packages/vim-mode/docs/motions.md
+++ b/atom/packages/vim-mode/docs/motions.md
@@ -35,3 +35,25 @@
* [;](http://vimhelp.appspot.com/motion.txt.html#%3B)
* [,](http://vimhelp.appspot.com/motion.txt.html#%2C)
* [/ and ?](http://vimhelp.appspot.com/pattern.txt.html#search-commands) (including `//` and `??`)
+
+## Implemented Text Objects
+
+[Vim text objects](http://vimhelp.appspot.com/motion.txt.html#object-select)
+
+* ``a "`` ``i "``
+* ``a '`` ``i '``
+* ``a ``` ``i ```
+* ``a (`` ``i (``
+* ``a )`` ``i )``
+* ``a <`` ``i <``
+* ``a >`` ``i >``
+* ``a [`` ``i [``
+* ``a ]`` ``i ]``
+* ``a {`` ``i {``
+* ``a }`` ``i }``
+* ``a b`` ``i b``
+* ``a B`` ``i B``
+* ``a p`` ``i p``
+* ``a w`` ``i w``
+* ``a W`` ``i W``
+* ``i t``
diff --git a/atom/packages/vim-mode/docs/operators.md b/atom/packages/vim-mode/docs/operators.md
index d816daa..dbfc45e 100644
--- a/atom/packages/vim-mode/docs/operators.md
+++ b/atom/packages/vim-mode/docs/operators.md
@@ -15,7 +15,7 @@
* `c2c` - repeated linewise
* `C` - change to the end of the line
* [Adding and subtracting](http://vimhelp.appspot.com/change.txt.html#CTRL-A)
- * `ctrl-a` and `ctrl-x` in command mode to increase/decrease numbers in text
+ * `ctrl-a` and `ctrl-x` in normal mode to increase/decrease numbers in text
* [Yank](http://vimhelp.appspot.com/change.txt.html#yank)
* `vwy` - works in visual mode
* `yw` - with a motion
@@ -26,13 +26,17 @@
* Indent/Outdent/Auto-indent
* `vw>` - works in visual mode
* `>>` - indent current line one level
+ * `>2>` - repeated linewise
+ * `v2>` - repeat indent operation in visual mode
* `<<` - outdent current line one level
+ * `<2<` - repeated linewise
+ * `v2<` - repeat outdent operation in visual mode
* `==` - auto-indents current line
* [Put](http://vimhelp.appspot.com/change.txt.html#p)
* `p` - default register
* `P` - pastes the default register before the current cursor.
- * `"ap` - supports registers (only named a-h, pending more
- advanced atom keymap support)
+ * `"ap` - supports registers
+ * `ctrl-r a` or `ctrl-r "` etc. - supports pasting register content in insert mode
* [Join](http://vimhelp.appspot.com/change.txt.html#J)
* `J` - joins the current line with the immediately following line.
* [Mark](http://vimhelp.appspot.com/motion.txt.html#m)
diff --git a/atom/packages/vim-mode/docs/overview.md b/atom/packages/vim-mode/docs/overview.md
index 3f91ea9..c59176c 100644
--- a/atom/packages/vim-mode/docs/overview.md
+++ b/atom/packages/vim-mode/docs/overview.md
@@ -1,8 +1,14 @@
## Overview
-* There are only currently two modes, command mode and insert mode.
+* There are only currently two modes, normal mode and insert mode.
* Motions have repeat support, `d3w` will delete three words.
* Insert mode can be entered using `i`, `I`, `a`, `A`, `o`, or `O`.
+ * The following commands are supported in insert mode:
+ * `ctrl-y` to copy the character right above the cursor
+ * `ctrl-e` to copy the character right below the cursor (**disabled by default**, see note&nbsp;1 below)
+* Replace mode can be entered using `R`
+ * Limitations:
+ * If repeating with `.` gets a bit confused (e.g. by multiple cursors or when more than one line was typed), please report it with steps to reproduce if you can.
* Registers are a work in progress
* What Exists:
* `a-z` - Named registers
@@ -13,3 +19,13 @@
* What Doesn't Exist:
* default buffer doesn't yet save on delete operations.
* Setting `wrapLeftRightMotion` acts like VIM's whichwrap=h,l,<,>
+
+
+#### Notes
+
+1. To enable the VIM key binding `ctrl-e` to copy the character right below the cursor, please put this in your `keymap.cson`:
+
+```
+'atom-text-editor.vim-mode.insert-mode':
+ 'ctrl-e': 'vim-mode:copy-from-line-below'
+```
diff --git a/atom/packages/vim-mode/docs/scrolling.md b/atom/packages/vim-mode/docs/scrolling.md
index 348b395..bfd0506 100644
--- a/atom/packages/vim-mode/docs/scrolling.md
+++ b/atom/packages/vim-mode/docs/scrolling.md
@@ -12,3 +12,5 @@
* [zz](http://vimhelp.appspot.com/scroll.txt.html#zz)
* [z-](http://vimhelp.appspot.com/scroll.txt.html#z-)
* [zb](http://vimhelp.appspot.com/scroll.txt.html#zb)
+* [zs](http://vimhelp.appspot.com/scroll.txt.html#zs)
+* [ze](http://vimhelp.appspot.com/scroll.txt.html#ze)