From 10cdcdfbd405456ae368e210db801fb2dd83b490 Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:35:47 -0600 Subject: [PATCH 1/8] Vimdoc --- doc/vundle.txt | 115 ++++++++++++++++++++++++++++--------------------- 1 file changed, 67 insertions(+), 48 deletions(-) diff --git a/doc/vundle.txt b/doc/vundle.txt index 677b4fe..0a3538e 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -1,46 +1,51 @@ -*vundle.txt* Vundle plug-in for Vim. *vundle* +*vundle.txt* Vundle the plug-in manager for Vim. *vundle* -CONTENTS *vundle-contents* +CONTENTS ~ + *vundle-contents* +=========================================================================== - 1. About |vundle-about| - 2. Why Vundle |vundle-why-vundle| - 3. Setup |vundle-setup| - 4. Scrips |vundle-scripts| - 4.1. Configure scripts |vundle-script-configure| - 4.2. Installing scripts |vundle-script-install| - 4.3. Searching scripts |vundle-script-search| - 4.4. Cleanup |vundle-about| +1. About |vundle-about| +2. Why Vundle |vundle-why-vundle| +3. Quick start |vundle-quickstart|| +4. Scrips |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| -ABOUT *vundle-about* +=========================================================================== -*Vundle* is a short cut for Vim bundle and is the Vim plugin manager. +ABOUT *vundle-about* -WHY VUNDLE *vunde-why-vundle* +Vundle is a short cut for Vim bundle and is the Vim plug-in manager. -*Vundle* allows to: +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 unused scripts up +- clean up from unused scripts -Also as a bonus *Vundle* : +Also as *Vundle* : - manages runtime path of your installed scripts - regenerates helptag atomatically -[Vundle] takes advantage of [vim-scripts.org](http://vim-scripts.org) +Vundle takes advantage of [vim-scripts.org](http://vim-scripts.org) in order to install/search [all available vim scripts] -SETUP *vundle-setup* - -1. Setup [Vundle]: +3. QUICK START ~ + *vundle-quickstart* +1) Setup Vundle: > git clone http://github.com/gmarik/vundle.git ~/.vim/vundle.git -2. Configure bundles: - - Append to your `~/.vimrc`: +2) Configure bundles: + Append to your `~/.vimrc`: > set rtp+=~/.vim/vundle.git/ call vundle#rc() @@ -53,52 +58,66 @@ SETUP *vundle-setup* Bundle "git://git.wincent.com/command-t.git" " ... -3. Install configured bundles: +3) Install configured bundles: - Launch `vim`, run `:BundleInstall` (**no `Vim` restart required** since v0.5) + Launch `vim`, run > - Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`. + :BundleInstall -SCRIPTS *vundle-scripts* +Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for +each configured repo to `~/.vim/bundle/`. -CONFIGURE SCRIPTS *vundle-scripts-configure* +4. SCRIPTS ~ + *vundle-scripts* +4.1 CONFIGURE SCRIPTS ~ + *vundle-scripts-configure* +Before installing scripts they need to be configured. It's done using `Bundle` +command in `.vimrc`: > - -## Script installation + 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| ) - `BundleInstall` installs script only if it hasn't been already installed. - `BundleInstall` is faster than `BundleInstall!` (note bang at the end) because latter fetches scripts without any checks. - Use `BundleInstall` to install new scripts. Use `BundleInstall!` to update scripts. +4.2 INSTALL SCRIPTS ~ + *vundle-scripts-install* +run > + :BundleInstall -SEARCHING |*vundle-scripts-search*| +installs configured scripts. Newly installed scripts will be automatically +enabled. Except special cases requiring compilation or preconfiguration. +4.3 UPDATE SCRIPTS ~ + *vundle-scripts-update* +run > + :BundleInstall! " note bang(!) + +installs or updates configured scripts. + +4.4 SEARCHING ~ + *vundle-scripts-search* +run > :BundleSearch foo lists search results in new split window, ie: - +> Bundle "VimFootnotes" Bundle "foo.vim" so you can just copy ones you need to `.vimrc`. - - :BundleSearch! foo +> + :BundleSearch! foo " note bang(!) refreshes script list before performing actual search. Searching requires [`curl`](http://curl.haxx.se/) -CLEANING UP |*vundle-scripts-cleanup*| - +4.5 CLEANING UP ~ + *vundle-scripts-cleanup* +run > :BundleClean confirms removal of unused script dirs from your `.vim/bundle`. -`BundleClean!` does that silently. +> + :BundleClean! - - -[Vundle]:http://github.com/gmarik/vundle -[Pathogen]:http://github.com/tpope/vim-pathogen/ -[Bundler]:http://github.com/wycats/bundler/ -[Vim]:http://vim.org -[Git]:http://git-scm.com -[all available vim scripts]:http://vim-scripts.org/vim/scripts.html +removes unused scripts with no questions. From 54825a51afd22ca8f3a7e08c7a8d3a02849afd2f Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:35:58 -0600 Subject: [PATCH 2/8] README.md --- README.md | 53 ++++++++++++++--------------------------------------- 1 file changed, 14 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index 6f672f5..4eeacd2 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,7 @@ [Vundle] is a short cut for **V**imb**undle** and is a [Vim] plugin manager. -## Why -[Vundle] allows to: - -- keep track and configure your scripts right in `.vimrc` -- install configured scripts (aka bundle) -- search [all available vim scripts] by name -- clean unused scripts up - -Also as a bonus [Vundle]: - -- manages runtime path of your installed scripts -- regenerates helptag atomatically - -[Vundle] takes advantage of [vim-scripts.org](http://vim-scripts.org) -in order to install/search [all available vim scripts] - -## How +## Quick start 1. Setup [Vundle]: @@ -45,34 +29,25 @@ in order to install/search [all available vim scripts] Installing requires [Git] and triggers [Git clone](http://gitref.org/creating/#clone) for each configured repo to `~/.vim/bundle/`. -## Script installation +## Why Vundle - `BundleInstall` installs script only if it hasn't been already installed. - `BundleInstall` is faster than `BundleInstall!` (note bang at the end) because latter fetches scripts without any checks. - Use `BundleInstall` to install new scripts. Use `BundleInstall!` to update scripts. +[Vundle] allows to: -## Searching +- 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 unused scripts up - :BundleSearch foo +Also as a bonus [Vundle]: -lists search results in new split window, ie: +- manages runtime path of your installed scripts +- regenerates helptag atomatically - Bundle "VimFootnotes" - Bundle "foo.vim" -so you can just copy ones you need to `.vimrc`. +## Docs - :BundleSearch! foo - -refreshes script list before performing actual search. - -Searching requires [`curl`](http://curl.haxx.se/) - -## Cleaning up - - :BundleClean - -confirms removal of unused script dirs from your `.vim/bundle`. `BundleClean!` does that silently. +see [documentation](doc/vundle.txt) for more details. ## Examples @@ -95,7 +70,7 @@ confirms removal of unused script dirs from your `.vim/bundle`. `BundleClean!` d * √ activate newly added bundles on .vimrc reload or after :BundleInstall * √ use preview window for search results -* Vim documentation +* √ vim documentation * improve error handling * allow specify revision/version? * search by description aswell From 49dabe940647f31fb357d22742406fd6d6450bb7 Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:37:52 -0600 Subject: [PATCH 3/8] Docs - fixed path --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4eeacd2..d17f58b 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Also as a bonus [Vundle]: ## Docs -see [documentation](doc/vundle.txt) for more details. +see [documentation](vundle/doc/vundle.txt) for more details. ## Examples From acb1f37dc6c6a88a4bf547e8964620642b705109 Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:39:30 -0600 Subject: [PATCH 4/8] Docs - fixed path --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d17f58b..557ca0f 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Also as a bonus [Vundle]: ## Docs -see [documentation](vundle/doc/vundle.txt) for more details. +see [documentation](vundle/blob/master/doc/vundle.txt) for more details. ## Examples From 20b1e8e5038e3cf43b436af8441b236ddd2f5474 Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:41:32 -0600 Subject: [PATCH 5/8] Docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 557ca0f..8e2b879 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Also as a bonus [Vundle]: ## Docs -see [documentation](vundle/blob/master/doc/vundle.txt) for more details. +see [`doc/vundle.txt`](vundle/blob/master/doc/vundle.txt) vimdoc for more details. ## Examples From c6d665769f8ba2d0ad7e58609c085f6aeceacb7a Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:46:59 -0600 Subject: [PATCH 6/8] Docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e2b879..009ad99 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ Also as a bonus [Vundle]: ## Docs -see [`doc/vundle.txt`](vundle/blob/master/doc/vundle.txt) vimdoc for more details. +see [`:h vundle`](vundle/blob/master/doc/vundle.txt) vimdoc for more details. ## Examples From 2b34c9481f191067a9a5345f2d55f2cf98d4c1a3 Mon Sep 17 00:00:00 2001 From: gmarik Date: Fri, 18 Feb 2011 21:50:54 -0600 Subject: [PATCH 7/8] Doc fix --- doc/vundle.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/vundle.txt b/doc/vundle.txt index 0a3538e..8ebb0f3 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -6,7 +6,7 @@ CONTENTS ~ 1. About |vundle-about| 2. Why Vundle |vundle-why-vundle| -3. Quick start |vundle-quickstart|| +3. Quick start |vundle-quickstart| 4. Scrips |vundle-scripts| 4.1. Configure scripts |vundle-scripts-configure| 4.2. Installing scripts |vundle-scripts-install| From 75e11ff51e41180eb00faf66277a490e5d83fbbb Mon Sep 17 00:00:00 2001 From: gmarik Date: Sat, 19 Feb 2011 11:21:22 -0600 Subject: [PATCH 8/8] Docs fixes --- doc/vundle.txt | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/vundle.txt b/doc/vundle.txt index 8ebb0f3..17f086c 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -70,7 +70,7 @@ each configured repo to `~/.vim/bundle/`. 4. SCRIPTS ~ *vundle-scripts* 4.1 CONFIGURE SCRIPTS ~ - *vundle-scripts-configure* + *vundle-scripts-configure* *Bundle* Before installing scripts they need to be configured. It's done using `Bundle` command in `.vimrc`: > @@ -79,7 +79,7 @@ or > Bundle 'script_name' " 'script-name' should be an official script name (see |vundle-scripts-search| ) 4.2 INSTALL SCRIPTS ~ - *vundle-scripts-install* + *vundle-scripts-install* *BundleInstall* run > :BundleInstall @@ -87,14 +87,14 @@ installs configured scripts. Newly installed scripts will be automatically enabled. Except special cases requiring compilation or preconfiguration. 4.3 UPDATE SCRIPTS ~ - *vundle-scripts-update* + *vundle-scripts-update* *BundleInstall!* run > :BundleInstall! " note bang(!) installs or updates configured scripts. 4.4 SEARCHING ~ - *vundle-scripts-search* + *vundle-scripts-search* *BundleSearch* run > :BundleSearch foo @@ -103,7 +103,7 @@ lists search results in new split window, ie: Bundle "VimFootnotes" Bundle "foo.vim" -so you can just copy ones you need to `.vimrc`. +so you can just copy ones you need to `.vimrc`. *BundleSearch!* > :BundleSearch! foo " note bang(!) @@ -112,12 +112,15 @@ refreshes script list before performing actual search. Searching requires [`curl`](http://curl.haxx.se/) 4.5 CLEANING UP ~ - *vundle-scripts-cleanup* + *vundle-scripts-cleanup* *BundleClean* run > :BundleClean confirms removal of unused script dirs from your `.vim/bundle`. + *BundleClean!* > :BundleClean! removes unused scripts with no questions. + +vim:tw=78:ts=8:ft=help:norl: