Dmitry Medvinsky avatar Dmitry Medvinsky committed 8586ee6

Add docs for configuration options

Comments (0)

Files changed (1)

 CONTENTS                                                   *vitality-contents*
 
     1. Overview and Usage .............. |VitalityOverview|
-    2. How it Works .................... |VitalityHow|
-    3. License ......................... |VitalityLicense|
-    4. Bugs ............................ |VitalityBugs|
-    5. Contributing .................... |VitalityContributing|
-    6. Changelog ....................... |VitalityChangelog|
+    2. Configuration ................... |VitalityConfig|
+        2.1 g:vitality_fix_cursor ...... |vitality_fix_cursor|
+        2.2 g:vitality_fix_focus ....... |vitality_fix_focus|
+    3. How it Works .................... |VitalityHow|
+    4. License ......................... |VitalityLicense|
+    5. Bugs ............................ |VitalityBugs|
+    6. Contributing .................... |VitalityContributing|
+    7. Changelog ....................... |VitalityChangelog|
 
 ==============================================================================
 1. Overview and Usage                       *VitalityOverview* *VitalityUsage*
 are a fiddly little rabbit hole, so it's entirely possible that things will
 sometimes break.
 ==============================================================================
-2. How it Works                                                  *VitalityHow*
+2. Configuration                                              *VitalityConfig*
+
+You can tweak the behavior of Vitality by setting a few variables in your
+:vimrc file. Currently two options are available: >
+
+    let g:vitality_fix_cursor = 0
+    let g:vitality_fix_focus = 0
+
+------------------------------------------------------------------------------
+2.1 g:vitality_fix_cursor                                *vitality_fix_cursor*
+
+Set this to 0 if you want to disable normal/insert block/bar cursor switching.
+
+Default: 1
+
+------------------------------------------------------------------------------
+2.2 g:vitality_fix_focus                                  *vitality_fix_focus*
+
+Set this to 0 if you don't want focus events to be processed.
+
+Default: 1
+
+==============================================================================
+3. How it Works                                                  *VitalityHow*
 
 You don't need to know this.
 
 You now have a friendlier Vim/tmux/iTerm 2 environment!
 
 ==============================================================================
-3. License                                                   *VitalityLicense*
+4. License                                                   *VitalityLicense*
 
 Vitality is MIT/X11 licensed.
 
 ==============================================================================
-4. Bugs                                                         *VitalityBugs*
+5. Bugs                                                         *VitalityBugs*
 
 If you find a bug please post it on the issue tracker:
 http://github.com/sjl/vitality.vim/issues/
 
 ==============================================================================
-5. Contributing                                         *VitalityContributing*
+6. Contributing                                         *VitalityContributing*
 
 Think you can make this plugin better?  Awesome!  Fork it on BitBucket or
 GitHub and send a pull request.
 GitHub: http://github.com/sjl/vitality.vim/
 
 ==============================================================================
-6. Changelog                                               *VitalityChangelog*
+7. Changelog                                               *VitalityChangelog*
 
 v1.0.0
     * Initial stable release.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.