aboutsummaryrefslogtreecommitdiff
path: root/atom/packages/vim-mode/docs
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2015-07-10 11:12:25 -0500
committerBen Beltran <ben@nsovocal.com>2015-07-10 11:12:25 -0500
commit24c7594d62d8d7fbbcdb64b11ce4adc5d8e6991a (patch)
treeded312222bb108923da1820ba40b04d710d20e5b /atom/packages/vim-mode/docs
parenteb786e82d170e2abc351a432ade616d6ecdeeb6b (diff)
Adds atom
Diffstat (limited to 'atom/packages/vim-mode/docs')
-rw-r--r--atom/packages/vim-mode/docs/motions.md37
-rw-r--r--atom/packages/vim-mode/docs/operators.md43
-rw-r--r--atom/packages/vim-mode/docs/overview.md15
-rw-r--r--atom/packages/vim-mode/docs/scrolling.md14
-rw-r--r--atom/packages/vim-mode/docs/windows.md12
5 files changed, 121 insertions, 0 deletions
diff --git a/atom/packages/vim-mode/docs/motions.md b/atom/packages/vim-mode/docs/motions.md
new file mode 100644
index 0000000..77442e6
--- /dev/null
+++ b/atom/packages/vim-mode/docs/motions.md
@@ -0,0 +1,37 @@
+## Implemented Motions
+
+* [w](http://vimhelp.appspot.com/motion.txt.html#w)
+* [W](http://vimhelp.appspot.com/motion.txt.html#W)
+* [e](http://vimhelp.appspot.com/motion.txt.html#e)
+* [E](http://vimhelp.appspot.com/motion.txt.html#E)
+* [b](http://vimhelp.appspot.com/motion.txt.html#b)
+* [B](http://vimhelp.appspot.com/motion.txt.html#B)
+* [h](http://vimhelp.appspot.com/motion.txt.html#h)
+* [j](http://vimhelp.appspot.com/motion.txt.html#j)
+* [k](http://vimhelp.appspot.com/motion.txt.html#k)
+* [l](http://vimhelp.appspot.com/motion.txt.html#l)
+* [{](http://vimhelp.appspot.com/motion.txt.html#%7B)
+* [}](http://vimhelp.appspot.com/motion.txt.html#%7D)
+* [^](http://vimhelp.appspot.com/motion.txt.html#%5E)
+* [$](http://vimhelp.appspot.com/motion.txt.html#%24)
+* [0](http://vimhelp.appspot.com/motion.txt.html#0)
+* [-](http://vimhelp.appspot.com/motion.txt.html#-)
+* [+](http://vimhelp.appspot.com/motion.txt.html#+)
+* [_](http://vimhelp.appspot.com/motion.txt.html#_)
+* [&lt;enter&gt;](http://vimhelp.appspot.com/motion.txt.html#<CR>)
+* [gg](http://vimhelp.appspot.com/motion.txt.html#gg)
+* [G](http://vimhelp.appspot.com/motion.txt.html#G)
+* [gt](http://vimhelp.appspot.com/tabpage.txt.html#gt)
+* [gT](http://vimhelp.appspot.com/tabpage.txt.html#gT)
+* [H](http://vimhelp.appspot.com/motion.txt.html#H)
+* [L](http://vimhelp.appspot.com/motion.txt.html#L)
+* [M](http://vimhelp.appspot.com/motion.txt.html#M)
+* ['[a-z][A-Z]](http://vimhelp.appspot.com/motion.txt.html#%27)
+* [`[a-z][A-Z]](http://vimhelp.appspot.com/motion.txt.html#%27)
+* [f](http://vimhelp.appspot.com/motion.txt.html#f)
+* [F](http://vimhelp.appspot.com/motion.txt.html#F)
+* [t](http://vimhelp.appspot.com/motion.txt.html#t)
+* [T](http://vimhelp.appspot.com/motion.txt.html#T)
+* [;](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 `??`)
diff --git a/atom/packages/vim-mode/docs/operators.md b/atom/packages/vim-mode/docs/operators.md
new file mode 100644
index 0000000..d816daa
--- /dev/null
+++ b/atom/packages/vim-mode/docs/operators.md
@@ -0,0 +1,43 @@
+## Implemented Operators
+
+* [Delete](http://vimhelp.appspot.com/change.txt.html#deleting)
+ * `vwd` - works in visual mode
+ * `dw` - with a motion
+ * `3d2w` - with repeating operator and motion
+ * `dd` - linewise
+ * `d2d` - repeated linewise
+ * `D` - delete to the end of the line
+ * `X` - delete the character before the cursor
+* [Change](http://vimhelp.appspot.com/change.txt.html#c)
+ * `vwc` - works in visual mode
+ * `cw` - deletes the next word and switches to insert mode.
+ * `cc` - linewise
+ * `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
+* [Yank](http://vimhelp.appspot.com/change.txt.html#yank)
+ * `vwy` - works in visual mode
+ * `yw` - with a motion
+ * `yy` - linewise
+ * `y2y` - repeated linewise
+ * `"ayy` - supports registers (named a-z, A-Z for append, *, +, %, _)
+ * `Y` - linewise
+* Indent/Outdent/Auto-indent
+ * `vw>` - works in visual mode
+ * `>>` - indent current line one level
+ * `<<` - outdent current line one level
+ * `==` - 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)
+* [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)
+ * `m[a-z][A-Z]` - marks the current cursor position
+* [Case](http://vimhelp.appspot.com/motion.txt.html#operator)
+ * `~` or `g~` - toggles case
+ * `gU`, or `U` in visual mode - changes to upper case
+ * `gu`, or `u` in visual mode - changes to lower case
diff --git a/atom/packages/vim-mode/docs/overview.md b/atom/packages/vim-mode/docs/overview.md
new file mode 100644
index 0000000..3f91ea9
--- /dev/null
+++ b/atom/packages/vim-mode/docs/overview.md
@@ -0,0 +1,15 @@
+## Overview
+
+* There are only currently two modes, command 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`.
+* Registers are a work in progress
+ * What Exists:
+ * `a-z` - Named registers
+ * `A-Z` - Appending to named registers
+ * `*`, `+` - System clipboard registers, although there's no distinction between the two currently.
+ * `%` - Current filename read-only register
+ * `_` - Blackhole register
+ * What Doesn't Exist:
+ * default buffer doesn't yet save on delete operations.
+* Setting `wrapLeftRightMotion` acts like VIM's whichwrap=h,l,<,>
diff --git a/atom/packages/vim-mode/docs/scrolling.md b/atom/packages/vim-mode/docs/scrolling.md
new file mode 100644
index 0000000..348b395
--- /dev/null
+++ b/atom/packages/vim-mode/docs/scrolling.md
@@ -0,0 +1,14 @@
+## Implemented Scrolling Commands
+
+* [ctrl-e](http://vimhelp.appspot.com/scroll.txt.html#CTRL-E)
+* [ctrl-y](http://vimhelp.appspot.com/scroll.txt.html#CTRL-Y)
+* [ctrl-f](http://vimhelp.appspot.com/scroll.txt.html#CTRL-F)
+* [ctrl-b](http://vimhelp.appspot.com/scroll.txt.html#CTRL-B)
+* [ctrl-u](http://vimhelp.appspot.com/scroll.txt.html#CTRL-U)
+* [ctrl-d](http://vimhelp.appspot.com/scroll.txt.html#CTRL-D)
+* [z enter](http://vimhelp.appspot.com/scroll.txt.html#z%3CCR%3E)
+* [zt](http://vimhelp.appspot.com/scroll.txt.html#zt)
+* [z.](http://vimhelp.appspot.com/scroll.txt.html#z.)
+* [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)
diff --git a/atom/packages/vim-mode/docs/windows.md b/atom/packages/vim-mode/docs/windows.md
new file mode 100644
index 0000000..ebad2d9
--- /dev/null
+++ b/atom/packages/vim-mode/docs/windows.md
@@ -0,0 +1,12 @@
+## Implemented Split Pane Commands
+
+* `ctrl-w h`/`ctrl-w left`/`ctrl-w ctrl-h` - focus pane on left
+* `ctrl-w l`/`ctrl-w right`/`ctrl-w ctrl-l` - focus pane on right
+* `ctrl-w k`/`ctrl-w up`/`ctrl-w ctrl-k` - focus pane above
+* `ctrl-w j`/`ctrl-w down`/`ctrl-w ctrl-j` - focus pane below
+* `ctrl-w w`/`ctrl-w ctrl-w` - focus next pane
+* `ctrl-w p`/`ctrl-w ctrl-p` - focus previous pane
+* `ctrl-w v`/`ctrl-w ctrl-v` - create vertical split
+* `ctrl-w s`/`ctrl-w ctrl-s` - create horizontal split
+* `ctrl-w c`/`ctrl-w ctrl-c` - close focused pane
+* `ctrl-w q`/`ctrl-w ctrl-q` - close focused tab