Updated vimrc

sources_non_forked/vim-multiple-cursors/README.md

@@ -1,5 +1,20 @@
 # vim-multiple-cursors [![Build Status](https://travis-ci.org/terryma/vim-multiple-cursors.svg)](https://travis-ci.org/terryma/vim-multiple-cursors)
 
+## Contents
+ - [About](#about)
+ - [Features](#features)
+ - [Installation](#installation)
+ - [Quick Start](#quick-start)
+ - [Mapping](#mapping)
+ - [Settings](#settings)
+ - [Interactions with other plugins](#interactions-with-other-plugins)
+ - [Highlight](#highlight)
+ - *[FAQ](#faq)*
+ - *[Known Issues](#known-issues)*
+ - [Changelog](#changelog)
+ - [Contributing](#contributing)
+ - [Credit](#credit) 
+
 ###Contributors
 - [eapache](https://github.com/eapache)
 - [aschrab](https://github.com/aschrab)
@@ -35,7 +50,7 @@ Install using [Pathogen], [Vundle], [Neobundle], or your favorite Vim package ma
 Requires vim 7.4 or later for full functionality.
 
 ## Quick Start
-Out of the box, all you need to know is a single key `Ctrl-n`. Pressing the key in Normal mode highlights the current word under the cursor in Visual mode and places a virtual cursor at the end of it. Pressing it again finds the next ocurrence and places another virtual cursor at the end of the visual selection. If you select multiple lines in Visual mode, pressing the key puts a virtual cursor at every line and leaves you in Normal mode.
+Out of the box, all you need to know is a single key `Ctrl-n`. Pressing the key in Normal mode highlights the current word under the cursor in Visual mode and places a virtual cursor at the end of it. Pressing it again finds the next occurrence and places another virtual cursor at the end of the visual selection. If you select multiple lines in Visual mode, pressing the key puts a virtual cursor at every line and leaves you in Normal mode.
 
 After you've marked all your locations with `Ctrl-n`, you can change the visual selection with normal Vim motion commands in Visual mode. You could go to Normal mode by pressing `v` and wield your motion commands there. Single key command to switch to Insert mode such as `c` or `s` from Visual mode or `i`, `a`, `I`, `A` in Normal mode should work without any issues.
 
@@ -51,12 +66,12 @@ You can also add multiple cursors using a regular expression. The command `Multi
 
 ## Mapping
 Out of the box, only the single key `Ctrl-n` is mapped in regular Vim's Normal mode and Visual mode to provide the functionality mentioned above. `Ctrl-n`, `Ctrl-p`, `Ctrl-x`, and `<Esc>` are mapped in the special multicursor mode once you've added at least one virtual cursor to the buffer. If you don't like the plugin taking over your favorite key bindings, you can turn off the default with
-```
+```viml
 let g:multi_cursor_use_default_mapping=0
 ```
 
 You can then map the 'next', 'previous', 'skip', and 'exit' keys like the following:
-```
+```viml
 " Default mapping
 let g:multi_cursor_next_key='<C-n>'
 let g:multi_cursor_prev_key='<C-p>'
@@ -65,17 +80,17 @@ let g:multi_cursor_quit_key='<Esc>'
 ```
 
 By default, the 'next' key is also used to enter multicursor mode. If you want to use a different key to start multicursor mode than for selecting the next location, do like the following:
-```
+```viml
 " Map start key separately from next key
 let g:multi_cursor_start_key='<F6>'
 ```
 
-Note that when multicursor mode is started, it selects current word without boundaries, i.e. it behaves like `g*`. If you want to use word boundaries in Normal mode (as `*` does) but still have old behaviour up your sleeve, you can do the following:
+Note that when multicursor mode is started, it selects current word with boundaries, i.e. it behaves like `*`. If you want to avoid word boundaries in Normal mode (as `g*` does) but still have old behaviour up your sleeve, you can do the following:
+```viml
+let g:multi_cursor_start_key='<C-n>'
+let g:multi_cursor_start_word_key='g<C-n>'
 ```
-let g:multi_cursor_start_key='g<C-n>'
-let g:multi_cursor_start_word_key='<C-n>'
-```
-In this configuration `<C-n>` will start multicursor mode using word boundaries (but only in Normal mode, as it does not make much sense to use it in Visual mode). Old behaviour without word boundaries is still available using `g<C-n>`.
+In this configuration `<C-n>` will start multicursor mode without word boundaries (but only in Normal mode, as it does not make much sense to use it in Visual mode). Old behaviour with word boundaries is still available using `g<C-n>`.
 
 **IMPORTANT:** Please note that currently only single keystrokes and special keys can be mapped. This means that a mapping like `<Leader>n` will NOT work correctly. For a list of special keys that are supported, see `help :key-notation`
 
@@ -83,7 +98,14 @@ In this configuration `<C-n>` will start multicursor mode using word boundaries
 
 **NOTE:** Prior to version 1.3, the recommended way to map the keys is using the expression quote syntax in Vim, using something like `"\<C-n>"` or `"\<Esc>"` (see h: expr-quote). After 1.3, the recommended way is to use a raw string like above. If your key mappings don't appear to work, give the new syntax a try.
 
-## Setting
+You can also map your own keys to quit, if ``g:multi_cursor_quit_key`` won't work:
+
+```
+let g:multi_cursor_quit_key='<C-c>'
+nnoremap <C-c> :call multiple_cursors#quit()<CR>
+```
+
+## Settings
 Currently there are four additional global settings one can tweak:
 
 ### ```g:multi_cursor_exit_from_visual_mode``` (Default: 1)
@@ -98,17 +120,25 @@ to pause for `timeoutlen` waiting for map completion just like normal vim.
 Otherwise keys mapped in insert mode are ignored when multiple cursors are
 active. For example, setting it to `{'\':1}` will make insert-mode mappings
 beginning with the default leader key work in multi-cursor mode. You have to
-manually set this because vim doesn't provide a way to see which keys *start*
+manually set this because vim doesn't provide a way to see which keys _start_
 mappings.
 
-### ```g:multi_cursor_normal_maps``` (Default: `{}`)
+### ```g:multi_cursor_normal_maps``` (Default: see below)
+Default value: `{'!':1, '@':1, '=':1, 'q':1, 'r':1, 't':1, 'T':1, 'y':1, '[':1, ']':1, '\':1, 'd':1, 'f':1, 'F':1, 'g':1, '"':1, 'z':1, 'c':1, 'm':1, '<':1, '>':1}`
+
 Any key in this map (values are ignored) will cause multi-cursor _Normal_ mode
 to pause for map completion just like normal vim. Otherwise keys mapped in
 normal mode will "fail to replay" when multiple cursors are active. For example,
-setting it to `{'d':1}` will make normal-mode mappings beginning with `d` (such
-as `dw` to delete a word) work in multi-cursor mode. You have to
-manually set this because vim doesn't provide a way to see which keys *start*
-mappings; setting it to include motion commands like `j` can break things.
+changing it from `{}` to `{'d':1}` makes normal-mode mappings beginning with `d`
+(such as `dw` to delete a word) work in multi-cursor mode.
+
+The default list contents should work for anybody, unless they have remapped a
+key from an operator-pending command to a non-operator-pending command or
+vice versa.
+
+These keys must be manually listed because vim doesn't provide a way to
+automatically see which keys _start_ mappings, and trying to run motion commands
+such as `j` as if they were operator-pending commands can break things.
 
 ### Interactions with other plugins
 
@@ -122,7 +152,7 @@ is entered.
 For example, if you are using [Neocomplete](https://github.com/Shougo/neocomplete.vim),
 add this to your vimrc to prevent conflict:
 
-```
+```viml
 " Called once right before you start selecting multiple cursors
 function! Multiple_cursors_before()
   if exists(':NeoCompleteLock')==2
@@ -143,14 +173,23 @@ With this locking and unlocking we prevent neocomplete to trigger it's function
 ### Highlight
 The plugin uses the highlight group `multiple_cursors_cursor` and `multiple_cursors_visual` to highlight the virtual cursors and their visual selections respectively. You can customize them by putting something similar like the following in your vimrc:
 
-```
+```viml
 " Default highlighting (see help :highlight and help :highlight-link)
 highlight multiple_cursors_cursor term=reverse cterm=reverse gui=reverse
 highlight link multiple_cursors_visual Visual
 ```
 
-## Issues
+## FAQ
+
+**Q** <kbd>CTRL</kbd>+<kbd>n</kbd> doesn't seem to work in gVIM?
+
+**A** Try setting `set selection=inclusive` in your `~/.gvimrc`
+
+## Known Issues
 - Select mode is not implemented
+- I and A do not work in Visual mode yet (See #55)
+  
+ Single key command to switch to Insert mode such as c or s from Visual mode or i, a, I, A in Normal mode should work without any issues. **NOTE**: vim's Visual block mode also supports I and A commands, however they do not work in this plugin's Visual mode at the moment. For now, to use I and A, switch to normal mode by pressing v first.
 
 ## Changelog
 See [CHANGELOG.md](CHANGELOG.md)