*vundle.txt* Vundle the plug-in manager for Vim.     *vundle*



CONTENTS ~

                                                   *vundle-contents*

===========================================================================



1. About                                           |vundle-about|

2. Why Vundle                                      |vundle-why-vundle|

3. Quick start                                     |vundle-quickstart|

4. Scripts                                          |vundle-scripts|

   4.1. Configure scripts                          |vundle-scripts-configure|

   4.2. Installing scripts                         |vundle-scripts-install|

   4.3. Updating scripts                           |vundle-scripts-update|

   4.4. Searching scripts                          |vundle-scripts-search|

   4.5. Cleanup                                    |vundle-scripts-cleanup|

5. Interactive mode                                |vundle-interactive|



===========================================================================



ABOUT                                              *vundle-about*



Vundle is a short cut for Vim bundle and is the Vim plug-in manager.



2. WHY VUNDLE ~

                                                   *vundle-why-vundle*

Vundle allows to:



- keep track and configure your scripts right in `.vimrc`

- install configured scripts (aka bundle) 

- update configured scripts

- search [all available vim scripts] by name

- clean up from unused scripts



Also *Vundle* :



- manages runtime path of your installed scripts

- regenerates helptags automatically



Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) 

in order to install/search [all available vim scripts]



3. QUICK START ~

                                                    *vundle-quickstart*

1) Setup Vundle: >



    git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git



2) Configure bundles:



   Sample `.vimrc`: >



     set nocompatible               " be iMproved

     filetype off                   " required!



     set rtp+=~/.vim/vundle.git/ 

     call vundle#rc()



     " My Bundles here:

     "

     " original repos on github

     Bundle 'tpope/vim-fugitive'

     Bundle 'lokaltog/vim-easymotion'

     Bundle 'rstacruz/sparkup', {'rtp': 'vim/'}

     " vim-scripts repos

     Bundle 'L9'

     Bundle 'FuzzyFinder'

     Bundle 'rails.vim'

     " non github repos

     Bundle 'git://git.wincent.com/command-t.git'

     " ...



     filetype plugin indent on     " required!



3) Install configured bundles:



   Launch `vim`, run >



    :BundleInstall



Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for 

each configured repo to `~/.vim/bundle/`.



4. SCRIPTS ~

                                                    *vundle-scripts*

4.1 CONFIGURE SCRIPTS ~

                                      *vundle-scripts-configure* *Bundle*

Before installing scripts they need to be configured. It's done using `Bundle`

command in `.vimrc`: >



    Bundle 'git_repo_uri'       " 'git_repo_uri' should be a valid uri to git repository 

or >

    Bundle 'script_name'        " 'script-name' should be an official script name (see |vundle-scripts-search| )



Vundle loves Github, that's why short uris can be used with commands: >



    Bundle 'tpope/vim-fugitive'



equals full uri >



    Bundle 'http://github.com/tpope/vim-fugitive.git'



NOTE: Vundle defaults to http:// protocol for the short URIs





4.2 INSTALL SCRIPTS ~

                                      *vundle-scripts-install* *BundleInstall*

run >

    :BundleInstall



installs configured scripts. Newly installed scripts will be automatically

enabled. Except special cases requiring compilation or pre-configuration.



BundleInstall allows to install scripts by name:>



    :BundleIntall unite.vim



installs and activates unite.vim. You can use Tab to auto-complete known script names.

NOTE: installation, as just described, doesn't automatically configure scripts; 

you have to configure them manually.



4.3 UPDATE SCRIPTS ~

                                      *vundle-scripts-update* *BundleInstall!*

run >

    :BundleInstall!             " NOTE: bang(!)



installs or updates configured scripts.



4.4 SEARCHING ~

                                       *vundle-scripts-search* *BundleSearch*

run >

    :Bundles foo                " NOTE: plural Bundles not singular Bundle



lists bundles matching 'foo' in new a new split window, ie:

>

    Bundle "VimFootnotes"

    Bundle "foo.vim"

>

and >



    :Bundles! foo



refreshes script list before performing actual search.



If command is run without argument: >



    :Bundles!



it will display all known scripts



Searching requires [`curl`](http://curl.haxx.se/)



4.5 CLEANING UP ~

                                     *vundle-scripts-cleanup* *BundleClean*

run >



    :BundleClean



requires confirmation before removal of unused script-dirs from your `.vim/bundle`. 



                                                            *BundleClean!*

>

    :BundleClean! 



removes unused scripts with no questions.



                                     *vundle-interactive*

5. INTERACTIVE MODE ~



Vundle provides simple interactive mode to help you explore new scripts easily.

Interactive mode is available as result of :Bundles command. For instance, running: >



    :Bundles! unite



triggers search for scripts matching 'unite' and yields a split window with

content: >



    "Keymap: i - Install bundle; c - Cleanup; r - Refine list; R - Reload list

    "Search results for: unite

    Bundle 'unite.vim'

    Bundle 'unite-yarm'

    Bundle 'unite-gem'

    Bundle 'unite-locate'

    Bundle 'unite-font'

    Bundle 'unite-colorscheme'



As the first line(starting with `"Keymap:`) shows 

certain Vundle commands can be triggered with single keypress, ie:



KEY | DESCRIPTION

----|-------------------------- >

 i  |  run :BundleInstall with name taken from line cursor is positioned on

 c  |  run :BundleCleanup

 r  |  refine list; requires a string to refine list with

 R  |  fetch fresh script list from server



Now move cursor over line `Bundle 'unite.vim'` and press i key(install). 

After unite.vim script is installed - `:Unite file` command should be

available to prove 'unite.vim' availability.



NOTE: Interactive installation doesn't update your .vimrc configuration.



vim:tw=78:ts=8:ft=help:norl: