/vundle.git/doc/vundle.txt
Plain Text | 202 lines | 142 code | 60 blank | 0 comment | 0 complexity | e66c0e7f5dc92d6545efab653b6d2a5b MD5 | raw file
1*vundle.txt* Vundle the plug-in manager for Vim. *vundle* 2 3CONTENTS ~ 4 *vundle-contents* 5=========================================================================== 6 71. About |vundle-about| 82. Why Vundle |vundle-why-vundle| 93. Quick start |vundle-quickstart| 104. Scripts |vundle-scripts| 11 4.1. Configure scripts |vundle-scripts-configure| 12 4.2. Installing scripts |vundle-scripts-install| 13 4.3. Updating scripts |vundle-scripts-update| 14 4.4. Searching scripts |vundle-scripts-search| 15 4.5. Cleanup |vundle-scripts-cleanup| 165. Interactive mode |vundle-interactive| 17 18=========================================================================== 19 20ABOUT *vundle-about* 21 22Vundle is a short cut for Vim bundle and is the Vim plug-in manager. 23 242. WHY VUNDLE ~ 25 *vundle-why-vundle* 26Vundle allows to: 27 28- keep track and configure your scripts right in `.vimrc` 29- install configured scripts (aka bundle) 30- update configured scripts 31- search [all available vim scripts] by name 32- clean up from unused scripts 33 34Also *Vundle* : 35 36- manages runtime path of your installed scripts 37- regenerates helptags automatically 38 39Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) 40in order to install/search [all available vim scripts] 41 423. QUICK START ~ 43 *vundle-quickstart* 441) Setup Vundle: > 45 46 git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git 47 482) Configure bundles: 49 50 Sample `.vimrc`: > 51 52 set nocompatible " be iMproved 53 filetype off " required! 54 55 set rtp+=~/.vim/vundle.git/ 56 call vundle#rc() 57 58 " My Bundles here: 59 " 60 " original repos on github 61 Bundle 'tpope/vim-fugitive' 62 Bundle 'lokaltog/vim-easymotion' 63 Bundle 'rstacruz/sparkup', {'rtp': 'vim/'} 64 " vim-scripts repos 65 Bundle 'L9' 66 Bundle 'FuzzyFinder' 67 Bundle 'rails.vim' 68 " non github repos 69 Bundle 'git://git.wincent.com/command-t.git' 70 " ... 71 72 filetype plugin indent on " required! 73 743) Install configured bundles: 75 76 Launch `vim`, run > 77 78 :BundleInstall 79 80Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for 81each configured repo to `~/.vim/bundle/`. 82 834. SCRIPTS ~ 84 *vundle-scripts* 854.1 CONFIGURE SCRIPTS ~ 86 *vundle-scripts-configure* *Bundle* 87Before installing scripts they need to be configured. It's done using `Bundle` 88command in `.vimrc`: > 89 90 Bundle 'git_repo_uri' " 'git_repo_uri' should be a valid uri to git repository 91or > 92 Bundle 'script_name' " 'script-name' should be an official script name (see |vundle-scripts-search| ) 93 94Vundle loves Github, that's why short uris can be used with commands: > 95 96 Bundle 'tpope/vim-fugitive' 97 98equals full uri > 99 100 Bundle 'http://github.com/tpope/vim-fugitive.git' 101 102NOTE: Vundle defaults to http:// protocol for the short URIs 103 104 1054.2 INSTALL SCRIPTS ~ 106 *vundle-scripts-install* *BundleInstall* 107run > 108 :BundleInstall 109 110installs configured scripts. Newly installed scripts will be automatically 111enabled. Except special cases requiring compilation or pre-configuration. 112 113BundleInstall allows to install scripts by name:> 114 115 :BundleIntall unite.vim 116 117installs and activates unite.vim. You can use Tab to auto-complete known script names. 118NOTE: installation, as just described, doesn't automatically configure scripts; 119you have to configure them manually. 120 1214.3 UPDATE SCRIPTS ~ 122 *vundle-scripts-update* *BundleInstall!* 123run > 124 :BundleInstall! " NOTE: bang(!) 125 126installs or updates configured scripts. 127 1284.4 SEARCHING ~ 129 *vundle-scripts-search* *BundleSearch* 130run > 131 :Bundles foo " NOTE: plural Bundles not singular Bundle 132 133lists bundles matching 'foo' in new a new split window, ie: 134> 135 Bundle "VimFootnotes" 136 Bundle "foo.vim" 137> 138and > 139 140 :Bundles! foo 141 142refreshes script list before performing actual search. 143 144If command is run without argument: > 145 146 :Bundles! 147 148it will display all known scripts 149 150Searching requires [`curl`](http://curl.haxx.se/) 151 1524.5 CLEANING UP ~ 153 *vundle-scripts-cleanup* *BundleClean* 154run > 155 156 :BundleClean 157 158requires confirmation before removal of unused script-dirs from your `.vim/bundle`. 159 160 *BundleClean!* 161> 162 :BundleClean! 163 164removes unused scripts with no questions. 165 166 *vundle-interactive* 1675. INTERACTIVE MODE ~ 168 169Vundle provides simple interactive mode to help you explore new scripts easily. 170Interactive mode is available as result of :Bundles command. For instance, running: > 171 172 :Bundles! unite 173 174triggers search for scripts matching 'unite' and yields a split window with 175content: > 176 177 "Keymap: i - Install bundle; c - Cleanup; r - Refine list; R - Reload list 178 "Search results for: unite 179 Bundle 'unite.vim' 180 Bundle 'unite-yarm' 181 Bundle 'unite-gem' 182 Bundle 'unite-locate' 183 Bundle 'unite-font' 184 Bundle 'unite-colorscheme' 185 186As the first line(starting with `"Keymap:`) shows 187certain Vundle commands can be triggered with single keypress, ie: 188 189KEY | DESCRIPTION 190----|-------------------------- > 191 i | run :BundleInstall with name taken from line cursor is positioned on 192 c | run :BundleCleanup 193 r | refine list; requires a string to refine list with 194 R | fetch fresh script list from server 195 196Now move cursor over line `Bundle 'unite.vim'` and press i key(install). 197After unite.vim script is installed - `:Unite file` command should be 198available to prove 'unite.vim' availability. 199 200NOTE: Interactive installation doesn't update your .vimrc configuration. 201 202vim:tw=78:ts=8:ft=help:norl: